feat(linter/eslint-plugin-vitest): reuse no-mocks-import jest linter rule

[Afsoon]

Related to #4656

Implement no-mocks-import lint ruler adding a new entry in the mapping between jest and vitest compatible rules.

Oxlint-migrate PR related: oxc-project/oxlint-migrate#269

[codspeed-hq]

CodSpeed Performance Report

Merging #16540 will not alter performance

_{Comparing Afsoon:12-05-vitest_no_mocks_import (9734366) with main (f1581c1)¹}

Summary

✅ 4 untouched
⏩ 41 skipped²

Footnotes

1. No successful run was found on main (90c950f) during the generation of this report, so f1581c1 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. ↩

[connorshea]

The docs block in the declare_oxc_lint! should be updated to mention that this rule is compatible with Vitest as well. (we should probably consider auto-generating something in the docs for these cases as well, honestly, but for now this is how it is done).

Other rules have a note like so:

    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest/blob/v1.1.9/docs/rules/no-alias-methods.md),
    /// to use it, add the following configuration to your `.oxlintrc.json`:
    ///
    /// ```json
    /// {
    ///   "rules": {
    ///      "vitest/no-alias-methods": "error"
    ///   }
    /// }
    /// ```

[Afsoon]

@connorshea Added missing dock blocks and update the PR description to point the oxlint-migrate PR. I haven't opened before because I didn't know when to open it.

The docs block in the declare_oxc_lint! should be updated to mention that this rule is compatible with Vitest as well. (we should probably consider auto-generating something in the docs for these cases as well, honestly, but for now this is how it is done).

Other rules have a note like so:

    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest/blob/v1.1.9/docs/rules/no-alias-methods.md),
    /// to use it, add the following configuration to your `.oxlintrc.json`:
    ///
    /// ```json
    /// {
    ///   "rules": {
    ///      "vitest/no-alias-methods": "error"
    ///   }
    /// }
    /// ```

Just FYI, some compatibles vitest rule are missing that doc block, for example jest/prefer_each. It's out of scope of this PR, but maybe can be a good idea to review which compatible rules don't have this dock block.

[connorshea]

Just FYI, some compatibles vitest rule are missing that doc block, for example jest/prefer_each. It's out of scope of this PR, but maybe can be a good idea to review which compatible rules don't have this dock block.

Good point, if you want to open a PR for that change, I'd be happy to review/merge that :)

[Afsoon]

Just FYI, some compatibles vitest rule are missing that doc block, for example jest/prefer_each. It's out of scope of this PR, but maybe can be a good idea to review which compatible rules don't have this dock block.

Good point, if you want to open a PR for that change, I'd be happy to review/merge that :)

PR created #16679

[camc314]

Thanks for working on this!

Do you mind also porting the vitest test cases for this rule to ensure that we're catching all cases?

This can be done by:

just new-vitest-rule no-mocks-import

And copying over the generated test cases to crates/oxc_linter/src/rules/jest/no_mocks_import.rs, this allows us to ensure that we're reporting all cases correctly for both vitest/jest

e.g.

oxc/crates/oxc_linter/src/rules/jest/consistent_test_it.rs

Lines 794 to 795 in 4911d60

	let fail_vitest = vec![

[Afsoon]

@camc314 Updated the PR with the vitests test case but I have notice the diagnostic message is framework dependant. I'm not sure how to approach here:

• The current approach
• One diagnostic method but add a new argument, for example:

let caller = {
  if ctx.frameworks().is_vitest() {
      "vi"
  }

 "jest"
};

fn no_mocks_import_diagnostic(span: Span, call: &str) -> OxcDiagnostic {
    OxcDiagnostic::warn("Mocks should not be manually imported from a `__mocks__` directory.")
        .with_help(format!("Instead use `{call}.mock` and import from the original module path."))
        .with_label(span)
}

• Duplicate the rule under the vitest folder.

[camc314]

Thank yoiu!

[camc314]

I pushed another commit - it just merges the two diagnostic messages together. It's tricky to know if we are in a vitest/jest file, so for simplicity, we just report the same error

stale - comment has been updated