feat(cli): JSON Schema generation + IDE autocomplete support#325
Merged
4 commits merged intomainfrom Apr 28, 2026
Merged
Conversation
added 4 commits
April 28, 2026 22:41
CI re-runs the full test suite (incl. doctests) on every PR via the .github/workflows/ci.yml tests job, so local pre-push duplication adds ~20 min per push without catching anything new. Pre-push hooks should be fast-fail; expensive checks belong on the CI server. Closes audit finding: silent productivity tax (pre-push duplication).
Documents the three-state intent (true/false/absent) of ProviderConfig.is_enabled and the dependency on deny_unknown_fields (added in the next commit) to reject typos like enbaled = false at parse time. Behaviour is unchanged; this is purely contractual clarity to support the silent-typo-killer audit. Closes audit finding: silent typo killer on provider config.
Adds #[serde(deny_unknown_fields)] to AppConfig and the major sub-structs (ProviderConfig, ModelConfig, TierConfig, RouterConfig, ScoringConfig, CacheConfig, BudgetConfig, DlpConfig, SecurityConfig). Without this guard, a typo like enbaled = false in a [[providers]] block silently parses (the unknown key is dropped) and the provider remains enabled with the wrong intent. With the guard, parsing fails loudly and the operator gets an actionable error pointing at the offending key. Tested with the full nextest suite (1268 tests) plus all doctests: no fixture, preset or example carries a stale field, so this is a pure tightening with no migration cost. Closes audit finding: silent typo killer on TOML config.
Each entry in DENIED_SECTIONS / DENIED_KEYS now carries a short justification table covering why it can not be hot-reloaded — either because the data is sensitive (credentials, DLP rules) or because the consumer is constructed once at process start (TLS listener, secret backend, TEE attestation, FIPS gate). Adds tee, fips, server.tls and secrets.backend to the deny-list so the documented "static-init" rationale matches actual behaviour. Also emits an INFO log on every denied attempt telling the operator to restart instead of expecting the silent reload to apply. Adds two unit tests covering the new deny entries (tee/fips sections and server.tls / secrets.backend keys) and asserts that sibling keys in the same sections remain editable. Closes audit finding: hot-reload UX (silent ignore of denied edits).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
grob schemasubcommand that prints a JSON Schema (Draft 7) for~/.grob/config.toml, generated fromJsonSchema-decorated config structs insrc/cli/config/. Operators editing the file get autocomplete, hover docs, and inline type errors in VS Code (Even Better TOML), JetBrains, Neovim (taplo / coc-toml), and Helix.schemas/grob-config.schema.jsonchecked into the repo, kept in sync by a new CI jobschema-up-to-datethat fails any PR where the committed schema drifts from the code..vscode/settings.jsonwires the schema in for contributors editing project configs;docs/how-to/ide-autocomplete.mdcovers VS Code / JetBrains / Neovim / Helix / CLI validation setups for end users.Implementation notes
schemars = "0.8"added toCargo.toml. All structs insrc/cli/config/*.rsplus thePort/BudgetUsd/BodySizeLimitnewtypes deriveJsonSchema.SecretStringfields use#[schemars(with = \"Option<String>\")]so the schema describes them as opaque strings (literal value,\$ENV_VAR, orsecret:<name>).AppConfigis mirrored by aSchemaAppConfigwrapper insrc/cli/config/schema.rs. Sections that live in cross-cutting feature modules (dlp,mcp,policies,tap,auth,tool_layer,log_export,pledge,classifier) are surfaced asserde_json::Valueplaceholders so future feature blocks remain valid without forcing aJsonSchemaderive on every internal feature module. The well-known sections (server, router, providers, models, tiers, presets, budget, security, cache, secrets, compliance, otel, tee, fips, user, harness) are fully typed.grob schemais short-circuited inmain.rsbefore config loading runs, so it works on a freshly cloned machine with no~/.grob/config.toml.oneOf(verified forAuthType->apikey/oauth,SecretsBackend->local_encrypted/env/file,EnforcementMode,ModelStrategy,FanOutMode,PoolStrategy).Test plan
cargo nextest run --lib-> 1060 / 1060 pass, including 7 new tests covering schema generation + thecmd_schemacommand.cargo test --doc-> doctest forcli::schema::generatecompiles.cargo fmt --all -- --checkclean.cargo clippy --all-targets -- -D warningsclean (default + CI feature subset +harnessfeature).cargo run --bin grob -- schema | jq .-> valid JSON, 33 named definitions, all 26 top-level config sections present.diff schemas/grob-config.schema.json <(grob schema)-> empty (CI guard verified locally before push).schemas/so this PR will not bump the version; release-plz runs only onsrc/**,Cargo.toml,Cargo.lock-> the release path triggers as expected sinceCargo.tomlandCargo.lockchanged).~/.grob/config.tomlin VS Code with Even Better TOML installed, hover[server]field -> description renders.🤖 Generated with Claude Code