docs(linter): Added in the missing jest rules that are compatible with vitest. (#16679)

After the review @connorshea did in
#16540 (review),
suggested to me add a missing part of documentation in the linter rule.
I hadn't added it because the reference rule I used lack of it.

So this PR aims to add it in all jest rules stated as compatible.

## Before this PR

The following Jest linter only had this documentation part:

- consistent-test-it
- expect-expect
- no-alias-methods
- no-commented-out-tests
- no-disabled-tests
- no-focused-tests
- no-identical-title
- no-test-prefixes
- prefer-hooks-in-order
- valid-describe-callback
- valid-expect

## Adding in this PR

- max-expects
- max-nested-describe
- no-conditional-expect
- no-conditional-in-test
- no-duplicate-hooks
- no-hooks
- no-interpolation-in-snapshots
- no-restricted-jest-methods: I have doubts here see my comment in the
[vitest-eslint-plugin
issue](#4656 (comment))
- no-restricted-matchers
- no-standalone-expect
- no-test-return-statement
- prefer-comparison-matcher
- prefer-each
- prefer-equality-matcher
- prefer-expect-resolves
- prefer-hooks-on-top
- prefer-lowercase-title
- prefer-mock-promise-shorthand
- prefer-strict-equal
- prefer-to-be
- prefer-to-have-length
- prefer-todo
- require-to-throw-message
- require-top-level-describe

Author: Afsoon

crates/oxc_linter/src/rules/jest/max_expects.rs

@@ -66,6 +66,17 @@ declare_oxc_lint!(
     ///     expect(true).toBeDefined();
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/max-expects.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/max-expects": "error"
+    ///   }
+    /// }
+    /// ```
     MaxExpects,
     jest,
     style,

crates/oxc_linter/src/rules/jest/max_nested_describe.rs

@@ -120,6 +120,17 @@ declare_oxc_lint!(
     ///     });
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/max-nested-describe": "error"
+    ///   }
+    /// }
+    /// ```
     MaxNestedDescribe,
     jest,
     style,

crates/oxc_linter/src/rules/jest/no_conditional_expect.rs

@@ -93,6 +93,17 @@ declare_oxc_lint!(
     ///   await expect(foo).rejects.toThrow(Error);
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-conditional-expect": "error"
+    ///   }
+    /// }
+    /// ```
     NoConditionalExpect,
     jest,
     correctness

crates/oxc_linter/src/rules/jest/no_conditional_in_test.rs

@@ -92,6 +92,17 @@ declare_oxc_lint!(
     ///   await expect(promiseValue()).resolves.toBe(1);
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-in-test.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-conditional-in-test": "error"
+    ///   }
+    /// }
+    /// ```
     NoConditionalInTest,
     jest,
     pedantic,

crates/oxc_linter/src/rules/jest/no_duplicate_hooks.rs

@@ -100,6 +100,17 @@ declare_oxc_lint!(
     ///     });
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-duplicate-hooks": "error"
+    ///   }
+    /// }
+    /// ```
     NoDuplicateHooks,
     jest,
     style,

crates/oxc_linter/src/rules/jest/no_hooks.rs

@@ -83,6 +83,17 @@ declare_oxc_lint!(
     ///     });
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-hooks.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-hooks": "error"
+    ///   }
+    /// }
+    /// ```
     NoHooks,
     jest,
     style,

crates/oxc_linter/src/rules/jest/no_interpolation_in_snapshots.rs

@@ -51,6 +51,17 @@ declare_oxc_lint!(
     ///   `${interpolated}`,
     /// );
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-interpolation-in-snapshots": "error"
+    ///   }
+    /// }
+    /// ```
     NoInterpolationInSnapshots,
     jest,
     style

crates/oxc_linter/src/rules/jest/no_restricted_jest_methods.rs

@@ -68,6 +68,17 @@ declare_oxc_lint!(
     ///   // ...
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-vi-methods.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-restricted-vi-methods": "error"
+    ///   }
+    /// }
+    /// ```
     NoRestrictedJestMethods,
     jest,
     style,

crates/oxc_linter/src/rules/jest/no_restricted_matchers.rs

@@ -105,6 +105,17 @@ declare_oxc_lint!(
     ///   });
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-matchers.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-restricted-matchers": "error"
+    ///   }
+    /// }
+    /// ```
     NoRestrictedMatchers,
     jest,
     style,

crates/oxc_linter/src/rules/jest/no_standalone_expect/mod.rs

@@ -70,6 +70,17 @@ declare_oxc_lint!(
     ///     expect(1).toBe(1);
     /// });
     /// ```
+    ///
+    /// This rule is compatible with [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md),
+    /// to use it, add the following configuration to your `.oxlintrc.json`:
+    ///
+    /// ```json
+    /// {
+    ///   "rules": {
+    ///      "vitest/no-standalone-expect": "error"
+    ///   }
+    /// }
+    /// ```
     NoStandaloneExpect,
     jest,
     correctness,