feat(linter/no-unused-vars): add experimental fix mode controls (off|suggestion|fix)#19774
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. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Merging this PR will not alter performance
Comparing Footnotes
|
aa78d30 to
daa6093
Compare
Merge activity
|
daa6093 to
2e0e1d0
Compare
There was a problem hiding this comment.
Pull request overview
Adds experimental, fine-grained auto-fix controls to eslint/no-unused-vars so users can independently disable/emit suggestions/emit fixes for unused imports vs unused variables, addressing the need to clean unused imports without impacting intentionally-unused vars.
Changes:
- Introduces
fix: { imports, variables }options with modesoff | suggestion | fixand parsing/defaulting behavior. - Updates the
no-unused-varsrule to emit fixes conditionally based on the configured symbol-kind fix mode. - Updates rule docs snapshot and adds tests covering the new configuration surface.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tasks/website_linter/src/rules/snapshots/docs_rule_pages.snap | Updates generated docs to describe the new fix option and revised fix capability metadata. |
| crates/oxc_linter/src/rules/eslint/no_unused_vars/tests/oxc.rs | Adds a new test for the fix options and expected fix kinds. |
| crates/oxc_linter/src/rules/eslint/no_unused_vars/options.rs | Adds NoUnusedVarsFixOptions / NoUnusedVarsFixMode and config parsing + tests. |
| crates/oxc_linter/src/rules/eslint/no_unused_vars/mod.rs | Switches rule fix metadata and routes diagnostics through a fix-mode-aware reporting helper. |
| Err(invalid_option_mismatch_error(name, ["off", "suggestion", "fix"], actual)) | ||
| } | ||
| }, | ||
| _ => Err(invalid_option_error(name, format!("Expected a boolean or string, got {value}"))), |
There was a problem hiding this comment.
parse_fix_mode only accepts string values ("off" | "suggestion" | "fix"), but the fallback error message says "Expected a boolean or string". This is misleading when users pass an invalid type (e.g. number/bool). Update the message to reflect the actual accepted types (e.g. "Expected a string") or add explicit boolean handling if booleans are intended to be supported.
| _ => Err(invalid_option_error(name, format!("Expected a boolean or string, got {value}"))), | |
| _ => Err(invalid_option_error(name, format!("Expected a string, got {value}"))), |
| #[test] | ||
| fn test_fix_options() { | ||
| let pass = vec![]; | ||
| let fail = vec![ | ||
| ("import foo from './foo';", Some(json!([{ "fix": { "imports": "off" } }]))), | ||
| ("let a = 1;", Some(json!([{ "fix": { "variables": "off" } }]))), | ||
| ]; | ||
|
|
||
| let fix = vec![ | ||
| ( | ||
| "let a = 1;", | ||
| "", | ||
| Some(json!([{ "fix": { "imports": "off" } }])), | ||
| FixKind::DangerousSuggestion, | ||
| ), | ||
| ( | ||
| "import foo from './foo';", | ||
| "", | ||
| Some(json!([{ "fix": { "variables": "off" } }])), | ||
| FixKind::DangerousSuggestion, | ||
| ), | ||
| ( | ||
| "import foo from './foo';", | ||
| "", | ||
| Some(json!([{ "fix": { "imports": "fix" } }])), | ||
| FixKind::DangerousFix, | ||
| ), | ||
| ("let a = 1;", "", Some(json!([{ "fix": { "variables": "fix" } }])), FixKind::DangerousFix), | ||
| ]; | ||
|
|
||
| Tester::new(NoUnusedVars::NAME, NoUnusedVars::PLUGIN, pass, fail).expect_fix(fix).test(); | ||
| } |
There was a problem hiding this comment.
The new fix config supports disabling fixes per symbol kind ("imports": "off" / "variables": "off"), but the tests here only assert that fixes still work when the other kind is turned off, and that "fix" switches the fix kind. Consider adding fixer test cases that assert no code change happens when the relevant kind is set to "off" (e.g. unused import with fix.imports = "off" and unused variable with fix.variables = "off"), to prevent regressions where fixes are still emitted despite being disabled.
# Oxlint ### 🚀 Features - 2e0e1d0 linter/no-unused-vars: Add experimental fix mode controls (off|suggestion|fix) (#19774) (camc314) - f34f6fa linter: Introduce typeCheck config option (#19764) (camc314) - 694be7d linter: Introduce typeAware as config options (#19614) (camc314) - 655c38f semantic: Add "did you mean?" suggestions to undefined name errors (#19102) (copilot-swe-agent) - e97a57e linter/id-length: Use serde to deserialize rule options (#19636) (camc314) - c4a3677 parser: Report error for initializer in ambient context (#19187) (camc314) - 346045a linter/id-length: Add `checkGeneric` option (#19634) (camc314) ### 🐛 Bug Fixes - 1b7a937 linter: Correct double-comparisons fix with swapped operands (#19846) (camc314) - c308857 linter/consistent_type_imports: Add missing help and notes to diagnostics (#19827) (Daniel Osmond) - 7682e5a linter/plugins: Decode escapes in identifier tokens (#19838) (overlookmotel) - f368fcd linter/consistent_type_assertions: Add missing with_help and with_note to diagnostics (#19826) (Daniel Osmond) - 04e6223 npm: Add `preferUnplugged` for Yarn PnP compatibility (#19829) (Boshen) - 86d5037 linter: Add help text to no-extend-native, no-useless-backreference (#19733) (Anthony Amaro) - 50e8eff linter: Add .with_help() to operator-assignment, no-nonoctal-decimal-escape (#19732) (Anthony Amaro) - 1417bdc linter/no-wrapper-object-types: Add help messages to missing diagnostics (#19771) (Daniel Osmond) - 0838477 linter/ban_ts_comment: Add help and notes to missing diagnostics (#19781) (Daniel Osmond) - e8c77cf linter/adjacent_overload_signatures: Add missing diagnostics (#19780) (Daniel Osmond) - 28834ac linter/ban_types: Add missing help and note to diagnostics (#19782) (Daniel Osmond) - fd938d3 linter/prefer-enum-initializers: Add help messages to missing diagnostics (#19772) (Daniel Osmond) - eb928ee linter/no-dynamic-delete: Add help messages to missing diagnostics (#19768) (Daniel Osmond) - a985666 linter/no-empty-interface: Add help messages to missing diagnostics (#19769) (Daniel Osmond) - 2dc0ceb linter/no-extra-non-null-assertion: Add help messages to missing diagnostics (#19770) (Daniel Osmond) - 95d5d66 linter/no-dupe-keys: Handle `__proto__` proto setters in (#19762) (camc314) - 24ff0db linter/exhaustive-deps: False positive for member expressions in IIFEs (#19751) (Dennis Chen) - 7243a58 linter/no-use-before-define: Honor `ignoreTypeReferences` when value and type name collisions (#19747) (Dimava) - eefd818 linter/explicit-module-boundary-types: Add help messages to missing diagnostics (#19736) (Daniel Osmond) - 0440e9a linter: Add help text to no_control_regex, no_fallthrough, no_param_reassign (#19655) (Anthony Amaro) - e84cb2f react/display-name: Handle merged type+value context symbols (#19608) (camc314) - ce7e253 linter/prefer-object-from-entries: Require exact path match in unicorn helper (#19687) (camc314) - f5694ce estree/tokens: Reverse field order of `regex` object in tokens (#19679) (overlookmotel) - b2b7a55 estree/tokens: Generate tokens for files with BOM (#19535) (overlookmotel) - 0722721 linter/jsx-curly-brace-presence: False positive with prop & mixed quotes (#19674) (camc314) - 3496acd linter: Enhance diagnostic help messages for eslint rules (#19653) (Anthony Amaro) - e384e94 linter: Enhance help diagnostic messages for more eslint rules (#19658) (Anthony Amaro) - a4d5b34 linter: Avoid non-promise catch false positives (#19574) (camc314) - 5706f38 linter: `unicorn/no-array-callback-reference` skip `Effect.*` array-like methods name. (#19633) (Said Atrahouch) ### ⚡ Performance - 05ccf9f linter/plugins: Transfer tokens via raw transfer (#19893) (overlookmotel) - 4b0611a estree/tokens: Introduce `ESTreeTokenConfig` trait (#19842) (overlookmotel) - ec88f6a estree/tokens: Serialize tokens while visiting AST (#19726) (overlookmotel) - d4dcf26 linter/plugins: Remove `typescript` from bundle (#19531) (overlookmotel) - 6a6513c linter/plugins: Use Oxc tokens in plugins (#19498) (camc314) ### 📚 Documentation - d86f59e linter: Improve docs for no-useless-concat, mark as pending fixer. (#19859) (connorshea) - caa091d linter/plugins: Correct doc comments for `initTokens` (#19530) (overlookmotel) - 2fa936f README.md: Map npm package links to npmx.dev (#19666) (Boshen) - dc0ff73 linter/no-useless-constructor: Warn for parameter properties as well (#19638) (Ole Asteo) # Oxfmt ### 🚀 Features - 5141bc2 formatter: Support trailing ignore comments (#19304) (Andreas Lubbe) - 4888a99 oxfmt/lsp: Support other schemes beside `file://` and `untitled://` (#19872) (Sysix) - 14a0181 oxfmt: Support `graphql()` variant for gql-in-js (#19703) (leaysgur) - ca68ea6 oxfmt: Support gql-in-js substitution (#19670) (leaysgur) - 035933c formatter,oxfmt: Support js-in-vue (partially) (#19514) (leaysgur) - 9e11dc6 parser,estree,coverage: Collect tokens in parser and convert to ESTree format (#19497) (camc314) ### 🐛 Bug Fixes - 8e3842d oxfmt: Avoid embedded TSFN crash by returning errors as data (take2) (#19806) (Yuji Sugiura) - 04e6223 npm: Add `preferUnplugged` for Yarn PnP compatibility (#19829) (Boshen) - e540585 oxfmt: Support tailwind sort for CSS/LESS/SCSS (#19803) (leaysgur) - 93bb861 formatter: Trim trailing whitespace before breaking line (#19740) (leaysgur) - b85f97b formatter: Drop blank line between terminal call and first chain member (#19659) (Dunqing) ### ⚡ Performance - b3b2d30 parser: Introduce `ParserConfig` (#19637) (overlookmotel) ### 📚 Documentation - 2fa936f README.md: Map npm package links to npmx.dev (#19666) (Boshen) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>

#18301