fix(linter): Fix VITEST override rule list and add test for alphabetizing the two lists by connorshea · Pull Request #16975 · oxc-project/oxc

connorshea · 2025-12-17T01:50:56Z

Is there a clippy rule to somehow catch these uses of binary_search on an unsorted array?

From what I understand from the docs, if you call binary_search on an unsorted array, the result is basically worthless (because it will not sort things for you):

Binary searches this slice for a given element. If the slice is not sorted, the returned result is unspecified and meaningless.

Please correct me if I'm wrong on that :)

Anyway, this needs tests or else we'll probably break it again later, so I've added them.

binary_search is used here:

pub fn is_jest_rule_adapted_to_vitest(rule_name: &str) -> bool {
    VITEST_COMPATIBLE_JEST_RULES.binary_search(&rule_name).is_ok()
}

pub fn is_eslint_rule_adapted_to_typescript(rule_name: &str) -> bool {
    TYPESCRIPT_COMPATIBLE_ESLINT_RULES.binary_search(&rule_name).is_ok()
}

No reason to sort them in the method since they're a static array and that'd be wasteful (though, maybe that wouldn't have any performance downside since it could be optimized away by the compiler? 🤷 )

This adds tests for a few other places where we're binary searching a static array.

Copilot

Pull request overview

This PR fixes a bug where the VITEST_COMPATIBLE_JEST_RULES array was not properly alphabetized, which caused binary_search to produce meaningless results. Since binary search requires a sorted array to function correctly, the fix moves "require-hook" from its incorrect position to the correct alphabetical location. The PR also adds preventive measures including warning comments and tests to ensure these arrays remain sorted in the future.

Key Changes:

Fixed alphabetical ordering of VITEST_COMPATIBLE_JEST_RULES by moving "require-hook" to correct position
Added NOTE comments to both arrays warning about alphabetization requirement for binary_search
Added unit tests to verify both VITEST_COMPATIBLE_JEST_RULES and TYPESCRIPT_COMPATIBLE_ESLINT_RULES remain alphabetized

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

crates/oxc_linter/src/utils/mod.rs

codspeed-hq · 2025-12-17T01:59:13Z

CodSpeed Performance Report

Merging #16975 will not alter performance

_{Comparing add-test-to-alphabetized-lists (b0d0c5a) with main (e466562)¹}

Summary

✅ 4 untouched
⏩ 41 skipped²

No successful run was found on main (5d211a8) during the generation of this report, so e466562 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
41 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 · 2025-12-17T11:04:07Z

We can probably use https://doc.rust-lang.org/std/primitive.slice.html#method.is_sorted and assert! rather than a manual comparison

… alphabetized. If the lists are not alphabetized, the binary_search calls in is_vitest_compatible_jest_rule and is_typescript_compatible_eslint_rule would break, and it doesn't look like we really have any other tests to catch that as a side-effect (nor would the cause of the failure be obvious if we did).

lol

# Oxlint ### 🚀 Features - 6cc3fdf linter/no-inferrable-types: Implement fixer (#17090) (camc314) - 2067997 linter/no-negation-in-equality-check: Implement suggestion (#17084) (camc314) - 552f9ef vscode: Auto-generate VSCode README configuration from package.json (#16970) (Copilot) - 9190c4b linter/no-unnecessary-array-flat-depth: Implement fixer (#17057) (camc314) - ed789de linter/misrefactored-assign-op: Implement fixer (#17056) (camc314) - a0f74a0 linter/config: Allow aliasing plugin names to allow names the same as builtin plugins (#15569) (Cameron) - a43d251 linter/plugins: `RuleTester` support `languageOptions.globals` (#17009) (overlookmotel) - 35070d9 linter/bad-bitwise-operator: Implement fixer (#17006) (camc314) - 322d995 linter/prefer-enum-initializers: Implement fixer (#17004) (camc314) - ae1e5bc vscode: Add support for tsgolint binary configuration (#16921) (ColemanDunn) - 3bfe31e linter/eslint-plugin-vitest: Add prefer-called-with as vitest compatible jest rule (#16993) (Said Atrahouch) - 0cd075f linter/eslint-plugin-jest: Add fix capabilities to prefer-called-with rule (#16987) (Said Atrahouch) - 357564b linter: Add options for `typescript/require-array-sort-compare` rule. (#16980) (connorshea) - 2b0ffba linter: Add options for `typescript/no-meaningless-void-operator` rule. (#16981) (connorshea) - 8bc4287 linter/plugins: Validate options against schema (#16974) (overlookmotel) - fdc7d08 linter: Implement eslint/capitalized-comments (#16896) (Tu Shaokun) - f8b6561 linter: Add support for `test.for` in vitest (#16925) (camchenry) - 7ee0379 linter/eslint-plugin-vitest: Implement prefer-spy-on (#16426) (Said Atrahouch) - fc96ee0 linter: Implement jest/prefer-to-have-been-called-times (#16938) (秦宇航) - 291b57b ast_tools: Generate TS declaration files for deserializer and walk files (#16912) (camc314) - e31da2a linter: Implement jest/perfer-to-have-been-called (#16899) (秦宇航) - 1a31306 linter/eslint-plugin-vitest: Add require-hook as vitest compatible jest rule (#16880) (Said Atrahouch) - cd3db21 linter: Add ignoredTypeNames option to no-base-to-string rule (#16898) (camc314) - 763b25a linter: Implement eslint/no-inline-comments (#16885) (Tu Shaokun) ### 🐛 Bug Fixes - fb9e193 linter: OOM problems with custom plugins (#17082) (overlookmotel) - 005ec25 linter: Permit `$schema` `.oxlintrc.json` struct (#17060) (Copilot) - fd03131 linter/plugins: Handle plugin names containing slashes (#17073) (overlookmotel) - b2a4fac linter/plugins: Error if plugin name alias is not normalized (#17071) (overlookmotel) - e046c4e linter/no-misused-spread: Add rule options support (#17054) (camc314) - 5c1a9e0 linter/no-deprecated: Add rule options support (#17053) (camc314) - 8c9cafe linter: `import/consistent-type-specifier-style`: add support for declaration files (#16979) (camchenry) - dab4780 linter/no-empty-pattern: Misleading help message for arrays (#17039) (Copilot) - 67f8c5d linter/plugins: Get correct plugin name in all cases (#17033) (overlookmotel) - 674dab9 linter/plugins: Fix indentation in error message (#17018) (overlookmotel) - 6524f72 linter/plugins: Add `@types/node` dev dependency to `oxlint` package (#17016) (overlookmotel) - 7a35513 linter/plugins: Better error for `null` in `globals` in `RuleTester` (#17011) (overlookmotel) - 42603ba linter/plugins: Always define `languageOptions.globals` (#17008) (overlookmotel) - 4cdc2f8 linter: Fix VITEST override rule list and add test for alphabetizing the two lists (#16975) (Connor Shea) - e466562 linter/consistent-type-definitions: Handle parenthesized types in rule (#16998) (camc314) - fce267c linter: Correct vitest plugin source to be `@vitest/eslint-plugin` (#16976) (connorshea) - 477bb57 linter: Fix `vitest/no-restricted-vi-methods` and add tests for it. (#16971) (connorshea) - 7d6974d linter: Ignore oxlint directive comments in capitalized-comments (#16989) (Tu Shaokun) - 23ac6b1 linter/plugins: Apply defaults from `meta.schema` to options (#16930) (overlookmotel) - 2f946cf linter/plugins: Error if `defaultOptions` is not JSON-serializable (#16959) (overlookmotel) - d8b8a57 linter/plugins: Freeze whole of merged options (#16958) (overlookmotel) - d446c43 linter: Prevent extra fields from being present on oxlint config file (#16874) (connorshea) - b845871 linter/plugins: Correctly handle object with `__proto__` keys in options merging (#16928) (overlookmotel) - c897794 linter: Fix eslint/sort-imports allowSeparatedGroups not working with single empty line (#16012) (Duc Nghiem Xuan) - 0c347a1 linter/array-type: Handle satisfies expression (#16903) (camc314) ### ⚡ Performance - 70d853c linter: Avoid cloning source text when cloning AST into fixed-size allocator (#17088) (overlookmotel) - 4d389f7 linter: Less bounds checks in `normalize_plugin_name` (#17030) (overlookmotel) - fd8e9c6 linter/plugins: Speed up cloning JSON objects (#16997) (overlookmotel) - d77e22d linter/plugins: Use `DEFAULT_OPTIONS` for rules with empty array as default options (#16913) (overlookmotel) ### 📚 Documentation - 6d053b4 linter: Fix typo in doc comment (#17091) (overlookmotel) - b5f3c91 linter: Document intentional exclusion of ignoreCase option in jsx-no-duplicate-props (#17046) (Copilot) - a0bf5d8 linter: Fix the config option docs for no-inline-comments rule. (#16983) (connorshea) - ca26a11 linter/plugins: Fix typo in doc comment (#16966) (overlookmotel) - 3183bf8 linter/plugins: Fix typo in JSDoc comment (#16900) (overlookmotel) # Oxfmt ### 🚀 Features - 15dfb55 oxfmt: Respect single nearest `.editorconfig` (#17043) (leaysgur) - 8c33ff4 oxfmt: Expose Node.js API: `format(fileName, sourceText, options?)` (#16939) (leaysgur) ### 🐛 Bug Fixes - d340c87 oxfmt: Update api `FormatOptions` type with `& Record<string, unknown>` (#17036) (leaysgur) - 827a256 oxfmt: Place ignorePatterns at bottom of JSON in --migrate prettier (#16926) (Boshen) Co-authored-by: overlookmotel <557937+overlookmotel@users.noreply.github.com>

…zing the two lists (oxc-project#16975) From what I understand from the docs, if you call `binary_search` on an unsorted array, the result is basically worthless (because it will not sort things for you): > Binary searches this slice for a given element. If the slice is not sorted, the returned result is unspecified and meaningless. binary_search is used here: ```rs pub fn is_jest_rule_adapted_to_vitest(rule_name: &str) -> bool { VITEST_COMPATIBLE_JEST_RULES.binary_search(&rule_name).is_ok() } pub fn is_eslint_rule_adapted_to_typescript(rule_name: &str) -> bool { TYPESCRIPT_COMPATIBLE_ESLINT_RULES.binary_search(&rule_name).is_ok() } ``` --------- Co-authored-by: Cameron Clark <cameron.clark@hey.com>

Copilot AI review requested due to automatic review settings December 17, 2025 01:50

connorshea requested a review from camc314 as a code owner December 17, 2025 01:50

github-actions bot added A-linter Area - Linter C-bug Category - Bug labels Dec 17, 2025

Copilot started reviewing on behalf of connorshea December 17, 2025 01:51 View session

Copilot AI reviewed Dec 17, 2025

View reviewed changes

crates/oxc_linter/src/utils/mod.rs Outdated Show resolved Hide resolved

crates/oxc_linter/src/utils/mod.rs Outdated Show resolved Hide resolved

connorshea added 4 commits December 17, 2025 12:29

Apparently it already wasn't sorted correctly, so that's fun.

5161a2e

lol

Simplify the tests a bit.

e9fe8bf

Add a few more tests for arrays used with binary_search.

c7a4ddc

camc314 force-pushed the add-test-to-alphabetized-lists branch from ab20ede to c7a4ddc Compare December 17, 2025 12:29

use is_sorted

b0d0c5a

camc314 approved these changes Dec 17, 2025

View reviewed changes

camc314 merged commit 4cdc2f8 into main Dec 17, 2025
20 checks passed

camc314 deleted the add-test-to-alphabetized-lists branch December 17, 2025 12:41

Boshen mentioned this pull request Dec 19, 2025

release(apps): oxlint v1.34.0 && oxfmt v0.19.0 #17097

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(linter): Fix VITEST override rule list and add test for alphabetizing the two lists#16975

fix(linter): Fix VITEST override rule list and add test for alphabetizing the two lists#16975
camc314 merged 5 commits intomainfrom
add-test-to-alphabetized-lists

connorshea commented Dec 17, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

codspeed-hq bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

camc314 commented Dec 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

connorshea commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

codspeed-hq bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #16975 will not alter performance

Summary

Footnotes

Uh oh!

camc314 commented Dec 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

connorshea commented Dec 17, 2025 •

edited

Loading

codspeed-hq bot commented Dec 17, 2025 •

edited

Loading