-
-
Notifications
You must be signed in to change notification settings - Fork 719
docs(linter): Add configuration option docs for 5 rules. #15199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors configuration schema handling for lint rules by moving configuration documentation from the declare_oxc_lint! macro into field-level doc comments on config structs. This enables automatic schema generation using serde and schemars, making configurations more maintainable and self-documenting.
Key changes:
- Added
JsonSchemaderive and serde attributes to config structs - Moved configuration option documentation from macro comments to struct field doc comments
- Added
config = ConfigTypeparameter todeclare_oxc_lint!macro invocations - Removed trailing whitespace from test strings in curly.rs
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/oxc_linter/src/rules/typescript/no_namespace.rs | Refactored NoNamespace config to use JsonSchema, moved option docs to struct fields |
| crates/oxc_linter/src/rules/typescript/array_type.rs | Refactored ArrayType config to use JsonSchema with serde derives, moved option docs to struct fields |
| crates/oxc_linter/src/rules/react/exhaustive_deps.rs | Refactored ExhaustiveDeps config to use JsonSchema, added field-level documentation |
| crates/oxc_linter/src/rules/promise/always_return.rs | Refactored AlwaysReturn config to use JsonSchema, moved option docs to struct fields |
| crates/oxc_linter/src/rules/eslint/curly.rs | Refactored Curly config to use JsonSchema with serde derives, removed trailing whitespace from test strings |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CodSpeed Performance ReportMerging #15199 will not alter performanceComparing Summary
Footnotes
|
Part of #14743.
Generated docs: