fix(linter): reverse extends overrides priority#14939
fix(linter): reverse extends overrides priority#14939camc314 merged 2 commits intooxc-project:mainfrom
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.
Pull Request Overview
This PR fixes the priority of extended configuration overrides to ensure that the current config's overrides take precedence over extended config's overrides, maintaining consistency with how base-level rules are handled.
Key Changes:
- Reversed the order of override merging so current config overrides have priority over extended config overrides
- Added comprehensive test coverage to verify the correct precedence behavior
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| crates/oxc_linter/src/config/oxlintrc.rs | Fixed override merge order to prioritize current config over extended config |
| crates/oxc_linter/src/config/config_builder.rs | Added test case verifying override precedence behavior |
| crates/oxc_linter/fixtures/extends_config/overrides/current_override.json | Test fixture for current config with overrides |
| crates/oxc_linter/fixtures/extends_config/overrides/base_override.json | Test fixture for base config with overrides |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CodSpeed Performance ReportMerging #14939 will not alter performanceComparing Summary
Footnotes
|
678b9f9 to
e2a347f
Compare
camc314
left a comment
There was a problem hiding this comment.
Sorry for the delay getting to this.
I'm worred about this breaking user's configs, but technically this is a bug fix rather than a breaking change, so I guess it's ok.
There was a problem hiding this comment.
Sorry I'm late to the party!
Would appreciate it if you could follow-up with fixes for the 2 things below. if you don't have time, please just say so, and I'll do it.
Secondly, has this change also reversed the order that extends are applied?
If so, good! Behavior prior to this PR was not in line with what's described in the docs: https://oxc.rs/docs/guide/usage/linter/config-file-reference.html#extends (so it was a bug fix, not a breaking change).
But could you please add a test for this, so we don't break it again by accident?
If this PR didn't fix that, we should re-open #14925 for this 2nd change.
| /// [Self] takes priority over `other` | ||
| #[must_use] | ||
| pub fn merge(&self, other: Oxlintrc) -> Oxlintrc { | ||
| pub fn merge(&self, other: &Oxlintrc) -> Oxlintrc { |
There was a problem hiding this comment.
Changing other from Oxlintrc to &Oxlintrc introduces the necessity for an additional clone. The caller has an owned Oxlintrc, so this is unnecessary.
I know taking an owned Oxlintrc is a bit weird, but given that we have one, we may as well avoid the clone.
Could you revert that change please?
| @@ -218,7 +218,7 @@ impl Oxlintrc { | |||
| /// Merges two [Oxlintrc] files together | |||
| /// [Self] takes priority over `other` | |||
There was a problem hiding this comment.
Is this comment still accurate? If not, please update it.
Given that this is a bit confusing (hence why implementation was wrong before this PR), it'd also be helpful to expand this comment with an example of what merging looks like - show who wins when self and other both have the same property.
|
@wagenet Just a ping to check you saw my comments above. If you don't have time to make the requested changes, no problem. But please let me know either way, so I can put them on my list if you're not going to be able to get to it. |
# Oxlint ### 🚀 Features - c199e38 linter: Implement config for all tsgolint rules supporting options (#15659) (camchenry) - 7598b3e linter: Allow configuring tsgolint rules (#15286) (camchenry) - e77f2ce vscode: Support `oxlint --lsp` (#15680) (Sysix) - e01c551 oxlint: Add `--lsp` flag to run the language server (#15611) (Sysix) - ac5c2ab lsp/fmt: Support ignore files & patterns (#15647) (Sysix) - e50a9bf linter: Add unicorn/prefer-response-static-json rule (#15692) (Mikhail Baev) - f5d9abb oxlint: Add enabled? column to --rules cli output (#15213) (Wren) - 6b5205c linter/plugins: Implement deprecated `SourceCode#getJSDocComment` method (#15653) (overlookmotel) - 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens methods (#15645) (overlookmotel) - 4c62ffa language_server: Add `run_server` helper for CLI tools (#15609) (Sysix) - 0d52a5e linter/plugins: Implement `Context#parserOptions` getter (#15632) (overlookmotel) - 287a538 linter/plugins: Implement `Context#get*` deprecated methods (#15606) (overlookmotel) - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (#15612) (leaysgur) - e763919 linter: Add test to enforce schema documentation for rules with configuration options (#15234) (Connor Shea) - 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr` option (#15507) (Li Wei) ### 🐛 Bug Fixes - 1decd57 linter/no-empty-named-blocks: Only search within node for comma token (#15751) (camc314) - 17c3d6d linter: Improve docs, diagnostic message, and implementation of typescript/consistent-indexed-object-style rule. (#15750) (connorshea) - 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for token (#15735) (camc314) - 042befd linter/require-await: Skip comments when searching for token (#15734) (camc314) - 7a78220 linter/no-async-await: Skip comments when searching for token (#15733) (camc314) - 23b9ad1 linter/consistent-type-specifier-style: Skip comments when searching for token (#15732) (camc314) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (#15710) (camc314) - 516d14e linter/no-namespace: Skip comments when searching for token (#15716) (camc314) - b5aaace linter/prefer-namespace-keyword: Skip comments when searching for token (#15715) (camc314) - 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (#14203) (Sysix) - 9f991a4 linter: Reverse extends overrides priority (#14939) (Peter Wagenet) - 7c4a916 linter: Restores `oxlint --rules -f=json` functionality. (#15689) (Wren) - 24d00f4 linter/plugins: Add types for suggested fixes (#15636) (overlookmotel) - 257360f linter/plugins: Fill in TS type def for `RuleMeta` (#15629) (overlookmotel) - 81e179c linter: Allow file extensions without a dot in react/jsx-filename-extension rule (#15574) (Connor Shea) - 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs (#15581) (connorshea) - bb5f8ca oxlint: Fix type annotation for big-endian (#15561) (Sysix) ### ⚡ Performance - e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat mode (#15693) (overlookmotel) - 7528db4 language_server: Pass file content as a referenced `String` (#15568) (Sysix) - 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines` (#15641) (overlookmotel) - ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (#15516) (Sysix) ### 📚 Documentation - 3ab750a linter: Clarify react-in-jsx-scope rule docs. (#15749) (connorshea) - a5feebc linter: `oxlint-disable` not `eslint-disable` (#15672) (overlookmotel) - 3d15805 linter: Reformat doc comments (#15670) (overlookmotel) - 16fcba6 linter: Remove "experimental" from description of stable features (#15669) (overlookmotel) - e62fd98 linter: Correct comment on what `EnablePlugins` does (#15668) (overlookmotel) - a25d31e linter: Fix grammar (#15666) (overlookmotel) - f5f452f linter: Add missing `perf` category (#15667) (overlookmotel) - 2c58952 linter: Add config docs for no-restricted-globals rule. (#15662) (connorshea) - a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema` (#15642) (overlookmotel) - 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in ESLint-compat `Context` shim (#15605) (overlookmotel) - fd58aea linter: Fix a typo in the docs for react/no-is-mounted. (#15575) (Connor Shea) # Oxfmt ### 🚀 Features - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (#15612) (leaysgur) - 99823ad oxfmt: Print nothing for default(write) mode (#15583) (leaysgur) - 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>` groups (#15578) (leaysgur) ### 🐛 Bug Fixes - bf20cf5 formatter: `CRLF` issue in the member chain (#15764) (Dunqing) - 5d688a0 formatter: Measuring multiline text in `fits_text` is incorrect (#15762) (Dunqing) - e306958 formatter: Regression case for test call (#15760) (Dunqing) - c42d983 formatter: Re-fix all cases that fail after `AstNode::Argument` was removed (#15676) (Dunqing) ### ⚡ Performance - d99a83f oxfmt: Use simdutf8 based read_to_string (#15614) (leaysgur) - 128e186 formatter/sort_imports: Precompute import metadata (#15580) (leaysgur) - cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for `next_elements` (#15579) (leaysgur) ### 📚 Documentation - 3d15805 linter: Reformat doc comments (#15670) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
- Revert merge signature to take ownership instead of reference - Update call site to pass ownership - Avoid unnecessary clones by using owned values - Expand comment with example showing merge priority Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
# Oxlint ### 🚀 Features - c199e38 linter: Implement config for all tsgolint rules supporting options (oxc-project#15659) (camchenry) - 7598b3e linter: Allow configuring tsgolint rules (oxc-project#15286) (camchenry) - e77f2ce vscode: Support `oxlint --lsp` (oxc-project#15680) (Sysix) - e01c551 oxlint: Add `--lsp` flag to run the language server (oxc-project#15611) (Sysix) - ac5c2ab lsp/fmt: Support ignore files & patterns (oxc-project#15647) (Sysix) - e50a9bf linter: Add unicorn/prefer-response-static-json rule (oxc-project#15692) (Mikhail Baev) - f5d9abb oxlint: Add enabled? column to --rules cli output (oxc-project#15213) (Wren) - 6b5205c linter/plugins: Implement deprecated `SourceCode#getJSDocComment` method (oxc-project#15653) (overlookmotel) - 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens methods (oxc-project#15645) (overlookmotel) - 4c62ffa language_server: Add `run_server` helper for CLI tools (oxc-project#15609) (Sysix) - 0d52a5e linter/plugins: Implement `Context#parserOptions` getter (oxc-project#15632) (overlookmotel) - 287a538 linter/plugins: Implement `Context#get*` deprecated methods (oxc-project#15606) (overlookmotel) - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (oxc-project#15612) (leaysgur) - e763919 linter: Add test to enforce schema documentation for rules with configuration options (oxc-project#15234) (Connor Shea) - 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr` option (oxc-project#15507) (Li Wei) ### 🐛 Bug Fixes - 1decd57 linter/no-empty-named-blocks: Only search within node for comma token (oxc-project#15751) (camc314) - 17c3d6d linter: Improve docs, diagnostic message, and implementation of typescript/consistent-indexed-object-style rule. (oxc-project#15750) (connorshea) - 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for token (oxc-project#15735) (camc314) - 042befd linter/require-await: Skip comments when searching for token (oxc-project#15734) (camc314) - 7a78220 linter/no-async-await: Skip comments when searching for token (oxc-project#15733) (camc314) - 23b9ad1 linter/consistent-type-specifier-style: Skip comments when searching for token (oxc-project#15732) (camc314) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (oxc-project#15710) (camc314) - 516d14e linter/no-namespace: Skip comments when searching for token (oxc-project#15716) (camc314) - b5aaace linter/prefer-namespace-keyword: Skip comments when searching for token (oxc-project#15715) (camc314) - 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (oxc-project#14203) (Sysix) - 9f991a4 linter: Reverse extends overrides priority (oxc-project#14939) (Peter Wagenet) - 7c4a916 linter: Restores `oxlint --rules -f=json` functionality. (oxc-project#15689) (Wren) - 24d00f4 linter/plugins: Add types for suggested fixes (oxc-project#15636) (overlookmotel) - 257360f linter/plugins: Fill in TS type def for `RuleMeta` (oxc-project#15629) (overlookmotel) - 81e179c linter: Allow file extensions without a dot in react/jsx-filename-extension rule (oxc-project#15574) (Connor Shea) - 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs (oxc-project#15581) (connorshea) - bb5f8ca oxlint: Fix type annotation for big-endian (oxc-project#15561) (Sysix) ### ⚡ Performance - e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat mode (oxc-project#15693) (overlookmotel) - 7528db4 language_server: Pass file content as a referenced `String` (oxc-project#15568) (Sysix) - 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines` (oxc-project#15641) (overlookmotel) - ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (oxc-project#15516) (Sysix) ### 📚 Documentation - 3ab750a linter: Clarify react-in-jsx-scope rule docs. (oxc-project#15749) (connorshea) - a5feebc linter: `oxlint-disable` not `eslint-disable` (oxc-project#15672) (overlookmotel) - 3d15805 linter: Reformat doc comments (oxc-project#15670) (overlookmotel) - 16fcba6 linter: Remove "experimental" from description of stable features (oxc-project#15669) (overlookmotel) - e62fd98 linter: Correct comment on what `EnablePlugins` does (oxc-project#15668) (overlookmotel) - a25d31e linter: Fix grammar (oxc-project#15666) (overlookmotel) - f5f452f linter: Add missing `perf` category (oxc-project#15667) (overlookmotel) - 2c58952 linter: Add config docs for no-restricted-globals rule. (oxc-project#15662) (connorshea) - a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema` (oxc-project#15642) (overlookmotel) - 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in ESLint-compat `Context` shim (oxc-project#15605) (overlookmotel) - fd58aea linter: Fix a typo in the docs for react/no-is-mounted. (oxc-project#15575) (Connor Shea) # Oxfmt ### 🚀 Features - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (oxc-project#15612) (leaysgur) - 99823ad oxfmt: Print nothing for default(write) mode (oxc-project#15583) (leaysgur) - 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>` groups (oxc-project#15578) (leaysgur) ### 🐛 Bug Fixes - bf20cf5 formatter: `CRLF` issue in the member chain (oxc-project#15764) (Dunqing) - 5d688a0 formatter: Measuring multiline text in `fits_text` is incorrect (oxc-project#15762) (Dunqing) - e306958 formatter: Regression case for test call (oxc-project#15760) (Dunqing) - c42d983 formatter: Re-fix all cases that fail after `AstNode::Argument` was removed (oxc-project#15676) (Dunqing) ### ⚡ Performance - d99a83f oxfmt: Use simdutf8 based read_to_string (oxc-project#15614) (leaysgur) - 128e186 formatter/sort_imports: Precompute import metadata (oxc-project#15580) (leaysgur) - cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for `next_elements` (oxc-project#15579) (leaysgur) ### 📚 Documentation - 3d15805 linter: Reformat doc comments (oxc-project#15670) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
…ics (#15786) Addresses post-merge review feedback on #14939. ## Changes - **Optimize `Oxlintrc::merge` signature**: Take ownership of `other` parameter instead of borrowing, avoiding unnecessary clone since caller owns the value - **Remove redundant clones**: Use owned fields directly (`other.categories`, `other.overrides`) - **Clarify merge semantics**: Expand documentation with concrete example showing `self` wins when both configs define the same property - **Fix documentation format**: Use inline code blocks for JSON examples instead of a code block with comments Previously confusing which config took precedence; documentation now makes the behavior explicit and clear. <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > review the code review comments on #14939 (comment) and action them </details> <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/oxc-project/oxc/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com> Co-authored-by: Cameron <cameron.clark@hey.com>
…ics (oxc-project#15786) Addresses post-merge review feedback on oxc-project#14939. ## Changes - **Optimize `Oxlintrc::merge` signature**: Take ownership of `other` parameter instead of borrowing, avoiding unnecessary clone since caller owns the value - **Remove redundant clones**: Use owned fields directly (`other.categories`, `other.overrides`) - **Clarify merge semantics**: Expand documentation with concrete example showing `self` wins when both configs define the same property - **Fix documentation format**: Use inline code blocks for JSON examples instead of a code block with comments Previously confusing which config took precedence; documentation now makes the behavior explicit and clear. <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > review the code review comments on oxc-project#14939 (comment) and action them </details> <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/oxc-project/oxc/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com> Co-authored-by: Cameron <cameron.clark@hey.com>
Fixes #14925