eslint-plugin-jsdoc 52.0.1 → 52.0.3

package/dist/rules/implementsOnClasses.js

@@ -0,0 +1,40 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/implementsOnClasses.js
+var implementsOnClasses_default = iterateJsdoc(({ report, utils }) => {
+	const iteratingFunction = utils.isIteratingFunction();
+	if (iteratingFunction) {
+		if (utils.hasATag(["class", "constructor"]) || utils.isConstructor()) return;
+	} else if (!utils.isVirtualFunction()) return;
+	utils.forEachPreferredTag("implements", (tag) => {
+		report("@implements used on a non-constructor function", null, tag);
+	});
+}, {
+	contextDefaults: true,
+	meta: {
+		docs: {
+			description: "Reports an issue with any non-constructor function using `@implements`.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: { contexts: {
+				items: { anyOf: [{ type: "string" }, {
+					additionalProperties: false,
+					properties: {
+						comment: { type: "string" },
+						context: { type: "string" }
+					},
+					type: "object"
+				}] },
+				type: "array"
+			} },
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { implementsOnClasses_default as default };
+//# sourceMappingURL=implementsOnClasses.js.map

package/dist/rules/implementsOnClasses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementsOnClasses.js","names":[],"sources":["../../src/rules/implementsOnClasses.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  const iteratingFunction = utils.isIteratingFunction();\n\n  if (iteratingFunction) {\n    if (utils.hasATag([\n      'class',\n      'constructor',\n    ]) ||\n      utils.isConstructor()\n    ) {\n      return;\n    }\n  } else if (!utils.isVirtualFunction()) {\n    return;\n  }\n\n  utils.forEachPreferredTag('implements', (tag) => {\n    report('@implements used on a non-constructor function', null, tag);\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Reports an issue with any non-constructor function using `@implements`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,kCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,MAAM,qBAAqB;AAErD,KAAI,mBACF;MAAI,MAAM,QAAQ,CAChB,SACA,aACD,EAAC,IACA,MAAM,eAAe,CAErB;CACD,WACQ,CAAC,MAAM,mBAAmB,CACnC;CAGF,MAAM,oBAAoB,cAAc,CAAC,QAAQ;EAC/C,OAAO,kDAAkD,MAAM,IAAI;CACpE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/importsAsDependencies.cjs

@@ -1,106 +1,69 @@
-"use strict";
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+const __es_joy_jsdoccomment = require_rolldown_runtime.__toESM(require("@es-joy/jsdoccomment"));
+const fs = require_rolldown_runtime.__toESM(require("fs"));
+const node_module = require_rolldown_runtime.__toESM(require("node:module"));
+const path = require_rolldown_runtime.__toESM(require("path"));
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-var _fs = require("fs");
-var _nodeModule = require("node:module");
-var _path = require("path");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//#region src/rules/importsAsDependencies.js
 /**
- * @type {Set<string>|null}
- */
+* @type {Set<string>|null}
+*/
 let deps;
-const setDeps = function () {
-  try {
-    const pkg = JSON.parse(
-    // @ts-expect-error It's ok
-    (0, _fs.readFileSync)((0, _path.join)(process.cwd(), './package.json')));
-    deps = new Set([...(pkg.dependencies ? /* c8 ignore next 2 */
-    Object.keys(pkg.dependencies) : []), ...(pkg.devDependencies ? /* c8 ignore next 2 */
-    Object.keys(pkg.devDependencies) : [])]);
-    /* c8 ignore next -- our package.json exists */
-  } catch (error) {
-    /* c8 ignore next -- our package.json exists */
-    deps = null;
-    /* c8 ignore next 4 -- our package.json exists */
-    /* eslint-disable no-console -- Inform user */
-    console.log(error);
-    /* eslint-enable no-console -- Inform user */
-  }
+const setDeps = function() {
+	try {
+		const pkg = JSON.parse((0, fs.readFileSync)((0, path.join)(process.cwd(), "./package.json")));
+		deps = new Set([...pkg.dependencies ? Object.keys(pkg.dependencies) : [], ...pkg.devDependencies ? Object.keys(pkg.devDependencies) : []]);
+	} catch (error) {
+		/* c8 ignore next -- our package.json exists */
+		deps = null;
+		/* c8 ignore next 4 -- our package.json exists */
+		console.log(error);
+	}
 };
-const moduleCheck = new Map();
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  jsdoc,
-  settings,
-  utils
-}) => {
-  if (deps === undefined) {
-    setDeps();
-  }
-
-  /* c8 ignore next 3 -- our package.json exists */
-  if (deps === null) {
-    return;
-  }
-  const {
-    mode
-  } = settings;
-  for (const tag of jsdoc.tags) {
-    let typeAst;
-    try {
-      typeAst = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(tag.type) : (0, _jsdoccomment.parse)(tag.type, mode);
-    } catch {
-      continue;
-    }
-
-    // eslint-disable-next-line no-loop-func -- Safe
-    (0, _jsdoccomment.traverse)(typeAst, nde => {
-      /* c8 ignore next 3 -- TS guard */
-      if (deps === null) {
-        return;
-      }
-      if (nde.type === 'JsdocTypeImport') {
-        let mod = nde.element.value.replace(/^(@[^\/]+\/[^\/]+|[^\/]+).*$/v, '$1');
-        if (/^[.\/]/v.test(mod)) {
-          return;
-        }
-        if ((0, _nodeModule.isBuiltin)(mod)) {
-          // mod = '@types/node';
-          // moduleCheck.set(mod, !deps.has(mod));
-          return;
-        } else if (!moduleCheck.has(mod)) {
-          let pkg;
-          try {
-            pkg = JSON.parse(
-            // @ts-expect-error It's ok
-            (0, _fs.readFileSync)((0, _path.join)(process.cwd(), 'node_modules', mod, './package.json')));
-          } catch {
-            // Ignore
-          }
-          if (!pkg || !pkg.types && !pkg.typings) {
-            mod = `@types/${mod}`;
-          }
-          moduleCheck.set(mod, !deps.has(mod));
-        }
-        if (moduleCheck.get(mod)) {
-          utils.reportJSDoc('import points to package which is not found in dependencies', tag);
-        }
-      }
-    });
-  }
+const moduleCheck = /* @__PURE__ */ new Map();
+var importsAsDependencies_default = require_iterateJsdoc.default(({ jsdoc, settings, utils }) => {
+	if (deps === void 0) setDeps();
+	/* c8 ignore next 3 -- our package.json exists */
+	if (deps === null) return;
+	const { mode } = settings;
+	for (const tag of jsdoc.tags) {
+		let typeAst;
+		try {
+			typeAst = mode === "permissive" ? (0, __es_joy_jsdoccomment.tryParse)(tag.type) : (0, __es_joy_jsdoccomment.parse)(tag.type, mode);
+		} catch {
+			continue;
+		}
+		(0, __es_joy_jsdoccomment.traverse)(typeAst, (nde) => {
+			/* c8 ignore next 3 -- TS guard */
+			if (deps === null) return;
+			if (nde.type === "JsdocTypeImport") {
+				let mod = nde.element.value.replace(/^(@[^\/]+\/[^\/]+|[^\/]+).*$/v, "$1");
+				if (/^[.\/]/v.test(mod)) return;
+				if ((0, node_module.isBuiltin)(mod)) return;
+				else if (!moduleCheck.has(mod)) {
+					let pkg;
+					try {
+						pkg = JSON.parse((0, fs.readFileSync)((0, path.join)(process.cwd(), "node_modules", mod, "./package.json")));
+					} catch {}
+					if (!pkg || !pkg.types && !pkg.typings) mod = `@types/${mod}`;
+					moduleCheck.set(mod, !deps.has(mod));
+				}
+				if (moduleCheck.get(mod)) utils.reportJSDoc("import points to package which is not found in dependencies", tag);
+			}
+		});
+	}
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header'
-    },
-    type: 'suggestion'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header"
+		},
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = importsAsDependencies_default;
 //# sourceMappingURL=importsAsDependencies.cjs.map

package/dist/rules/importsAsDependencies.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"importsAsDependencies.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","_fs","_nodeModule","_path","e","__esModule","default","deps","setDeps","pkg","JSON","parse","readFileSync","join","process","cwd","Set","dependencies","Object","keys","devDependencies","error","console","log","moduleCheck","Map","_default","exports","iterateJsdoc","jsdoc","settings","utils","undefined","mode","tag","tags","typeAst","tryParse","type","traverse","nde","mod","element","value","replace","test","isBuiltinModule","has","types","typings","set","get","reportJSDoc","iterateAllJsdocs","meta","docs","description","url","module"],"sources":["../../src/rules/importsAsDependencies.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\nimport {\n  readFileSync,\n} from 'fs';\nimport {\n  isBuiltin as isBuiltinModule,\n} from 'node:module';\nimport {\n  join,\n} from 'path';\n\n/**\n * @type {Set<string>|null}\n */\nlet deps;\n\nconst setDeps = function () {\n  try {\n    const pkg = JSON.parse(\n      // @ts-expect-error It's ok\n      readFileSync(join(process.cwd(), './package.json')),\n    );\n    deps = new Set([\n      ...(pkg.dependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.dependencies) :\n        []),\n      ...(pkg.devDependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.devDependencies) :\n        []),\n    ]);\n  /* c8 ignore next -- our package.json exists */\n  } catch (error) {\n    /* c8 ignore next -- our package.json exists */\n    deps = null;\n    /* c8 ignore next 4 -- our package.json exists */\n    /* eslint-disable no-console -- Inform user */\n    console.log(error);\n    /* eslint-enable no-console -- Inform user */\n  }\n};\n\nconst moduleCheck = new Map();\n\nexport default iterateJsdoc(({\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  if (deps === undefined) {\n    setDeps();\n  }\n\n  /* c8 ignore next 3 -- our package.json exists */\n  if (deps === null) {\n    return;\n  }\n\n  const {\n    mode,\n  } = settings;\n\n  for (const tag of jsdoc.tags) {\n    let typeAst;\n    try {\n      typeAst = mode === 'permissive' ? tryParse(tag.type) : parse(tag.type, mode);\n    } catch {\n      continue;\n    }\n\n    // eslint-disable-next-line no-loop-func -- Safe\n    traverse(typeAst, (nde) => {\n      /* c8 ignore next 3 -- TS guard */\n      if (deps === null) {\n        return;\n      }\n\n      if (nde.type === 'JsdocTypeImport') {\n        let mod = nde.element.value.replace(\n          /^(@[^\\/]+\\/[^\\/]+|[^\\/]+).*$/v, '$1',\n        );\n\n        if ((/^[.\\/]/v).test(mod)) {\n          return;\n        }\n\n        if (isBuiltinModule(mod)) {\n          // mod = '@types/node';\n          // moduleCheck.set(mod, !deps.has(mod));\n          return;\n        } else if (!moduleCheck.has(mod)) {\n          let pkg;\n          try {\n            pkg = JSON.parse(\n              // @ts-expect-error It's ok\n              readFileSync(join(process.cwd(), 'node_modules', mod, './package.json')),\n            );\n          } catch {\n            // Ignore\n          }\n\n          if (!pkg || (!pkg.types && !pkg.typings)) {\n            mod = `@types/${mod}`;\n          }\n\n          moduleCheck.set(mod, !deps.has(mod));\n        }\n\n        if (moduleCheck.get(mod)) {\n          utils.reportJSDoc(\n            'import points to package which is not found in dependencies',\n            tag,\n          );\n        }\n      }\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAKA,IAAAE,GAAA,GAAAF,OAAA;AAGA,IAAAG,WAAA,GAAAH,OAAA;AAGA,IAAAI,KAAA,GAAAJ,OAAA;AAEc,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEd;AACA;AACA;AACA,IAAIG,IAAI;AAER,MAAMC,OAAO,GAAG,SAAAA,CAAA,EAAY;EAC1B,IAAI;IACF,MAAMC,GAAG,GAAGC,IAAI,CAACC,KAAK;IACpB;IACA,IAAAC,gBAAY,EAAC,IAAAC,UAAI,EAACC,OAAO,CAACC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,CACpD,CAAC;IACDR,IAAI,GAAG,IAAIS,GAAG,CAAC,CACb,IAAIP,GAAG,CAACQ,YAAY,GAClB;IACAC,MAAM,CAACC,IAAI,CAACV,GAAG,CAACQ,YAAY,CAAC,GAC7B,EAAE,CAAC,EACL,IAAIR,GAAG,CAACW,eAAe,GACrB;IACAF,MAAM,CAACC,IAAI,CAACV,GAAG,CAACW,eAAe,CAAC,GAChC,EAAE,CAAC,CACN,CAAC;IACJ;EACA,CAAC,CAAC,OAAOC,KAAK,EAAE;IACd;IACAd,IAAI,GAAG,IAAI;IACX;IACA;IACAe,OAAO,CAACC,GAAG,CAACF,KAAK,CAAC;IAClB;EACF;AACF,CAAC;AAED,MAAMG,WAAW,GAAG,IAAIC,GAAG,CAAC,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAArB,OAAA,GAEf,IAAAsB,qBAAY,EAAC,CAAC;EAC3BC,KAAK;EACLC,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ,IAAIxB,IAAI,KAAKyB,SAAS,EAAE;IACtBxB,OAAO,CAAC,CAAC;EACX;;EAEA;EACA,IAAID,IAAI,KAAK,IAAI,EAAE;IACjB;EACF;EAEA,MAAM;IACJ0B;EACF,CAAC,GAAGH,QAAQ;EAEZ,KAAK,MAAMI,GAAG,IAAIL,KAAK,CAACM,IAAI,EAAE;IAC5B,IAAIC,OAAO;IACX,IAAI;MACFA,OAAO,GAAGH,IAAI,KAAK,YAAY,GAAG,IAAAI,sBAAQ,EAACH,GAAG,CAACI,IAAI,CAAC,GAAG,IAAA3B,mBAAK,EAACuB,GAAG,CAACI,IAAI,EAAEL,IAAI,CAAC;IAC9E,CAAC,CAAC,MAAM;MACN;IACF;;IAEA;IACA,IAAAM,sBAAQ,EAACH,OAAO,EAAGI,GAAG,IAAK;MACzB;MACA,IAAIjC,IAAI,KAAK,IAAI,EAAE;QACjB;MACF;MAEA,IAAIiC,GAAG,CAACF,IAAI,KAAK,iBAAiB,EAAE;QAClC,IAAIG,GAAG,GAAGD,GAAG,CAACE,OAAO,CAACC,KAAK,CAACC,OAAO,CACjC,+BAA+B,EAAE,IACnC,CAAC;QAED,IAAK,SAAS,CAAEC,IAAI,CAACJ,GAAG,CAAC,EAAE;UACzB;QACF;QAEA,IAAI,IAAAK,qBAAe,EAACL,GAAG,CAAC,EAAE;UACxB;UACA;UACA;QACF,CAAC,MAAM,IAAI,CAACjB,WAAW,CAACuB,GAAG,CAACN,GAAG,CAAC,EAAE;UAChC,IAAIhC,GAAG;UACP,IAAI;YACFA,GAAG,GAAGC,IAAI,CAACC,KAAK;YACd;YACA,IAAAC,gBAAY,EAAC,IAAAC,UAAI,EAACC,OAAO,CAACC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE0B,GAAG,EAAE,gBAAgB,CAAC,CACzE,CAAC;UACH,CAAC,CAAC,MAAM;YACN;UAAA;UAGF,IAAI,CAAChC,GAAG,IAAK,CAACA,GAAG,CAACuC,KAAK,IAAI,CAACvC,GAAG,CAACwC,OAAQ,EAAE;YACxCR,GAAG,GAAG,UAAUA,GAAG,EAAE;UACvB;UAEAjB,WAAW,CAAC0B,GAAG,CAACT,GAAG,EAAE,CAAClC,IAAI,CAACwC,GAAG,CAACN,GAAG,CAAC,CAAC;QACtC;QAEA,IAAIjB,WAAW,CAAC2B,GAAG,CAACV,GAAG,CAAC,EAAE;UACxBV,KAAK,CAACqB,WAAW,CACf,6DAA6D,EAC7DlB,GACF,CAAC;QACH;MACF;IACF,CAAC,CAAC;EACJ;AACF,CAAC,EAAE;EACDmB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,sHAAsH;MACnIC,GAAG,EAAE;IACP,CAAC;IACDnB,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAoB,MAAA,CAAA/B,OAAA,GAAAA,OAAA,CAAArB,OAAA","ignoreList":[]}
+{"version":3,"file":"importsAsDependencies.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/importsAsDependencies.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\nimport {\n  readFileSync,\n} from 'fs';\nimport {\n  isBuiltin as isBuiltinModule,\n} from 'node:module';\nimport {\n  join,\n} from 'path';\n\n/**\n * @type {Set<string>|null}\n */\nlet deps;\n\nconst setDeps = function () {\n  try {\n    const pkg = JSON.parse(\n      // @ts-expect-error It's ok\n      readFileSync(join(process.cwd(), './package.json')),\n    );\n    deps = new Set([\n      ...(pkg.dependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.dependencies) :\n        []),\n      ...(pkg.devDependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.devDependencies) :\n        []),\n    ]);\n  /* c8 ignore next -- our package.json exists */\n  } catch (error) {\n    /* c8 ignore next -- our package.json exists */\n    deps = null;\n    /* c8 ignore next 4 -- our package.json exists */\n    /* eslint-disable no-console -- Inform user */\n    console.log(error);\n    /* eslint-enable no-console -- Inform user */\n  }\n};\n\nconst moduleCheck = new Map();\n\nexport default iterateJsdoc(({\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  if (deps === undefined) {\n    setDeps();\n  }\n\n  /* c8 ignore next 3 -- our package.json exists */\n  if (deps === null) {\n    return;\n  }\n\n  const {\n    mode,\n  } = settings;\n\n  for (const tag of jsdoc.tags) {\n    let typeAst;\n    try {\n      typeAst = mode === 'permissive' ? tryParse(tag.type) : parse(tag.type, mode);\n    } catch {\n      continue;\n    }\n\n    // eslint-disable-next-line no-loop-func -- Safe\n    traverse(typeAst, (nde) => {\n      /* c8 ignore next 3 -- TS guard */\n      if (deps === null) {\n        return;\n      }\n\n      if (nde.type === 'JsdocTypeImport') {\n        let mod = nde.element.value.replace(\n          /^(@[^\\/]+\\/[^\\/]+|[^\\/]+).*$/v, '$1',\n        );\n\n        if ((/^[.\\/]/v).test(mod)) {\n          return;\n        }\n\n        if (isBuiltinModule(mod)) {\n          // mod = '@types/node';\n          // moduleCheck.set(mod, !deps.has(mod));\n          return;\n        } else if (!moduleCheck.has(mod)) {\n          let pkg;\n          try {\n            pkg = JSON.parse(\n              // @ts-expect-error It's ok\n              readFileSync(join(process.cwd(), 'node_modules', mod, './package.json')),\n            );\n          } catch {\n            // Ignore\n          }\n\n          if (!pkg || (!pkg.types && !pkg.typings)) {\n            mod = `@types/${mod}`;\n          }\n\n          moduleCheck.set(mod, !deps.has(mod));\n        }\n\n        if (moduleCheck.get(mod)) {\n          utils.reportJSDoc(\n            'import points to package which is not found in dependencies',\n            tag,\n          );\n        }\n      }\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;AAmBA,IAAI;AAEJ,MAAM,UAAU,WAAY;AAC1B,KAAI;EACF,MAAM,MAAM,KAAK,0CAEG,QAAQ,KAAK,EAAE,iBAAiB,CAAC,CACpD;EACD,OAAO,IAAI,IAAI,CACb,GAAI,IAAI,eAEN,OAAO,KAAK,IAAI,aAAa,GAC7B,CAAE,GACJ,GAAI,IAAI,kBAEN,OAAO,KAAK,IAAI,gBAAgB,GAChC,CAAE,CACL;CAEF,SAAQ,OAAO;;EAEd,OAAO;;EAGP,QAAQ,IAAI,MAAM;CAEnB;AACF;AAED,MAAM,8BAAc,IAAI;AAExB,oCAAeA,6BAAa,CAAC,EAC3B,OACA,UACA,OACD,KAAK;AACJ,KAAI,SAAS,QACX,SAAS;;AAIX,KAAI,SAAS,KACX;CAGF,MAAM,EACJ,MACD,GAAG;AAEJ,MAAK,MAAM,OAAO,MAAM,MAAM;EAC5B,IAAI;AACJ,MAAI;GACF,UAAU,SAAS,mDAAwB,IAAI,KAAK,oCAAS,IAAI,MAAM,KAAK;EAC7E,QAAO;AACN;EACD;sCAGQ,SAAS,CAAC,QAAQ;;AAEzB,OAAI,SAAS,KACX;AAGF,OAAI,IAAI,SAAS,mBAAmB;IAClC,IAAI,MAAM,IAAI,QAAQ,MAAM,QAC1B,iCAAiC,KAClC;AAED,QAAK,UAAW,KAAK,IAAI,CACvB;AAGF,mCAAoB,IAAI,CAGtB;aACS,CAAC,YAAY,IAAI,IAAI,EAAE;KAChC,IAAI;AACJ,SAAI;MACF,MAAM,KAAK,0CAES,QAAQ,KAAK,EAAE,gBAAgB,KAAK,iBAAiB,CAAC,CACzE;KACF,QAAO,CAEP;AAED,SAAI,CAAC,OAAQ,CAAC,IAAI,SAAS,CAAC,IAAI,SAC9B,MAAM,CAAC,OAAO,EAAE,KAAK;KAGvB,YAAY,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC;IACrC;AAED,QAAI,YAAY,IAAI,IAAI,EACtB,MAAM,YACJ,+DACA,IACD;GAEJ;EACF,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/importsAsDependencies.js

@@ -0,0 +1,68 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+import { isBuiltin } from "node:module";
+import { parse, traverse, tryParse } from "@es-joy/jsdoccomment";
+import { readFileSync } from "fs";
+import { join } from "path";
+
+//#region src/rules/importsAsDependencies.js
+/**
+* @type {Set<string>|null}
+*/
+let deps;
+const setDeps = function() {
+	try {
+		const pkg = JSON.parse(readFileSync(join(process.cwd(), "./package.json")));
+		deps = new Set([...pkg.dependencies ? Object.keys(pkg.dependencies) : [], ...pkg.devDependencies ? Object.keys(pkg.devDependencies) : []]);
+	} catch (error) {
+		/* c8 ignore next -- our package.json exists */
+		deps = null;
+		/* c8 ignore next 4 -- our package.json exists */
+		console.log(error);
+	}
+};
+const moduleCheck = /* @__PURE__ */ new Map();
+var importsAsDependencies_default = iterateJsdoc(({ jsdoc, settings, utils }) => {
+	if (deps === void 0) setDeps();
+	/* c8 ignore next 3 -- our package.json exists */
+	if (deps === null) return;
+	const { mode } = settings;
+	for (const tag of jsdoc.tags) {
+		let typeAst;
+		try {
+			typeAst = mode === "permissive" ? tryParse(tag.type) : parse(tag.type, mode);
+		} catch {
+			continue;
+		}
+		traverse(typeAst, (nde) => {
+			/* c8 ignore next 3 -- TS guard */
+			if (deps === null) return;
+			if (nde.type === "JsdocTypeImport") {
+				let mod = nde.element.value.replace(/^(@[^\/]+\/[^\/]+|[^\/]+).*$/v, "$1");
+				if (/^[.\/]/v.test(mod)) return;
+				if (isBuiltin(mod)) return;
+				else if (!moduleCheck.has(mod)) {
+					let pkg;
+					try {
+						pkg = JSON.parse(readFileSync(join(process.cwd(), "node_modules", mod, "./package.json")));
+					} catch {}
+					if (!pkg || !pkg.types && !pkg.typings) mod = `@types/${mod}`;
+					moduleCheck.set(mod, !deps.has(mod));
+				}
+				if (moduleCheck.get(mod)) utils.reportJSDoc("import points to package which is not found in dependencies", tag);
+			}
+		});
+	}
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header"
+		},
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { importsAsDependencies_default as default };
+//# sourceMappingURL=importsAsDependencies.js.map

package/dist/rules/importsAsDependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importsAsDependencies.js","names":["isBuiltinModule"],"sources":["../../src/rules/importsAsDependencies.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\nimport {\n  readFileSync,\n} from 'fs';\nimport {\n  isBuiltin as isBuiltinModule,\n} from 'node:module';\nimport {\n  join,\n} from 'path';\n\n/**\n * @type {Set<string>|null}\n */\nlet deps;\n\nconst setDeps = function () {\n  try {\n    const pkg = JSON.parse(\n      // @ts-expect-error It's ok\n      readFileSync(join(process.cwd(), './package.json')),\n    );\n    deps = new Set([\n      ...(pkg.dependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.dependencies) :\n        []),\n      ...(pkg.devDependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.devDependencies) :\n        []),\n    ]);\n  /* c8 ignore next -- our package.json exists */\n  } catch (error) {\n    /* c8 ignore next -- our package.json exists */\n    deps = null;\n    /* c8 ignore next 4 -- our package.json exists */\n    /* eslint-disable no-console -- Inform user */\n    console.log(error);\n    /* eslint-enable no-console -- Inform user */\n  }\n};\n\nconst moduleCheck = new Map();\n\nexport default iterateJsdoc(({\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  if (deps === undefined) {\n    setDeps();\n  }\n\n  /* c8 ignore next 3 -- our package.json exists */\n  if (deps === null) {\n    return;\n  }\n\n  const {\n    mode,\n  } = settings;\n\n  for (const tag of jsdoc.tags) {\n    let typeAst;\n    try {\n      typeAst = mode === 'permissive' ? tryParse(tag.type) : parse(tag.type, mode);\n    } catch {\n      continue;\n    }\n\n    // eslint-disable-next-line no-loop-func -- Safe\n    traverse(typeAst, (nde) => {\n      /* c8 ignore next 3 -- TS guard */\n      if (deps === null) {\n        return;\n      }\n\n      if (nde.type === 'JsdocTypeImport') {\n        let mod = nde.element.value.replace(\n          /^(@[^\\/]+\\/[^\\/]+|[^\\/]+).*$/v, '$1',\n        );\n\n        if ((/^[.\\/]/v).test(mod)) {\n          return;\n        }\n\n        if (isBuiltinModule(mod)) {\n          // mod = '@types/node';\n          // moduleCheck.set(mod, !deps.has(mod));\n          return;\n        } else if (!moduleCheck.has(mod)) {\n          let pkg;\n          try {\n            pkg = JSON.parse(\n              // @ts-expect-error It's ok\n              readFileSync(join(process.cwd(), 'node_modules', mod, './package.json')),\n            );\n          } catch {\n            // Ignore\n          }\n\n          if (!pkg || (!pkg.types && !pkg.typings)) {\n            mod = `@types/${mod}`;\n          }\n\n          moduleCheck.set(mod, !deps.has(mod));\n        }\n\n        if (moduleCheck.get(mod)) {\n          utils.reportJSDoc(\n            'import points to package which is not found in dependencies',\n            tag,\n          );\n        }\n      }\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;AAmBA,IAAI;AAEJ,MAAM,UAAU,WAAY;AAC1B,KAAI;EACF,MAAM,MAAM,KAAK,MAEf,aAAa,KAAK,QAAQ,KAAK,EAAE,iBAAiB,CAAC,CACpD;EACD,OAAO,IAAI,IAAI,CACb,GAAI,IAAI,eAEN,OAAO,KAAK,IAAI,aAAa,GAC7B,CAAE,GACJ,GAAI,IAAI,kBAEN,OAAO,KAAK,IAAI,gBAAgB,GAChC,CAAE,CACL;CAEF,SAAQ,OAAO;;EAEd,OAAO;;EAGP,QAAQ,IAAI,MAAM;CAEnB;AACF;AAED,MAAM,8BAAc,IAAI;AAExB,oCAAe,aAAa,CAAC,EAC3B,OACA,UACA,OACD,KAAK;AACJ,KAAI,SAAS,QACX,SAAS;;AAIX,KAAI,SAAS,KACX;CAGF,MAAM,EACJ,MACD,GAAG;AAEJ,MAAK,MAAM,OAAO,MAAM,MAAM;EAC5B,IAAI;AACJ,MAAI;GACF,UAAU,SAAS,eAAe,SAAS,IAAI,KAAK,GAAG,MAAM,IAAI,MAAM,KAAK;EAC7E,QAAO;AACN;EACD;EAGD,SAAS,SAAS,CAAC,QAAQ;;AAEzB,OAAI,SAAS,KACX;AAGF,OAAI,IAAI,SAAS,mBAAmB;IAClC,IAAI,MAAM,IAAI,QAAQ,MAAM,QAC1B,iCAAiC,KAClC;AAED,QAAK,UAAW,KAAK,IAAI,CACvB;AAGF,QAAIA,UAAgB,IAAI,CAGtB;aACS,CAAC,YAAY,IAAI,IAAI,EAAE;KAChC,IAAI;AACJ,SAAI;MACF,MAAM,KAAK,MAET,aAAa,KAAK,QAAQ,KAAK,EAAE,gBAAgB,KAAK,iBAAiB,CAAC,CACzE;KACF,QAAO,CAEP;AAED,SAAI,CAAC,OAAQ,CAAC,IAAI,SAAS,CAAC,IAAI,SAC9B,MAAM,CAAC,OAAO,EAAE,KAAK;KAGvB,YAAY,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC;IACrC;AAED,QAAI,YAAY,IAAI,IAAI,EACtB,MAAM,YACJ,+DACA,IACD;GAEJ;EACF,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/informativeDocs.cjs

@@ -1,148 +1,111 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _areDocsInformative = require("are-docs-informative");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const defaultAliases = {
-  a: ['an', 'our']
-};
-const defaultUselessWords = ['a', 'an', 'i', 'in', 'of', 's', 'the'];
-
-/* eslint-disable complexity -- Temporary */
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+const are_docs_informative = require_rolldown_runtime.__toESM(require("are-docs-informative"));
 
+//#region src/rules/informativeDocs.js
+const defaultAliases = { a: ["an", "our"] };
+const defaultUselessWords = [
+	"a",
+	"an",
+	"i",
+	"in",
+	"of",
+	"s",
+	"the"
+];
 /**
- * @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node
- * @returns {string[]}
- */
-const getNamesFromNode = node => {
-  switch (node?.type) {
-    case 'AccessorProperty':
-    case 'MethodDefinition':
-    case 'PropertyDefinition':
-    case 'TSAbstractAccessorProperty':
-    case 'TSAbstractMethodDefinition':
-    case 'TSAbstractPropertyDefinition':
-      return [...getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */node.parent.parent), ...getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.key)];
-    case 'ClassDeclaration':
-    case 'ClassExpression':
-    case 'FunctionDeclaration':
-    case 'FunctionExpression':
-    case 'TSDeclareFunction':
-    case 'TSEnumDeclaration':
-    case 'TSEnumMember':
-    case 'TSInterfaceDeclaration':
-    case 'TSMethodSignature':
-    case 'TSModuleDeclaration':
-    case 'TSTypeAliasDeclaration':
-      return getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */
-      node.id);
-    case 'ExportDefaultDeclaration':
-    case 'ExportNamedDeclaration':
-      return getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */
-      node.declaration);
-    case 'Identifier':
-      return [node.name];
-    case 'Property':
-      return getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.key);
-    case 'VariableDeclaration':
-      return getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.declarations[0]);
-    case 'VariableDeclarator':
-      return [...getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.id), ...getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.init)].filter(Boolean);
-    default:
-      return [];
-  }
+* @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node
+* @returns {string[]}
+*/
+const getNamesFromNode = (node) => {
+	switch (node?.type) {
+		case "AccessorProperty":
+		case "MethodDefinition":
+		case "PropertyDefinition":
+		case "TSAbstractAccessorProperty":
+		case "TSAbstractMethodDefinition":
+		case "TSAbstractPropertyDefinition": return [...getNamesFromNode(
+			/** @type {import('@typescript-eslint/types').TSESTree.Node} */
+			node.parent.parent
+		), ...getNamesFromNode(node.key)];
+		case "ClassDeclaration":
+		case "ClassExpression":
+		case "FunctionDeclaration":
+		case "FunctionExpression":
+		case "TSDeclareFunction":
+		case "TSEnumDeclaration":
+		case "TSEnumMember":
+		case "TSInterfaceDeclaration":
+		case "TSMethodSignature":
+		case "TSModuleDeclaration":
+		case "TSTypeAliasDeclaration": return getNamesFromNode(
+			/** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */
+			node.id
+		);
+		case "ExportDefaultDeclaration":
+		case "ExportNamedDeclaration": return getNamesFromNode(
+			/** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */
+			node.declaration
+		);
+		case "Identifier": return [node.name];
+		case "Property": return getNamesFromNode(node.key);
+		case "VariableDeclaration": return getNamesFromNode(node.declarations[0]);
+		case "VariableDeclarator": return [...getNamesFromNode(node.id), ...getNamesFromNode(node.init)].filter(Boolean);
+		default: return [];
+	}
 };
-/* eslint-enable complexity -- Temporary */
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  node,
-  report,
-  utils
-}) => {
-  const /** @type {{aliases: {[key: string]: string[]}, excludedTags: string[], uselessWords: string[]}} */{
-    aliases = defaultAliases,
-    excludedTags = [],
-    uselessWords = defaultUselessWords
-  } = context.options[0] || {};
-  const nodeNames = getNamesFromNode(node);
-
-  /**
-   * @param {string} text
-   * @param {string} extraName
-   * @returns {boolean}
-   */
-  const descriptionIsRedundant = (text, extraName = '') => {
-    const textTrimmed = text.trim();
-    return Boolean(textTrimmed) && !(0, _areDocsInformative.areDocsInformative)(textTrimmed, [extraName, nodeNames].filter(Boolean).join(' '), {
-      aliases,
-      uselessWords
-    });
-  };
-  const {
-    description,
-    lastDescriptionLine
-  } = utils.getDescription();
-  let descriptionReported = false;
-  for (const tag of jsdoc.tags) {
-    if (excludedTags.includes(tag.tag)) {
-      continue;
-    }
-    if (descriptionIsRedundant(tag.description, tag.name)) {
-      utils.reportJSDoc('This tag description only repeats the name it describes.', tag);
-    }
-    descriptionReported ||= tag.description === description && /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */
-    tag.line === lastDescriptionLine;
-  }
-  if (!descriptionReported && descriptionIsRedundant(description)) {
-    report('This description only repeats the name it describes.');
-  }
+var informativeDocs_default = require_iterateJsdoc.default(({ context, jsdoc, node, report, utils }) => {
+	const { aliases = defaultAliases, excludedTags = [], uselessWords = defaultUselessWords } = context.options[0] || {};
+	const nodeNames = getNamesFromNode(node);
+	/**
+	* @param {string} text
+	* @param {string} extraName
+	* @returns {boolean}
+	*/
+	const descriptionIsRedundant = (text, extraName = "") => {
+		const textTrimmed = text.trim();
+		return Boolean(textTrimmed) && !(0, are_docs_informative.areDocsInformative)(textTrimmed, [extraName, nodeNames].filter(Boolean).join(" "), {
+			aliases,
+			uselessWords
+		});
+	};
+	const { description, lastDescriptionLine } = utils.getDescription();
+	let descriptionReported = false;
+	for (const tag of jsdoc.tags) {
+		if (excludedTags.includes(tag.tag)) continue;
+		if (descriptionIsRedundant(tag.description, tag.name)) utils.reportJSDoc("This tag description only repeats the name it describes.", tag);
+		descriptionReported ||= tag.description === description && tag.line === lastDescriptionLine;
+	}
+	if (!descriptionReported && descriptionIsRedundant(description)) report("This description only repeats the name it describes.");
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'This rule reports doc comments that only restate their attached name.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        aliases: {
-          patternProperties: {
-            '.*': {
-              items: {
-                type: 'string'
-              },
-              type: 'array'
-            }
-          }
-        },
-        excludedTags: {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        uselessWords: {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "This rule reports doc comments that only restate their attached name.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				aliases: { patternProperties: { ".*": {
+					items: { type: "string" },
+					type: "array"
+				} } },
+				excludedTags: {
+					items: { type: "string" },
+					type: "array"
+				},
+				uselessWords: {
+					items: { type: "string" },
+					type: "array"
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = informativeDocs_default;
 //# sourceMappingURL=informativeDocs.cjs.map