fix(extensions): always calculate fix option (#393)

lnhrdt · JounQin · web-flow · commit 14cb9480c6c1 · 2025-06-24T23:27:56.000+08:00
Co-authored-by: JounQin &lt;admin@1stg.me&gt;
diff --git a/.changeset/angry-lions-learn.md b/.changeset/angry-lions-learn.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix(extensions): always calculate `fix` option
diff --git a/docs/rules/extensions.md b/docs/rules/extensions.md
@@ -4,6 +4,18 @@
 
 <!-- end auto-generated rule header -->
 
+> [!NOTE]
+>
+> This rule is only fixable when the `fix` option is set to `true` for compatibility, otherwise `suggestions` will be provided instead.
+>
+> Example:
+>
+> ```json
+> "import-x/extensions": ["error", "never", { "fix": true }]
+> ```
+>
+> It will change to be automatically fixable in the next major version.
+
 Some file resolve algorithms allow you to omit the file extension within the import source path. For example the `node` resolver (which does not yet support ESM/`import`) can resolve `./foo/bar` to the absolute path `/User/someone/foo/bar.js` because the `.js` extension is resolved automatically by default in CJS. Depending on the resolver you can configure more extensions to get resolved automatically.
 
 In order to provide a consistent use of file extensions across your code base, this rule can enforce or disallow the use of certain file extensions.
diff --git a/src/rules/extensions.ts b/src/rules/extensions.ts
@@ -132,6 +132,10 @@ function buildProperties(context: RuleContext<MessageId, Options>) {
       continue
     }
 
+    if (obj.fix != null) {
+      result.fix = Boolean(obj.fix)
+    }
+
     // If this is not the new structure, transfer all props to result.pattern
     if (
       (!('pattern' in obj) || obj.pattern == null) &&
@@ -156,10 +160,6 @@ function buildProperties(context: RuleContext<MessageId, Options>) {
       result.checkTypeImports = obj.checkTypeImports
     }
 
-    if (obj.fix != null) {
-      result.fix = Boolean(obj.fix)
-    }
-
     if (Array.isArray(obj.pathGroupOverrides)) {
       result.pathGroupOverrides = obj.pathGroupOverrides
     }
diff --git a/test/rules/extensions.spec.ts b/test/rules/extensions.spec.ts
@@ -173,6 +173,83 @@ ruleTester.run('extensions', rule, {
   ],
 
   invalid: [
+    tInvalid({
+      name: 'extensions should provide suggestions by default',
+      code: 'import a from "./foo.js"',
+      options: ['never'],
+      errors: [
+        {
+          messageId: 'unexpected',
+          data: { extension: 'js', importPath: './foo.js' },
+          line: 1,
+          column: 15,
+          suggestions: [
+            {
+              messageId: 'removeUnexpected',
+              data: {
+                extension: 'js',
+                importPath: './foo.js',
+                fixedImportPath: './foo',
+              },
+              output: 'import a from "./foo"',
+            },
+          ],
+        },
+      ],
+    }),
+    tInvalid({
+      name: 'extensions should autofix when fix is set to true',
+      code: 'import a from "./foo.js"',
+      options: ['never', { fix: true }],
+      errors: [
+        {
+          messageId: 'unexpected',
+          data: { extension: 'js', importPath: './foo.js' },
+          line: 1,
+          column: 15,
+        },
+      ],
+      output: 'import a from "./foo"',
+    }),
+    tInvalid({
+      name: 'extensions should autofix when fix is set to true and a pattern object is provided',
+      code: 'import a from "./foo.js"',
+      options: ['never', { fix: true, pattern: {} }],
+      errors: [
+        {
+          messageId: 'unexpected',
+          data: { extension: 'js', importPath: './foo.js' },
+          line: 1,
+          column: 15,
+        },
+      ],
+      output: 'import a from "./foo"',
+    }),
+    tInvalid({
+      name: 'extensions should not autofix when fix is set to false',
+      code: 'import a from "./foo.js"',
+      options: ['never', { fix: false }],
+      errors: [
+        {
+          messageId: 'unexpected',
+          data: { extension: 'js', importPath: './foo.js' },
+          line: 1,
+          column: 15,
+          suggestions: [
+            {
+              messageId: 'removeUnexpected',
+              data: {
+                extension: 'js',
+                importPath: './foo.js',
+                fixedImportPath: './foo',
+              },
+              output: 'import a from "./foo"',
+            },
+          ],
+        },
+      ],
+      output: null,
+    }),
     tInvalid({
       code: 'import a from "a/index.js"',
       errors: [

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-import-x": patch
 +---
++
 +fix(extensions): always calculate `fix` option
Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,10 @@ function buildProperties(context: RuleContext<MessageId, Options>) {`
`132`	`132`	`continue`
`133`	`133`	`}`
`134`	`134`
	`135`	`+ if (obj.fix != null) {`
	`136`	`+ result.fix = Boolean(obj.fix)`
	`137`	`+ }`
	`138`	`+`
`135`	`139`	`// If this is not the new structure, transfer all props to result.pattern`
`136`	`140`	`if (`
`137`	`141`	`(!('pattern' in obj) \|\| obj.pattern == null) &&`
`@@ -156,10 +160,6 @@ function buildProperties(context: RuleContext<MessageId, Options>) {`
`156`	`160`	`result.checkTypeImports = obj.checkTypeImports`
`157`	`161`	`}`
`158`	`162`
`159`		`- if (obj.fix != null) {`
`160`		`- result.fix = Boolean(obj.fix)`
`161`		`- }`
`162`		`-`
`163`	`163`	`if (Array.isArray(obj.pathGroupOverrides)) {`
`164`	`164`	`result.pathGroupOverrides = obj.pathGroupOverrides`
`165`	`165`	`}`