Skip to content

feat(linter/eslint-plugin-vitest): implement prefer-spy-on#16426

Merged
camc314 merged 10 commits intooxc-project:mainfrom
Afsoon:12-03-vitest_lint_prefer_spy_on
Dec 16, 2025
Merged

feat(linter/eslint-plugin-vitest): implement prefer-spy-on#16426
camc314 merged 10 commits intooxc-project:mainfrom
Afsoon:12-03-vitest_lint_prefer_spy_on

Conversation

@Afsoon
Copy link
Contributor

@Afsoon Afsoon commented Dec 3, 2025

Related to #4656

Implement prefer-spy-on lint ruler.

It's my first contribution made in Rust, and in Oxc, any suggestion to improve the code it's welcome. The logic is based on the JS rule implementation.

Update 12/04/2025: I have just notice Jest have a similar linter rule, so I have duplicate the code and adapt it to vitest. I discarded the option to abstract all the logic as none can ensure that both lints rule are going to be the same in the future. Discarded the map between jest and vitest rules as the documentacion for this specific rule is distinct.

Update 12/15/2025: The rule is implemented as a compatible with jest instead of duplicate code:

Oxlint migrate PR: oxc-project/oxlint-migrate#291

@Afsoon Afsoon requested a review from camc314 as a code owner December 3, 2025 06:40
@graphite-app
Copy link
Contributor

graphite-app bot commented Dec 3, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

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.

@github-actions github-actions bot added A-linter Area - Linter C-enhancement Category - New feature or request labels Dec 3, 2025
@Afsoon Afsoon force-pushed the 12-03-vitest_lint_prefer_spy_on branch from 96d896c to 2da32f1 Compare December 3, 2025 06:47
@codspeed-hq
Copy link

codspeed-hq bot commented Dec 3, 2025

CodSpeed Performance Report

Merging #16426 will not alter performance

Comparing Afsoon:12-03-vitest_lint_prefer_spy_on (724136c) with main (e31da2a)1

Summary

✅ 4 untouched
⏩ 41 skipped2

Footnotes

  1. No successful run was found on main (3bd0554) during the generation of this report, so e31da2a was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

  2. 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.

@Afsoon Afsoon force-pushed the 12-03-vitest_lint_prefer_spy_on branch 5 times, most recently from ba59b2c to 2bc59ba Compare December 5, 2025 12:25
@camc314 camc314 self-assigned this Dec 10, 2025
@camc314
Copy link
Contributor

camc314 commented Dec 10, 2025

I have just notice Jest have a similar linter rule, so I have duplicate the code and adapt it to vitest. I discarded the option to abstract all the logic as none can ensure that both lints rule are going to be the same in the future. Discarded the map between jest and vitest rules as the documentacion for this specific rule is distinct.

Do these two different rules catch the same sort of issues? If so, we probably don't need both, and we can alias between the two (when we see vitest/prefer-spy-on, we enable jest/prefer-spy-on).

const VITEST_COMPATIBLE_JEST_RULES: [&str; 36] = [

@Afsoon
Copy link
Contributor Author

Afsoon commented Dec 10, 2025

@camc314 they catch the same issues, the main difference between rules are:

  • Detect vi.fn instead of jest.fn
  • And the fix should add the correct vi or jest

@Afsoon Afsoon force-pushed the 12-03-vitest_lint_prefer_spy_on branch from 3587450 to e8d0a37 Compare December 15, 2025 15:45
@Afsoon
Copy link
Contributor Author

Afsoon commented Dec 15, 2025

@camc314 I'm back to this PR, after did the other ones, you are right, it's better to make it as compatible instead of duplicate it.

@camchenry The suggestion you did I have applied to the jest rule, as now this rule will works for both frameworks. The initial code was a duplication of the jest rule.

@camchenry camchenry self-assigned this Dec 15, 2025
Copy link
Contributor

@camc314 camc314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@camc314 camc314 merged commit 7ee0379 into oxc-project:main Dec 16, 2025
21 checks passed
Boshen pushed a commit that referenced this pull request Dec 16, 2025
Related to #4656 

Implement
[prefer-spy-on](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md)
lint ruler.

~~It's my first contribution made in Rust, and in Oxc, any suggestion to
improve the code it's welcome. The logic is based on the JS rule
implementation.~~

~~Update 12/04/2025: I have just notice Jest have a similar linter rule,
so I have duplicate the code and adapt it to vitest. I discarded the
option to abstract all the logic as none can ensure that both lints rule
are going to be the same in the future. Discarded the map between jest
and vitest rules as the documentacion for this specific rule is
distinct.~~

Update 12/15/2025: The rule is implemented as a compatible with jest
instead of duplicate code:

Oxlint migrate PR:
oxc-project/oxlint-migrate#291
overlookmotel added a commit that referenced this pull request Dec 19, 2025
# 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 <[email protected]>
qinyuhang pushed a commit to qinyuhang/oxc that referenced this pull request Jan 22, 2026
…ct#16426)

Related to oxc-project#4656 

Implement
[prefer-spy-on](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md)
lint ruler.

~~It's my first contribution made in Rust, and in Oxc, any suggestion to
improve the code it's welcome. The logic is based on the JS rule
implementation.~~

~~Update 12/04/2025: I have just notice Jest have a similar linter rule,
so I have duplicate the code and adapt it to vitest. I discarded the
option to abstract all the logic as none can ensure that both lints rule
are going to be the same in the future. Discarded the map between jest
and vitest rules as the documentacion for this specific rule is
distinct.~~

Update 12/15/2025: The rule is implemented as a compatible with jest
instead of duplicate code:

Oxlint migrate PR:
oxc-project/oxlint-migrate#291
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments