[prefer-import-tag] Autofix creates import with invalid identifier

[ehoogeveen-medweb]

I have the following jsdoc comment:

/** @type { import('@typescript-eslint/utils').TSESLint.FlatConfig.Config['rules'] } */

The new prefer-import-tag rule suggests replacing the import() with an @import comment. The autofix then generates the following:

/** @import * as @typescript-eslint/utils from '@typescript-eslint/utils'; */

/** @type {@typescript-eslint/utils.TSESLint.FlatConfig.Config['rules']} */

But @typescript-eslint/utils is not a valid identifier. This triggers an escape-inline-tags warning on the first line and a valid-types warning on the second - but more importantly, it doesn't work.

I suggest either disabling the autofix if the package name isn't a valid identifier, or adding some sort of escaping logic.

For example, typescriptEslintUtils would be valid - but that means stripping the @ and producing upper case letters after - and /. More generally you'd need to handle . too for cases like https://www.npmjs.com/package/chart.js and there might be other exceptions, so I don't know if it's worth it (though import()s can be very repetitive, so an autofix is definitely nice to have).

[ehoogeveen-medweb]

Another case: node: prefixes like node:zlib.

[ehoogeveen-medweb]

Relative imports like ./lib/someFile.js are also pretty messy - I guess libSomeFileJs would work, though you'd want to rename it afterward.

[brettz9]

Apologies for the naive implementation. See what you think of https://github.com/gajus/eslint-plugin-jsdoc/pull/1573/files#diff-16381b2579fe9f4f49925f28cb4a429c9048aef95de8f00d5902ad1b5f77ae78 . It gets a bit ugly as there are indeed several considerations for escaping.

[ehoogeveen-medweb]

I think that works. While working through the warnings I found that I often ended up switching to a bunch of named imports anyway. For example, the @typescript-eslint/utils import is better written as

/** @import { TSESLint } from '@typescript-eslint/utils'; */

/** @type {TSESLint.FlatConfig.Config['rules']} */

But this requires manual inspection and the namespace import is still a decent starting point. Renaming it is trivial with VSCode, thankfully.

[brettz9]

Cool.. But did you not want the outputType: 'named-import' option enabled?

[ehoogeveen-medweb]

Ah... Yes, that would have been a better fit, especially looking back now. I didn't realize that the rule had different autofix variants through an option; usually when there are multiple possible autofixes for a linter warning, they become suggestions instead (although that does make them more cumbersome to apply).

[github-actions]

🎉 This issue has been resolved in version 61.1.3 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀