npm - eslint-plugin-jsdoc - Versions diffs - 52.0.0 → 52.0.2 - Mend

eslint-plugin-jsdoc 52.0.0 → 52.0.2

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.

Files changed (12) hide show

package/dist/generateRule.cjs +1 -1
package/dist/generateRule.cjs.map +1 -1
package/dist/getJsdocProcessorPlugin.cjs +33 -14
package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
package/dist/getJsdocProcessorPlugin.d.ts +67 -0
package/dist/getJsdocProcessorPlugin.d.ts.map +1 -0
package/dist/iterateJsdoc.d.ts +462 -0
package/dist/iterateJsdoc.d.ts.map +1 -0
package/package.json +11 -17
package/src/getJsdocProcessorPlugin.js +34 -14
package/eslint.config.js +0 -92
package/pnpm-workspace.yaml +0 -3

package/dist/generateRule.cjs CHANGED Viewed

@@ -9,7 +9,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); } /* eslint-disable no-console -- CLI */ /**
  * @example
  * ```shell
- * npm run create-rule my-new-rule -- --recommended
+ * pnpm run create-rule my-new-rule -- --recommended
  * ```
  */
 // Todo: Would ideally have prompts, e.g., to ask for whether

package/dist/generateRule.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"generateRule.cjs","names":["_camelcase","_interopRequireDefault","require","_fs","_promises","_openEditor","_path","e","__esModule","default","_interopRequireWildcard","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","ruleName","options","process","argv","recommended","includes","console","error","test","ruleNamesPath","ruleNames","JSON","parse","fs","readFile","push","sort","writeFile","stringify","log","ruleTemplate","camelCasedRuleName","camelCase","rulePath","existsSync","ruleTestTemplate","ruleTestPath","ruleReadmeTemplate","ruleReadmePath","replaceInOrder","checkName","newLine","oldIsCamel","oldRegex","path","offsets","readme","replace","matchedLine","n1","offset","str","oldRule","oldRuleB","alreadyIncluded","itemIndex","findIndex","item","undefined","pop","length","slice","repeat","Promise","resolve","then","chdir","__dirname","open"],"sources":["../src/bin/generateRule.js"],"sourcesContent":["/* eslint-disable no-console -- CLI /\n\nimport camelCase from 'camelcase';\nimport {\n existsSync,\n} from 'fs';\nimport fs from 'fs/promises';\n/\n @example\n * ```shell\n * npm run create-rule my-new-rule -- --recommended\n * ```\n /\nimport open from 'open-editor';\nimport {\n resolve,\n} from 'path';\n\n// Todo: Would ideally have prompts, e.g., to ask for whether\n// type was problem/layout, etc.\n\nconst [\n , , ruleName,\n ...options\n] = process.argv;\n\nconst recommended = options.includes('--recommended');\n\n(async () => {\n if (!ruleName) {\n console.error('Please supply a rule name');\n\n return;\n }\n\n if ((/[A-Z]/v).test(ruleName)) {\n console.error('Please ensure the rule has no capital letters');\n\n return;\n }\n\n const ruleNamesPath = './test/rules/ruleNames.json';\n // @ts-expect-error Older types?\n const ruleNames = JSON.parse(await fs.readFile(\n ruleNamesPath,\n ));\n if (!ruleNames.includes(ruleName)) {\n ruleNames.push(ruleName);\n ruleNames.sort();\n }\n\n await fs.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\\n');\n console.log('ruleNames', ruleNames);\n\n const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n // Rule here\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: '',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n // Option properties here (or remove the object)\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n`;\n\n const camelCasedRuleName = camelCase(ruleName);\n\n const rulePath = `./src/rules/${camelCasedRuleName}.js`;\n\n if (!existsSync(rulePath)) {\n await fs.writeFile(rulePath, ruleTemplate);\n }\n\n const ruleTestTemplate = `export default {\n invalid: [\n {\n code: \\`\n \\`,\n errors: [\n {\n line: 2,\n message: '',\n },\n ],\n },\n ],\n valid: [\n {\n code: \\`\n \\`,\n },\n ],\n};\n`;\n\n const ruleTestPath = `./test/rules/assertions/${camelCasedRuleName}.js`;\n if (!existsSync(ruleTestPath)) {\n await fs.writeFile(ruleTestPath, ruleTestTemplate);\n }\n\n const ruleReadmeTemplate = `# \\`${ruleName}\\`\n\n\|\|\|\n\|---\|---\|\n\|Context\|everywhere\|\n\|Tags\|\\`\\`\|\n\|Recommended\|${recommended ? 'true' : 'false'}\|\n\|Settings\|\|\n\|Options\|\|\n\n## Failing examples\n\n<!-- assertions-failing ${camelCasedRuleName} -->\n\n## Passing examples\n\n<!-- assertions-passing ${camelCasedRuleName} -->\n`;\n\n const ruleReadmePath = `./.README/rules/${ruleName}.md`;\n if (!existsSync(ruleReadmePath)) {\n await fs.writeFile(ruleReadmePath, ruleReadmeTemplate);\n }\n\n /\n @param {object} cfg\n * @param {string} cfg.path\n * @param {RegExp} cfg.oldRegex\n * @param {string} cfg.checkName\n * @param {string} cfg.newLine\n * @param {boolean} [cfg.oldIsCamel]\n * @returns {Promise<void>}\n /\n const replaceInOrder = async ({\n checkName,\n newLine,\n oldIsCamel,\n oldRegex,\n path,\n }) => {\n /\n @typedef {number} Integer\n /\n /\n @typedef {{\n * matchedLine: string,\n * offset: Integer,\n * oldRule: string,\n * }} OffsetInfo\n /\n /\n @type {OffsetInfo[]}\n /\n const offsets = [];\n\n let readme = await fs.readFile(path, 'utf8');\n readme.replace(\n oldRegex,\n /\n @param {string} matchedLine\n * @param {string} n1\n * @param {Integer} offset\n * @param {string} str\n * @param {object} groups\n * @param {string} groups.oldRule\n * @returns {string}\n /\n (matchedLine, n1, offset, str, {\n oldRule,\n }) => {\n offsets.push({\n matchedLine,\n offset,\n oldRule,\n });\n\n return matchedLine;\n },\n );\n\n offsets.sort(({\n oldRule,\n }, {\n oldRule: oldRuleB,\n }) => {\n return oldRule < oldRuleB ? -1 : (oldRule > oldRuleB ? 1 : 0);\n });\n\n let alreadyIncluded = false;\n const itemIndex = offsets.findIndex(({\n oldRule,\n }) => {\n alreadyIncluded \|\|= oldIsCamel ? camelCasedRuleName === oldRule : ruleName === oldRule;\n\n return oldIsCamel ? camelCasedRuleName < oldRule : ruleName < oldRule;\n });\n let item = itemIndex !== undefined && offsets[itemIndex];\n if (item && itemIndex === 0 &&\n\n // This property would not always be sufficient but in this case it is.\n oldIsCamel\n ) {\n item.offset = 0;\n }\n\n if (!item) {\n item = /* @type {OffsetInfo} / (offsets.pop());\n item.offset += item.matchedLine.length;\n }\n\n if (alreadyIncluded) {\n console.log(`Rule name is already present in ${checkName}.`);\n } else {\n readme = readme.slice(0, item.offset) +\n (item.offset ? '\\n' : '') +\n newLine +\n (item.offset ? '' : '\\n') +\n readme.slice(item.offset);\n\n await fs.writeFile(path, readme);\n }\n };\n\n // await replaceInOrder({\n // checkName: 'README',\n // newLine: `{\"gitdown\": \"include\", \"file\": \"./rules/${ruleName}.md\"}`,\n // oldRegex: /\\n\\{\"gitdown\": \"include\", \"file\": \".\\/rules\\/(?<oldRule>[^.]).md\"\\}/gv,\n // path: './.README/README.md',\n // });\n\n await replaceInOrder({\n checkName: 'index import',\n newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}.js';`,\n oldIsCamel: true,\n oldRegex: /\\nimport (?<oldRule>[^ ]) from '.\\/rules\\/\\1\\.js';/gv,\n path: './src/index.js',\n });\n\n await replaceInOrder({\n checkName: 'index recommended',\n newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\\'off\\''},`,\n oldRegex: /\\n\\s{6}'jsdoc\\/(?<oldRule>[^'])': .?,/gv,\n path: './src/index.js',\n });\n\n await replaceInOrder({\n checkName: 'index rules',\n newLine: `${' '.repeat(4)}'${ruleName}': ${camelCasedRuleName},`,\n oldRegex: /\\n\\s{4}'(?<oldRule>[^'])': [^,],/gv,\n path: './src/index.js',\n });\n\n await import('./generateDocs.js');\n\n /\n console.log('Paths to open for further editing\\n');\n console.log(`open ${ruleReadmePath}`);\n console.log(`open ${rulePath}`);\n console.log(`open ${ruleTestPath}\\n`);\n */\n\n // Set chdir as somehow still in operation from other test\n process.chdir(resolve(import.meta.dirname, '../../'));\n await open([\n // Could even add editor line column numbers like `${rulePath}:1:1`\n ruleReadmePath,\n ruleTestPath,\n rulePath,\n ]);\n})();\n"],"mappings":";;AAEA,IAAAA,UAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,GAAA,GAAAD,OAAA;AAGA,IAAAE,SAAA,GAAAH,sBAAA,CAAAC,OAAA;AAOA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,KAAA,GAAAJ,OAAA;AAEc,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,wBAAAH,CAAA,EAAAI,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,uBAAA,YAAAA,CAAAH,CAAA,EAAAI,CAAA,SAAAA,CAAA,IAAAJ,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAQ,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAT,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAU,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAZ,CAAA,UAAAQ,CAAA,CAAAK,GAAA,CAAAb,CAAA,GAAAQ,CAAA,CAAAM,GAAA,CAAAd,CAAA,EAAAU,CAAA,gBAAAN,CAAA,IAAAJ,CAAA,gBAAAI,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAI,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAnB,CAAA,EAAAI,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAJ,CAAA,CAAAI,CAAA,WAAAM,CAAA,KAAAV,CAAA,EAAAI,CAAA,KAhBd,uCAOA;AACA;AACA;AACA;AACA;AACA;AAMA;AACA;;AAEA,MAAM,IACAgB,QAAQ,EACZ,GAAGC,OAAO,CACX,GAAGC,OAAO,CAACC,IAAI;AAEhB,MAAMC,WAAW,GAAGH,OAAO,CAACI,QAAQ,CAAC,eAAe,CAAC;AAErD,CAAC,YAAY;EACX,IAAI,CAACL,QAAQ,EAAE;IACbM,OAAO,CAACC,KAAK,CAAC,2BAA2B,CAAC;IAE1C;EACF;EAEA,IAAK,QAAQ,CAAEC,IAAI,CAACR,QAAQ,CAAC,EAAE;IAC7BM,OAAO,CAACC,KAAK,CAAC,+CAA+C,CAAC;IAE9D;EACF;EAEA,MAAME,aAAa,GAAG,6BAA6B;EACnD;EACA,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAAC,MAAMC,iBAAE,CAACC,QAAQ,CAC5CL,aACF,CAAC,CAAC;EACF,IAAI,CAACC,SAAS,CAACL,QAAQ,CAACL,QAAQ,CAAC,EAAE;IACjCU,SAAS,CAACK,IAAI,CAACf,QAAQ,CAAC;IACxBU,SAAS,CAACM,IAAI,CAAC,CAAC;EAClB;EAEA,MAAMH,iBAAE,CAACI,SAAS,CAACR,aAAa,EAAEE,IAAI,CAACO,SAAS,CAACR,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;EAC5EJ,OAAO,CAACa,GAAG,CAAC,WAAW,EAAET,SAAS,CAAC;EAEnC,MAAMU,YAAY,GAAG;AACvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,gFAAgFpB,QAAQ;AACxF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMqB,kBAAkB,GAAG,IAAAC,kBAAS,EAACtB,QAAQ,CAAC;EAE9C,MAAMuB,QAAQ,GAAG,eAAeF,kBAAkB,KAAK;EAEvD,IAAI,CAAC,IAAAG,cAAU,EAACD,QAAQ,CAAC,EAAE;IACzB,MAAMV,iBAAE,CAACI,SAAS,CAACM,QAAQ,EAAEH,YAAY,CAAC;EAC5C;EAEA,MAAMK,gBAAgB,GAAG;AAC3B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMC,YAAY,GAAG,2BAA2BL,kBAAkB,KAAK;EACvE,IAAI,CAAC,IAAAG,cAAU,EAACE,YAAY,CAAC,EAAE;IAC7B,MAAMb,iBAAE,CAACI,SAAS,CAACS,YAAY,EAAED,gBAAgB,CAAC;EACpD;EAEA,MAAME,kBAAkB,GAAG,OAAO3B,QAAQ;AAC5C;AACA;AACA;AACA;AACA;AACA,eAAeI,WAAW,GAAG,MAAM,GAAG,OAAO;AAC7C;AACA;AACA;AACA;AACA;AACA,0BAA0BiB,kBAAkB;AAC5C;AACA;AACA;AACA,0BAA0BA,kBAAkB;AAC5C,CAAC;EAEC,MAAMO,cAAc,GAAG,mBAAmB5B,QAAQ,KAAK;EACvD,IAAI,CAAC,IAAAwB,cAAU,EAACI,cAAc,CAAC,EAAE;IAC/B,MAAMf,iBAAE,CAACI,SAAS,CAACW,cAAc,EAAED,kBAAkB,CAAC;EACxD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAME,cAAc,GAAG,MAAAA,CAAO;IAC5BC,SAAS;IACTC,OAAO;IACPC,UAAU;IACVC,QAAQ;IACRC;EACF,CAAC,KAAK;IACJ;AACJ;AACA;IACI;AACJ;AACA;AACA;AACA;AACA;AACA;IACI;AACJ;AACA;IACI,MAAMC,OAAO,GAAG,EAAE;IAElB,IAAIC,MAAM,GAAG,MAAMvB,iBAAE,CAACC,QAAQ,CAACoB,IAAI,EAAE,MAAM,CAAC;IAC5CE,MAAM,CAACC,OAAO,CACZJ,QAAQ;IACR;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,CAACK,WAAW,EAAEC,EAAE,EAAEC,MAAM,EAAEC,GAAG,EAAE;MAC7BC;IACF,CAAC,KAAK;MACJP,OAAO,CAACpB,IAAI,CAAC;QACXuB,WAAW;QACXE,MAAM;QACNE;MACF,CAAC,CAAC;MAEF,OAAOJ,WAAW;IACpB,CACF,CAAC;IAEDH,OAAO,CAACnB,IAAI,CAAC,CAAC;MACZ0B;IACF,CAAC,EAAE;MACDA,OAAO,EAAEC;IACX,CAAC,KAAK;MACJ,OAAOD,OAAO,GAAGC,QAAQ,GAAG,CAAC,CAAC,GAAID,OAAO,GAAGC,QAAQ,GAAG,CAAC,GAAG,CAAE;IAC/D,CAAC,CAAC;IAEF,IAAIC,eAAe,GAAG,KAAK;IAC3B,MAAMC,SAAS,GAAGV,OAAO,CAACW,SAAS,CAAC,CAAC;MACnCJ;IACF,CAAC,KAAK;MACJE,eAAe,KAAKZ,UAAU,GAAGX,kBAAkB,KAAKqB,OAAO,GAAG1C,QAAQ,KAAK0C,OAAO;MAEtF,OAAOV,UAAU,GAAGX,kBAAkB,GAAGqB,OAAO,GAAG1C,QAAQ,GAAG0C,OAAO;IACvE,CAAC,CAAC;IACF,IAAIK,IAAI,GAAGF,SAAS,KAAKG,SAAS,IAAIb,OAAO,CAACU,SAAS,CAAC;IACxD,IAAIE,IAAI,IAAIF,SAAS,KAAK,CAAC;IAEzB;IACAb,UAAU,EACV;MACAe,IAAI,CAACP,MAAM,GAAG,CAAC;IACjB;IAEA,IAAI,CAACO,IAAI,EAAE;MACTA,IAAI,GAAG,yBAA2BZ,OAAO,CAACc,GAAG,CAAC,CAAE;MAChDF,IAAI,CAACP,MAAM,IAAIO,IAAI,CAACT,WAAW,CAACY,MAAM;IACxC;IAEA,IAAIN,eAAe,EAAE;MACnBtC,OAAO,CAACa,GAAG,CAAC,mCAAmCW,SAAS,GAAG,CAAC;IAC9D,CAAC,MAAM;MACLM,MAAM,GAAGA,MAAM,CAACe,KAAK,CAAC,CAAC,EAAEJ,IAAI,CAACP,MAAM,CAAC,IAC1BO,IAAI,CAACP,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC,GACzBT,OAAO,IACNgB,IAAI,CAACP,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,GACzBJ,MAAM,CAACe,KAAK,CAACJ,IAAI,CAACP,MAAM,CAAC;MAEnC,MAAM3B,iBAAE,CAACI,SAAS,CAACiB,IAAI,EAAEE,MAAM,CAAC;IAClC;EACF,CAAC;;EAED;EACA;EACA;EACA;EACA;EACA;;EAEA,MAAMP,cAAc,CAAC;IACnBC,SAAS,EAAE,cAAc;IACzBC,OAAO,EAAE,UAAUV,kBAAkB,kBAAkBA,kBAAkB,OAAO;IAChFW,UAAU,EAAE,IAAI;IAChBC,QAAQ,EAAE,uDAAuD;IACjEC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAML,cAAc,CAAC;IACnBC,SAAS,EAAE,mBAAmB;IAC9BC,OAAO,EAAE,GAAG,GAAG,CAACqB,MAAM,CAAC,CAAC,CAAC,UAAUpD,QAAQ,MAAMI,WAAW,GAAG,aAAa,GAAG,SAAS,GAAG;IAC3F6B,QAAQ,EAAE,2CAA2C;IACrDC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAML,cAAc,CAAC;IACnBC,SAAS,EAAE,aAAa;IACxBC,OAAO,EAAE,GAAG,GAAG,CAACqB,MAAM,CAAC,CAAC,CAAC,IAAIpD,QAAQ,MAAMqB,kBAAkB,GAAG;IAChEY,QAAQ,EAAE,sCAAsC;IAChDC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAAmB,OAAA,CAAAC,OAAA,GAAAC,IAAA,OAAAxE,uBAAA,CAAAR,OAAA,CAAa,mBAAmB,GAAC;;EAEjC;AACF;AACA;AACA;AACA;AACA;;EAEE;EACA2B,OAAO,CAACsD,KAAK,CAAC,IAAAF,aAAO,EAAAG,SAAA,EAAsB,QAAQ,CAAC,CAAC;EACrD,MAAM,IAAAC,mBAAI,EAAC;EACT;EACA9B,cAAc,EACdF,YAAY,EACZH,QAAQ,CACT,CAAC;AACJ,CAAC,EAAE,CAAC","ignoreList":[]}
1	+ {"version":3,"file":"generateRule.cjs","names":["_camelcase","_interopRequireDefault","require","_fs","_promises","_openEditor","_path","e","__esModule","default","_interopRequireWildcard","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","ruleName","options","process","argv","recommended","includes","console","error","test","ruleNamesPath","ruleNames","JSON","parse","fs","readFile","push","sort","writeFile","stringify","log","ruleTemplate","camelCasedRuleName","camelCase","rulePath","existsSync","ruleTestTemplate","ruleTestPath","ruleReadmeTemplate","ruleReadmePath","replaceInOrder","checkName","newLine","oldIsCamel","oldRegex","path","offsets","readme","replace","matchedLine","n1","offset","str","oldRule","oldRuleB","alreadyIncluded","itemIndex","findIndex","item","undefined","pop","length","slice","repeat","Promise","resolve","then","chdir","__dirname","open"],"sources":["../src/bin/generateRule.js"],"sourcesContent":["/* eslint-disable no-console -- CLI /\n\nimport camelCase from 'camelcase';\nimport {\n existsSync,\n} from 'fs';\nimport fs from 'fs/promises';\n/\n @example\n * ```shell\n * pnpm run create-rule my-new-rule -- --recommended\n * ```\n /\nimport open from 'open-editor';\nimport {\n resolve,\n} from 'path';\n\n// Todo: Would ideally have prompts, e.g., to ask for whether\n// type was problem/layout, etc.\n\nconst [\n , , ruleName,\n ...options\n] = process.argv;\n\nconst recommended = options.includes('--recommended');\n\n(async () => {\n if (!ruleName) {\n console.error('Please supply a rule name');\n\n return;\n }\n\n if ((/[A-Z]/v).test(ruleName)) {\n console.error('Please ensure the rule has no capital letters');\n\n return;\n }\n\n const ruleNamesPath = './test/rules/ruleNames.json';\n // @ts-expect-error Older types?\n const ruleNames = JSON.parse(await fs.readFile(\n ruleNamesPath,\n ));\n if (!ruleNames.includes(ruleName)) {\n ruleNames.push(ruleName);\n ruleNames.sort();\n }\n\n await fs.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\\n');\n console.log('ruleNames', ruleNames);\n\n const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n // Rule here\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: '',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n // Option properties here (or remove the object)\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n`;\n\n const camelCasedRuleName = camelCase(ruleName);\n\n const rulePath = `./src/rules/${camelCasedRuleName}.js`;\n\n if (!existsSync(rulePath)) {\n await fs.writeFile(rulePath, ruleTemplate);\n }\n\n const ruleTestTemplate = `export default {\n invalid: [\n {\n code: \\`\n \\`,\n errors: [\n {\n line: 2,\n message: '',\n },\n ],\n },\n ],\n valid: [\n {\n code: \\`\n \\`,\n },\n ],\n};\n`;\n\n const ruleTestPath = `./test/rules/assertions/${camelCasedRuleName}.js`;\n if (!existsSync(ruleTestPath)) {\n await fs.writeFile(ruleTestPath, ruleTestTemplate);\n }\n\n const ruleReadmeTemplate = `# \\`${ruleName}\\`\n\n\|\|\|\n\|---\|---\|\n\|Context\|everywhere\|\n\|Tags\|\\`\\`\|\n\|Recommended\|${recommended ? 'true' : 'false'}\|\n\|Settings\|\|\n\|Options\|\|\n\n## Failing examples\n\n<!-- assertions-failing ${camelCasedRuleName} -->\n\n## Passing examples\n\n<!-- assertions-passing ${camelCasedRuleName} -->\n`;\n\n const ruleReadmePath = `./.README/rules/${ruleName}.md`;\n if (!existsSync(ruleReadmePath)) {\n await fs.writeFile(ruleReadmePath, ruleReadmeTemplate);\n }\n\n /\n @param {object} cfg\n * @param {string} cfg.path\n * @param {RegExp} cfg.oldRegex\n * @param {string} cfg.checkName\n * @param {string} cfg.newLine\n * @param {boolean} [cfg.oldIsCamel]\n * @returns {Promise<void>}\n /\n const replaceInOrder = async ({\n checkName,\n newLine,\n oldIsCamel,\n oldRegex,\n path,\n }) => {\n /\n @typedef {number} Integer\n /\n /\n @typedef {{\n * matchedLine: string,\n * offset: Integer,\n * oldRule: string,\n * }} OffsetInfo\n /\n /\n @type {OffsetInfo[]}\n /\n const offsets = [];\n\n let readme = await fs.readFile(path, 'utf8');\n readme.replace(\n oldRegex,\n /\n @param {string} matchedLine\n * @param {string} n1\n * @param {Integer} offset\n * @param {string} str\n * @param {object} groups\n * @param {string} groups.oldRule\n * @returns {string}\n /\n (matchedLine, n1, offset, str, {\n oldRule,\n }) => {\n offsets.push({\n matchedLine,\n offset,\n oldRule,\n });\n\n return matchedLine;\n },\n );\n\n offsets.sort(({\n oldRule,\n }, {\n oldRule: oldRuleB,\n }) => {\n return oldRule < oldRuleB ? -1 : (oldRule > oldRuleB ? 1 : 0);\n });\n\n let alreadyIncluded = false;\n const itemIndex = offsets.findIndex(({\n oldRule,\n }) => {\n alreadyIncluded \|\|= oldIsCamel ? camelCasedRuleName === oldRule : ruleName === oldRule;\n\n return oldIsCamel ? camelCasedRuleName < oldRule : ruleName < oldRule;\n });\n let item = itemIndex !== undefined && offsets[itemIndex];\n if (item && itemIndex === 0 &&\n\n // This property would not always be sufficient but in this case it is.\n oldIsCamel\n ) {\n item.offset = 0;\n }\n\n if (!item) {\n item = /* @type {OffsetInfo} / (offsets.pop());\n item.offset += item.matchedLine.length;\n }\n\n if (alreadyIncluded) {\n console.log(`Rule name is already present in ${checkName}.`);\n } else {\n readme = readme.slice(0, item.offset) +\n (item.offset ? '\\n' : '') +\n newLine +\n (item.offset ? '' : '\\n') +\n readme.slice(item.offset);\n\n await fs.writeFile(path, readme);\n }\n };\n\n // await replaceInOrder({\n // checkName: 'README',\n // newLine: `{\"gitdown\": \"include\", \"file\": \"./rules/${ruleName}.md\"}`,\n // oldRegex: /\\n\\{\"gitdown\": \"include\", \"file\": \".\\/rules\\/(?<oldRule>[^.]).md\"\\}/gv,\n // path: './.README/README.md',\n // });\n\n await replaceInOrder({\n checkName: 'index import',\n newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}.js';`,\n oldIsCamel: true,\n oldRegex: /\\nimport (?<oldRule>[^ ]) from '.\\/rules\\/\\1\\.js';/gv,\n path: './src/index.js',\n });\n\n await replaceInOrder({\n checkName: 'index recommended',\n newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\\'off\\''},`,\n oldRegex: /\\n\\s{6}'jsdoc\\/(?<oldRule>[^'])': .?,/gv,\n path: './src/index.js',\n });\n\n await replaceInOrder({\n checkName: 'index rules',\n newLine: `${' '.repeat(4)}'${ruleName}': ${camelCasedRuleName},`,\n oldRegex: /\\n\\s{4}'(?<oldRule>[^'])': [^,],/gv,\n path: './src/index.js',\n });\n\n await import('./generateDocs.js');\n\n /\n console.log('Paths to open for further editing\\n');\n console.log(`open ${ruleReadmePath}`);\n console.log(`open ${rulePath}`);\n console.log(`open ${ruleTestPath}\\n`);\n */\n\n // Set chdir as somehow still in operation from other test\n process.chdir(resolve(import.meta.dirname, '../../'));\n await open([\n // Could even add editor line column numbers like `${rulePath}:1:1`\n ruleReadmePath,\n ruleTestPath,\n rulePath,\n ]);\n})();\n"],"mappings":";;AAEA,IAAAA,UAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,GAAA,GAAAD,OAAA;AAGA,IAAAE,SAAA,GAAAH,sBAAA,CAAAC,OAAA;AAOA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,KAAA,GAAAJ,OAAA;AAEc,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,wBAAAH,CAAA,EAAAI,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,uBAAA,YAAAA,CAAAH,CAAA,EAAAI,CAAA,SAAAA,CAAA,IAAAJ,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAQ,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAT,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAU,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAZ,CAAA,UAAAQ,CAAA,CAAAK,GAAA,CAAAb,CAAA,GAAAQ,CAAA,CAAAM,GAAA,CAAAd,CAAA,EAAAU,CAAA,gBAAAN,CAAA,IAAAJ,CAAA,gBAAAI,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAI,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAnB,CAAA,EAAAI,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAJ,CAAA,CAAAI,CAAA,WAAAM,CAAA,KAAAV,CAAA,EAAAI,CAAA,KAhBd,uCAOA;AACA;AACA;AACA;AACA;AACA;AAMA;AACA;;AAEA,MAAM,IACAgB,QAAQ,EACZ,GAAGC,OAAO,CACX,GAAGC,OAAO,CAACC,IAAI;AAEhB,MAAMC,WAAW,GAAGH,OAAO,CAACI,QAAQ,CAAC,eAAe,CAAC;AAErD,CAAC,YAAY;EACX,IAAI,CAACL,QAAQ,EAAE;IACbM,OAAO,CAACC,KAAK,CAAC,2BAA2B,CAAC;IAE1C;EACF;EAEA,IAAK,QAAQ,CAAEC,IAAI,CAACR,QAAQ,CAAC,EAAE;IAC7BM,OAAO,CAACC,KAAK,CAAC,+CAA+C,CAAC;IAE9D;EACF;EAEA,MAAME,aAAa,GAAG,6BAA6B;EACnD;EACA,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAAC,MAAMC,iBAAE,CAACC,QAAQ,CAC5CL,aACF,CAAC,CAAC;EACF,IAAI,CAACC,SAAS,CAACL,QAAQ,CAACL,QAAQ,CAAC,EAAE;IACjCU,SAAS,CAACK,IAAI,CAACf,QAAQ,CAAC;IACxBU,SAAS,CAACM,IAAI,CAAC,CAAC;EAClB;EAEA,MAAMH,iBAAE,CAACI,SAAS,CAACR,aAAa,EAAEE,IAAI,CAACO,SAAS,CAACR,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;EAC5EJ,OAAO,CAACa,GAAG,CAAC,WAAW,EAAET,SAAS,CAAC;EAEnC,MAAMU,YAAY,GAAG;AACvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,gFAAgFpB,QAAQ;AACxF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMqB,kBAAkB,GAAG,IAAAC,kBAAS,EAACtB,QAAQ,CAAC;EAE9C,MAAMuB,QAAQ,GAAG,eAAeF,kBAAkB,KAAK;EAEvD,IAAI,CAAC,IAAAG,cAAU,EAACD,QAAQ,CAAC,EAAE;IACzB,MAAMV,iBAAE,CAACI,SAAS,CAACM,QAAQ,EAAEH,YAAY,CAAC;EAC5C;EAEA,MAAMK,gBAAgB,GAAG;AAC3B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMC,YAAY,GAAG,2BAA2BL,kBAAkB,KAAK;EACvE,IAAI,CAAC,IAAAG,cAAU,EAACE,YAAY,CAAC,EAAE;IAC7B,MAAMb,iBAAE,CAACI,SAAS,CAACS,YAAY,EAAED,gBAAgB,CAAC;EACpD;EAEA,MAAME,kBAAkB,GAAG,OAAO3B,QAAQ;AAC5C;AACA;AACA;AACA;AACA;AACA,eAAeI,WAAW,GAAG,MAAM,GAAG,OAAO;AAC7C;AACA;AACA;AACA;AACA;AACA,0BAA0BiB,kBAAkB;AAC5C;AACA;AACA;AACA,0BAA0BA,kBAAkB;AAC5C,CAAC;EAEC,MAAMO,cAAc,GAAG,mBAAmB5B,QAAQ,KAAK;EACvD,IAAI,CAAC,IAAAwB,cAAU,EAACI,cAAc,CAAC,EAAE;IAC/B,MAAMf,iBAAE,CAACI,SAAS,CAACW,cAAc,EAAED,kBAAkB,CAAC;EACxD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAME,cAAc,GAAG,MAAAA,CAAO;IAC5BC,SAAS;IACTC,OAAO;IACPC,UAAU;IACVC,QAAQ;IACRC;EACF,CAAC,KAAK;IACJ;AACJ;AACA;IACI;AACJ;AACA;AACA;AACA;AACA;AACA;IACI;AACJ;AACA;IACI,MAAMC,OAAO,GAAG,EAAE;IAElB,IAAIC,MAAM,GAAG,MAAMvB,iBAAE,CAACC,QAAQ,CAACoB,IAAI,EAAE,MAAM,CAAC;IAC5CE,MAAM,CAACC,OAAO,CACZJ,QAAQ;IACR;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,CAACK,WAAW,EAAEC,EAAE,EAAEC,MAAM,EAAEC,GAAG,EAAE;MAC7BC;IACF,CAAC,KAAK;MACJP,OAAO,CAACpB,IAAI,CAAC;QACXuB,WAAW;QACXE,MAAM;QACNE;MACF,CAAC,CAAC;MAEF,OAAOJ,WAAW;IACpB,CACF,CAAC;IAEDH,OAAO,CAACnB,IAAI,CAAC,CAAC;MACZ0B;IACF,CAAC,EAAE;MACDA,OAAO,EAAEC;IACX,CAAC,KAAK;MACJ,OAAOD,OAAO,GAAGC,QAAQ,GAAG,CAAC,CAAC,GAAID,OAAO,GAAGC,QAAQ,GAAG,CAAC,GAAG,CAAE;IAC/D,CAAC,CAAC;IAEF,IAAIC,eAAe,GAAG,KAAK;IAC3B,MAAMC,SAAS,GAAGV,OAAO,CAACW,SAAS,CAAC,CAAC;MACnCJ;IACF,CAAC,KAAK;MACJE,eAAe,KAAKZ,UAAU,GAAGX,kBAAkB,KAAKqB,OAAO,GAAG1C,QAAQ,KAAK0C,OAAO;MAEtF,OAAOV,UAAU,GAAGX,kBAAkB,GAAGqB,OAAO,GAAG1C,QAAQ,GAAG0C,OAAO;IACvE,CAAC,CAAC;IACF,IAAIK,IAAI,GAAGF,SAAS,KAAKG,SAAS,IAAIb,OAAO,CAACU,SAAS,CAAC;IACxD,IAAIE,IAAI,IAAIF,SAAS,KAAK,CAAC;IAEzB;IACAb,UAAU,EACV;MACAe,IAAI,CAACP,MAAM,GAAG,CAAC;IACjB;IAEA,IAAI,CAACO,IAAI,EAAE;MACTA,IAAI,GAAG,yBAA2BZ,OAAO,CAACc,GAAG,CAAC,CAAE;MAChDF,IAAI,CAACP,MAAM,IAAIO,IAAI,CAACT,WAAW,CAACY,MAAM;IACxC;IAEA,IAAIN,eAAe,EAAE;MACnBtC,OAAO,CAACa,GAAG,CAAC,mCAAmCW,SAAS,GAAG,CAAC;IAC9D,CAAC,MAAM;MACLM,MAAM,GAAGA,MAAM,CAACe,KAAK,CAAC,CAAC,EAAEJ,IAAI,CAACP,MAAM,CAAC,IAC1BO,IAAI,CAACP,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC,GACzBT,OAAO,IACNgB,IAAI,CAACP,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,GACzBJ,MAAM,CAACe,KAAK,CAACJ,IAAI,CAACP,MAAM,CAAC;MAEnC,MAAM3B,iBAAE,CAACI,SAAS,CAACiB,IAAI,EAAEE,MAAM,CAAC;IAClC;EACF,CAAC;;EAED;EACA;EACA;EACA;EACA;EACA;;EAEA,MAAMP,cAAc,CAAC;IACnBC,SAAS,EAAE,cAAc;IACzBC,OAAO,EAAE,UAAUV,kBAAkB,kBAAkBA,kBAAkB,OAAO;IAChFW,UAAU,EAAE,IAAI;IAChBC,QAAQ,EAAE,uDAAuD;IACjEC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAML,cAAc,CAAC;IACnBC,SAAS,EAAE,mBAAmB;IAC9BC,OAAO,EAAE,GAAG,GAAG,CAACqB,MAAM,CAAC,CAAC,CAAC,UAAUpD,QAAQ,MAAMI,WAAW,GAAG,aAAa,GAAG,SAAS,GAAG;IAC3F6B,QAAQ,EAAE,2CAA2C;IACrDC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAML,cAAc,CAAC;IACnBC,SAAS,EAAE,aAAa;IACxBC,OAAO,EAAE,GAAG,GAAG,CAACqB,MAAM,CAAC,CAAC,CAAC,IAAIpD,QAAQ,MAAMqB,kBAAkB,GAAG;IAChEY,QAAQ,EAAE,sCAAsC;IAChDC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAAmB,OAAA,CAAAC,OAAA,GAAAC,IAAA,OAAAxE,uBAAA,CAAAR,OAAA,CAAa,mBAAmB,GAAC;;EAEjC;AACF;AACA;AACA;AACA;AACA;;EAEE;EACA2B,OAAO,CAACsD,KAAK,CAAC,IAAAF,aAAO,EAAAG,SAAA,EAAsB,QAAQ,CAAC,CAAC;EACrD,MAAM,IAAAC,mBAAI,EAAC;EACT;EACA9B,cAAc,EACdF,YAAY,EACZH,QAAQ,CACT,CAAC;AACJ,CAAC,EAAE,CAAC","ignoreList":[]}

package/dist/getJsdocProcessorPlugin.cjs CHANGED Viewed

@@ -10,6 +10,17 @@ var espree = _interopRequireWildcard(require("espree"));
 var _nodeFs = require("node:fs");
 var _nodePath = require("node:path");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+/**
+ * @import {
+ *   Integer,
+ *   JsdocBlockWithInline,
+ * } from './iterateJsdoc.js';
+ * @import {
+ *   ESLint,
+ *   Linter,
+ * } from 'eslint';
+ */
 const {
   version
 } = JSON.parse(
@@ -35,7 +46,7 @@ const escapeStringRegexp = str => {
 /**
  * @param {string} str
  * @param {string} ch
- * @returns {import('./iterateJsdoc.js').Integer}
+ * @returns {Integer}
  */
 const countChars = (str, ch) => {
   return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) || []).length;
@@ -44,8 +55,8 @@ const countChars = (str, ch) => {
 /**
  * @param {string} text
  * @returns {[
- *   import('./iterateJsdoc.js').Integer,
- *   import('./iterateJsdoc.js').Integer
+ *   Integer,
+ *   Integer
  * ]}
  */
 const getLinesCols = text => {
@@ -81,6 +92,7 @@ const getLinesCols = text => {
  * We use a function for the ability of the user to pass in a config, but
  * without requiring all users of the plugin to do so.
  * @param {JsdocProcessorOptions} [options]
+ * @returns {ESLint.Plugin}
  */
 const getJsdocProcessorPlugin = (options = {}) => {
   const {
@@ -128,7 +140,7 @@ const getJsdocProcessorPlugin = (options = {}) => {
   let extraMessages = [];
   /**
-   * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+   * @param {JsdocBlockWithInline} jsdoc
    * @param {string} jsFileName
    * @param {[number, number]} commentLineCols
    */
@@ -148,19 +160,19 @@ const getJsdocProcessorPlugin = (options = {}) => {
      *   source: string,
      *   targetTagName: string,
      *   rules?: import('eslint').Linter.RulesRecord|undefined,
-     *   lines?: import('./iterateJsdoc.js').Integer,
-     *   cols?: import('./iterateJsdoc.js').Integer,
+     *   lines?: Integer,
+     *   cols?: Integer,
      *   skipInit?: boolean,
      *   ext: string,
      *   sources?: {
-     *     nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
-     *     nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
+     *     nonJSPrefacingCols: Integer,
+     *     nonJSPrefacingLines: Integer,
      *     string: string,
      *   }[],
      *   tag?: import('comment-parser').Spec & {
-     *     line?: import('./iterateJsdoc.js').Integer,
+     *     line?: Integer,
      *   }|{
-     *     line: import('./iterateJsdoc.js').Integer,
+     *     line: Integer,
      *   }
      * }} cfg
      */
@@ -188,8 +200,8 @@ const getJsdocProcessorPlugin = (options = {}) => {
       /**
        * @param {{
-       *   nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
-       *   nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
+       *   nonJSPrefacingCols: Integer,
+       *   nonJSPrefacingLines: Integer,
        *   string: string
        * }} cfg
        */
@@ -210,7 +222,7 @@ const getJsdocProcessorPlugin = (options = {}) => {
         const codeStartLine =
         /**
          * @type {import('comment-parser').Spec & {
-         *     line: import('./iterateJsdoc.js').Integer,
+         *     line: Integer,
          * }}
          */
         tag.line + nonJSPrefacingLines;
@@ -485,6 +497,7 @@ const getJsdocProcessorPlugin = (options = {}) => {
         /**
          * @param {string} text
          * @param {string} filename
+         * @returns {(string | Linter.ProcessorFile)[]}
          */
         preprocess(text, filename) {
           try {
@@ -533,7 +546,13 @@ const getJsdocProcessorPlugin = (options = {}) => {
             });
             return [text, ...jsdocComments.flatMap((jsdoc, idx) => {
               return getTextsAndFileNames(jsdoc, filename, commentLineCols[idx]);
-            }).filter(Boolean)];
+            }).filter(
+            /**
+             * @returns {file is Linter.ProcessorFile}
+             */
+            file => {
+              return file !== null && file !== undefined;
+            })];
             /* c8 ignore next 6 */
           } catch (error) {
             // eslint-disable-next-line no-console -- Debugging

package/dist/getJsdocProcessorPlugin.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"getJsdocProcessorPlugin.cjs","names":["_jsdocUtils","require","_jsdoccomment","espree","_interopRequireWildcard","_nodeFs","_nodePath","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","version","JSON","parse","readFileSync","join","__dirname","likelyNestedJSDocIndentSpace","preTagSpaceLength","firstLinePrefixLength","hasCaptionRegex","escapeStringRegexp","str","replaceAll","countChars","ch","match","RegExp","length","getLinesCols","text","matchLines","colDelta","slice","lastIndexOf","getJsdocProcessorPlugin","options","allowedLanguagesToProcess","captionRequired","checkDefaults","checkExamples","checkParams","checkProperties","exampleCodeRegex","matchingFileName","matchingFileNameDefaults","matchingFileNameParams","matchingFileNameProperties","paddedIndent","parser","undefined","rejectExampleCodeRegex","sourceType","exampleCodeRegExp","rejectExampleCodeRegExp","getRegexFromString","otherInfo","extraMessages","getTextsAndFileNames","jsdoc","jsFileName","commentLineCols","textsAndFileNames","checkSource","cols","defaultFileName","ext","filename","lines","skipInit","source","sources","tag","line","targetTagName","push","nonJSPrefacingCols","nonJSPrefacingLines","string","addSourceInfo","src","file","number","codeStartLine","codeStartCol","targetSource","getFilenameInfo","includes","replace","filenameInfo","forEachPreferredTag","description","trim","getTagDescription","tagName","getPreferredTagName","hasTag","matchingFilenameInfo","column","message","ruleId","severity","test","matches","exec","groups","language","toLowerCase","startingIndex","lastStringCount","exampleCode","lastIndex","n0","n1","index","preMatch","preMatchLines","nonJSPreface","nonJSPrefaceLineCount","idx","indexOf","charsInLastLine","global","meta","name","processors","examples","postprocess","jsMessages","messages","entries","msg","endColumn","endLine","fatal","messageText","codeCtxLine","codeCtxColumn","startLine","startCol","ret","concat","preprocess","ast","parseForESLint","comment","ecmaVersion","jsdocComments","comments","filter","value","map","start","range","textToStart","parseComment","flatMap","Boolean","error","console","log","supportsAutofix","exports"],"sources":["../src/getJsdocProcessorPlugin.js"],"sourcesContent":["import {\n forEachPreferredTag,\n getPreferredTagName,\n getRegexFromString,\n getTagDescription,\n hasTag,\n} from './jsdocUtils.js';\nimport {\n parseComment,\n} from '@es-joy/jsdoccomment';\nimport * as espree from 'espree';\nimport {\n readFileSync,\n} from 'node:fs';\nimport {\n join,\n} from 'node:path';\n\nconst {\n version,\n} = JSON.parse(\n // @ts-expect-error `Buffer` is ok for `JSON.parse`\n readFileSync(join(import.meta.dirname, '../package.json')),\n);\n\n// const zeroBasedLineIndexAdjust = -1;\nconst likelyNestedJSDocIndentSpace = 1;\nconst preTagSpaceLength = 1;\n\n// If a space is present, we should ignore it\nconst firstLinePrefixLength = preTagSpaceLength;\n\nconst hasCaptionRegex = /^\\s<caption>([\\s\\S]?)<\\/caption>/v;\n\n/*\n @param {string} str\n * @returns {string}\n /\nconst escapeStringRegexp = (str) => {\n return str.replaceAll(/[.+?^$\\{\\}\$\$\\\|\\[\\]\\\\]/gv, '\\\\$&');\n};\n\n/*\n @param {string} str\n * @param {string} ch\n * @returns {import('./iterateJsdoc.js').Integer}\n /\nconst countChars = (str, ch) => {\n return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) \|\| []).length;\n};\n\n/\n @param {string} text\n * @returns {[\n * import('./iterateJsdoc.js').Integer,\n * import('./iterateJsdoc.js').Integer\n * ]}\n /\nconst getLinesCols = (text) => {\n const matchLines = countChars(text, '\\n');\n\n const colDelta = matchLines ?\n text.slice(text.lastIndexOf('\\n') + 1).length :\n text.length;\n\n return [\n matchLines, colDelta,\n ];\n};\n\n/\n @typedef {number} Integer\n /\n\n/\n @typedef {object} JsdocProcessorOptions\n * @property {boolean} [captionRequired] Require captions for example tags\n * @property {Integer} [paddedIndent] See docs\n * @property {boolean} [checkDefaults] See docs\n * @property {boolean} [checkParams] See docs\n * @property {boolean} [checkExamples] See docs\n * @property {boolean} [checkProperties] See docs\n * @property {string} [matchingFileName] See docs\n * @property {string} [matchingFileNameDefaults] See docs\n * @property {string} [matchingFileNameParams] See docs\n * @property {string} [matchingFileNameProperties] See docs\n * @property {string\|RegExp} [exampleCodeRegex] See docs\n * @property {string\|RegExp} [rejectExampleCodeRegex] See docs\n * @property {string[]} [allowedLanguagesToProcess] See docs\n * @property {\"script\"\|\"module\"} [sourceType] See docs\n * @property {import('eslint').Linter.ESTreeParser\|import('eslint').Linter.NonESTreeParser} [parser] See docs\n /\n\n/\n We use a function for the ability of the user to pass in a config, but\n * without requiring all users of the plugin to do so.\n * @param {JsdocProcessorOptions} [options]\n /\nexport const getJsdocProcessorPlugin = (options = {}) => {\n const {\n allowedLanguagesToProcess = [\n 'js', 'ts', 'javascript', 'typescript',\n ],\n captionRequired = false,\n checkDefaults = false,\n checkExamples = true,\n checkParams = false,\n checkProperties = false,\n exampleCodeRegex = null,\n matchingFileName = null,\n matchingFileNameDefaults = null,\n matchingFileNameParams = null,\n matchingFileNameProperties = null,\n paddedIndent = 0,\n parser = undefined,\n rejectExampleCodeRegex = null,\n sourceType = 'module',\n } = options;\n\n /* @type {RegExp} /\n let exampleCodeRegExp;\n /* @type {RegExp} /\n let rejectExampleCodeRegExp;\n\n if (exampleCodeRegex) {\n exampleCodeRegExp = typeof exampleCodeRegex === 'string' ?\n getRegexFromString(exampleCodeRegex) :\n exampleCodeRegex;\n }\n\n if (rejectExampleCodeRegex) {\n rejectExampleCodeRegExp = typeof rejectExampleCodeRegex === 'string' ?\n getRegexFromString(rejectExampleCodeRegex) :\n rejectExampleCodeRegex;\n }\n\n /\n @type {{\n * targetTagName: string,\n * ext: string,\n * codeStartLine: number,\n * codeStartCol: number,\n * nonJSPrefacingCols: number,\n * commentLineCols: [number, number]\n * }[]}\n /\n const otherInfo = [];\n\n /* @type {import('eslint').Linter.LintMessage[]} /\n let extraMessages = [];\n\n /\n @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc\n * @param {string} jsFileName\n * @param {[number, number]} commentLineCols\n /\n const getTextsAndFileNames = (jsdoc, jsFileName, commentLineCols) => {\n /\n @type {{\n * text: string,\n * filename: string\|null\|undefined\n * }[]}\n /\n const textsAndFileNames = [];\n\n /\n @param {{\n * filename: string\|null,\n * defaultFileName: string\|undefined,\n * source: string,\n * targetTagName: string,\n * rules?: import('eslint').Linter.RulesRecord\|undefined,\n * lines?: import('./iterateJsdoc.js').Integer,\n * cols?: import('./iterateJsdoc.js').Integer,\n * skipInit?: boolean,\n * ext: string,\n * sources?: {\n * nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,\n * nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,\n * string: string,\n * }[],\n * tag?: import('comment-parser').Spec & {\n * line?: import('./iterateJsdoc.js').Integer,\n * }\|{\n * line: import('./iterateJsdoc.js').Integer,\n * }\n * }} cfg\n /\n const checkSource = ({\n cols = 0,\n defaultFileName,\n ext,\n filename,\n lines = 0,\n skipInit,\n source,\n sources = [],\n tag = {\n line: 0,\n },\n targetTagName,\n }) => {\n if (!skipInit) {\n sources.push({\n nonJSPrefacingCols: cols,\n nonJSPrefacingLines: lines,\n string: source,\n });\n }\n\n /\n @param {{\n * nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,\n * nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,\n * string: string\n * }} cfg\n /\n const addSourceInfo = function ({\n nonJSPrefacingCols,\n nonJSPrefacingLines,\n string,\n }) {\n const src = paddedIndent ?\n string.replaceAll(new RegExp(`(^\|\\n) {${paddedIndent}}(?!$)`, 'gv'), '\\n') :\n string;\n\n // Programmatic ESLint API: https://eslint.org/docs/developer-guide/nodejs-api\n const file = filename \|\| defaultFileName;\n\n if (!('line' in tag)) {\n tag.line = tag.source[0].number;\n }\n\n // NOTE: `tag.line` can be 0 if of form `/* @tag ... /`\n const codeStartLine = /\n @type {import('comment-parser').Spec & {\n * line: import('./iterateJsdoc.js').Integer,\n * }}\n / (tag).line + nonJSPrefacingLines;\n const codeStartCol = likelyNestedJSDocIndentSpace;\n\n textsAndFileNames.push({\n filename: file,\n text: src,\n });\n otherInfo.push({\n codeStartCol,\n codeStartLine,\n commentLineCols,\n ext,\n nonJSPrefacingCols,\n targetTagName,\n });\n };\n\n for (const targetSource of sources) {\n addSourceInfo(targetSource);\n }\n };\n\n /\n \n * @param {string\|null} filename\n * @param {string} [ext] Since `eslint-plugin-markdown` v2, and\n * ESLint 7, this is the default which other JS-fenced rules will used.\n * Formerly \"md\" was the default.\n * @returns {{\n * defaultFileName: string\|undefined,\n * filename: string\|null,\n * ext: string\n * }}\n /\n const getFilenameInfo = (filename, ext = 'md/.js') => {\n let defaultFileName;\n if (!filename) {\n if (typeof jsFileName === 'string' && jsFileName.includes('.')) {\n defaultFileName = jsFileName.replace(/\\.[^.]$/v, `.${ext}`);\n } else {\n defaultFileName = `dummy.${ext}`;\n }\n }\n\n return {\n defaultFileName,\n ext,\n filename,\n };\n };\n\n if (checkDefaults) {\n const filenameInfo = getFilenameInfo(matchingFileNameDefaults, 'jsdoc-defaults');\n forEachPreferredTag(jsdoc, 'default', (tag, targetTagName) => {\n if (!tag.description.trim()) {\n return;\n }\n\n checkSource({\n source: `(${getTagDescription(tag)})`,\n targetTagName,\n ...filenameInfo,\n });\n });\n }\n\n if (checkParams) {\n const filenameInfo = getFilenameInfo(matchingFileNameParams, 'jsdoc-params');\n forEachPreferredTag(jsdoc, 'param', (tag, targetTagName) => {\n if (!tag.default \|\| !tag.default.trim()) {\n return;\n }\n\n checkSource({\n source: `(${tag.default})`,\n targetTagName,\n ...filenameInfo,\n });\n });\n }\n\n if (checkProperties) {\n const filenameInfo = getFilenameInfo(matchingFileNameProperties, 'jsdoc-properties');\n forEachPreferredTag(jsdoc, 'property', (tag, targetTagName) => {\n if (!tag.default \|\| !tag.default.trim()) {\n return;\n }\n\n checkSource({\n source: `(${tag.default})`,\n targetTagName,\n ...filenameInfo,\n });\n });\n }\n\n if (!checkExamples) {\n return textsAndFileNames;\n }\n\n const tagName = /* @type {string} / (getPreferredTagName(jsdoc, {\n tagName: 'example',\n }));\n if (!hasTag(jsdoc, tagName)) {\n return textsAndFileNames;\n }\n\n const matchingFilenameInfo = getFilenameInfo(matchingFileName);\n\n forEachPreferredTag(jsdoc, 'example', (tag, targetTagName) => {\n let source = /* @type {string} / (getTagDescription(tag));\n const match = source.match(hasCaptionRegex);\n\n if (captionRequired && (!match \|\| !match[1].trim())) {\n extraMessages.push({\n column: commentLineCols[1] + 1,\n line: 1 + commentLineCols[0] + (tag.line ?? tag.source[0].number),\n message: `@${targetTagName} error - Caption is expected for examples.`,\n ruleId: 'jsdoc/example-missing-caption',\n severity: 2,\n });\n return;\n }\n\n source = source.replace(hasCaptionRegex, '');\n const [\n lines,\n cols,\n ] = match ? getLinesCols(match[0]) : [\n 0, 0,\n ];\n\n if (exampleCodeRegex && !exampleCodeRegExp.test(source) \|\|\n rejectExampleCodeRegex && rejectExampleCodeRegExp.test(source)\n ) {\n return;\n }\n\n // If `allowedLanguagesToProcess` is falsy, all languages should be processed.\n if (allowedLanguagesToProcess) {\n const matches = (/^\\s```(?<language>\\S+)([\\s\\S])```\\s$/v).exec(source);\n if (matches?.groups && !allowedLanguagesToProcess.includes(\n matches.groups.language.toLowerCase(),\n )) {\n return;\n }\n }\n\n const sources = [];\n let skipInit = false;\n if (exampleCodeRegex) {\n let nonJSPrefacingCols = 0;\n let nonJSPrefacingLines = 0;\n\n let startingIndex = 0;\n let lastStringCount = 0;\n\n let exampleCode;\n exampleCodeRegExp.lastIndex = 0;\n while ((exampleCode = exampleCodeRegExp.exec(source)) !== null) {\n const {\n '0': n0,\n '1': n1,\n index,\n } = exampleCode;\n\n // Count anything preceding user regex match (can affect line numbering)\n const preMatch = source.slice(startingIndex, index);\n\n const [\n preMatchLines,\n colDelta,\n ] = getLinesCols(preMatch);\n\n let nonJSPreface;\n let nonJSPrefaceLineCount;\n if (n1) {\n const idx = n0.indexOf(n1);\n nonJSPreface = n0.slice(0, idx);\n nonJSPrefaceLineCount = countChars(nonJSPreface, '\\n');\n } else {\n nonJSPreface = '';\n nonJSPrefaceLineCount = 0;\n }\n\n nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;\n\n // Ignore `preMatch` delta if newlines here\n if (nonJSPrefaceLineCount) {\n const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf('\\n') + 1).length;\n\n nonJSPrefacingCols += charsInLastLine;\n } else {\n nonJSPrefacingCols += colDelta + nonJSPreface.length;\n }\n\n const string = n1 \|\| n0;\n sources.push({\n nonJSPrefacingCols,\n nonJSPrefacingLines,\n string,\n });\n startingIndex = exampleCodeRegExp.lastIndex;\n lastStringCount = countChars(string, '\\n');\n if (!exampleCodeRegExp.global) {\n break;\n }\n }\n\n skipInit = true;\n }\n\n checkSource({\n cols,\n lines,\n skipInit,\n source,\n sources,\n tag,\n targetTagName,\n ...matchingFilenameInfo,\n });\n });\n\n return textsAndFileNames;\n };\n\n // See https://eslint.org/docs/latest/extend/plugins#processors-in-plugins\n // See https://eslint.org/docs/latest/extend/custom-processors\n // From https://github.com/eslint/eslint/issues/14745#issuecomment-869457265\n /\n {\n \"files\": [\".js\", \".ts\"],\n \"processor\": \"jsdoc/example\" // a pretended value here\n },\n {\n \"files\": [\n \".js/_jsdoc-example.js\",\n \".ts/_jsdoc-example.js\",\n \".js/_jsdoc-example.ts\"\n ],\n \"rules\": {\n // specific rules for examples in jsdoc only here\n // And other rules for `.js` and `.ts` will also be enabled for them\n }\n }\n /\n return {\n meta: {\n name: 'eslint-plugin-jsdoc/processor',\n version,\n },\n processors: {\n examples: {\n meta: {\n name: 'eslint-plugin-jsdoc/preprocessor',\n version,\n },\n /*\n @param {import('eslint').Linter.LintMessage[][]} messages\n * @param {string} filename\n /\n postprocess ([\n jsMessages,\n ...messages\n // eslint-disable-next-line no-unused-vars -- Placeholder\n ], filename) {\n for (const [\n idx,\n message,\n ] of messages.entries()) {\n const {\n codeStartCol,\n codeStartLine,\n commentLineCols,\n nonJSPrefacingCols,\n targetTagName,\n } = otherInfo[idx];\n\n for (const msg of message) {\n const {\n column,\n endColumn,\n endLine,\n fatal,\n line,\n message: messageText,\n ruleId,\n severity,\n\n // Todo: Make fixable\n // fix\n // fix: {range: [number, number], text: string}\n // suggestions: {desc: , messageId:, fix: }[],\n } = msg;\n\n const [\n codeCtxLine,\n codeCtxColumn,\n ] = commentLineCols;\n const startLine = codeCtxLine + codeStartLine + line;\n\n // Seems to need one more now\n const startCol = 1 +\n codeCtxColumn + codeStartCol + (\n // This might not work for line 0, but line 0 is unlikely for examples\n line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength\n ) + column;\n\n msg.message = '@' + targetTagName + ' ' + (severity === 2 ? 'error' : 'warning') +\n (ruleId ? ' (' + ruleId + ')' : '') + ': ' +\n (fatal ? 'Fatal: ' : '') +\n messageText;\n msg.line = startLine;\n msg.column = startCol;\n msg.endLine = endLine ? startLine + endLine : startLine;\n // added `- column` to offset what `endColumn` already seemed to include\n msg.endColumn = endColumn ? startCol - column + endColumn : startCol;\n }\n }\n\n const ret = [\n ...jsMessages,\n ].concat(...messages, ...extraMessages);\n extraMessages = [];\n return ret;\n },\n\n /\n @param {string} text\n * @param {string} filename\n /\n preprocess (text, filename) {\n try {\n let ast;\n\n // May be running a second time so catch and ignore\n try {\n ast = parser ?\n // @ts-expect-error Should be present\n parser.parseForESLint(text, {\n comment: true,\n ecmaVersion: 'latest',\n sourceType,\n }).ast :\n espree.parse(text, {\n comment: true,\n ecmaVersion: 'latest',\n sourceType,\n });\n } catch {\n return [\n text,\n ];\n }\n\n /* @type {[number, number][]} /\n const commentLineCols = [];\n const jsdocComments = /* @type {import('estree').Comment[]} / (\n /\n @type {import('estree').Program & {\n * comments?: import('estree').Comment[]\n * }}\n /\n (ast).comments\n ).filter((comment) => {\n return (/^\\\\s/v).test(comment.value);\n }).map((comment) => {\n const [\n start,\n /* c8 ignore next -- Unsupporting processors only? /\n ] = comment.range ?? [];\n const textToStart = text.slice(0, start);\n\n const [\n lines,\n cols,\n ] = getLinesCols(textToStart);\n\n // const lines = [...textToStart.matchAll(/\\n/gv)].length\n // const lastLinePos = textToStart.lastIndexOf('\\n');\n // const cols = lastLinePos === -1\n // ? 0\n // : textToStart.slice(lastLinePos).length;\n commentLineCols.push([\n lines, cols,\n ]);\n return parseComment(comment);\n });\n\n return [\n text,\n ...jsdocComments.flatMap((jsdoc, idx) => {\n return getTextsAndFileNames(\n jsdoc,\n filename,\n commentLineCols[idx],\n );\n }).filter(Boolean),\n ];\n / c8 ignore next 6 */\n } catch (error) {\n // eslint-disable-next-line no-console -- Debugging\n console.log('err', filename, error);\n }\n\n return [];\n },\n // Todo: Reenable\n supportsAutofix: false,\n },\n },\n };\n};\n"],"mappings":";;;;;;AAAA,IAAAA,WAAA,GAAAC,OAAA;AAOA,IAAAC,aAAA,GAAAD,OAAA;AAGA,IAAAE,MAAA,GAAAC,uBAAA,CAAAH,OAAA;AACA,IAAAI,OAAA,GAAAJ,OAAA;AAGA,IAAAK,SAAA,GAAAL,OAAA;AAEmB,SAAAG,wBAAAG,CAAA,EAAAC,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAL,uBAAA,YAAAA,CAAAG,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA,GAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA,gBAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA,WAAAO,CAAA,KAAAR,CAAA,EAAAC,CAAA;AAEnB,MAAM;EACJkB;AACF,CAAC,GAAGC,IAAI,CAACC,KAAK;AACZ;AACA,IAAAC,oBAAY,EAAC,IAAAC,cAAI,EAAAC,SAAA,EAAsB,iBAAiB,CAAC,CAC3D,CAAC;;AAED;AACA,MAAMC,4BAA4B,GAAG,CAAC;AACtC,MAAMC,iBAAiB,GAAG,CAAC;;AAE3B;AACA,MAAMC,qBAAqB,GAAGD,iBAAiB;AAE/C,MAAME,eAAe,GAAG,qCAAqC;;AAE7D;AACA;AACA;AACA;AACA,MAAMC,kBAAkB,GAAIC,GAAG,IAAK;EAClC,OAAOA,GAAG,CAACC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC;AAC7D,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMC,UAAU,GAAGA,CAACF,GAAG,EAAEG,EAAE,KAAK;EAC9B,OAAO,CAACH,GAAG,CAACI,KAAK,CAAC,IAAIC,MAAM,CAACN,kBAAkB,CAACI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAEG,MAAM;AAC3E,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,YAAY,GAAIC,IAAI,IAAK;EAC7B,MAAMC,UAAU,GAAGP,UAAU,CAACM,IAAI,EAAE,IAAI,CAAC;EAEzC,MAAME,QAAQ,GAAGD,UAAU,GACzBD,IAAI,CAACG,KAAK,CAACH,IAAI,CAACI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAACN,MAAM,GAC7CE,IAAI,CAACF,MAAM;EAEb,OAAO,CACLG,UAAU,EAAEC,QAAQ,CACrB;AACH,CAAC;;AAED;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACO,MAAMG,uBAAuB,GAAGA,CAACC,OAAO,GAAG,CAAC,CAAC,KAAK;EACvD,MAAM;IACJC,yBAAyB,GAAG,CAC1B,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,CACvC;IACDC,eAAe,GAAG,KAAK;IACvBC,aAAa,GAAG,KAAK;IACrBC,aAAa,GAAG,IAAI;IACpBC,WAAW,GAAG,KAAK;IACnBC,eAAe,GAAG,KAAK;IACvBC,gBAAgB,GAAG,IAAI;IACvBC,gBAAgB,GAAG,IAAI;IACvBC,wBAAwB,GAAG,IAAI;IAC/BC,sBAAsB,GAAG,IAAI;IAC7BC,0BAA0B,GAAG,IAAI;IACjCC,YAAY,GAAG,CAAC;IAChBC,MAAM,GAAGC,SAAS;IAClBC,sBAAsB,GAAG,IAAI;IAC7BC,UAAU,GAAG;EACf,CAAC,GAAGhB,OAAO;;EAEX;EACA,IAAIiB,iBAAiB;EACrB;EACA,IAAIC,uBAAuB;EAE3B,IAAIX,gBAAgB,EAAE;IACpBU,iBAAiB,GAAG,OAAOV,gBAAgB,KAAK,QAAQ,GACtD,IAAAY,8BAAkB,EAACZ,gBAAgB,CAAC,GACpCA,gBAAgB;EACpB;EAEA,IAAIQ,sBAAsB,EAAE;IAC1BG,uBAAuB,GAAG,OAAOH,sBAAsB,KAAK,QAAQ,GAClE,IAAAI,8BAAkB,EAACJ,sBAAsB,CAAC,GAC1CA,sBAAsB;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMK,SAAS,GAAG,EAAE;;EAEpB;EACA,IAAIC,aAAa,GAAG,EAAE;;EAEtB;AACF;AACA;AACA;AACA;EACE,MAAMC,oBAAoB,GAAGA,CAACC,KAAK,EAAEC,UAAU,EAAEC,eAAe,KAAK;IACnE;AACJ;AACA;AACA;AACA;AACA;IACI,MAAMC,iBAAiB,GAAG,EAAE;;IAE5B;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,MAAMC,WAAW,GAAGA,CAAC;MACnBC,IAAI,GAAG,CAAC;MACRC,eAAe;MACfC,GAAG;MACHC,QAAQ;MACRC,KAAK,GAAG,CAAC;MACTC,QAAQ;MACRC,MAAM;MACNC,OAAO,GAAG,EAAE;MACZC,GAAG,GAAG;QACJC,IAAI,EAAE;MACR,CAAC;MACDC;IACF,CAAC,KAAK;MACJ,IAAI,CAACL,QAAQ,EAAE;QACbE,OAAO,CAACI,IAAI,CAAC;UACXC,kBAAkB,EAAEZ,IAAI;UACxBa,mBAAmB,EAAET,KAAK;UAC1BU,MAAM,EAAER;QACV,CAAC,CAAC;MACJ;;MAEA;AACN;AACA;AACA;AACA;AACA;AACA;MACM,MAAMS,aAAa,GAAG,SAAAA,CAAU;QAC9BH,kBAAkB;QAClBC,mBAAmB;QACnBC;MACF,CAAC,EAAE;QACD,MAAME,GAAG,GAAGhC,YAAY,GACtB8B,MAAM,CAACvD,UAAU,CAAC,IAAII,MAAM,CAAC,WAAWqB,YAAY,QAAQ,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,GAC1E8B,MAAM;;QAER;QACA,MAAMG,IAAI,GAAGd,QAAQ,IAAIF,eAAe;QAExC,IAAI,EAAE,MAAM,IAAIO,GAAG,CAAC,EAAE;UACpBA,GAAG,CAACC,IAAI,GAAGD,GAAG,CAACF,MAAM,CAAC,CAAC,CAAC,CAACY,MAAM;QACjC;;QAEA;QACA,MAAMC,aAAa;QAAG;AAC9B;AACA;AACA;AACA;QAAmCX,GAAG,CAAEC,IAAI,GAAGI,mBAAmB;QAC1D,MAAMO,YAAY,GAAGnE,4BAA4B;QAEjD6C,iBAAiB,CAACa,IAAI,CAAC;UACrBR,QAAQ,EAAEc,IAAI;UACdnD,IAAI,EAAEkD;QACR,CAAC,CAAC;QACFxB,SAAS,CAACmB,IAAI,CAAC;UACbS,YAAY;UACZD,aAAa;UACbtB,eAAe;UACfK,GAAG;UACHU,kBAAkB;UAClBF;QACF,CAAC,CAAC;MACJ,CAAC;MAED,KAAK,MAAMW,YAAY,IAAId,OAAO,EAAE;QAClCQ,aAAa,CAACM,YAAY,CAAC;MAC7B;IACF,CAAC;;IAED;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,MAAMC,eAAe,GAAGA,CAACnB,QAAQ,EAAED,GAAG,GAAG,SAAS,KAAK;MACrD,IAAID,eAAe;MACnB,IAAI,CAACE,QAAQ,EAAE;QACb,IAAI,OAAOP,UAAU,KAAK,QAAQ,IAAIA,UAAU,CAAC2B,QAAQ,CAAC,GAAG,CAAC,EAAE;UAC9DtB,eAAe,GAAGL,UAAU,CAAC4B,OAAO,CAAC,WAAW,EAAE,IAAItB,GAAG,EAAE,CAAC;QAC9D,CAAC,MAAM;UACLD,eAAe,GAAG,SAASC,GAAG,EAAE;QAClC;MACF;MAEA,OAAO;QACLD,eAAe;QACfC,GAAG;QACHC;MACF,CAAC;IACH,CAAC;IAED,IAAI5B,aAAa,EAAE;MACjB,MAAMkD,YAAY,GAAGH,eAAe,CAACzC,wBAAwB,EAAE,gBAAgB,CAAC;MAChF,IAAA6C,+BAAmB,EAAC/B,KAAK,EAAE,SAAS,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;QAC5D,IAAI,CAACF,GAAG,CAACmB,WAAW,CAACC,IAAI,CAAC,CAAC,EAAE;UAC3B;QACF;QAEA7B,WAAW,CAAC;UACVO,MAAM,EAAE,IAAI,IAAAuB,6BAAiB,EAACrB,GAAG,CAAC,GAAG;UACrCE,aAAa;UACb,GAAGe;QACL,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEA,IAAIhD,WAAW,EAAE;MACf,MAAMgD,YAAY,GAAGH,eAAe,CAACxC,sBAAsB,EAAE,cAAc,CAAC;MAC5E,IAAA4C,+BAAmB,EAAC/B,KAAK,EAAE,OAAO,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;QAC1D,IAAI,CAACF,GAAG,CAACtE,OAAO,IAAI,CAACsE,GAAG,CAACtE,OAAO,CAAC0F,IAAI,CAAC,CAAC,EAAE;UACvC;QACF;QAEA7B,WAAW,CAAC;UACVO,MAAM,EAAE,IAAIE,GAAG,CAACtE,OAAO,GAAG;UAC1BwE,aAAa;UACb,GAAGe;QACL,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEA,IAAI/C,eAAe,EAAE;MACnB,MAAM+C,YAAY,GAAGH,eAAe,CAACvC,0BAA0B,EAAE,kBAAkB,CAAC;MACpF,IAAA2C,+BAAmB,EAAC/B,KAAK,EAAE,UAAU,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;QAC7D,IAAI,CAACF,GAAG,CAACtE,OAAO,IAAI,CAACsE,GAAG,CAACtE,OAAO,CAAC0F,IAAI,CAAC,CAAC,EAAE;UACvC;QACF;QAEA7B,WAAW,CAAC;UACVO,MAAM,EAAE,IAAIE,GAAG,CAACtE,OAAO,GAAG;UAC1BwE,aAAa;UACb,GAAGe;QACL,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEA,IAAI,CAACjD,aAAa,EAAE;MAClB,OAAOsB,iBAAiB;IAC1B;IAEA,MAAMgC,OAAO,GAAG,qBAAuB,IAAAC,+BAAmB,EAACpC,KAAK,EAAE;MAChEmC,OAAO,EAAE;IACX,CAAC,CAAE;IACH,IAAI,CAAC,IAAAE,kBAAM,EAACrC,KAAK,EAAEmC,OAAO,CAAC,EAAE;MAC3B,OAAOhC,iBAAiB;IAC1B;IAEA,MAAMmC,oBAAoB,GAAGX,eAAe,CAAC1C,gBAAgB,CAAC;IAE9D,IAAA8C,+BAAmB,EAAC/B,KAAK,EAAE,SAAS,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;MAC5D,IAAIJ,MAAM,GAAG,qBAAuB,IAAAuB,6BAAiB,EAACrB,GAAG,CAAE;MAC3D,MAAM9C,KAAK,GAAG4C,MAAM,CAAC5C,KAAK,CAACN,eAAe,CAAC;MAE3C,IAAIkB,eAAe,KAAK,CAACZ,KAAK,IAAI,CAACA,KAAK,CAAC,CAAC,CAAC,CAACkE,IAAI,CAAC,CAAC,CAAC,EAAE;QACnDnC,aAAa,CAACkB,IAAI,CAAC;UACjBuB,MAAM,EAAErC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC;UAC9BY,IAAI,EAAE,CAAC,GAAGZ,eAAe,CAAC,CAAC,CAAC,IAAIW,GAAG,CAACC,IAAI,IAAID,GAAG,CAACF,MAAM,CAAC,CAAC,CAAC,CAACY,MAAM,CAAC;UACjEiB,OAAO,EAAE,IAAIzB,aAAa,4CAA4C;UACtE0B,MAAM,EAAE,+BAA+B;UACvCC,QAAQ,EAAE;QACZ,CAAC,CAAC;QACF;MACF;MAEA/B,MAAM,GAAGA,MAAM,CAACkB,OAAO,CAACpE,eAAe,EAAE,EAAE,CAAC;MAC5C,MAAM,CACJgD,KAAK,EACLJ,IAAI,CACL,GAAGtC,KAAK,GAAGG,YAAY,CAACH,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CACnC,CAAC,EAAE,CAAC,CACL;MAED,IAAIiB,gBAAgB,IAAI,CAACU,iBAAiB,CAACiD,IAAI,CAAChC,MAAM,CAAC,IACrDnB,sBAAsB,IAAIG,uBAAuB,CAACgD,IAAI,CAAChC,MAAM,CAAC,EAC9D;QACA;MACF;;MAEA;MACA,IAAIjC,yBAAyB,EAAE;QAC7B,MAAMkE,OAAO,GAAI,0CAA0C,CAAEC,IAAI,CAAClC,MAAM,CAAC;QACzE,IAAIiC,OAAO,EAAEE,MAAM,IAAI,CAACpE,yBAAyB,CAACkD,QAAQ,CACxDgB,OAAO,CAACE,MAAM,CAACC,QAAQ,CAACC,WAAW,CAAC,CACtC,CAAC,EAAE;UACD;QACF;MACF;MAEA,MAAMpC,OAAO,GAAG,EAAE;MAClB,IAAIF,QAAQ,GAAG,KAAK;MACpB,IAAI1B,gBAAgB,EAAE;QACpB,IAAIiC,kBAAkB,GAAG,CAAC;QAC1B,IAAIC,mBAAmB,GAAG,CAAC;QAE3B,IAAI+B,aAAa,GAAG,CAAC;QACrB,IAAIC,eAAe,GAAG,CAAC;QAEvB,IAAIC,WAAW;QACfzD,iBAAiB,CAAC0D,SAAS,GAAG,CAAC;QAC/B,OAAO,CAACD,WAAW,GAAGzD,iBAAiB,CAACmD,IAAI,CAAClC,MAAM,CAAC,MAAM,IAAI,EAAE;UAC9D,MAAM;YACJ,GAAG,EAAE0C,EAAE;YACP,GAAG,EAAEC,EAAE;YACPC;UACF,CAAC,GAAGJ,WAAW;;UAEf;UACA,MAAMK,QAAQ,GAAG7C,MAAM,CAACrC,KAAK,CAAC2E,aAAa,EAAEM,KAAK,CAAC;UAEnD,MAAM,CACJE,aAAa,EACbpF,QAAQ,CACT,GAAGH,YAAY,CAACsF,QAAQ,CAAC;UAE1B,IAAIE,YAAY;UAChB,IAAIC,qBAAqB;UACzB,IAAIL,EAAE,EAAE;YACN,MAAMM,GAAG,GAAGP,EAAE,CAACQ,OAAO,CAACP,EAAE,CAAC;YAC1BI,YAAY,GAAGL,EAAE,CAAC/E,KAAK,CAAC,CAAC,EAAEsF,GAAG,CAAC;YAC/BD,qBAAqB,GAAG9F,UAAU,CAAC6F,YAAY,EAAE,IAAI,CAAC;UACxD,CAAC,MAAM;YACLA,YAAY,GAAG,EAAE;YACjBC,qBAAqB,GAAG,CAAC;UAC3B;UAEAzC,mBAAmB,IAAIgC,eAAe,GAAGO,aAAa,GAAGE,qBAAqB;;UAE9E;UACA,IAAIA,qBAAqB,EAAE;YACzB,MAAMG,eAAe,GAAGJ,YAAY,CAACpF,KAAK,CAACoF,YAAY,CAACnF,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAACN,MAAM;YAErFgD,kBAAkB,IAAI6C,eAAe;UACvC,CAAC,MAAM;YACL7C,kBAAkB,IAAI5C,QAAQ,GAAGqF,YAAY,CAACzF,MAAM;UACtD;UAEA,MAAMkD,MAAM,GAAGmC,EAAE,IAAID,EAAE;UACvBzC,OAAO,CAACI,IAAI,CAAC;YACXC,kBAAkB;YAClBC,mBAAmB;YACnBC;UACF,CAAC,CAAC;UACF8B,aAAa,GAAGvD,iBAAiB,CAAC0D,SAAS;UAC3CF,eAAe,GAAGrF,UAAU,CAACsD,MAAM,EAAE,IAAI,CAAC;UAC1C,IAAI,CAACzB,iBAAiB,CAACqE,MAAM,EAAE;YAC7B;UACF;QACF;QAEArD,QAAQ,GAAG,IAAI;MACjB;MAEAN,WAAW,CAAC;QACVC,IAAI;QACJI,KAAK;QACLC,QAAQ;QACRC,MAAM;QACNC,OAAO;QACPC,GAAG;QACHE,aAAa;QACb,GAAGuB;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,OAAOnC,iBAAiB;EAC1B,CAAC;;EAED;EACA;EACA;EACA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAO;IACL6D,IAAI,EAAE;MACJC,IAAI,EAAE,+BAA+B;MACrCjH;IACF,CAAC;IACDkH,UAAU,EAAE;MACVC,QAAQ,EAAE;QACRH,IAAI,EAAE;UACJC,IAAI,EAAE,kCAAkC;UACxCjH;QACF,CAAC;QACD;AACR;AACA;AACA;QACQoH,WAAWA,CAAE,CACXC,UAAU,EACV,GAAGC;QACL;QAAA,CACC,EAAE9D,QAAQ,EAAE;UACX,KAAK,MAAM,CACToD,GAAG,EACHpB,OAAO,CACR,IAAI8B,QAAQ,CAACC,OAAO,CAAC,CAAC,EAAE;YACvB,MAAM;cACJ9C,YAAY;cACZD,aAAa;cACbtB,eAAe;cACfe,kBAAkB;cAClBF;YACF,CAAC,GAAGlB,SAAS,CAAC+D,GAAG,CAAC;YAElB,KAAK,MAAMY,GAAG,IAAIhC,OAAO,EAAE;cACzB,MAAM;gBACJD,MAAM;gBACNkC,SAAS;gBACTC,OAAO;gBACPC,KAAK;gBACL7D,IAAI;gBACJ0B,OAAO,EAAEoC,WAAW;gBACpBnC,MAAM;gBACNC;;gBAEA;gBACA;gBACA;gBACA;cACF,CAAC,GAAG8B,GAAG;cAEP,MAAM,CACJK,WAAW,EACXC,aAAa,CACd,GAAG5E,eAAe;cACnB,MAAM6E,SAAS,GAAGF,WAAW,GAAGrD,aAAa,GAAGV,IAAI;;cAEpD;cACA,MAAMkE,QAAQ,GAAG,CAAC,GAChBF,aAAa,GAAGrD,YAAY;cAC9B;cACEX,IAAI,IAAI,CAAC,GAAGG,kBAAkB,GAAGzD,qBAAqB,GAAGD,iBAAiB,CAC3E,GAAGgF,MAAM;cAEViC,GAAG,CAAChC,OAAO,GAAG,GAAG,GAAGzB,aAAa,GAAG,GAAG,IAAI2B,QAAQ,KAAK,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,IAC7ED,MAAM,GAAG,IAAI,GAAGA,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,IACzCkC,KAAK,GAAG,SAAS,GAAG,EAAE,CAAC,GACxBC,WAAW;cACbJ,GAAG,CAAC1D,IAAI,GAAGiE,SAAS;cACpBP,GAAG,CAACjC,MAAM,GAAGyC,QAAQ;cACrBR,GAAG,CAACE,OAAO,GAAGA,OAAO,GAAGK,SAAS,GAAGL,OAAO,GAAGK,SAAS;cACvD;cACAP,GAAG,CAACC,SAAS,GAAGA,SAAS,GAAGO,QAAQ,GAAGzC,MAAM,GAAGkC,SAAS,GAAGO,QAAQ;YACtE;UACF;UAEA,MAAMC,GAAG,GAAG,CACV,GAAGZ,UAAU,CACd,CAACa,MAAM,CAAC,GAAGZ,QAAQ,EAAE,GAAGxE,aAAa,CAAC;UACvCA,aAAa,GAAG,EAAE;UAClB,OAAOmF,GAAG;QACZ,CAAC;QAED;AACR;AACA;AACA;QACQE,UAAUA,CAAEhH,IAAI,EAAEqC,QAAQ,EAAE;UAC1B,IAAI;YACF,IAAI4E,GAAG;;YAEP;YACA,IAAI;cACFA,GAAG,GAAG9F,MAAM;cACV;cACAA,MAAM,CAAC+F,cAAc,CAAClH,IAAI,EAAE;gBAC1BmH,OAAO,EAAE,IAAI;gBACbC,WAAW,EAAE,QAAQ;gBACrB9F;cACF,CAAC,CAAC,CAAC2F,GAAG,GACN3J,MAAM,CAACyB,KAAK,CAACiB,IAAI,EAAE;gBACjBmH,OAAO,EAAE,IAAI;gBACbC,WAAW,EAAE,QAAQ;gBACrB9F;cACF,CAAC,CAAC;YACN,CAAC,CAAC,MAAM;cACN,OAAO,CACLtB,IAAI,CACL;YACH;;YAEA;YACA,MAAM+B,eAAe,GAAG,EAAE;YAC1B,MAAMsF,aAAa,GAAG,yCAA0C;YAC9D;AACd;AACA;AACA;AACA;YACeJ,GAAG,CAAEK,QAAQ,EACdC,MAAM,CAAEJ,OAAO,IAAK;cACpB,OAAQ,QAAQ,CAAE3C,IAAI,CAAC2C,OAAO,CAACK,KAAK,CAAC;YACvC,CAAC,CAAC,CAACC,GAAG,CAAEN,OAAO,IAAK;cAClB,MAAM,CACJO;cACA,sDACD,GAAGP,OAAO,CAACQ,KAAK,IAAI,EAAE;cACvB,MAAMC,WAAW,GAAG5H,IAAI,CAACG,KAAK,CAAC,CAAC,EAAEuH,KAAK,CAAC;cAExC,MAAM,CACJpF,KAAK,EACLJ,IAAI,CACL,GAAGnC,YAAY,CAAC6H,WAAW,CAAC;;cAE7B;cACA;cACA;cACA;cACA;cACA7F,eAAe,CAACc,IAAI,CAAC,CACnBP,KAAK,EAAEJ,IAAI,CACZ,CAAC;cACF,OAAO,IAAA2F,0BAAY,EAACV,OAAO,CAAC;YAC9B,CAAC,CAAC;YAEF,OAAO,CACLnH,IAAI,EACJ,GAAGqH,aAAa,CAACS,OAAO,CAAC,CAACjG,KAAK,EAAE4D,GAAG,KAAK;cACvC,OAAO7D,oBAAoB,CACzBC,KAAK,EACLQ,QAAQ,EACRN,eAAe,CAAC0D,GAAG,CACrB,CAAC;YACH,CAAC,CAAC,CAAC8B,MAAM,CAACQ,OAAO,CAAC,CACnB;YACH;UACA,CAAC,CAAC,OAAOC,KAAK,EAAE;YACd;YACAC,OAAO,CAACC,GAAG,CAAC,KAAK,EAAE7F,QAAQ,EAAE2F,KAAK,CAAC;UACrC;UAEA,OAAO,EAAE;QACX,CAAC;QACD;QACAG,eAAe,EAAE;MACnB;IACF;EACF,CAAC;AACH,CAAC;AAACC,OAAA,CAAA/H,uBAAA,GAAAA,uBAAA","ignoreList":[]}
1	+ {"version":3,"file":"getJsdocProcessorPlugin.cjs","names":["_jsdocUtils","require","_jsdoccomment","espree","_interopRequireWildcard","_nodeFs","_nodePath","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","version","JSON","parse","readFileSync","join","__dirname","likelyNestedJSDocIndentSpace","preTagSpaceLength","firstLinePrefixLength","hasCaptionRegex","escapeStringRegexp","str","replaceAll","countChars","ch","match","RegExp","length","getLinesCols","text","matchLines","colDelta","slice","lastIndexOf","getJsdocProcessorPlugin","options","allowedLanguagesToProcess","captionRequired","checkDefaults","checkExamples","checkParams","checkProperties","exampleCodeRegex","matchingFileName","matchingFileNameDefaults","matchingFileNameParams","matchingFileNameProperties","paddedIndent","parser","undefined","rejectExampleCodeRegex","sourceType","exampleCodeRegExp","rejectExampleCodeRegExp","getRegexFromString","otherInfo","extraMessages","getTextsAndFileNames","jsdoc","jsFileName","commentLineCols","textsAndFileNames","checkSource","cols","defaultFileName","ext","filename","lines","skipInit","source","sources","tag","line","targetTagName","push","nonJSPrefacingCols","nonJSPrefacingLines","string","addSourceInfo","src","file","number","codeStartLine","codeStartCol","targetSource","getFilenameInfo","includes","replace","filenameInfo","forEachPreferredTag","description","trim","getTagDescription","tagName","getPreferredTagName","hasTag","matchingFilenameInfo","column","message","ruleId","severity","test","matches","exec","groups","language","toLowerCase","startingIndex","lastStringCount","exampleCode","lastIndex","n0","n1","index","preMatch","preMatchLines","nonJSPreface","nonJSPrefaceLineCount","idx","indexOf","charsInLastLine","global","meta","name","processors","examples","postprocess","jsMessages","messages","entries","msg","endColumn","endLine","fatal","messageText","codeCtxLine","codeCtxColumn","startLine","startCol","ret","concat","preprocess","ast","parseForESLint","comment","ecmaVersion","jsdocComments","comments","filter","value","map","start","range","textToStart","parseComment","flatMap","error","console","log","supportsAutofix","exports"],"sources":["../src/getJsdocProcessorPlugin.js"],"sourcesContent":["import {\n forEachPreferredTag,\n getPreferredTagName,\n getRegexFromString,\n getTagDescription,\n hasTag,\n} from './jsdocUtils.js';\nimport {\n parseComment,\n} from '@es-joy/jsdoccomment';\nimport * as espree from 'espree';\nimport {\n readFileSync,\n} from 'node:fs';\nimport {\n join,\n} from 'node:path';\n\n/*\n @import {\n * Integer,\n * JsdocBlockWithInline,\n * } from './iterateJsdoc.js';\n * @import {\n * ESLint,\n * Linter,\n * } from 'eslint';\n /\n\nconst {\n version,\n} = JSON.parse(\n // @ts-expect-error `Buffer` is ok for `JSON.parse`\n readFileSync(join(import.meta.dirname, '../package.json')),\n);\n\n// const zeroBasedLineIndexAdjust = -1;\nconst likelyNestedJSDocIndentSpace = 1;\nconst preTagSpaceLength = 1;\n\n// If a space is present, we should ignore it\nconst firstLinePrefixLength = preTagSpaceLength;\n\nconst hasCaptionRegex = /^\\s<caption>([\\s\\S]?)<\\/caption>/v;\n\n/\n @param {string} str\n * @returns {string}\n /\nconst escapeStringRegexp = (str) => {\n return str.replaceAll(/[.+?^$\\{\\}\$\$\\\|\\[\\]\\\\]/gv, '\\\\$&');\n};\n\n/*\n @param {string} str\n * @param {string} ch\n * @returns {Integer}\n /\nconst countChars = (str, ch) => {\n return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) \|\| []).length;\n};\n\n/\n @param {string} text\n * @returns {[\n * Integer,\n * Integer\n * ]}\n /\nconst getLinesCols = (text) => {\n const matchLines = countChars(text, '\\n');\n\n const colDelta = matchLines ?\n text.slice(text.lastIndexOf('\\n') + 1).length :\n text.length;\n\n return [\n matchLines, colDelta,\n ];\n};\n\n/\n @typedef {number} Integer\n /\n\n/\n @typedef {object} JsdocProcessorOptions\n * @property {boolean} [captionRequired] Require captions for example tags\n * @property {Integer} [paddedIndent] See docs\n * @property {boolean} [checkDefaults] See docs\n * @property {boolean} [checkParams] See docs\n * @property {boolean} [checkExamples] See docs\n * @property {boolean} [checkProperties] See docs\n * @property {string} [matchingFileName] See docs\n * @property {string} [matchingFileNameDefaults] See docs\n * @property {string} [matchingFileNameParams] See docs\n * @property {string} [matchingFileNameProperties] See docs\n * @property {string\|RegExp} [exampleCodeRegex] See docs\n * @property {string\|RegExp} [rejectExampleCodeRegex] See docs\n * @property {string[]} [allowedLanguagesToProcess] See docs\n * @property {\"script\"\|\"module\"} [sourceType] See docs\n * @property {import('eslint').Linter.ESTreeParser\|import('eslint').Linter.NonESTreeParser} [parser] See docs\n /\n\n/\n We use a function for the ability of the user to pass in a config, but\n * without requiring all users of the plugin to do so.\n * @param {JsdocProcessorOptions} [options]\n * @returns {ESLint.Plugin}\n /\nexport const getJsdocProcessorPlugin = (options = {}) => {\n const {\n allowedLanguagesToProcess = [\n 'js', 'ts', 'javascript', 'typescript',\n ],\n captionRequired = false,\n checkDefaults = false,\n checkExamples = true,\n checkParams = false,\n checkProperties = false,\n exampleCodeRegex = null,\n matchingFileName = null,\n matchingFileNameDefaults = null,\n matchingFileNameParams = null,\n matchingFileNameProperties = null,\n paddedIndent = 0,\n parser = undefined,\n rejectExampleCodeRegex = null,\n sourceType = 'module',\n } = options;\n\n /* @type {RegExp} /\n let exampleCodeRegExp;\n /* @type {RegExp} /\n let rejectExampleCodeRegExp;\n\n if (exampleCodeRegex) {\n exampleCodeRegExp = typeof exampleCodeRegex === 'string' ?\n getRegexFromString(exampleCodeRegex) :\n exampleCodeRegex;\n }\n\n if (rejectExampleCodeRegex) {\n rejectExampleCodeRegExp = typeof rejectExampleCodeRegex === 'string' ?\n getRegexFromString(rejectExampleCodeRegex) :\n rejectExampleCodeRegex;\n }\n\n /\n @type {{\n * targetTagName: string,\n * ext: string,\n * codeStartLine: number,\n * codeStartCol: number,\n * nonJSPrefacingCols: number,\n * commentLineCols: [number, number]\n * }[]}\n /\n const otherInfo = [];\n\n /* @type {import('eslint').Linter.LintMessage[]} /\n let extraMessages = [];\n\n /\n @param {JsdocBlockWithInline} jsdoc\n * @param {string} jsFileName\n * @param {[number, number]} commentLineCols\n /\n const getTextsAndFileNames = (jsdoc, jsFileName, commentLineCols) => {\n /\n @type {{\n * text: string,\n * filename: string\|null\|undefined\n * }[]}\n /\n const textsAndFileNames = [];\n\n /\n @param {{\n * filename: string\|null,\n * defaultFileName: string\|undefined,\n * source: string,\n * targetTagName: string,\n * rules?: import('eslint').Linter.RulesRecord\|undefined,\n * lines?: Integer,\n * cols?: Integer,\n * skipInit?: boolean,\n * ext: string,\n * sources?: {\n * nonJSPrefacingCols: Integer,\n * nonJSPrefacingLines: Integer,\n * string: string,\n * }[],\n * tag?: import('comment-parser').Spec & {\n * line?: Integer,\n * }\|{\n * line: Integer,\n * }\n * }} cfg\n /\n const checkSource = ({\n cols = 0,\n defaultFileName,\n ext,\n filename,\n lines = 0,\n skipInit,\n source,\n sources = [],\n tag = {\n line: 0,\n },\n targetTagName,\n }) => {\n if (!skipInit) {\n sources.push({\n nonJSPrefacingCols: cols,\n nonJSPrefacingLines: lines,\n string: source,\n });\n }\n\n /\n @param {{\n * nonJSPrefacingCols: Integer,\n * nonJSPrefacingLines: Integer,\n * string: string\n * }} cfg\n /\n const addSourceInfo = function ({\n nonJSPrefacingCols,\n nonJSPrefacingLines,\n string,\n }) {\n const src = paddedIndent ?\n string.replaceAll(new RegExp(`(^\|\\n) {${paddedIndent}}(?!$)`, 'gv'), '\\n') :\n string;\n\n // Programmatic ESLint API: https://eslint.org/docs/developer-guide/nodejs-api\n const file = filename \|\| defaultFileName;\n\n if (!('line' in tag)) {\n tag.line = tag.source[0].number;\n }\n\n // NOTE: `tag.line` can be 0 if of form `/* @tag ... /`\n const codeStartLine = /\n @type {import('comment-parser').Spec & {\n * line: Integer,\n * }}\n / (tag).line + nonJSPrefacingLines;\n const codeStartCol = likelyNestedJSDocIndentSpace;\n\n textsAndFileNames.push({\n filename: file,\n text: src,\n });\n otherInfo.push({\n codeStartCol,\n codeStartLine,\n commentLineCols,\n ext,\n nonJSPrefacingCols,\n targetTagName,\n });\n };\n\n for (const targetSource of sources) {\n addSourceInfo(targetSource);\n }\n };\n\n /\n \n * @param {string\|null} filename\n * @param {string} [ext] Since `eslint-plugin-markdown` v2, and\n * ESLint 7, this is the default which other JS-fenced rules will used.\n * Formerly \"md\" was the default.\n * @returns {{\n * defaultFileName: string\|undefined,\n * filename: string\|null,\n * ext: string\n * }}\n /\n const getFilenameInfo = (filename, ext = 'md/.js') => {\n let defaultFileName;\n if (!filename) {\n if (typeof jsFileName === 'string' && jsFileName.includes('.')) {\n defaultFileName = jsFileName.replace(/\\.[^.]$/v, `.${ext}`);\n } else {\n defaultFileName = `dummy.${ext}`;\n }\n }\n\n return {\n defaultFileName,\n ext,\n filename,\n };\n };\n\n if (checkDefaults) {\n const filenameInfo = getFilenameInfo(matchingFileNameDefaults, 'jsdoc-defaults');\n forEachPreferredTag(jsdoc, 'default', (tag, targetTagName) => {\n if (!tag.description.trim()) {\n return;\n }\n\n checkSource({\n source: `(${getTagDescription(tag)})`,\n targetTagName,\n ...filenameInfo,\n });\n });\n }\n\n if (checkParams) {\n const filenameInfo = getFilenameInfo(matchingFileNameParams, 'jsdoc-params');\n forEachPreferredTag(jsdoc, 'param', (tag, targetTagName) => {\n if (!tag.default \|\| !tag.default.trim()) {\n return;\n }\n\n checkSource({\n source: `(${tag.default})`,\n targetTagName,\n ...filenameInfo,\n });\n });\n }\n\n if (checkProperties) {\n const filenameInfo = getFilenameInfo(matchingFileNameProperties, 'jsdoc-properties');\n forEachPreferredTag(jsdoc, 'property', (tag, targetTagName) => {\n if (!tag.default \|\| !tag.default.trim()) {\n return;\n }\n\n checkSource({\n source: `(${tag.default})`,\n targetTagName,\n ...filenameInfo,\n });\n });\n }\n\n if (!checkExamples) {\n return textsAndFileNames;\n }\n\n const tagName = /* @type {string} / (getPreferredTagName(jsdoc, {\n tagName: 'example',\n }));\n if (!hasTag(jsdoc, tagName)) {\n return textsAndFileNames;\n }\n\n const matchingFilenameInfo = getFilenameInfo(matchingFileName);\n\n forEachPreferredTag(jsdoc, 'example', (tag, targetTagName) => {\n let source = /* @type {string} / (getTagDescription(tag));\n const match = source.match(hasCaptionRegex);\n\n if (captionRequired && (!match \|\| !match[1].trim())) {\n extraMessages.push({\n column: commentLineCols[1] + 1,\n line: 1 + commentLineCols[0] + (tag.line ?? tag.source[0].number),\n message: `@${targetTagName} error - Caption is expected for examples.`,\n ruleId: 'jsdoc/example-missing-caption',\n severity: 2,\n });\n return;\n }\n\n source = source.replace(hasCaptionRegex, '');\n const [\n lines,\n cols,\n ] = match ? getLinesCols(match[0]) : [\n 0, 0,\n ];\n\n if (exampleCodeRegex && !exampleCodeRegExp.test(source) \|\|\n rejectExampleCodeRegex && rejectExampleCodeRegExp.test(source)\n ) {\n return;\n }\n\n // If `allowedLanguagesToProcess` is falsy, all languages should be processed.\n if (allowedLanguagesToProcess) {\n const matches = (/^\\s```(?<language>\\S+)([\\s\\S])```\\s$/v).exec(source);\n if (matches?.groups && !allowedLanguagesToProcess.includes(\n matches.groups.language.toLowerCase(),\n )) {\n return;\n }\n }\n\n const sources = [];\n let skipInit = false;\n if (exampleCodeRegex) {\n let nonJSPrefacingCols = 0;\n let nonJSPrefacingLines = 0;\n\n let startingIndex = 0;\n let lastStringCount = 0;\n\n let exampleCode;\n exampleCodeRegExp.lastIndex = 0;\n while ((exampleCode = exampleCodeRegExp.exec(source)) !== null) {\n const {\n '0': n0,\n '1': n1,\n index,\n } = exampleCode;\n\n // Count anything preceding user regex match (can affect line numbering)\n const preMatch = source.slice(startingIndex, index);\n\n const [\n preMatchLines,\n colDelta,\n ] = getLinesCols(preMatch);\n\n let nonJSPreface;\n let nonJSPrefaceLineCount;\n if (n1) {\n const idx = n0.indexOf(n1);\n nonJSPreface = n0.slice(0, idx);\n nonJSPrefaceLineCount = countChars(nonJSPreface, '\\n');\n } else {\n nonJSPreface = '';\n nonJSPrefaceLineCount = 0;\n }\n\n nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;\n\n // Ignore `preMatch` delta if newlines here\n if (nonJSPrefaceLineCount) {\n const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf('\\n') + 1).length;\n\n nonJSPrefacingCols += charsInLastLine;\n } else {\n nonJSPrefacingCols += colDelta + nonJSPreface.length;\n }\n\n const string = n1 \|\| n0;\n sources.push({\n nonJSPrefacingCols,\n nonJSPrefacingLines,\n string,\n });\n startingIndex = exampleCodeRegExp.lastIndex;\n lastStringCount = countChars(string, '\\n');\n if (!exampleCodeRegExp.global) {\n break;\n }\n }\n\n skipInit = true;\n }\n\n checkSource({\n cols,\n lines,\n skipInit,\n source,\n sources,\n tag,\n targetTagName,\n ...matchingFilenameInfo,\n });\n });\n\n return textsAndFileNames;\n };\n\n // See https://eslint.org/docs/latest/extend/plugins#processors-in-plugins\n // See https://eslint.org/docs/latest/extend/custom-processors\n // From https://github.com/eslint/eslint/issues/14745#issuecomment-869457265\n /\n {\n \"files\": [\".js\", \".ts\"],\n \"processor\": \"jsdoc/example\" // a pretended value here\n },\n {\n \"files\": [\n \".js/_jsdoc-example.js\",\n \".ts/_jsdoc-example.js\",\n \".js/_jsdoc-example.ts\"\n ],\n \"rules\": {\n // specific rules for examples in jsdoc only here\n // And other rules for `.js` and `.ts` will also be enabled for them\n }\n }\n /\n return {\n meta: {\n name: 'eslint-plugin-jsdoc/processor',\n version,\n },\n processors: {\n examples: {\n meta: {\n name: 'eslint-plugin-jsdoc/preprocessor',\n version,\n },\n /*\n @param {import('eslint').Linter.LintMessage[][]} messages\n * @param {string} filename\n /\n postprocess ([\n jsMessages,\n ...messages\n // eslint-disable-next-line no-unused-vars -- Placeholder\n ], filename) {\n for (const [\n idx,\n message,\n ] of messages.entries()) {\n const {\n codeStartCol,\n codeStartLine,\n commentLineCols,\n nonJSPrefacingCols,\n targetTagName,\n } = otherInfo[idx];\n\n for (const msg of message) {\n const {\n column,\n endColumn,\n endLine,\n fatal,\n line,\n message: messageText,\n ruleId,\n severity,\n\n // Todo: Make fixable\n // fix\n // fix: {range: [number, number], text: string}\n // suggestions: {desc: , messageId:, fix: }[],\n } = msg;\n\n const [\n codeCtxLine,\n codeCtxColumn,\n ] = commentLineCols;\n const startLine = codeCtxLine + codeStartLine + line;\n\n // Seems to need one more now\n const startCol = 1 +\n codeCtxColumn + codeStartCol + (\n // This might not work for line 0, but line 0 is unlikely for examples\n line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength\n ) + column;\n\n msg.message = '@' + targetTagName + ' ' + (severity === 2 ? 'error' : 'warning') +\n (ruleId ? ' (' + ruleId + ')' : '') + ': ' +\n (fatal ? 'Fatal: ' : '') +\n messageText;\n msg.line = startLine;\n msg.column = startCol;\n msg.endLine = endLine ? startLine + endLine : startLine;\n // added `- column` to offset what `endColumn` already seemed to include\n msg.endColumn = endColumn ? startCol - column + endColumn : startCol;\n }\n }\n\n const ret = [\n ...jsMessages,\n ].concat(...messages, ...extraMessages);\n extraMessages = [];\n return ret;\n },\n\n /\n @param {string} text\n * @param {string} filename\n * @returns {(string \| Linter.ProcessorFile)[]}\n /\n preprocess (text, filename) {\n try {\n let ast;\n\n // May be running a second time so catch and ignore\n try {\n ast = parser ?\n // @ts-expect-error Should be present\n parser.parseForESLint(text, {\n comment: true,\n ecmaVersion: 'latest',\n sourceType,\n }).ast :\n espree.parse(text, {\n comment: true,\n ecmaVersion: 'latest',\n sourceType,\n });\n } catch {\n return [\n text,\n ];\n }\n\n /* @type {[number, number][]} /\n const commentLineCols = [];\n const jsdocComments = /* @type {import('estree').Comment[]} / (\n /\n @type {import('estree').Program & {\n * comments?: import('estree').Comment[]\n * }}\n /\n (ast).comments\n ).filter((comment) => {\n return (/^\\\\s/v).test(comment.value);\n }).map((comment) => {\n const [\n start,\n /* c8 ignore next -- Unsupporting processors only? /\n ] = comment.range ?? [];\n const textToStart = text.slice(0, start);\n\n const [\n lines,\n cols,\n ] = getLinesCols(textToStart);\n\n // const lines = [...textToStart.matchAll(/\\n/gv)].length\n // const lastLinePos = textToStart.lastIndexOf('\\n');\n // const cols = lastLinePos === -1\n // ? 0\n // : textToStart.slice(lastLinePos).length;\n commentLineCols.push([\n lines, cols,\n ]);\n return parseComment(comment);\n });\n\n return [\n text,\n ...jsdocComments.flatMap((jsdoc, idx) => {\n return getTextsAndFileNames(\n jsdoc,\n filename,\n commentLineCols[idx],\n );\n }).filter(\n /\n @returns {file is Linter.ProcessorFile}\n /\n (file) => {\n return file !== null && file !== undefined;\n },\n ),\n ];\n / c8 ignore next 6 */\n } catch (error) {\n // eslint-disable-next-line no-console -- Debugging\n console.log('err', filename, error);\n }\n\n return [];\n },\n // Todo: Reenable\n supportsAutofix: false,\n },\n },\n };\n};\n"],"mappings":";;;;;;AAAA,IAAAA,WAAA,GAAAC,OAAA;AAOA,IAAAC,aAAA,GAAAD,OAAA;AAGA,IAAAE,MAAA,GAAAC,uBAAA,CAAAH,OAAA;AACA,IAAAI,OAAA,GAAAJ,OAAA;AAGA,IAAAK,SAAA,GAAAL,OAAA;AAEmB,SAAAG,wBAAAG,CAAA,EAAAC,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAL,uBAAA,YAAAA,CAAAG,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA,GAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA,gBAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA,WAAAO,CAAA,KAAAR,CAAA,EAAAC,CAAA;AAEnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,MAAM;EACJkB;AACF,CAAC,GAAGC,IAAI,CAACC,KAAK;AACZ;AACA,IAAAC,oBAAY,EAAC,IAAAC,cAAI,EAAAC,SAAA,EAAsB,iBAAiB,CAAC,CAC3D,CAAC;;AAED;AACA,MAAMC,4BAA4B,GAAG,CAAC;AACtC,MAAMC,iBAAiB,GAAG,CAAC;;AAE3B;AACA,MAAMC,qBAAqB,GAAGD,iBAAiB;AAE/C,MAAME,eAAe,GAAG,qCAAqC;;AAE7D;AACA;AACA;AACA;AACA,MAAMC,kBAAkB,GAAIC,GAAG,IAAK;EAClC,OAAOA,GAAG,CAACC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC;AAC7D,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMC,UAAU,GAAGA,CAACF,GAAG,EAAEG,EAAE,KAAK;EAC9B,OAAO,CAACH,GAAG,CAACI,KAAK,CAAC,IAAIC,MAAM,CAACN,kBAAkB,CAACI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAEG,MAAM;AAC3E,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,YAAY,GAAIC,IAAI,IAAK;EAC7B,MAAMC,UAAU,GAAGP,UAAU,CAACM,IAAI,EAAE,IAAI,CAAC;EAEzC,MAAME,QAAQ,GAAGD,UAAU,GACzBD,IAAI,CAACG,KAAK,CAACH,IAAI,CAACI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAACN,MAAM,GAC7CE,IAAI,CAACF,MAAM;EAEb,OAAO,CACLG,UAAU,EAAEC,QAAQ,CACrB;AACH,CAAC;;AAED;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,uBAAuB,GAAGA,CAACC,OAAO,GAAG,CAAC,CAAC,KAAK;EACvD,MAAM;IACJC,yBAAyB,GAAG,CAC1B,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,CACvC;IACDC,eAAe,GAAG,KAAK;IACvBC,aAAa,GAAG,KAAK;IACrBC,aAAa,GAAG,IAAI;IACpBC,WAAW,GAAG,KAAK;IACnBC,eAAe,GAAG,KAAK;IACvBC,gBAAgB,GAAG,IAAI;IACvBC,gBAAgB,GAAG,IAAI;IACvBC,wBAAwB,GAAG,IAAI;IAC/BC,sBAAsB,GAAG,IAAI;IAC7BC,0BAA0B,GAAG,IAAI;IACjCC,YAAY,GAAG,CAAC;IAChBC,MAAM,GAAGC,SAAS;IAClBC,sBAAsB,GAAG,IAAI;IAC7BC,UAAU,GAAG;EACf,CAAC,GAAGhB,OAAO;;EAEX;EACA,IAAIiB,iBAAiB;EACrB;EACA,IAAIC,uBAAuB;EAE3B,IAAIX,gBAAgB,EAAE;IACpBU,iBAAiB,GAAG,OAAOV,gBAAgB,KAAK,QAAQ,GACtD,IAAAY,8BAAkB,EAACZ,gBAAgB,CAAC,GACpCA,gBAAgB;EACpB;EAEA,IAAIQ,sBAAsB,EAAE;IAC1BG,uBAAuB,GAAG,OAAOH,sBAAsB,KAAK,QAAQ,GAClE,IAAAI,8BAAkB,EAACJ,sBAAsB,CAAC,GAC1CA,sBAAsB;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMK,SAAS,GAAG,EAAE;;EAEpB;EACA,IAAIC,aAAa,GAAG,EAAE;;EAEtB;AACF;AACA;AACA;AACA;EACE,MAAMC,oBAAoB,GAAGA,CAACC,KAAK,EAAEC,UAAU,EAAEC,eAAe,KAAK;IACnE;AACJ;AACA;AACA;AACA;AACA;IACI,MAAMC,iBAAiB,GAAG,EAAE;;IAE5B;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,MAAMC,WAAW,GAAGA,CAAC;MACnBC,IAAI,GAAG,CAAC;MACRC,eAAe;MACfC,GAAG;MACHC,QAAQ;MACRC,KAAK,GAAG,CAAC;MACTC,QAAQ;MACRC,MAAM;MACNC,OAAO,GAAG,EAAE;MACZC,GAAG,GAAG;QACJC,IAAI,EAAE;MACR,CAAC;MACDC;IACF,CAAC,KAAK;MACJ,IAAI,CAACL,QAAQ,EAAE;QACbE,OAAO,CAACI,IAAI,CAAC;UACXC,kBAAkB,EAAEZ,IAAI;UACxBa,mBAAmB,EAAET,KAAK;UAC1BU,MAAM,EAAER;QACV,CAAC,CAAC;MACJ;;MAEA;AACN;AACA;AACA;AACA;AACA;AACA;MACM,MAAMS,aAAa,GAAG,SAAAA,CAAU;QAC9BH,kBAAkB;QAClBC,mBAAmB;QACnBC;MACF,CAAC,EAAE;QACD,MAAME,GAAG,GAAGhC,YAAY,GACtB8B,MAAM,CAACvD,UAAU,CAAC,IAAII,MAAM,CAAC,WAAWqB,YAAY,QAAQ,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,GAC1E8B,MAAM;;QAER;QACA,MAAMG,IAAI,GAAGd,QAAQ,IAAIF,eAAe;QAExC,IAAI,EAAE,MAAM,IAAIO,GAAG,CAAC,EAAE;UACpBA,GAAG,CAACC,IAAI,GAAGD,GAAG,CAACF,MAAM,CAAC,CAAC,CAAC,CAACY,MAAM;QACjC;;QAEA;QACA,MAAMC,aAAa;QAAG;AAC9B;AACA;AACA;AACA;QAAmCX,GAAG,CAAEC,IAAI,GAAGI,mBAAmB;QAC1D,MAAMO,YAAY,GAAGnE,4BAA4B;QAEjD6C,iBAAiB,CAACa,IAAI,CAAC;UACrBR,QAAQ,EAAEc,IAAI;UACdnD,IAAI,EAAEkD;QACR,CAAC,CAAC;QACFxB,SAAS,CAACmB,IAAI,CAAC;UACbS,YAAY;UACZD,aAAa;UACbtB,eAAe;UACfK,GAAG;UACHU,kBAAkB;UAClBF;QACF,CAAC,CAAC;MACJ,CAAC;MAED,KAAK,MAAMW,YAAY,IAAId,OAAO,EAAE;QAClCQ,aAAa,CAACM,YAAY,CAAC;MAC7B;IACF,CAAC;;IAED;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,MAAMC,eAAe,GAAGA,CAACnB,QAAQ,EAAED,GAAG,GAAG,SAAS,KAAK;MACrD,IAAID,eAAe;MACnB,IAAI,CAACE,QAAQ,EAAE;QACb,IAAI,OAAOP,UAAU,KAAK,QAAQ,IAAIA,UAAU,CAAC2B,QAAQ,CAAC,GAAG,CAAC,EAAE;UAC9DtB,eAAe,GAAGL,UAAU,CAAC4B,OAAO,CAAC,WAAW,EAAE,IAAItB,GAAG,EAAE,CAAC;QAC9D,CAAC,MAAM;UACLD,eAAe,GAAG,SAASC,GAAG,EAAE;QAClC;MACF;MAEA,OAAO;QACLD,eAAe;QACfC,GAAG;QACHC;MACF,CAAC;IACH,CAAC;IAED,IAAI5B,aAAa,EAAE;MACjB,MAAMkD,YAAY,GAAGH,eAAe,CAACzC,wBAAwB,EAAE,gBAAgB,CAAC;MAChF,IAAA6C,+BAAmB,EAAC/B,KAAK,EAAE,SAAS,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;QAC5D,IAAI,CAACF,GAAG,CAACmB,WAAW,CAACC,IAAI,CAAC,CAAC,EAAE;UAC3B;QACF;QAEA7B,WAAW,CAAC;UACVO,MAAM,EAAE,IAAI,IAAAuB,6BAAiB,EAACrB,GAAG,CAAC,GAAG;UACrCE,aAAa;UACb,GAAGe;QACL,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEA,IAAIhD,WAAW,EAAE;MACf,MAAMgD,YAAY,GAAGH,eAAe,CAACxC,sBAAsB,EAAE,cAAc,CAAC;MAC5E,IAAA4C,+BAAmB,EAAC/B,KAAK,EAAE,OAAO,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;QAC1D,IAAI,CAACF,GAAG,CAACtE,OAAO,IAAI,CAACsE,GAAG,CAACtE,OAAO,CAAC0F,IAAI,CAAC,CAAC,EAAE;UACvC;QACF;QAEA7B,WAAW,CAAC;UACVO,MAAM,EAAE,IAAIE,GAAG,CAACtE,OAAO,GAAG;UAC1BwE,aAAa;UACb,GAAGe;QACL,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEA,IAAI/C,eAAe,EAAE;MACnB,MAAM+C,YAAY,GAAGH,eAAe,CAACvC,0BAA0B,EAAE,kBAAkB,CAAC;MACpF,IAAA2C,+BAAmB,EAAC/B,KAAK,EAAE,UAAU,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;QAC7D,IAAI,CAACF,GAAG,CAACtE,OAAO,IAAI,CAACsE,GAAG,CAACtE,OAAO,CAAC0F,IAAI,CAAC,CAAC,EAAE;UACvC;QACF;QAEA7B,WAAW,CAAC;UACVO,MAAM,EAAE,IAAIE,GAAG,CAACtE,OAAO,GAAG;UAC1BwE,aAAa;UACb,GAAGe;QACL,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEA,IAAI,CAACjD,aAAa,EAAE;MAClB,OAAOsB,iBAAiB;IAC1B;IAEA,MAAMgC,OAAO,GAAG,qBAAuB,IAAAC,+BAAmB,EAACpC,KAAK,EAAE;MAChEmC,OAAO,EAAE;IACX,CAAC,CAAE;IACH,IAAI,CAAC,IAAAE,kBAAM,EAACrC,KAAK,EAAEmC,OAAO,CAAC,EAAE;MAC3B,OAAOhC,iBAAiB;IAC1B;IAEA,MAAMmC,oBAAoB,GAAGX,eAAe,CAAC1C,gBAAgB,CAAC;IAE9D,IAAA8C,+BAAmB,EAAC/B,KAAK,EAAE,SAAS,EAAE,CAACa,GAAG,EAAEE,aAAa,KAAK;MAC5D,IAAIJ,MAAM,GAAG,qBAAuB,IAAAuB,6BAAiB,EAACrB,GAAG,CAAE;MAC3D,MAAM9C,KAAK,GAAG4C,MAAM,CAAC5C,KAAK,CAACN,eAAe,CAAC;MAE3C,IAAIkB,eAAe,KAAK,CAACZ,KAAK,IAAI,CAACA,KAAK,CAAC,CAAC,CAAC,CAACkE,IAAI,CAAC,CAAC,CAAC,EAAE;QACnDnC,aAAa,CAACkB,IAAI,CAAC;UACjBuB,MAAM,EAAErC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC;UAC9BY,IAAI,EAAE,CAAC,GAAGZ,eAAe,CAAC,CAAC,CAAC,IAAIW,GAAG,CAACC,IAAI,IAAID,GAAG,CAACF,MAAM,CAAC,CAAC,CAAC,CAACY,MAAM,CAAC;UACjEiB,OAAO,EAAE,IAAIzB,aAAa,4CAA4C;UACtE0B,MAAM,EAAE,+BAA+B;UACvCC,QAAQ,EAAE;QACZ,CAAC,CAAC;QACF;MACF;MAEA/B,MAAM,GAAGA,MAAM,CAACkB,OAAO,CAACpE,eAAe,EAAE,EAAE,CAAC;MAC5C,MAAM,CACJgD,KAAK,EACLJ,IAAI,CACL,GAAGtC,KAAK,GAAGG,YAAY,CAACH,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CACnC,CAAC,EAAE,CAAC,CACL;MAED,IAAIiB,gBAAgB,IAAI,CAACU,iBAAiB,CAACiD,IAAI,CAAChC,MAAM,CAAC,IACrDnB,sBAAsB,IAAIG,uBAAuB,CAACgD,IAAI,CAAChC,MAAM,CAAC,EAC9D;QACA;MACF;;MAEA;MACA,IAAIjC,yBAAyB,EAAE;QAC7B,MAAMkE,OAAO,GAAI,0CAA0C,CAAEC,IAAI,CAAClC,MAAM,CAAC;QACzE,IAAIiC,OAAO,EAAEE,MAAM,IAAI,CAACpE,yBAAyB,CAACkD,QAAQ,CACxDgB,OAAO,CAACE,MAAM,CAACC,QAAQ,CAACC,WAAW,CAAC,CACtC,CAAC,EAAE;UACD;QACF;MACF;MAEA,MAAMpC,OAAO,GAAG,EAAE;MAClB,IAAIF,QAAQ,GAAG,KAAK;MACpB,IAAI1B,gBAAgB,EAAE;QACpB,IAAIiC,kBAAkB,GAAG,CAAC;QAC1B,IAAIC,mBAAmB,GAAG,CAAC;QAE3B,IAAI+B,aAAa,GAAG,CAAC;QACrB,IAAIC,eAAe,GAAG,CAAC;QAEvB,IAAIC,WAAW;QACfzD,iBAAiB,CAAC0D,SAAS,GAAG,CAAC;QAC/B,OAAO,CAACD,WAAW,GAAGzD,iBAAiB,CAACmD,IAAI,CAAClC,MAAM,CAAC,MAAM,IAAI,EAAE;UAC9D,MAAM;YACJ,GAAG,EAAE0C,EAAE;YACP,GAAG,EAAEC,EAAE;YACPC;UACF,CAAC,GAAGJ,WAAW;;UAEf;UACA,MAAMK,QAAQ,GAAG7C,MAAM,CAACrC,KAAK,CAAC2E,aAAa,EAAEM,KAAK,CAAC;UAEnD,MAAM,CACJE,aAAa,EACbpF,QAAQ,CACT,GAAGH,YAAY,CAACsF,QAAQ,CAAC;UAE1B,IAAIE,YAAY;UAChB,IAAIC,qBAAqB;UACzB,IAAIL,EAAE,EAAE;YACN,MAAMM,GAAG,GAAGP,EAAE,CAACQ,OAAO,CAACP,EAAE,CAAC;YAC1BI,YAAY,GAAGL,EAAE,CAAC/E,KAAK,CAAC,CAAC,EAAEsF,GAAG,CAAC;YAC/BD,qBAAqB,GAAG9F,UAAU,CAAC6F,YAAY,EAAE,IAAI,CAAC;UACxD,CAAC,MAAM;YACLA,YAAY,GAAG,EAAE;YACjBC,qBAAqB,GAAG,CAAC;UAC3B;UAEAzC,mBAAmB,IAAIgC,eAAe,GAAGO,aAAa,GAAGE,qBAAqB;;UAE9E;UACA,IAAIA,qBAAqB,EAAE;YACzB,MAAMG,eAAe,GAAGJ,YAAY,CAACpF,KAAK,CAACoF,YAAY,CAACnF,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAACN,MAAM;YAErFgD,kBAAkB,IAAI6C,eAAe;UACvC,CAAC,MAAM;YACL7C,kBAAkB,IAAI5C,QAAQ,GAAGqF,YAAY,CAACzF,MAAM;UACtD;UAEA,MAAMkD,MAAM,GAAGmC,EAAE,IAAID,EAAE;UACvBzC,OAAO,CAACI,IAAI,CAAC;YACXC,kBAAkB;YAClBC,mBAAmB;YACnBC;UACF,CAAC,CAAC;UACF8B,aAAa,GAAGvD,iBAAiB,CAAC0D,SAAS;UAC3CF,eAAe,GAAGrF,UAAU,CAACsD,MAAM,EAAE,IAAI,CAAC;UAC1C,IAAI,CAACzB,iBAAiB,CAACqE,MAAM,EAAE;YAC7B;UACF;QACF;QAEArD,QAAQ,GAAG,IAAI;MACjB;MAEAN,WAAW,CAAC;QACVC,IAAI;QACJI,KAAK;QACLC,QAAQ;QACRC,MAAM;QACNC,OAAO;QACPC,GAAG;QACHE,aAAa;QACb,GAAGuB;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,OAAOnC,iBAAiB;EAC1B,CAAC;;EAED;EACA;EACA;EACA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAO;IACL6D,IAAI,EAAE;MACJC,IAAI,EAAE,+BAA+B;MACrCjH;IACF,CAAC;IACDkH,UAAU,EAAE;MACVC,QAAQ,EAAE;QACRH,IAAI,EAAE;UACJC,IAAI,EAAE,kCAAkC;UACxCjH;QACF,CAAC;QACD;AACR;AACA;AACA;QACQoH,WAAWA,CAAE,CACXC,UAAU,EACV,GAAGC;QACL;QAAA,CACC,EAAE9D,QAAQ,EAAE;UACX,KAAK,MAAM,CACToD,GAAG,EACHpB,OAAO,CACR,IAAI8B,QAAQ,CAACC,OAAO,CAAC,CAAC,EAAE;YACvB,MAAM;cACJ9C,YAAY;cACZD,aAAa;cACbtB,eAAe;cACfe,kBAAkB;cAClBF;YACF,CAAC,GAAGlB,SAAS,CAAC+D,GAAG,CAAC;YAElB,KAAK,MAAMY,GAAG,IAAIhC,OAAO,EAAE;cACzB,MAAM;gBACJD,MAAM;gBACNkC,SAAS;gBACTC,OAAO;gBACPC,KAAK;gBACL7D,IAAI;gBACJ0B,OAAO,EAAEoC,WAAW;gBACpBnC,MAAM;gBACNC;;gBAEA;gBACA;gBACA;gBACA;cACF,CAAC,GAAG8B,GAAG;cAEP,MAAM,CACJK,WAAW,EACXC,aAAa,CACd,GAAG5E,eAAe;cACnB,MAAM6E,SAAS,GAAGF,WAAW,GAAGrD,aAAa,GAAGV,IAAI;;cAEpD;cACA,MAAMkE,QAAQ,GAAG,CAAC,GAChBF,aAAa,GAAGrD,YAAY;cAC9B;cACEX,IAAI,IAAI,CAAC,GAAGG,kBAAkB,GAAGzD,qBAAqB,GAAGD,iBAAiB,CAC3E,GAAGgF,MAAM;cAEViC,GAAG,CAAChC,OAAO,GAAG,GAAG,GAAGzB,aAAa,GAAG,GAAG,IAAI2B,QAAQ,KAAK,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,IAC7ED,MAAM,GAAG,IAAI,GAAGA,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,IACzCkC,KAAK,GAAG,SAAS,GAAG,EAAE,CAAC,GACxBC,WAAW;cACbJ,GAAG,CAAC1D,IAAI,GAAGiE,SAAS;cACpBP,GAAG,CAACjC,MAAM,GAAGyC,QAAQ;cACrBR,GAAG,CAACE,OAAO,GAAGA,OAAO,GAAGK,SAAS,GAAGL,OAAO,GAAGK,SAAS;cACvD;cACAP,GAAG,CAACC,SAAS,GAAGA,SAAS,GAAGO,QAAQ,GAAGzC,MAAM,GAAGkC,SAAS,GAAGO,QAAQ;YACtE;UACF;UAEA,MAAMC,GAAG,GAAG,CACV,GAAGZ,UAAU,CACd,CAACa,MAAM,CAAC,GAAGZ,QAAQ,EAAE,GAAGxE,aAAa,CAAC;UACvCA,aAAa,GAAG,EAAE;UAClB,OAAOmF,GAAG;QACZ,CAAC;QAED;AACR;AACA;AACA;AACA;QACQE,UAAUA,CAAEhH,IAAI,EAAEqC,QAAQ,EAAE;UAC1B,IAAI;YACF,IAAI4E,GAAG;;YAEP;YACA,IAAI;cACFA,GAAG,GAAG9F,MAAM;cACV;cACAA,MAAM,CAAC+F,cAAc,CAAClH,IAAI,EAAE;gBAC1BmH,OAAO,EAAE,IAAI;gBACbC,WAAW,EAAE,QAAQ;gBACrB9F;cACF,CAAC,CAAC,CAAC2F,GAAG,GACN3J,MAAM,CAACyB,KAAK,CAACiB,IAAI,EAAE;gBACjBmH,OAAO,EAAE,IAAI;gBACbC,WAAW,EAAE,QAAQ;gBACrB9F;cACF,CAAC,CAAC;YACN,CAAC,CAAC,MAAM;cACN,OAAO,CACLtB,IAAI,CACL;YACH;;YAEA;YACA,MAAM+B,eAAe,GAAG,EAAE;YAC1B,MAAMsF,aAAa,GAAG,yCAA0C;YAC9D;AACd;AACA;AACA;AACA;YACeJ,GAAG,CAAEK,QAAQ,EACdC,MAAM,CAAEJ,OAAO,IAAK;cACpB,OAAQ,QAAQ,CAAE3C,IAAI,CAAC2C,OAAO,CAACK,KAAK,CAAC;YACvC,CAAC,CAAC,CAACC,GAAG,CAAEN,OAAO,IAAK;cAClB,MAAM,CACJO;cACA,sDACD,GAAGP,OAAO,CAACQ,KAAK,IAAI,EAAE;cACvB,MAAMC,WAAW,GAAG5H,IAAI,CAACG,KAAK,CAAC,CAAC,EAAEuH,KAAK,CAAC;cAExC,MAAM,CACJpF,KAAK,EACLJ,IAAI,CACL,GAAGnC,YAAY,CAAC6H,WAAW,CAAC;;cAE7B;cACA;cACA;cACA;cACA;cACA7F,eAAe,CAACc,IAAI,CAAC,CACnBP,KAAK,EAAEJ,IAAI,CACZ,CAAC;cACF,OAAO,IAAA2F,0BAAY,EAACV,OAAO,CAAC;YAC9B,CAAC,CAAC;YAEF,OAAO,CACLnH,IAAI,EACJ,GAAGqH,aAAa,CAACS,OAAO,CAAC,CAACjG,KAAK,EAAE4D,GAAG,KAAK;cACvC,OAAO7D,oBAAoB,CACzBC,KAAK,EACLQ,QAAQ,EACRN,eAAe,CAAC0D,GAAG,CACrB,CAAC;YACH,CAAC,CAAC,CAAC8B,MAAM;YACP;AAChB;AACA;YACiBpE,IAAI,IAAK;cACR,OAAOA,IAAI,KAAK,IAAI,IAAIA,IAAI,KAAK/B,SAAS;YAC5C,CACF,CAAC,CACF;YACH;UACA,CAAC,CAAC,OAAO2G,KAAK,EAAE;YACd;YACAC,OAAO,CAACC,GAAG,CAAC,KAAK,EAAE5F,QAAQ,EAAE0F,KAAK,CAAC;UACrC;UAEA,OAAO,EAAE;QACX,CAAC;QACD;QACAG,eAAe,EAAE;MACnB;IACF;EACF,CAAC;AACH,CAAC;AAACC,OAAA,CAAA9H,uBAAA,GAAAA,uBAAA","ignoreList":[]}

package/dist/getJsdocProcessorPlugin.d.ts ADDED Viewed

@@ -0,0 +1,67 @@
+export function getJsdocProcessorPlugin(options?: JsdocProcessorOptions): ESLint.Plugin;
+export type Integer = number;
+export type JsdocProcessorOptions = {
+    /**
+     * Require captions for example tags
+     */
+    captionRequired?: boolean | undefined;
+    /**
+     * See docs
+     */
+    paddedIndent?: number | undefined;
+    /**
+     * See docs
+     */
+    checkDefaults?: boolean | undefined;
+    /**
+     * See docs
+     */
+    checkParams?: boolean | undefined;
+    /**
+     * See docs
+     */
+    checkExamples?: boolean | undefined;
+    /**
+     * See docs
+     */
+    checkProperties?: boolean | undefined;
+    /**
+     * See docs
+     */
+    matchingFileName?: string | undefined;
+    /**
+     * See docs
+     */
+    matchingFileNameDefaults?: string | undefined;
+    /**
+     * See docs
+     */
+    matchingFileNameParams?: string | undefined;
+    /**
+     * See docs
+     */
+    matchingFileNameProperties?: string | undefined;
+    /**
+     * See docs
+     */
+    exampleCodeRegex?: string | RegExp | undefined;
+    /**
+     * See docs
+     */
+    rejectExampleCodeRegex?: string | RegExp | undefined;
+    /**
+     * See docs
+     */
+    allowedLanguagesToProcess?: string[] | undefined;
+    /**
+     * See docs
+     */
+    sourceType?: "module" | "script" | undefined;
+    /**
+     * See docs
+     */
+    parser?: Linter.ESTreeParser | Linter.NonESTreeParser | undefined;
+};
+import type { ESLint } from 'eslint';
+import type { Linter } from 'eslint';
+//# sourceMappingURL=getJsdocProcessorPlugin.d.ts.map

package/dist/getJsdocProcessorPlugin.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"getJsdocProcessorPlugin.d.ts","sourceRoot":"","sources":["../src/getJsdocProcessorPlugin.js"],"names":[],"mappings":"AA8GO,kDAHI,qBAAqB,GACnB,aAAa,CAmjBzB;sBA7kBY,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAxDT,QAAQ;4BAAR,QAAQ"}

package/dist/iterateJsdoc.d.ts ADDED Viewed

@@ -0,0 +1,462 @@
+/**
+ * @param {JsdocVisitor} iterator
+ * @param {RuleConfig} ruleConfig
+ * @returns {import('eslint').Rule.RuleModule}
+ */
+export default function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): import("eslint").Rule.RuleModule;
+export { parseComment } from "@es-joy/jsdoccomment";
+export type Integer = number;
+export type JsdocBlockWithInline = import("@es-joy/jsdoccomment").JsdocBlockWithInline;
+export type ContextObject = {
+    disallowName?: string;
+    allowName?: string;
+    context?: string;
+    comment?: string;
+    tags?: string[];
+    replacement?: string;
+    minimum?: Integer;
+    message?: string;
+    forceRequireReturn?: boolean;
+};
+export type Context = string | ContextObject;
+export type CheckJsdoc = (info: {
+    lastIndex?: Integer;
+    isFunctionContext?: boolean;
+    selector?: string;
+    comment?: string;
+}, handler: null | ((jsdoc: import("@es-joy/jsdoccomment").JsdocBlockWithInline) => boolean | undefined), node: import("eslint").Rule.Node) => void;
+export type ForEachPreferredTag = (tagName: string, arrayHandler: (matchingJsdocTag: import("@es-joy/jsdoccomment").JsdocTagWithInline, targetTagName: string) => void, skipReportingBlockedTag?: boolean | undefined) => void;
+export type ReportSettings = (message: string) => void;
+export type ParseClosureTemplateTag = (tag: import("comment-parser").Spec) => string[];
+export type GetPreferredTagNameObject = (cfg: {
+    tagName: string;
+}) => string | false | {
+    message: string;
+    replacement?: string | undefined;
+} | {
+    blocked: true;
+    tagName: string;
+};
+export type BasicUtils = {
+    forEachPreferredTag: ForEachPreferredTag;
+    reportSettings: ReportSettings;
+    parseClosureTemplateTag: ParseClosureTemplateTag;
+    getPreferredTagNameObject: GetPreferredTagNameObject;
+    pathDoesNotBeginWith: import("./jsdocUtils.js").PathDoesNotBeginWith;
+};
+export type IsIteratingFunction = () => boolean;
+export type IsVirtualFunction = () => boolean;
+export type Stringify = (tagBlock: import("comment-parser").Block, specRewire?: boolean | undefined) => string;
+export type ReportJSDoc = (msg: string, tag?: import("comment-parser").Spec | {
+    line: Integer;
+    column?: Integer;
+} | null | undefined, handler?: (() => void) | null | undefined, specRewire?: boolean | undefined, data?: undefined | {
+    [key: string]: string;
+}) => any;
+export type GetRegexFromString = (str: string, requiredFlags?: string | undefined) => RegExp;
+export type GetTagDescription = (tg: import("comment-parser").Spec, returnArray?: boolean | undefined) => string[] | string;
+export type SetTagDescription = (tg: import("comment-parser").Spec, matcher: RegExp, setter: (description: string) => string) => Integer;
+export type GetDescription = () => {
+    description: string;
+    descriptions: string[];
+    lastDescriptionLine: Integer;
+};
+export type SetBlockDescription = (setter: (info: {
+    delimiter: string;
+    postDelimiter: string;
+    start: string;
+}, seedTokens: (tokens?: Partial<import("comment-parser").Tokens>) => import("comment-parser").Tokens, descLines: string[]) => import("comment-parser").Line[]) => void;
+export type SetDescriptionLines = (matcher: RegExp, setter: (description: string) => string) => Integer;
+export type ChangeTag = (tag: import("comment-parser").Spec, ...tokens: Partial<import("comment-parser").Tokens>[]) => void;
+export type SetTag = (tag: import("comment-parser").Spec & {
+    line: Integer;
+}, tokens?: Partial<import("comment-parser").Tokens> | undefined) => void;
+export type RemoveTag = (tagIndex: Integer, cfg?: {
+    removeEmptyBlock?: boolean;
+    tagSourceOffset?: Integer;
+} | undefined) => void;
+export type AddTag = (targetTagName: string, number?: number | undefined, tokens?: {} | import("comment-parser").Tokens | undefined) => void;
+export type GetFirstLine = () => Integer | undefined;
+export type SeedTokens = (tokens?: Partial<import("comment-parser").Tokens> | undefined) => import("comment-parser").Tokens;
+/**
+ * Sets tokens to empty string.
+ */
+export type EmptyTokens = (tokens: import("comment-parser").Tokens) => void;
+export type AddLine = (sourceIndex: Integer, tokens: Partial<import("comment-parser").Tokens>) => void;
+export type AddLines = (tagIndex: Integer, tagSourceOffset: Integer, numLines: Integer) => void;
+export type MakeMultiline = () => void;
+export type GetFunctionParameterNames = (useDefaultObjectProperties?: boolean | undefined) => import("./jsdocUtils.js").ParamNameInfo[];
+export type HasParams = () => Integer;
+export type IsGenerator = () => boolean;
+export type IsConstructor = () => boolean;
+export type GetJsdocTagsDeep = (tagName: string) => false | {
+    idx: Integer;
+    name: string;
+    type: string;
+}[];
+export type GetPreferredTagName = (cfg: {
+    tagName: string;
+    skipReportingBlockedTag?: boolean;
+    allowObjectReturn?: boolean;
+    defaultMessage?: string;
+}) => string | undefined | false | {
+    message: string;
+    replacement?: string | undefined;
+} | {
+    blocked: true;
+    tagName: string;
+};
+export type IsValidTag = (name: string, definedTags: string[]) => boolean;
+export type HasATag = (names: string[]) => boolean;
+export type HasTag = (name: string) => boolean;
+export type ComparePaths = (name: string) => (otherPathName: string) => boolean;
+export type DropPathSegmentQuotes = (name: string) => string;
+export type AvoidDocs = () => boolean;
+export type TagMightHaveNamePositionTypePosition = (tagName: string, otherModeMaps?: import("./getDefaultTagStructureForMode.js").TagStructure[] | undefined) => boolean | {
+    otherMode: true;
+};
+export type TagMustHave = (tagName: string, otherModeMaps: import("./getDefaultTagStructureForMode.js").TagStructure[]) => boolean | {
+    otherMode: false;
+};
+export type TagMissingRequiredTypeOrNamepath = (tag: import("comment-parser").Spec, otherModeMaps: import("./getDefaultTagStructureForMode.js").TagStructure[]) => boolean | {
+    otherMode: false;
+};
+export type IsNamepathX = (tagName: string) => boolean;
+export type GetTagStructureForMode = (mde: import("./jsdocUtils.js").ParserMode) => import("./getDefaultTagStructureForMode.js").TagStructure;
+export type MayBeUndefinedTypeTag = (tag: import("comment-parser").Spec) => boolean;
+export type HasValueOrExecutorHasNonEmptyResolveValue = (anyPromiseAsReturn: boolean, allBranches?: boolean | undefined) => boolean;
+export type HasYieldValue = () => boolean;
+export type HasYieldReturnValue = () => boolean;
+export type HasThrowValue = () => boolean;
+export type IsAsync = () => boolean | undefined;
+export type GetTags = (tagName: string) => import("comment-parser").Spec[];
+export type GetPresentTags = (tagList: string[]) => import("@es-joy/jsdoccomment").JsdocTagWithInline[];
+export type FilterTags = (filter: (tag: import("@es-joy/jsdoccomment").JsdocTagWithInline) => boolean) => import("@es-joy/jsdoccomment").JsdocTagWithInline[];
+export type FilterAllTags = (filter: (tag: (import("comment-parser").Spec | import("@es-joy/jsdoccomment").JsdocInlineTagNoType)) => boolean) => (import("comment-parser").Spec | import("@es-joy/jsdoccomment").JsdocInlineTagNoType)[];
+export type GetTagsByType = (tags: import("comment-parser").Spec[]) => {
+    tagsWithNames: import("comment-parser").Spec[];
+    tagsWithoutNames: import("comment-parser").Spec[];
+};
+export type HasOptionTag = (tagName: string) => boolean;
+export type GetClassNode = () => Node | null;
+export type GetClassJsdoc = () => null | JsdocBlockWithInline;
+export type ClassHasTag = (tagName: string) => boolean;
+export type FindContext = (contexts: Context[], comment: string | undefined) => {
+    foundContext: Context | undefined;
+    contextStr: string;
+};
+export type Utils = BasicUtils & {
+    isIteratingFunction: IsIteratingFunction;
+    isVirtualFunction: IsVirtualFunction;
+    stringify: Stringify;
+    reportJSDoc: ReportJSDoc;
+    getRegexFromString: GetRegexFromString;
+    getTagDescription: GetTagDescription;
+    setTagDescription: SetTagDescription;
+    getDescription: GetDescription;
+    setBlockDescription: SetBlockDescription;
+    setDescriptionLines: SetDescriptionLines;
+    changeTag: ChangeTag;
+    setTag: SetTag;
+    removeTag: RemoveTag;
+    addTag: AddTag;
+    getFirstLine: GetFirstLine;
+    seedTokens: SeedTokens;
+    emptyTokens: EmptyTokens;
+    addLine: AddLine;
+    addLines: AddLines;
+    makeMultiline: MakeMultiline;
+    flattenRoots: import("./jsdocUtils.js").FlattenRoots;
+    getFunctionParameterNames: GetFunctionParameterNames;
+    hasParams: HasParams;
+    isGenerator: IsGenerator;
+    isConstructor: IsConstructor;
+    getJsdocTagsDeep: GetJsdocTagsDeep;
+    getPreferredTagName: GetPreferredTagName;
+    isValidTag: IsValidTag;
+    hasATag: HasATag;
+    hasTag: HasTag;
+    comparePaths: ComparePaths;
+    dropPathSegmentQuotes: DropPathSegmentQuotes;
+    avoidDocs: AvoidDocs;
+    tagMightHaveNamePosition: TagMightHaveNamePositionTypePosition;
+    tagMightHaveTypePosition: TagMightHaveNamePositionTypePosition;
+    tagMustHaveNamePosition: TagMustHave;
+    tagMustHaveTypePosition: TagMustHave;
+    tagMissingRequiredTypeOrNamepath: TagMissingRequiredTypeOrNamepath;
+    isNamepathDefiningTag: IsNamepathX;
+    isNamepathReferencingTag: IsNamepathX;
+    isNamepathOrUrlReferencingTag: IsNamepathX;
+    tagMightHaveNamepath: IsNamepathX;
+    getTagStructureForMode: GetTagStructureForMode;
+    mayBeUndefinedTypeTag: MayBeUndefinedTypeTag;
+    hasValueOrExecutorHasNonEmptyResolveValue: HasValueOrExecutorHasNonEmptyResolveValue;
+    hasYieldValue: HasYieldValue;
+    hasYieldReturnValue: HasYieldReturnValue;
+    hasThrowValue: HasThrowValue;
+    isAsync: IsAsync;
+    getTags: GetTags;
+    getPresentTags: GetPresentTags;
+    filterTags: FilterTags;
+    filterAllTags: FilterAllTags;
+    getTagsByType: GetTagsByType;
+    hasOptionTag: HasOptionTag;
+    getClassNode: GetClassNode;
+    getClassJsdoc: GetClassJsdoc;
+    classHasTag: ClassHasTag;
+    findContext: FindContext;
+};
+/**
+ * Should use ESLint rule's typing.
+ */
+export type EslintRuleMeta = import("eslint").Rule.RuleMetaData;
+/**
+ * A plain object for tracking state as needed by rules across iterations.
+ */
+export type StateObject = {
+    globalTags: {};
+    hasDuplicates: {
+        [key: string]: boolean;
+    };
+    selectorMap: {
+        [selector: string]: {
+            [comment: string]: Integer;
+        };
+    };
+    hasTag: {
+        [key: string]: boolean;
+    };
+    hasNonComment: number;
+    hasNonCommentBeforeTag: {
+        [key: string]: boolean | number;
+    };
+};
+/**
+ * The Node AST as supplied by the parser.
+ */
+export type Node = import("eslint").Rule.Node;
+export type Report = (message: string, fix?: import("eslint").Rule.ReportFixer | null | undefined, jsdocLoc?: {
+    line?: Integer;
+    column?: Integer;
+} | (import("comment-parser").Spec & {
+    line?: Integer;
+}) | null | undefined, data?: undefined | {
+    [key: string]: string;
+}) => void;
+export type PreferredTypes = {
+    [key: string]: false | string | {
+        message: string;
+        replacement?: false | string;
+        skipRootChecking?: boolean;
+    };
+};
+export type StructuredTags = {
+    [key: string]: {
+        name?: "text" | "namepath-defining" | "namepath-referencing" | false;
+        type?: boolean | string[];
+        required?: ("name" | "type" | "typeOrNameRequired")[];
+    };
+};
+/**
+ * Settings from ESLint types.
+ */
+export type Settings = {
+    maxLines: Integer;
+    minLines: Integer;
+    tagNamePreference: import("./jsdocUtils.js").TagNamePreference;
+    mode: import("./jsdocUtils.js").ParserMode;
+    preferredTypes: PreferredTypes;
+    structuredTags: StructuredTags;
+    [name: string]: any;
+    contexts?: Context[];
+};
+export type JSDocSettings = {
+    settings?: {
+        jsdoc?: {
+            ignorePrivate: boolean;
+            ignoreInternal: boolean;
+            maxLines: Integer;
+            minLines: Integer;
+            tagNamePreference: import("./jsdocUtils.js").TagNamePreference;
+            preferredTypes: PreferredTypes;
+            structuredTags: StructuredTags;
+            overrideReplacesDocs: boolean;
+            ignoreReplacesDocs: boolean;
+            implementsReplacesDocs: boolean;
+            augmentsExtendsReplacesDocs: boolean;
+            exemptDestructuredRootsFromChecks: boolean;
+            mode: import("./jsdocUtils.js").ParserMode;
+            contexts: Context[];
+        };
+    };
+};
+/**
+ * Create the report function
+ */
+export type MakeReport = (context: import("eslint").Rule.RuleContext, commentNode: import("estree").Node) => Report;
+export type JsdocVisitorBasic = (arg: {
+    context: import("eslint").Rule.RuleContext;
+    sourceCode: import("eslint").SourceCode;
+    indent?: string;
+    info?: {
+        comment?: string | undefined;
+        lastIndex?: Integer | undefined;
+    };
+    state?: StateObject;
+    globalState?: Map<string, Map<string, string>>;
+    jsdoc?: JsdocBlockWithInline;
+    jsdocNode?: import("eslint").Rule.Node & {
+        range: [number, number];
+    };
+    node?: Node;
+    allComments?: import("estree").Node[];
+    report?: Report;
+    makeReport?: MakeReport;
+    settings: Settings;
+    utils: BasicUtils;
+}) => any;
+export type JsdocVisitor = (arg: {
+    context: import("eslint").Rule.RuleContext;
+    sourceCode: import("eslint").SourceCode;
+    indent: string;
+    info: {
+        comment?: string | undefined;
+        lastIndex?: Integer | undefined;
+    };
+    state: StateObject;
+    globalState: Map<string, Map<string, string>>;
+    jsdoc: JsdocBlockWithInline;
+    jsdocNode: import("eslint").Rule.Node & {
+        range: [number, number];
+    };
+    node: Node | null;
+    allComments?: import("estree").Node[];
+    report: Report;
+    makeReport?: MakeReport;
+    settings: Settings;
+    utils: Utils;
+}) => any;
+export type NonCommentArgs = {
+    node: Node & {
+        range: [number, number];
+    };
+    state: StateObject;
+};
+export type RuleConfig = {
+    /**
+     * ESLint rule meta
+     */
+    meta: EslintRuleMeta;
+    /**
+     * Any default contexts
+     */
+    contextDefaults?: jsdocUtils.DefaultContexts | undefined;
+    /**
+     * Whether to force a `contexts` check
+     */
+    contextSelected?: true | undefined;
+    /**
+     * Whether to iterate all JSDoc blocks by default
+     * regardless of context
+     */
+    iterateAllJsdocs?: true | undefined;
+    /**
+     * Whether to check `@private` blocks (normally exempted)
+     */
+    checkPrivate?: true | undefined;
+    /**
+     * Whether to check `@internal` blocks (normally exempted)
+     */
+    checkInternal?: true | undefined;
+    /**
+     * Whether to iterates over all JSDoc blocks regardless of attachment
+     */
+    checkFile?: true | undefined;
+    /**
+     * Whether to avoid relying on settings for global contexts
+     */
+    nonGlobalSettings?: true | undefined;
+    /**
+     * Whether to disable the tracking of visited comment nodes (as
+     * non-tracked may conduct further actions)
+     */
+    noTracking?: true | undefined;
+    /**
+     * Whether the rule expects contexts to be based on a match option
+     */
+    matchContext?: true | undefined;
+    /**
+     * Handler to be executed upon exiting iteration of program AST
+     */
+    exit?: ((args: {
+        context: import("eslint").Rule.RuleContext;
+        state: StateObject;
+        settings: Settings;
+        utils: BasicUtils;
+    }) => void) | undefined;
+    /**
+     * Handler to be executed if rule wishes
+     * to be supplied nodes without comments
+     */
+    nonComment?: ((nca: NonCommentArgs) => void) | undefined;
+};
+/**
+ * @typedef {{
+ *   [key: string]: false|string|{
+ *     message: string,
+ *     replacement?: false|string
+ *     skipRootChecking?: boolean
+ *   }
+ * }} PreferredTypes
+ */
+/**
+ * @typedef {{
+ *   [key: string]: {
+ *     name?: "text"|"namepath-defining"|"namepath-referencing"|false,
+ *     type?: boolean|string[],
+ *     required?: ("name"|"type"|"typeOrNameRequired")[]
+ *   }
+ * }} StructuredTags
+ */
+/**
+ * Settings from ESLint types.
+ * @typedef {{
+ *   maxLines: Integer,
+ *   minLines: Integer,
+ *   tagNamePreference: import('./jsdocUtils.js').TagNamePreference,
+ *   mode: import('./jsdocUtils.js').ParserMode,
+ *   preferredTypes: PreferredTypes,
+ *   structuredTags: StructuredTags,
+ *   [name: string]: any,
+ *   contexts?: Context[]
+ * }} Settings
+ */
+/**
+ * @typedef {{
+ *   settings?: {
+ *     jsdoc?: {
+ *       ignorePrivate: boolean,
+ *       ignoreInternal: boolean,
+ *       maxLines: Integer,
+ *       minLines: Integer,
+ *       tagNamePreference: import('./jsdocUtils.js').TagNamePreference,
+ *       preferredTypes: PreferredTypes,
+ *       structuredTags: StructuredTags,
+ *       overrideReplacesDocs: boolean,
+ *       ignoreReplacesDocs: boolean,
+ *       implementsReplacesDocs: boolean,
+ *       augmentsExtendsReplacesDocs: boolean,
+ *       exemptDestructuredRootsFromChecks: boolean,
+ *       mode: import('./jsdocUtils.js').ParserMode,
+ *       contexts: Context[],
+ *     }
+ *   }
+ * }} JSDocSettings
+ */
+/**
+ * @param {import('eslint').Rule.RuleContext & JSDocSettings} context
+ * @returns {Settings|false}
+ */
+export function getSettings(context: import("eslint").Rule.RuleContext & JSDocSettings): Settings | false;
+import * as jsdocUtils from './jsdocUtils.js';
+//# sourceMappingURL=iterateJsdoc.d.ts.map

package/dist/iterateJsdoc.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"iterateJsdoc.d.ts","sourceRoot":"","sources":["../src/iterateJsdoc.js"],"names":[],"mappings":"AAgyEA;;;;GAIG;AACH,+CAJW,YAAY,cACZ,UAAU,GACR,OAAO,QAAQ,EAAE,IAAI,CAAC,UAAU,CA8K5C;;sBAp8EY,MAAM;mCAIN,OAAO,sBAAsB,EAAE,oBAAoB;4BAInD;IACR,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;sBAGS,MAAM,GAAC,aAAa;gCAKtB;IACN,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,WACO,IAAI,GAAC,CAAC,CAAC,KAAK,EAAE,OAAO,sBAAsB,EAAE,oBAAoB,KAAK,OAAO,GAAC,SAAS,CAAC,QACxF,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,KACxB,IAAI;4CAKN,MAAM,gBACN,CACN,gBAAgB,EAAE,OAAO,sBAAsB,EAAE,kBAAkB,EACnE,aAAa,EAAE,MAAM,KAClB,IAAI,oDAEC,IAAI;uCAKN,MAAM,KACJ,IAAI;4CAKN,OAAO,gBAAgB,EAAE,IAAI,KAC3B,MAAM,EAAE;8CAKV;IACN,OAAO,EAAE,MAAM,CAAA;CAChB,KACS,MAAM,GAAC,KAAK,GAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,GAAC,SAAS,CAAA;CAC/B,GAAC;IACA,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;yBAIS;IACR,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,cAAc,EAAE,cAAc,CAAC;IAC/B,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,OAAO,iBAAiB,EAAE,oBAAoB,CAAA;CACrE;wCAKS,OAAO;sCAKP,OAAO;mCAKT,OAAO,gBAAgB,EAAE,KAAK,uCAE5B,MAAM;gCAKR,MAAM;UACoC,OAAO;aAAW,OAAO;uCAC5D,IAAI,+DAEX,SAAS,GAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB;uCAKO,MAAM,yCAEJ,MAAM;qCAKR,OAAO,gBAAgB,EAAE,IAAI,wCAE3B,MAAM,EAAE,GAAC,MAAM;qCAKjB,OAAO,gBAAgB,EAAE,IAAI,WAC7B,MAAM,UACN,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,KAC7B,OAAO;mCAKP;IACR,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAA;CAC7B;2CAKO,CACN,IAAI,EAAE;IACJ,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAA;CACd,EACD,UAAU,EAAE,CACV,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,KAC9C,OAAO,gBAAgB,EAAE,MAAM,EACpC,SAAS,EAAE,MAAM,EAAE,KAChB,OAAO,gBAAgB,EAAE,IAAI,EAAE,KAC1B,IAAI;4CAKN,MAAM,UACN,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,KAC7B,OAAO;8BAKT,OAAO,gBAAgB,EAAE,IAAI,aAC1B,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,EAAA,KACzC,IAAI;2BAKN,OAAO,gBAAgB,EAAE,IAAI,GAAG;IACtC,IAAI,EAAE,OAAO,CAAA;CACd,oEAES,IAAI;mCAKN,OAAO;uBAEM,OAAO;sBACR,OAAO;kBAEjB,IAAI;qCAKN,MAAM,6FAGJ,IAAI;iCAKJ,OAAO,GAAC,SAAS;yBAIjB,CACR,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,GAAG,SAAS,KAC1D,OAAO,gBAAgB,EAAE,MAAM;;;;mCAM5B,OAAO,gBAAgB,EAAE,MAAM,KAC7B,IAAI;oCAKN,OAAO,UACP,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,KACtC,IAAI;kCAKN,OAAO,mBACP,OAAO,YACP,OAAO,KACL,IAAI;kCAKJ,IAAI;8FAMJ,OAAO,iBAAiB,EAAE,aAAa,EAAE;8BAKzC,OAAO;gCAKP,OAAO;kCAKP,OAAO;yCAKT,MAAM,KACJ,KAAK,GAAC;IACd,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAA;CACb,EAAE;wCAKK;IACN,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,KACS,MAAM,GAAC,SAAS,GAAC,KAAK,GAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;CAChC,GAAC;IACA,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;gCAKO,MAAM,eACN,MAAM,EAAE,KACN,OAAO;8BAKT,MAAM,EAAE,KACN,OAAO;4BAKT,MAAM,KACJ,OAAO;kCAKT,MAAM,KACJ,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO;2CAKpC,MAAM,KACJ,MAAM;8BAKN,OAAO;6DAKT,MAAM,8FAGJ,OAAO,GAAC;IAAC,SAAS,EAAE,IAAI,CAAA;CAAC;oCAK3B,MAAM,iBACN,OAAO,oCAAoC,EACjD,YAAY,EAAE,KACN,OAAO,GAAC;IAChB,SAAS,EAAE,KAAK,CAAA;CACjB;qDAKO,OAAO,gBAAgB,EAAE,IAAI,iBAC7B,OAAO,oCAAoC,EACjD,YAAY,EAAE,KACN,OAAO,GAAC;IAChB,SAAS,EAAE,KAAK,CAAA;CACjB;oCAKO,MAAM,KACJ,OAAO;2CAKT,OAAO,iBAAiB,EAAE,UAAU,KAClC,OAAO,oCAAoC,EAAE,YAAY;0CAK3D,OAAO,gBAAgB,EAAE,IAAI,KAC3B,OAAO;6EAKT,OAAO,wCAEL,OAAO;kCAKP,OAAO;wCAKP,OAAO;kCAKP,OAAO;4BAKP,OAAO,GAAC,SAAS;gCAKnB,MAAM,KACJ,OAAO,gBAAgB,EAAE,IAAI,EAAE;uCAKjC,MAAM,EAAE,KACN,OAAO,sBAAsB,EAAE,kBAAkB,EAAE;kCAKrD,CAAC,GAAG,EAAE,OAAO,sBAAsB,EAAE,kBAAkB,KAAK,OAAO,KACjE,OAAO,sBAAsB,EAAE,kBAAkB,EAAE;qCAKrD,CAAC,GAAG,EAAE,CAAC,OAAO,gBAAgB,EAAE,IAAI,GAC9C,OAAW,sBAAsB,EAAE,oBAAoB,CAAC,KAAK,OAAO,KACxD,CAAC,OAAO,gBAAgB,EAAE,IAAI,GAC1C,OAAW,sBAAsB,EAAE,oBAAoB,CAAC,EAAE;mCAKhD,OAAO,gBAAgB,EAAE,IAAI,EAAE,KAC7B;IACR,aAAa,EAAE,OAAO,gBAAgB,EAAE,IAAI,EAAE,CAAC;IAC/C,gBAAgB,EAAE,OAAO,gBAAgB,EAAE,IAAI,EAAE,CAAA;CAClD;qCAKO,MAAM,KACJ,OAAO;iCAKP,IAAI,GAAC,IAAI;kCAKT,IAAI,GAAC,oBAAoB;oCAK3B,MAAM,KACJ,OAAO;qCAKT,OAAO,EAAE,WACT,MAAM,GAAC,SAAS,KACd;IACR,YAAY,EAAE,OAAO,GAAC,SAAS,CAAC;IAChC,UAAU,EAAE,MAAM,CAAA;CACnB;oBAIS,UAAU,GAAG;IACrB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,cAAc,EAAE,cAAc,CAAC;IAC/B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,YAAY,EAAE,OAAO,iBAAiB,EAAE,YAAY,CAAC;IACrD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;IAC3B,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,SAAS,EAAE,SAAS,CAAC;IACrB,wBAAwB,EAAE,oCAAoC,CAAC;IAC/D,wBAAwB,EAAE,oCAAoC,CAAC;IAC/D,uBAAuB,EAAE,WAAW,CAAC;IACrC,uBAAuB,EAAE,WAAW,CAAC;IACrC,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,qBAAqB,EAAE,WAAW,CAAC;IACnC,wBAAwB,EAAE,WAAW,CAAC;IACtC,6BAA6B,EAAE,WAAW,CAAC;IAC3C,oBAAoB,EAAE,WAAW,CAAC;IAClC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,yCAAyC,EAAE,yCAAyC,CAAC;IACrF,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,aAAa,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,WAAW,CAAA;CACzB;;;;6BAYS,OAAO,QAAQ,EAAE,IAAI,CAAC,YAAY;;;;0BAKlC;IACR,UAAU,EAAE,EAAE,CAAC;IACf,aAAa,EAAE;QACnB,CAAO,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACvB,CAAC;IACF,WAAW,EAAE;QACjB,CAAO,QAAQ,EAAE,MAAM,GAAG;YAC1B,CAAS,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;SAC3B,CAAA;KACF,CAAC;IACF,MAAM,EAAE;QACZ,CAAO,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACvB,CAAC;IACF,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB,EAAE;QAC5B,CAAO,GAAG,EAAE,MAAM,GAAG,OAAO,GAAC,MAAM,CAAA;KAC9B,CAAA;CACF;;;;mBAKS,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI;+BA6E5B,MAAM;WAGJ,OAAO;aAAW,OAAO;;WACO,OAAO;8BAEzC,SAAS,GAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,KACS,IAAI;6BA+gCJ;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG,KAAK,GAAC,MAAM,GAAC;QAC1B,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,KAAK,GAAC,MAAM,CAAA;QAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAC3B,CAAA;CACF;6BAGS;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,CAAC,EAAE,MAAM,GAAC,mBAAmB,GAAC,sBAAsB,GAAC,KAAK,CAAC;QAC/D,IAAI,CAAC,EAAE,OAAO,GAAC,MAAM,EAAE,CAAC;QACxB,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAC,MAAM,GAAC,oBAAoB,CAAC,EAAE,CAAA;KAClD,CAAA;CACF;;;;uBAIS;IACR,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,iBAAiB,EAAE,OAAO,iBAAiB,EAAE,iBAAiB,CAAC;IAC/D,IAAI,EAAE,OAAO,iBAAiB,EAAE,UAAU,CAAC;IAC3C,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IACnC,CAAK,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB;4BAIS;IACR,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE;YACN,aAAa,EAAE,OAAO,CAAC;YACvB,cAAc,EAAE,OAAO,CAAC;YACxB,QAAQ,EAAE,OAAO,CAAC;YAClB,QAAQ,EAAE,OAAO,CAAC;YAClB,iBAAiB,EAAE,OAAO,iBAAiB,EAAE,iBAAiB,CAAC;YAC/D,cAAc,EAAE,cAAc,CAAC;YAC/B,cAAc,EAAE,cAAc,CAAC;YAC/B,oBAAoB,EAAE,OAAO,CAAC;YAC9B,kBAAkB,EAAE,OAAO,CAAC;YAC5B,sBAAsB,EAAE,OAAO,CAAC;YAChC,2BAA2B,EAAE,OAAO,CAAC;YACrC,iCAAiC,EAAE,OAAO,CAAC;YAC3C,IAAI,EAAE,OAAO,iBAAiB,EAAE,UAAU,CAAC;YAC3C,QAAQ,EAAE,OAAO,EAAE,CAAC;SACrB,CAAA;KACF,CAAA;CACF;;;;mCAsEO,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,eACjC,OAAO,QAAQ,EAAE,IAAI,KACnB,MAAM;gCAuDN,CACR,GAAG,EAAE;IACH,OAAO,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;IAC3C,UAAU,EAAE,OAAO,QAAQ,EAAE,UAAU,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;QAC3B,SAAS,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;KAC9B,CAAC;IACF,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/C,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAG;QACvC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,WAAW,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,EAAE,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,UAAU,CAAC;CACnB,KACE,GAAG;2BAGE,CACR,GAAG,EAAE;IACH,OAAO,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;IAC3C,UAAU,EAAE,OAAO,QAAQ,EAAE,UAAU,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;QAC3B,SAAS,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;KAC9B,CAAC;IACF,KAAK,EAAE,WAAW,CAAC;IACnB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9C,KAAK,EAAE,oBAAoB,CAAC;IAC5B,SAAS,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAG;QACtC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IACF,IAAI,EAAE,IAAI,GAAC,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,EAAE,CAAA;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,KACE,GAAG;6BA8HE;IAAC,IAAI,EAAE,IAAI,GAAG;QACtB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAC;;;;;UAKX,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAYP;QAChB,OAAO,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;QAC3C,KAAK,EAAE,WAAW,CAAC;QACnB,QAAQ,EAAE,QAAQ,CAAC;QACnB,KAAK,EAAE,UAAU,CAAA;KAClB,KAAK,IAAI;;;;;wBACO,cAAc,KAAK,IAAI;;AAzX3C;;;;;;;;GAQG;AACH;;;;;;;;GAQG;AACH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;GAGG;AACH,qCAHW,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,GAAG,aAAa,GAC/C,QAAQ,GAAC,KAAK,CA4D1B;4BAxxD2B,iBAAiB"}

package/package.json CHANGED Viewed

@@ -50,7 +50,6 @@
     "c8": "^10.1.3",
     "camelcase": "^8.0.0",
     "chai": "^5.2.0",
-    "cross-env": "^7.0.3",
     "decamelize": "^6.0.0",
     "eslint": "9.29.0",
     "eslint-config-canonical": "~44.9.5",
@@ -80,11 +79,7 @@
   ],
   "license": "BSD-3-Clause",
   "lint-staged": {
-    ".eslintignore": [
-      "npm run lint-fix",
-      "git add ."
-    ],
-    "*.js": "npm run lint-arg -- --fix"
+    "*.js": "eslint --fix"
   },
   "type": "module",
   "main": "./dist/index.cjs",
@@ -140,25 +135,24 @@
     "url": "https://github.com/gajus/eslint-plugin-jsdoc/issues"
   },
   "run-if-changed": {
-    "package-lock.json": "npm run install-offline"
+    "package-lock.json": "pnpm run install-offline"
   },
   "scripts": {
     "tsc": "tsc",
     "tsc-build": "tsc -p tsconfig-prod.json",
-    "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
+    "build": "rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
     "check-docs": "babel-node ./src/bin/generateDocs.js --check",
-    "create-docs": "npm run create-options && babel-node ./src/bin/generateDocs.js",
+    "create-docs": "pnpm run create-options && babel-node ./src/bin/generateDocs.js",
     "create-rule": "babel-node ./src/bin/generateRule.js",
     "create-options": "node ./src/bin/generateOptions.mjs",
     "install-offline": "pnpm install --prefer-offline --no-audit",
-    "lint": "npm run lint-arg -- .",
-    "lint-arg": "eslint",
-    "lint-fix": "npm run lint-arg -- --fix .",
+    "lint": "eslint",
+    "lint-fix": "eslint --fix",
     "prepare": "husky",
-    "test-no-cov": "cross-env BABEL_ENV=test mocha",
-    "test": "c8 npm run test-no-cov",
-    "test-cov": "cross-env TIMING=1 c8 --reporter text npm run test-no-cov",
-    "test-index": "npm run test-no-cov -- test/rules/index.js"
+    "test-no-cov": "BABEL_ENV=test mocha",
+    "test": "c8 pnpm run test-no-cov",
+    "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
+    "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "52.0.0"
+  "version": "52.0.2"
 }

package/src/getJsdocProcessorPlugin.js CHANGED Viewed

@@ -16,6 +16,17 @@ import {
   join,
 } from 'node:path';
+/**
+ * @import {
+ *   Integer,
+ *   JsdocBlockWithInline,
+ * } from './iterateJsdoc.js';
+ * @import {
+ *   ESLint,
+ *   Linter,
+ * } from 'eslint';
+ */
 const {
   version,
 } = JSON.parse(
@@ -43,7 +54,7 @@ const escapeStringRegexp = (str) => {
 /**
  * @param {string} str
  * @param {string} ch
- * @returns {import('./iterateJsdoc.js').Integer}
+ * @returns {Integer}
  */
 const countChars = (str, ch) => {
   return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) || []).length;
@@ -52,8 +63,8 @@ const countChars = (str, ch) => {
 /**
  * @param {string} text
  * @returns {[
- *   import('./iterateJsdoc.js').Integer,
- *   import('./iterateJsdoc.js').Integer
+ *   Integer,
+ *   Integer
  * ]}
  */
 const getLinesCols = (text) => {
@@ -95,6 +106,7 @@ const getLinesCols = (text) => {
  * We use a function for the ability of the user to pass in a config, but
  * without requiring all users of the plugin to do so.
  * @param {JsdocProcessorOptions} [options]
+ * @returns {ESLint.Plugin}
  */
 export const getJsdocProcessorPlugin = (options = {}) => {
   const {
@@ -150,7 +162,7 @@ export const getJsdocProcessorPlugin = (options = {}) => {
   let extraMessages = [];
   /**
-   * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+   * @param {JsdocBlockWithInline} jsdoc
    * @param {string} jsFileName
    * @param {[number, number]} commentLineCols
    */
@@ -170,19 +182,19 @@ export const getJsdocProcessorPlugin = (options = {}) => {
      *   source: string,
      *   targetTagName: string,
      *   rules?: import('eslint').Linter.RulesRecord|undefined,
-     *   lines?: import('./iterateJsdoc.js').Integer,
-     *   cols?: import('./iterateJsdoc.js').Integer,
+     *   lines?: Integer,
+     *   cols?: Integer,
      *   skipInit?: boolean,
      *   ext: string,
      *   sources?: {
-     *     nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
-     *     nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
+     *     nonJSPrefacingCols: Integer,
+     *     nonJSPrefacingLines: Integer,
      *     string: string,
      *   }[],
      *   tag?: import('comment-parser').Spec & {
-     *     line?: import('./iterateJsdoc.js').Integer,
+     *     line?: Integer,
      *   }|{
-     *     line: import('./iterateJsdoc.js').Integer,
+     *     line: Integer,
      *   }
      * }} cfg
      */
@@ -210,8 +222,8 @@ export const getJsdocProcessorPlugin = (options = {}) => {
       /**
        * @param {{
-       *   nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
-       *   nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
+       *   nonJSPrefacingCols: Integer,
+       *   nonJSPrefacingLines: Integer,
        *   string: string
        * }} cfg
        */
@@ -234,7 +246,7 @@ export const getJsdocProcessorPlugin = (options = {}) => {
         // NOTE: `tag.line` can be 0 if of form `/** @tag ... */`
         const codeStartLine = /**
                                * @type {import('comment-parser').Spec & {
-                               *     line: import('./iterateJsdoc.js').Integer,
+                               *     line: Integer,
                                * }}
                                */ (tag).line + nonJSPrefacingLines;
         const codeStartCol = likelyNestedJSDocIndentSpace;
@@ -567,6 +579,7 @@ export const getJsdocProcessorPlugin = (options = {}) => {
         /**
          * @param {string} text
          * @param {string} filename
+         * @returns {(string | Linter.ProcessorFile)[]}
          */
         preprocess (text, filename) {
           try {
@@ -634,7 +647,14 @@ export const getJsdocProcessorPlugin = (options = {}) => {
                   filename,
                   commentLineCols[idx],
                 );
-              }).filter(Boolean),
+              }).filter(
+                /**
+                 * @returns {file is Linter.ProcessorFile}
+                 */
+                (file) => {
+                  return file !== null && file !== undefined;
+                },
+              ),
             ];
           /* c8 ignore next 6 */
           } catch (error) {

package/eslint.config.js DELETED Viewed

@@ -1,92 +0,0 @@
-import jsdoc from './src/index.js';
-import {
-  recommended as canonical,
-} from 'eslint-config-canonical/canonical';
-import {
-  recommended as canonicalJsdoc,
-} from 'eslint-config-canonical/jsdoc';
-import globals from 'globals';
-const common = {
-  linterOptions: {
-    reportUnusedDisableDirectives: 'off',
-  },
-};
-export default [
-  ...canonical,
-  ...canonicalJsdoc,
-  ...jsdoc.configs['examples-and-default-expressions'],
-  {
-    // Must be by itself
-    ignores: [
-      'dist/**', '.ignore/**', '**/*.d.ts',
-    ],
-  },
-  {
-    ...common,
-    languageOptions: {
-      ecmaVersion: 'latest',
-      globals: globals.node,
-      sourceType: 'module',
-    },
-    rules: {
-      '@stylistic/array-element-newline': 0,
-      '@stylistic/no-extra-parens': 0,
-      'filenames/match-regex': 0,
-      'import/extensions': 0,
-      'import/no-useless-path-segments': 0,
-      'linebreak-style': 0,
-      'no-inline-comments': 0,
-      'prefer-named-capture-group': 0,
-      'require-unicode-regexp': [
-        'error',
-        {
-          requireFlag: 'v',
-        },
-      ],
-      'unicorn/import-index': 0,
-      'unicorn/no-array-reduce': 0,
-      'unicorn/no-unsafe-regex': 0,
-      'unicorn/prefer-array-some': 0,
-      'unicorn/prevent-abbreviations': 0,
-    },
-  },
-  {
-    ...common,
-    files: [
-      '.ncurc.cjs',
-    ],
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          impliedStrict: false,
-        },
-      },
-      sourceType: 'script',
-    },
-    rules: {
-      'canonical/filename-match-regex': 0,
-      'import/no-commonjs': 0,
-      strict: [
-        'error',
-        'global',
-      ],
-    },
-  },
-  {
-    ...common,
-    files: [
-      'test/**/*.js',
-    ],
-    languageOptions: {
-      ecmaVersion: 'latest',
-      globals: globals.mocha,
-      sourceType: 'module',
-    },
-    rules: {
-      'no-restricted-syntax': 0,
-      'unicorn/prevent-abbreviations': 0,
-    },
-  },
-];

package/pnpm-workspace.yaml DELETED Viewed

@@ -1,3 +0,0 @@
-ignoredBuiltDependencies:
-  - core-js
-  - core-js-pure