eslint-plugin-jsdoc 46.2.0 → 46.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -28,6 +28,8 @@ try {
|
|
|
28
28
|
console.log(error);
|
|
29
29
|
/* eslint-enable no-console -- Inform user */
|
|
30
30
|
}
|
|
31
|
+
|
|
32
|
+
const moduleCheck = new Map();
|
|
31
33
|
var _default = (0, _iterateJsdoc.default)(({
|
|
32
34
|
jsdoc,
|
|
33
35
|
settings,
|
|
@@ -48,8 +50,25 @@ var _default = (0, _iterateJsdoc.default)(({
|
|
|
48
50
|
continue;
|
|
49
51
|
}
|
|
50
52
|
(0, _jsdoccomment.traverse)(typeAst, nde => {
|
|
51
|
-
if (nde.type === 'JsdocTypeImport'
|
|
52
|
-
|
|
53
|
+
if (nde.type === 'JsdocTypeImport') {
|
|
54
|
+
let mod = nde.element.value.replace(/^(@[^/]+\/[^/]+|[^/]+).*$/u, '$1');
|
|
55
|
+
if (!moduleCheck.has(mod)) {
|
|
56
|
+
let pkg;
|
|
57
|
+
try {
|
|
58
|
+
pkg = JSON.parse(
|
|
59
|
+
// @ts-expect-error It's ok
|
|
60
|
+
(0, _fs.readFileSync)((0, _path.join)(process.cwd(), 'node_modules', mod, './package.json')));
|
|
61
|
+
} catch {
|
|
62
|
+
// Ignore
|
|
63
|
+
}
|
|
64
|
+
if (!pkg || !pkg.types) {
|
|
65
|
+
mod = `@types/${mod}`;
|
|
66
|
+
}
|
|
67
|
+
moduleCheck.set(mod, !deps.has(mod));
|
|
68
|
+
}
|
|
69
|
+
if (moduleCheck.get(mod)) {
|
|
70
|
+
utils.reportJSDoc('import points to package which is not found in dependencies', tag);
|
|
71
|
+
}
|
|
53
72
|
}
|
|
54
73
|
});
|
|
55
74
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"importsAsDependencies.js","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","_fs","_path","obj","__esModule","default","deps","pkg","JSON","parse","readFileSync","join","process","cwd","Set","dependencies","Object","keys","devDependencies","error","console","log","_default","iterateJsdoc","jsdoc","settings","utils","mode","tag","tags","typeAst","tryParse","type","traverse","nde","
|
|
1
|
+
{"version":3,"file":"importsAsDependencies.js","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","_fs","_path","obj","__esModule","default","deps","pkg","JSON","parse","readFileSync","join","process","cwd","Set","dependencies","Object","keys","devDependencies","error","console","log","moduleCheck","Map","_default","iterateJsdoc","jsdoc","settings","utils","mode","tag","tags","typeAst","tryParse","type","traverse","nde","mod","element","value","replace","has","types","set","get","reportJSDoc","iterateAllJsdocs","meta","docs","description","url","exports","module"],"sources":["../../src/rules/importsAsDependencies.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc';\nimport {\n parse,\n traverse,\n tryParse,\n} from '@es-joy/jsdoccomment';\nimport {\n readFileSync,\n} from 'fs';\nimport {\n join,\n} from 'path';\n\n/**\n * @type {Set<string>}\n */\nlet deps;\ntry {\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 Object.keys(pkg.dependencies) :\n // istanbul ignore next\n []),\n ...(pkg.devDependencies ?\n Object.keys(pkg.devDependencies) :\n // istanbul ignore next\n []),\n ]);\n} catch (error) {\n /* eslint-disable no-console -- Inform user */\n // istanbul ignore next\n console.log(error);\n /* eslint-enable no-console -- Inform user */\n}\n\nconst moduleCheck = new Map();\n\nexport default iterateJsdoc(({\n jsdoc,\n settings,\n utils,\n}) => {\n // istanbul ignore if\n if (!deps) {\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 traverse(typeAst, (nde) => {\n if (nde.type === 'JsdocTypeImport') {\n let mod = nde.element.value.replace(\n /^(@[^/]+\\/[^/]+|[^/]+).*$/u, '$1',\n );\n 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) {\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,KAAA,GAAAH,OAAA;AAEc,SAAAD,uBAAAK,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAEd;AACA;AACA;AACA,IAAIG,IAAI;AACR,IAAI;EACF,MAAMC,GAAG,GAAGC,IAAI,CAACC,KAAK;EACpB;EACA,IAAAC,gBAAY,EAAC,IAAAC,UAAI,EAACC,OAAO,CAACC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,CACpD,CAAC;EACDP,IAAI,GAAG,IAAIQ,GAAG,CAAC,CACb,IAAIP,GAAG,CAACQ,YAAY,GAClBC,MAAM,CAACC,IAAI,CAACV,GAAG,CAACQ,YAAY,CAAC;EAC7B;EACA,EAAE,CAAC,EACL,IAAIR,GAAG,CAACW,eAAe,GACrBF,MAAM,CAACC,IAAI,CAACV,GAAG,CAACW,eAAe,CAAC;EAChC;EACA,EAAE,CAAC,CACN,CAAC;AACJ,CAAC,CAAC,OAAOC,KAAK,EAAE;EACd;EACA;EACAC,OAAO,CAACC,GAAG,CAACF,KAAK,CAAC;EAClB;AACF;;AAEA,MAAMG,WAAW,GAAG,IAAIC,GAAG,CAAC,CAAC;AAAC,IAAAC,QAAA,GAEf,IAAAC,qBAAY,EAAC,CAAC;EAC3BC,KAAK;EACLC,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ;EACA,IAAI,CAACtB,IAAI,EAAE;IACT;EACF;EAEA,MAAM;IACJuB;EACF,CAAC,GAAGF,QAAQ;EAEZ,KAAK,MAAMG,GAAG,IAAIJ,KAAK,CAACK,IAAI,EAAE;IAC5B,IAAIC,OAAO;IACX,IAAI;MACFA,OAAO,GAAGH,IAAI,KAAK,YAAY,GAAG,IAAAI,sBAAQ,EAACH,GAAG,CAACI,IAAI,CAAC,GAAG,IAAAzB,mBAAK,EAACqB,GAAG,CAACI,IAAI,EAAEL,IAAI,CAAC;IAC9E,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAM,sBAAQ,EAACH,OAAO,EAAGI,GAAG,IAAK;MACzB,IAAIA,GAAG,CAACF,IAAI,KAAK,iBAAiB,EAAE;QAClC,IAAIG,GAAG,GAAGD,GAAG,CAACE,OAAO,CAACC,KAAK,CAACC,OAAO,CACjC,4BAA4B,EAAE,IAChC,CAAC;QACD,IAAI,CAAClB,WAAW,CAACmB,GAAG,CAACJ,GAAG,CAAC,EAAE;UACzB,IAAI9B,GAAG;UACP,IAAI;YACFA,GAAG,GAAGC,IAAI,CAACC,KAAK;YACd;YACA,IAAAC,gBAAY,EAAC,IAAAC,UAAI,EAACC,OAAO,CAACC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAEwB,GAAG,EAAE,gBAAgB,CAAC,CACzE,CAAC;UACH,CAAC,CAAC,MAAM;YACN;UAAA;UAGF,IAAI,CAAC9B,GAAG,IAAI,CAACA,GAAG,CAACmC,KAAK,EAAE;YACtBL,GAAG,GAAI,UAASA,GAAI,EAAC;UACvB;UAEAf,WAAW,CAACqB,GAAG,CAACN,GAAG,EAAE,CAAC/B,IAAI,CAACmC,GAAG,CAACJ,GAAG,CAAC,CAAC;QACtC;QAEA,IAAIf,WAAW,CAACsB,GAAG,CAACP,GAAG,CAAC,EAAE;UACxBT,KAAK,CAACiB,WAAW,CACf,6DAA6D,EAC7Df,GACF,CAAC;QACH;MACF;IACF,CAAC,CAAC;EACJ;AACF,CAAC,EAAE;EACDgB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,sHAAsH;MACnIC,GAAG,EAAE;IACP,CAAC;IACDhB,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAiB,OAAA,CAAA9C,OAAA,GAAAmB,QAAA;AAAA4B,MAAA,CAAAD,OAAA,GAAAA,OAAA,CAAA9C,OAAA"}
|
package/package.json
CHANGED