feat: Option to disable autofix of prefer-import-in-mock (#846)

* feat: Option to disable autofix of prefer-import-in-mock

* chore: apply formatting and update docs

---------

Co-authored-by: Verite Mugabo <mugaboverite@gmail.com>

Author: nunomarks

docs/rules/prefer-import-in-mock.md

@@ -21,3 +21,25 @@ The following pattern is not considered a warning:
 ```js
 vi.mock(import('./path/to/module'))
 ```
+
+### Options
+
+This rule has a `fixable` option that tells the plugin to automatically fix the imports for you.
+The option is enabled by default. You can disable it in your `eslint.config.js` file using the following configuration.
+
+```ts
+import vitest from 'eslint-plugin-vitest'
+
+export default [
+  {
+    files: ['**/*.ts', '**/*.js'], // or any other pattern
+    plugins: {
+      vitest,
+    },
+    rules: {
+      ...vitest.configs.recommended.all,
+      'vitest/prefer-import-in-mock': ['error', { fixable: false }],
+    },
+  },
+]
+```

src/rules/prefer-import-in-mock.ts

@@ -5,8 +5,13 @@ import { parseVitestFnCall } from '../utils/parse-vitest-fn-call'
 export const RULE_NAME = 'prefer-import-in-mock'
 
 type MESSAGE_ID = 'preferImport'
+type Options = [
+  Partial<{
+    fixable: boolean
+  }>,
+]
 
-export default createEslintRule<[], MESSAGE_ID>({
+export default createEslintRule<Options, MESSAGE_ID>({
   name: RULE_NAME,
   meta: {
     fixable: 'code',
@@ -17,10 +22,23 @@ export default createEslintRule<[], MESSAGE_ID>({
     messages: {
       preferImport: "Replace '{{path}}' with import('{{path}}')",
     },
-    schema: [],
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          fixable: {
+            type: 'boolean',
+            default: true,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
   },
-  defaultOptions: [],
-  create(context) {
+  defaultOptions: [{ fixable: true }],
+  create(context, options) {
+    const fixable = options[0].fixable!
+
     return {
       CallExpression(node) {
         // Only consider vi.mock() calls
@@ -50,6 +68,8 @@ export default createEslintRule<[], MESSAGE_ID>({
             },
             node: node,
             fix(fixer) {
+              if (!fixable) return null
+
               return fixer.replaceText(pathArg, `import('${pathArg.value}')`)
             },
           })

tests/prefer-import-in-mock.test.ts

@@ -2,6 +2,61 @@ import rule, { RULE_NAME } from '../src/rules/prefer-import-in-mock'
 import { ruleTester } from './ruleTester'
 
 describe(RULE_NAME, () => {
+
+  ruleTester.run(RULE_NAME, rule, {
+    valid: [
+      'vi.mock(import("foo"))',
+      'vi.mock(import("node:fs/promises"))',
+      'vi.mock(import("./foo.js"), () => ({ Foo: vi.fn() }))',
+      'vi.mock(import("./foo.js"), { spy: true });',
+    ],
+    invalid: [
+      {
+        options: [
+          {
+            fixable: false,
+          },
+        ],
+        code: `vi.mock('foo', () => {})`,
+        errors: [
+          {
+            messageId: 'preferImport',
+          },
+        ],
+      },
+      {
+        options: [
+          {
+            fixable: false,
+          },
+        ],
+        code: 'vi.mock("node:fs/promises")',
+        errors: [{ messageId: 'preferImport', column: 1, line: 1 }],
+      },
+      {
+        options: [
+          {
+            fixable: false,
+          },
+        ],
+        code: 'vi.mock("./foo.js", () => ({ Foo: vi.fn() }))',
+        errors: [{ messageId: 'preferImport', column: 1, line: 1 }],
+      },
+      {
+        options: [
+          {
+            fixable: false,
+          },
+        ],
+        code: `
+        import { vi as renamedVi } from 'vitest';
+        renamedVi.mock('./foo.js', () => ({ Foo: vi.fn() }))
+      `,
+        errors: [{ messageId: 'preferImport', column: 9, line: 3 }],
+      },
+    ],
+  })
+
   ruleTester.run(RULE_NAME, rule, {
     valid: [
       'vi.mock(import("foo"))',