fix(linter/sort-keys): don't autofix if comment could be misplaced by Amund211 · Pull Request #22052 · oxc-project/oxc

Amund211 · 2026-05-01T18:31:50Z

The old logic conservatively skipped generating autofixes when there were comments between any of the properties. This is to prevent detaching comments from their properties, as the fixes currently do not move comments.

This patch adds the same safeguard to comments before the first property and comments after the last property.

It also adds more test coverage for autofix behavior on objects with comments; 4 of which were failing before this patch:

---- rules::eslint::sort_keys::test stdout ----

4 fixes did not produce expected output:

   1.    Input:
      │ const values = {
      │   c: 3,
      │   b: 2,
      │   a: 1, // Inline comment on a
      │ };
      Expected:
      │ const values = {
      │   c: 3,
      │   b: 2,
      │   a: 1, // Inline comment on a
      │ };
        Actual:
      │ const values = {
      │   a: 1,
      │   b: 2,
      │   c: 3, // Inline comment on a
      │ };

   2.    Input: const values = { /** inline jsdoc on b */ b: 2, a: 1}
      Expected: const values = { /** inline jsdoc on b */ b: 2, a: 1}
        Actual: const values = { /** inline jsdoc on b */ a: 1, b: 2}

   3.    Input: const values = { /* comment */ b: 2, a: 1}
      Expected: const values = { /* comment */ b: 2, a: 1}
        Actual: const values = { /* comment */ a: 1, b: 2}

   4.    Input: const values = {b: 2, a: 1 /* comment */ }
      Expected: const values = {b: 2, a: 1 /* comment */ }
        Actual: const values = {a: 1, b: 2 /* comment */ }

Fixes #20873

The old logic conservatively skipped generating autofixes when there were comments between any of the properties. This is to prevent detaching comments from their properties, as the fixes currently do not move comments. This patch adds the same safeguard to comments before the first property and comments after the last property. It also adds more test coverage for autofix behavior on objects with comments; 4 of which were failing before this patch: ``` ---- rules::eslint::sort_keys::test stdout ---- 4 fixes did not produce expected output: 1. Input: │ const values = { │ c: 3, │ b: 2, │ a: 1, // Inline comment on a │ }; Expected: │ const values = { │ c: 3, │ b: 2, │ a: 1, // Inline comment on a │ }; Actual: │ const values = { │ a: 1, │ b: 2, │ c: 3, // Inline comment on a │ }; 2. Input: const values = { /** inline jsdoc on b */ b: 2, a: 1} Expected: const values = { /** inline jsdoc on b */ b: 2, a: 1} Actual: const values = { /** inline jsdoc on b */ a: 1, b: 2} 3. Input: const values = { /* comment */ b: 2, a: 1} Expected: const values = { /* comment */ b: 2, a: 1} Actual: const values = { /* comment */ a: 1, b: 2} 4. Input: const values = {b: 2, a: 1 /* comment */ } Expected: const values = {b: 2, a: 1 /* comment */ } Actual: const values = {a: 1, b: 2 /* comment */ } ``` Fixes oxc-project#20873

codspeed-hq · 2026-05-01T18:39:39Z

Merging this PR will not alter performance

✅ 4 untouched benchmarks
⏩ 47 skipped benchmarks¹

_{Comparing Amund211:sort-keys-destructive (a490d02) with main (d7230b0)}

47 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

camc314 · 2026-05-01T20:11:50Z

thanks!

> [!NOTE] > This PR is completely AI-generated, and I have only briefly read through it to check that it looked sensible. Feel free to reject it if the code seems unmaintainable or poorly implemented :^) Building on the work I did in #22052, I want to "re-activate" some autofixes for this rule. Specifically targetting js-doc and same-line, trailing `//` comments here as I feel pretty confident in attributing them to a specific property based on their position. Leading `/** ... */` comments attached to a property and trailing same-line ``// ...` comments are now absorbed into that property's lifted text during the autofix, so they travel with the key when it moves. Other comment kinds still cause the fix to bail out. --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Cameron Clark <cameron.clark@hey.com>

# Oxlint ### 🚀 Features - 1d40d60 linter: Implement SARIF formatter (#22067) (camchenry) - c0982fe linter/eslint: Implement no-restricted-properties rule (#22080) (AJ Bienz) - 5699d53 linter: Add help text to `agent` formatter (#22064) (camchenry) - fe7194d oxlint: Add agent output mode (#21955) (Jovi De Croock) - fb2f052 linter: Suggest moving shared branch code (#22022) (camc314) - 5868335 linter/no-else-return: Improve nested if diagnostic spans (#22009) (camc314) - 8b4829b linter: Split `no-negated-condition` rule to unicorn & eslint (#21998) (Sysix) - fea301a linter: Split jest/prefer-to-be into separate vitest rule (#21977) (camchenry) - 44aa0d6 linter: Split jest/prefer-strict-equal into separate vitest rule (#21976) (camchenry) - 2262b27 linter: Split jest/prefer-spy-on into separate vitest rule (#21975) (camchenry) - fef9143 linter: Split jest/prefer-mock-return-shorthand into separate vitest rule (#21974) (camchenry) - 2bda504 linter: Split jest/prefer-mock-promise-shorthand into separate vitest rule (#21973) (camchenry) - 6ef6c7d linter: Split jest/prefer-lowercase into separate vitest rule (#21972) (camchenry) - f4d2498 linter: Split jest/prefer-hooks-on-top into separate vitest rule (#21971) (camchenry) - fb8e366 linter: Split jest/prefer-hooks-in-order into separate vitest rule (#21970) (camchenry) - adcd85c linter: Split jest/prefer-expect-resolves into separate vitest rule (#21969) (camchenry) - 8ddc7ec linter: Split jest/prefer-equality-matcher into separate vitest rule (#21968) (camchenry) - 46bb1f3 linter: Split jest/prefer-each into separate vitest rule (#21967) (camchenry) - bdbff66 linter: Implement interactive-supports-focus (#21767) (mehm8128) - 733b094 linter: Split `prefer-to-have-been-called-times` rule (#21898) (Said Atrahouch) - 8804425 linter/eslint: Implement `logical-assignment-operators` rule (#21900) (Mikhail Baev) - 296d147 linter: Split jest/prefer-comparison-matcher into separate vitest rule (#21929) (camchenry) - 38146b6 linter: Split jest/prefer-called-with into separate vitest rule (#21927) (camchenry) - 6f86175 linter/vue: Implement return-in-computed-property rule (#21909) (bab) - dc2d0e4 linter: Split jest/no-unneeded-async-expect-function into separate vitest rule (#21878) (camchenry) - a03fc37 linter: Split jest/no-test-return-statement into separate vitest rule (#21877) (camchenry) - f11313e linter: Split jest/no-test-prefixes into separate vitest rule (#21876) (camchenry) - 4380812 linter: Split `prefer-to-have-length` rule (#21893) (Said Atrahouch) - 511bcc1 linter: Split jest `require-hook` rule (#21889) (Said Atrahouch) - 64a8180 linter: Split `jest/prefer-snapshot-hint` into a Jest rule and a Vitest rule. (#21881) (connorshea) - ae7924a linter/vue: Implement no-deprecated-model-definition rule (#21886) (bab) - 0dfe8b3 linter: Split `jest/require-to-throw-message` into Jest and Vitest rules. (#21879) (connorshea) - 51229ff linter: Split jest `valid-describe-callback` rule (#21882) (Said Atrahouch) - 2d102fd linter: Split `no-standalone-expect` rule into jest and vitest (#21862) (Sysix) - ee46a29 linter: Split `no-restricted-matchers` rule into jest and vitest (#21860) (Sysix) - 1f29459 linter: Split `no-restricted-jest-methods` rule into jest and vitest (#21859) (Sysix) - e7f8d55 linter: Remove eslint prefixes from plugin names in diagnostics (#21806) (Connor Shea) - 89fff8b linter: Split valid-expect-in-promise/jest rule into jest and vitest rules (#21854) (Said Atrahouch) ### 🐛 Bug Fixes - 0b48848 linter/prefer-array-some: Make find rewrite a suggestion (#22103) (camc314) - d24027e linter/prefer-array-some: Preserve find comparison fixes (#22094) (camc314) - af2d26c linter/astro: Handle js `---` after frontmatter in .astro files (#22091) (Andrew Powell) - 78d4ff0 linter/jsdoc/require-returns: Only look at the nearest jsdoc block (#22077) (camc314) - fa88857 linter/no-map-spread: Use default codegen options for fix (#22074) (camc314) - 2047a35 linter: Treat adjacent fixes as overlapping (#22071) (camc314) - 75fc551 linter: Handle no-extra-boolean-cast edge cases (#22031) (camc314) - e9d5284 linter/sort-keys: Don't autofix if comment could be misplaced (#22052) (Amund Eggen Svandal) - d7230b0 linter/no-constant-condition: Handle generator yields (#22046) (camc314) - e8dbc56 linter/array-type: Enable edge case tests (#22047) (camc314) - d57b51f linter/no-constant-condition: Propagate config errors (#22045) (camc314) - bdb6d95 linter/typescript: Remove duplicate rule tests (#22044) (camc314) - 0beaffc linter: Print resolved extended config (#22040) (camc314) - 192ad0e linter/react/only-export-components: Align rule with upstream cases (#22039) (camc314) - cdf4c53 linter/only-export-components: Support tanstack router (#21937) (camc314) - 893e18f linter: Stop gitignore lookup at repo boundary (#22033) (camc314) - 7100712 linter/constructor-super: Clarify duplicate super diagnostics (#22035) (camc314) - fce5b7c linter/constructor-super: Improve invalid `super` calls diagnostic (#22032) (camc314) - b3de93c linter/rules-of-hooks: Clarify conditional diagnostics (#22030) (camc314) - 4f9f629 linter/rules-of-hooks: Clarify loop diagnostics (#22029) (camc314) - e6f0978 linter/rules-of-hooks: Clarify async component diagnostics (#22024) (camc314) - e262f51 linter/rules-of-hooks: Improve diagnostic for hook inside class component (#22023) (camc314) - 7b71b0d linter/no-restricted-imports: Report once per import declaration (#22021) (camc314) - 3d5ae3d linter/vitest/require-mock-type-parameters: Handle chained typed mocks (#22019) (camc314) - 959a2db linter/reporter/github: Omit empty `file` annotations (#22017) (camc314) - 16003a1 linter/unicorn: Remove duplicate rule tests (#22018) (camc314) - 86b7547 linter/no-unreachable: Suppress nested unreachable diagnostics (#22011) (camc314) - 1d92ae8 linter/oxc: Remove duplicate rule tests (#22013) (camc314) - f270246 linter/branches-sharing-code: Ignore empty statements (#22012) (camc314) - f1c25dd linter: Stabilize debug diagnostic comparison (#22010) (camc314) - b6bc421 linter: Skip linting astro scripts with non JS script types (#21954) (camc314) - a77547d linter: Support plugin-qualified disable directives (#21999) (camc314) - 079cfdd linter: Match disable directive rule names exactly, not by substring (#21906) (Christian Vuerings) - 11a4e67 linter: Comptibles rules need to be disabled in jest and vitest at same time (#21982) (Said Atrahouch) - ce62f16 linter: `jsx-a11y/prefer-tag-over-role` detect more roles (#21933) (bab) - 024c390 linter/jest/vitest: Padding around after all blocks not working as expected (#21952) (kapobajza) - 05a8f75 linter/jest/no-standalone-expect: False positive with expect in an `ObjectProperty` (#21948) (Said Atrahouch) - 6a37c98 linter/no-unused-vars: Report unused re-exported imports (#21938) (camc314) - 2d5fc16 linter: `jsx-a11y/media-has-caption` report only once for self-closing tags (#21934) (bab) - 5adca29 linter: `jsx-a11y/no-autofocus` ignore `false` attribute values (#21918) (Sysix) - 2e5c18e linter/max-nested-describe: Reset nested describe depth (#21891) (camc314) ### ⚡ Performance - a77f0f7 linter/require-returns: Avoid jsdoc tag vec allocation (#22081) (camc314) - d9a1b32 linter/plugins: Avoid array lookups where possible in CFG visitor (#21940) (overlookmotel) - fefefd8 linter/plugins: Replace addition with bitwise OR in CFG visitor (#21939) (overlookmotel) ### 📚 Documentation - d58f594 oxlint/lsp: Auto generate docs for LSP options (#22082) (Sysix) - 9adc3b3 linter/no-misused-new: Clarify construct signatures behaviour (#22016) (camc314) - 1caf5ad linter/plugins: Reformat comments (#21873) (overlookmotel) # Oxfmt ### 🐛 Bug Fixes - ef0db6b formatter: Sequence expression in arrow function body collapses onto one line (#21183) (Justin Mecham) - 5d5d808 formatter: Preserve blank line after directive with trailing comment (#21153) (Justin Mecham) ### ⚡ Performance - 2fd907d formatter: Sort imports during IR construction (#22065) (overlookmotel) --------- Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com> Co-authored-by: Cameron Clark <cameron.clark@hey.com>

Amund211 requested a review from camc314 as a code owner May 1, 2026 18:31

camc314 changed the title ~~fix: Don't autofix sort-keys if comment could be misplaced~~ fix(linter/sort-keys): don't autofix if comment could be misplaced May 1, 2026

camc314 added the A-linter Area - Linter label May 1, 2026

camc314 self-assigned this May 1, 2026

Amund211 mentioned this pull request May 1, 2026

linter: eslint/sort-keys autofix can move inline comments #20873

Closed

camc314 approved these changes May 1, 2026

View reviewed changes

Merge branch 'main' into sort-keys-destructive

a490d02

camc314 merged commit e9d5284 into oxc-project:main May 1, 2026
26 checks passed

Amund211 deleted the sort-keys-destructive branch May 1, 2026 20:29

Amund211 mentioned this pull request May 1, 2026

feat(linter/sort-keys): support autofix with comments #22061

Merged

oxc-guard Bot mentioned this pull request May 4, 2026

release(apps): oxlint v1.63.0 && oxfmt v0.48.0 #22109

Merged

Dunqing mentioned this pull request May 7, 2026

fix(codegen): emit call end mapping at ) position, not past it #22199

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(linter/sort-keys): don't autofix if comment could be misplaced#22052

fix(linter/sort-keys): don't autofix if comment could be misplaced#22052
camc314 merged 2 commits intooxc-project:mainfrom
Amund211:sort-keys-destructive

Amund211 commented May 1, 2026

Uh oh!

codspeed-hq Bot commented May 1, 2026 •

edited

Loading

Uh oh!

camc314 commented May 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Amund211 commented May 1, 2026

Uh oh!

codspeed-hq Bot commented May 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

camc314 commented May 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codspeed-hq Bot commented May 1, 2026 •

edited

Loading