new rule: prefer-import-tag

[boneskull]

Motivation

I have a codebase littered with inline type-level imports (e.g., @type {import('foo').bar}). I'd like to be able to put a halt to this madness and use import tags instead. I would especially like this to be a fixable rule.

Current behavior

It's the wild west out there

Desired behavior

A rule which could raise an error if an inline type import was detected. Default behavior of this rule, when enabled, would be to always prefer import tags over inline imports.

Highly desired, but not required for a first pass:

• automatically fixable (though this may be difficult or dangerous, because it will introduce symbols into the module scope [insofar as TS is concerned] and symbols can conflict)

Optionally:

• inline imports could be preferred over import tags
• exceptions based on some criteria (e.g., imports from foo are an exception to the configured behavior)

Alternatives considered

• While TS itself supports JSDoc, typescript-eslint does not and will not support JSDoc.
• I thought about writing a codemod but that seems too complicated.

---

I am unsure how feasible this is or how difficult an implementation would be, so I apologize in advance if it's ridiculous.

[brettz9]

You can currently get this without a fixer by using:

'jsdoc/no-restricted-syntax': ['warn', {
  contexts: [
    {
      comment: 'JsdocBlock:has(JsdocTag:has(JsdocTypeImport))',
      context: 'any',
      message: 'Use @import tag over import() statements',
    },
  ],
}]

[JounQin]

@brettz9 @import is not reorganized currently:

  ⚠  jsdoc/check-values

     Bad @import tag


     packages/postcss-config/index.js:2:1
     1 | /**
   > 2 |  * @import {ConfigFn, ConfigPlugin} from 'postcss-load-config
       | ^
     3 |  */
     4 | 
     5 | import { NODE_ENV, __DEV__, __PROD__ } from '@pkgr/utils'

  ⚠  jsdoc/no-undefined-types

     The type 'ConfigFn' is undefined


     packages/postcss-config/index.js:16:1
     14 | /**
     15 |  *
   > 16 |  * @type {ConfigFn}
        | ^
     17 |  */
     18 | const config = ({
     19 |   advanced,

  ⚠  jsdoc/no-undefined-types

     The type 'ConfigPlugin' is undefined


     packages/postcss-config/index.js:30:1
     28 | } = {}) => {
     29 |   /**
   > 30 |    * @type {ConfigPlugin[]}
        | ^
     31 |    */
     32 |   const plugins = [
     33 |     presetEnv_(presetEnv),

[brettz9]

It looks like you are missing an ending apostrophe after 'postcss-load-config.

[JounQin]

It looks like you are missing an ending apostrophe after 'postcss-load-config.

Holy... You're damn right, the error message is confusing.

[brettz9]

It looks like you are missing an ending apostrophe after 'postcss-load-config.

Holy... You're damn right, the error message is confusing.

The parse-imports package we are using does not provide more specific feedback as to the type of error. We need to use one message to report any kind of @import error.