imports-as-dependencies: Node package not found

[regseb]

Expected behavior

imports-as-dependencies should support Node package (e.g. http, fs, path).

Actual behavior

imports-as-dependencies reports: import points to package which is not found in dependencies

Files

package.json

{
  "name": "testcase",
  "dependencies": {
    "eslint": "8.42.0",
    "eslint-plugin-jsdoc": "46.2.4",
    "typescript": "5.1.3"
  },
  "eslintConfig": {
    "plugins": ["jsdoc"],
    "rules": {
      "jsdoc/imports-as-dependencies": "error"
    }
  }
}

tsconfig.json

{
  "compilerOptions": {
    "allowJs": true,
    "noEmit": true,
    "checkJs": true
  }
}

index.js

/**
 * @typedef {import("node:http").Server} Server
 */

/**
 * @param {Server} server
 */
module.exports = function foo(server) {
    console.log(server.maxHeadersCount);
};

To reproduce

npx eslint index.js

/home/regseb/testcase/index.js
  2:1  error  import points to package which is not found in dependencies  jsdoc/imports-as-dependencies

✖ 1 problem (1 error, 0 warnings)

Environment

• Node version: 18.16.0
• ESLint version: 8.42.0
• eslint-plugin-jsdoc version: 46.2.4

Additional info

• npx tsc support Node package (no error reported).
• You can use @typedef {import("http").Server} Server (without node: prefix).

[brettz9]

Makes sense, but shouldn't @types/node be detected as present?

[regseb]

I don't have @types/node in the dependencies.

If I add it, there's always the error. I think the rule can't make the connection between node:http and the dependency @types/node.

---

You may need to add a list of allowed imports with module.builtinModules:

import { builtinModules } from "node:module";

const allowed = builtinModules.flatMap((m) => [m, "node:" + m]);

Or use module.isBuiltin():

import { isBuiltin } from "node:module";
isBuiltin("node:http"); // true
isBuiltin("http"); // true
isBuiltin("wss"); // false 

[brettz9]

Yes, I've already prepared a PR. I'm just wondering whether the desired behavior should require @types/node or nothing at all.

[brettz9]

Since Intellisense works without @types/node installed, I guess @types/node is not strictly required.

[github-actions]

🎉 This issue has been resolved in version 46.2.5 🎉

The release is available on:

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

Your semantic-release bot 📦🚀