[DOCS] Settings Documentation
Documentation Type
settings.local.json
Documentation Location
_No response_
Section/Topic
Settings Documentation
Current Documentation
_No response_
What's Wrong or Missing?
Problem
There's a community-maintained JSON schema on SchemaStore that does a solid job giving IDE autocomplete for settings files. Huge thanks to the folks keeping that going! However, it inevitably drifts after new releases since there's no automated sync, and contributors are basically reverse-engineering the schema from behavior (see
#24995).
Hook input payloads (the JSON piped to stdin) have no schema or types at all, so writing hooks is a lot of trial
and error.
Suggested Improvement
Unless these already exist somewhere I'm not finding:
- Ship a JSON schema with Claude Code: maintain it in the repo so it stays in sync with releases. Editors can
reference it directly; whether it also gets published to SchemaStore is secondary.
- Publish types for hook input payloads: a .d.ts file or even a docs page showing what each hook event sends on stdin would save hook authors from console.log-driven development.
Impact
Low - Minor confusion or inconvenience
Additional Context
_No response_
This issue has 2 comments on GitHub. Read the full discussion on GitHub ↗