fix(prefer-import-tag): ensure import is a valid identifier; fixes #1572

Author: brettz9

docs/rules/prefer-import-tag.md

@@ -315,6 +315,15 @@ let foo;
 /** @type {import('foo').default} */
 let foo;
 // Message: Inline `import()` found; prefer `@import`
+
+/** @type { import('@typescript-eslint/utils').TSESLint.FlatConfig.Config['rules'] } */
+// Message: Inline `import()` found; prefer `@import`
+
+/** @type { import('node:zlib').createGzip } */
+// Message: Inline `import()` found; prefer `@import`
+
+/** @type { import('./lib/someFile.js').someImport } */
+// Message: Inline `import()` found; prefer `@import`
 ````
 
 

package.json

@@ -67,6 +67,7 @@
     "replace": "^1.2.2",
     "rimraf": "^6.0.1",
     "semantic-release": "^24.2.9",
+    "to-valid-identifier": "^0.1.1",
     "typescript": "5.9.3",
     "typescript-eslint": "^8.46.0"
   },

pnpm-lock.yaml

@@ -13,6 +13,7 @@ import {
 import {
   parseImportsExports,
 } from 'parse-imports-exports';
+import toValidIdentifier from 'to-valid-identifier';
 
 export default iterateJsdoc(({
   context,
@@ -133,10 +134,11 @@ export default iterateJsdoc(({
       }
 
       /**
-       * @param {string} matchingName
+       * @param {string} name
        * @param {string[]} extrPathSegments
        */
-      const getFixer = (matchingName, extrPathSegments) => {
+      const getFixer = (name, extrPathSegments) => {
+        const matchingName = toValidIdentifier(name);
         return () => {
           /** @type {import('jsdoc-type-pratt-parser').NamePathResult|undefined} */
           let node = nodes.at(0);
@@ -369,7 +371,7 @@ export default iterateJsdoc(({
             return fixer.insertTextBefore(
               // @ts-expect-error Ok
               commentNodes[0] ?? programNode,
-              `/** @import * as ${element.value} from '${element.value}'; */${
+              `/** @import * as ${toValidIdentifier(element.value)} from '${element.value}'; */${
                 commentNodes[0] ? '\n' + indent : ''
               }`,
             );
@@ -422,10 +424,13 @@ export default iterateJsdoc(({
             // @ts-expect-error Ok
             commentNodes[0] ?? programNode,
             outputType === 'namespaced-import' ?
-              `/** @import * as ${element.value} from '${element.value}'; */${
+              `/** @import * as ${toValidIdentifier(element.value)} from '${element.value}'; */${
                 commentNodes[0] ? '\n' + indent : ''
               }` :
-              `/** @import { ${pathSegments.at(-1)} } from '${element.value}'; */${
+              `/** @import { ${toValidIdentifier(
+                /* c8 ignore next -- TS */
+                pathSegments.at(-1) ?? '',
+              )} } from '${element.value}'; */${
                 commentNodes[0] ? '\n' + indent : ''
               }`,
           );

src/rules/preferImportTag.js

@@ -906,6 +906,48 @@ let foo;
         let foo;
       `,
     },
+    {
+      code: `
+        /** @type { import('@typescript-eslint/utils').TSESLint.FlatConfig.Config['rules'] } */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Inline `import()` found; prefer `@import`',
+        },
+      ],
+      output: `/** @import * as $12$typescript$j$eslint$l$utils from '@typescript-eslint/utils'; */
+        /** @type {$12$typescript$j$eslint$l$utils.TSESLint.FlatConfig.Config['rules']} */
+      `,
+    },
+    {
+      code: `
+        /** @type { import('node:zlib').createGzip } */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Inline `import()` found; prefer `@import`',
+        },
+      ],
+      output: `/** @import * as node$w$zlib from 'node:zlib'; */
+        /** @type {node$w$zlib.createGzip} */
+      `,
+    },
+    {
+      code: `
+        /** @type { import('./lib/someFile.js').someImport } */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Inline `import()` found; prefer `@import`',
+        },
+      ],
+      output: `/** @import * as $k$$l$lib$l$someFile$k$js from './lib/someFile.js'; */
+        /** @type {$k$$l$lib$l$someFile$k$js.someImport} */
+      `,
+    },
   ],
   valid: [
     {