Publish a JSON Schema of jevgate.toml

CHANGELOG.md

@@ -4,6 +4,7 @@ Notable changes to JevGate. Versions follow [Semantic Versioning](https://semver
 
 ## [Unreleased]
 
+- `jevgate.schema.json` is a JSON Schema of `jevgate.toml`, generated from the configuration types with every rule name and level, and `jevgate init` writes a `#:schema` line so editors with TOML schema support complete and check the file.
 - pre-commit hooks: `jevgate-system` runs the installed `jevgate` on the staged changes, and `jevgate` builds it from source with Rust first.
 - `--format sarif` writes a SARIF 2.1.0 log for GitHub code scanning, GitLab and editors: the findings `--format github` annotates, as `error` when they fail the gate and `warning` otherwise, with every rule's question, related locations, the finding's fingerprint and probability. Run errors and files that could not be judged are tool notifications.
 - Agent output is colored on a terminal: the headline by the gate's outcome, review and consider headings, and each finding's location. `--color auto|always|never` chooses, and `NO_COLOR` and `CLICOLOR_FORCE` are honored; JSON and GitHub annotations are never colored.

Cargo.toml

@@ -48,6 +48,10 @@ tree-sitter-php = "=0.24.2"
 tree-sitter-java = "=0.23.5"
 ureq = { version = "=3.4.2", default-features = false, features = ["rustls", "json"] }
 
+# The JSON Schema of jevgate.toml is generated by a test from the configuration types.
+[dev-dependencies]
+schemars = "=1.2.2"
+
 [target.'cfg(unix)'.dependencies]
 libc = "=0.2.189"
 signal-hook = { version = "=0.4.4", default-features = false }

README.md

@@ -221,7 +221,7 @@ Other CI systems work the same way: install with `install.sh` or `cargo binstall
 
 ## Configuration
 
-`jevgate init` writes a commented `jevgate.toml` at the repository root. The command line wins over the file, except that upload patterns and budgets in the file are ceilings that flags can only narrow. Unknown keys are errors.
+`jevgate init` writes a commented `jevgate.toml` at the repository root. The command line wins over the file, except that upload patterns and budgets in the file are ceilings that flags can only narrow. Unknown keys are errors. Its first line points editors with TOML schema support (Even Better TOML, Taplo) to [`jevgate.schema.json`](jevgate.schema.json), which completes keys, rule names and levels and flags mistakes as you type.
 
 ```toml
 upload_allow = ["src/**", "tests/**"]   # only these paths may be uploaded