imports-as-dependencies doesn't detect missing @types packages

[DetachHead]

thanks for adding the rule i suggested in #896! i noticed that it doesn't seem to detect @types/ packages though

Expected behavior

error because @types/eslint is not in dependencies or devDependencies

Actual behavior

no error

ESLint Config

module.exports = {
    // ...
    rules: {
        'jsdoc/imports-as-dependencies': 'error'
    }
}

ESLint sample

source code

/** @type {import('eslint').Linter.ParserOptions} */
const foo = {}

package.json

{
  "dependencies": {
    "eslint": "^8.13.0"
  },
  "devDependencies": {}
}

Environment

• Node version: 19.7.0
• ESLint version
• eslint-plugin-jsdoc version: 46.2.0

[brettz9]

Ugh, yeah, I really hadn't thought this through. I'm not sure how much detection we want to be doing, e.g., to know whether to check for types in package.json, not to mention typeRoots or whatever.

[brettz9]

I'm thinking I may need to remove the rule unless TypeScript provides an API for detection, since there is quite a bit involved here--e.g., types within exports, typeRoots, etc.

[DetachHead]

import/no-extraneous-dependencies is able to detect this, maybe its worth looking at the source code for that rule to see how it works

[brettz9]

That appears to be able to look for type imports, but not checking whether declaration files are present.

[brettz9]

Ok, I've submitted #1108 which should handle this. It doesn't do caching as it probably should, nor does it take into account typeRoots or use of types within exports, but it should provide an easy fix for the current problem at least.

[github-actions]

🎉 This issue has been resolved in version 46.2.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[DetachHead]

@brettz9 looks like it now errors on imports from packages that come with type definitions (ie. does not need a @types package)

/** @type {import('typescript').Program} */ // error  import points to package which is not found in dependencies  jsdoc/imports-as-dependencies
const foo = {}

in this case, i have typescript in devDependencies but there's no need for @types/typescript to be installed

[brettz9]

With the exception of TypeScript itself (for which I can supply a fix), it should still be working for packages with their own types. TypeScript just doesn't have types in package.json as other packages should.

[DetachHead]

looks like typescript uses typings instead of types, which is apparently an alias for the same thing, see https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package

Note that the "typings" field is synonymous with types, and could be used as well.

[github-actions]

🎉 This issue has been resolved in version 46.2.3 🎉

The release is available on:

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

Your semantic-release bot 📦🚀