npm - eslint-plugin-jsdoc - Versions diffs - 62.6.1 → 62.7.1 - Mend

eslint-plugin-jsdoc 62.6.1 → 62.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

package/dist/cjs/rules/requireJsdoc.d.ts +0 -1
package/dist/iterateJsdoc.cjs +7 -1
package/dist/iterateJsdoc.cjs.map +1 -1
package/dist/rules/checkExamples.cjs +1 -0
package/dist/rules/checkExamples.cjs.map +1 -1
package/dist/rules/checkTagNames.cjs +4 -2
package/dist/rules/checkTagNames.cjs.map +1 -1
package/dist/rules/convertToJsdocComments.cjs +1 -0
package/dist/rules/convertToJsdocComments.cjs.map +1 -1
package/dist/rules/preferImportTag.cjs +43 -16
package/dist/rules/preferImportTag.cjs.map +1 -1
package/dist/rules/requireJsdoc.cjs +1 -1
package/dist/rules/requireJsdoc.cjs.map +1 -1
package/dist/rules/requireJsdoc.d.ts +0 -1
package/dist/rules/requireProperty.cjs +17 -0
package/dist/rules/requireProperty.cjs.map +1 -1
package/dist/rules/requireReturns.cjs +1 -0
package/dist/rules/requireReturns.cjs.map +1 -1
package/package.json +19 -19
package/src/iterateJsdoc.js +8 -1
package/src/rules/checkExamples.js +1 -0
package/src/rules/checkTagNames.js +4 -2
package/src/rules/convertToJsdocComments.js +1 -0
package/src/rules/preferImportTag.js +72 -37
package/src/rules/requireJsdoc.js +1 -1
package/src/rules/requireProperty.js +18 -0
package/src/rules/requireReturns.js +1 -0

package/dist/rules/preferImportTag.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"preferImportTag.cjs","names":["_iterateJsdoc","_interopRequireWildcard","require","_jsdoccomment","_parseImportsExports","_toValidIdentifier","_interopRequireDefault","e","__esModule","default","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","_default","exports","iterateJsdoc","context","indent","jsdoc","settings","sourceCode","utils","mode","enableFixer","exemptTypedefs","outputType","options","allComments","getAllComments","comments","filter","comment","test","value","map","commentNode","commentParserToESTree","parseComment","typedefs","flatMap","doc","tags","tag","isNameOrNamepathDefiningTag","imports","delimiter","iterateInlineImports","potentialType","type","parsedType","tryParseType","parseType","traverse","nde","parentNode","element","currentNode","pathSegments","nodes","extraPathSegments","quotes","propertyOrBrackets","unshift","right","stringify","pathType","undefined","meta","quote","getFixer","name","extrPathSegments","matchingName","toValidIdentifier","node","at","keys","key","length","newNode","shift","left","nameNode","src","source","tokens","unusedPathSegments","findMatchingTypedef","pthSegments","find","typedef","typedefNode","namepathMatch","pathSegment","push","matchingTypedef","reportJSDoc","slice","findMatchingImport","imprt","parsedImport","parseImportsExports","estreeToString","replace","trim","namedImportsModuleSpecifier","namedImports","values","namedImportNames","names","namespaceImports","namespaceImportsDefault","namespaceImportsNamespace","namespace","namespaceImportsModuleSpecifier","lastPathSegment","includes","matchingImport","lastPthSegment","fixer","programNode","ast","commentNodes","getCommentsBefore","insertTextBefore","lstPathSegment","mightHaveTypePosition","tagMightHaveTypePosition","hasTypePosition","Boolean","iterateAllJsdocs","docs","description","url","fixable","schema","additionalProperties","properties","enum","module"],"sources":["../../src/rules/preferImportTag.js"],"sourcesContent":["import iterateJsdoc, {\n parseComment,\n} from '../iterateJsdoc.js';\nimport {\n commentParserToESTree,\n estreeToString,\n // getJSDocComment,\n parse as parseType,\n stringify,\n traverse,\n tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\nimport {\n parseImportsExports,\n} from 'parse-imports-exports';\nimport toValidIdentifier from 'to-valid-identifier';\n\nexport default iterateJsdoc(({\n context,\n indent,\n jsdoc,\n settings,\n sourceCode,\n utils,\n}) => {\n const {\n mode,\n } = settings;\n\n const {\n enableFixer = true,\n exemptTypedefs = true,\n outputType = 'namespaced-import',\n } = context.options[0] \|\| {};\n\n const allComments = sourceCode.getAllComments();\n const comments = allComments\n .filter((comment) => {\n return (/^\\(?!\\)/v).test(comment.value);\n })\n .map((commentNode) => {\n return commentParserToESTree(\n parseComment(commentNode, ''), mode === 'permissive' ? 'typescript' : mode,\n );\n });\n\n const typedefs = comments\n .flatMap((doc) => {\n return doc.tags.filter(({\n tag,\n }) => {\n return utils.isNameOrNamepathDefiningTag(tag);\n });\n });\n\n const imports = comments\n .flatMap((doc) => {\n return doc.tags.filter(({\n tag,\n }) => {\n return tag === 'import';\n });\n }).map((tag) => {\n // Causes problems with stringification otherwise\n tag.delimiter = '';\n return tag;\n });\n\n /*\n @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n /\n const iterateInlineImports = (tag) => {\n const potentialType = tag.type;\n let parsedType;\n try {\n parsedType = mode === 'permissive' ?\n tryParseType(/* @type {string} / (potentialType)) :\n parseType(/* @type {string} / (potentialType), mode);\n } catch {\n return;\n }\n\n traverse(parsedType, (nde, parentNode) => {\n // @ts-expect-error Adding our own property for use below\n nde.parentNode = parentNode;\n });\n\n traverse(parsedType, (nde) => {\n const {\n element,\n type,\n } = /* @type {import('jsdoc-type-pratt-parser').ImportResult} / (nde);\n if (type !== 'JsdocTypeImport') {\n return;\n }\n\n let currentNode = nde;\n\n /* @type {string[]} /\n const pathSegments = [];\n\n /* @type {import('jsdoc-type-pratt-parser').NamePathResult[]} /\n const nodes = [];\n\n /* @type {string[]} /\n const extraPathSegments = [];\n\n /* @type {(import('jsdoc-type-pratt-parser').QuoteStyle\|undefined)[]} /\n const quotes = [];\n\n const propertyOrBrackets = /* @type {import('jsdoc-type-pratt-parser').NamePathResult['pathType'][]} / ([]);\n\n // @ts-expect-error Referencing our own property added above\n while (currentNode && currentNode.parentNode) {\n // @ts-expect-error Referencing our own property added above\n currentNode = currentNode.parentNode;\n / c8 ignore next 3 -- Guard /\n if (currentNode.type !== 'JsdocTypeNamePath') {\n break;\n }\n\n pathSegments.unshift(\n currentNode.right.type === 'JsdocTypeIndexedAccessIndex' ?\n stringify(currentNode.right.right) :\n currentNode.right.value,\n );\n nodes.unshift(currentNode);\n propertyOrBrackets.unshift(currentNode.pathType);\n quotes.unshift(\n currentNode.right.type === 'JsdocTypeIndexedAccessIndex' ?\n undefined :\n currentNode.right.meta.quote,\n );\n }\n\n /\n @param {string} name\n * @param {string[]} extrPathSegments\n /\n const getFixer = (name, extrPathSegments) => {\n const matchingName = toValidIdentifier(name);\n return () => {\n /* @type {import('jsdoc-type-pratt-parser').NamePathResult\|undefined} /\n let node = nodes.at(0);\n if (!node) {\n // Not really a NamePathResult, but will be converted later anyways\n node = /* @type {import('jsdoc-type-pratt-parser').NamePathResult} / (\n /* @type {unknown} /\n (nde)\n );\n }\n\n const keys = /* @type {(keyof import('jsdoc-type-pratt-parser').NamePathResult)[]} / (\n Object.keys(node)\n );\n\n for (const key of keys) {\n delete node[key];\n }\n\n if (extrPathSegments.length) {\n let newNode = /* @type {import('jsdoc-type-pratt-parser').NamePathResult} / (\n /* @type {unknown} /\n (node)\n );\n while (extrPathSegments.length && newNode) {\n newNode.type = 'JsdocTypeNamePath';\n newNode.right = {\n meta: {\n quote: quotes.shift(),\n },\n type: 'JsdocTypeProperty',\n value: /* @type {string} / (extrPathSegments.shift()),\n };\n\n newNode.pathType = /* @type {import('jsdoc-type-pratt-parser').NamePathResult['pathType']} / (\n propertyOrBrackets.shift()\n );\n // @ts-expect-error Temporary\n newNode.left = {};\n newNode = /* @type {import('jsdoc-type-pratt-parser').NamePathResult} / (\n newNode.left\n );\n }\n\n const nameNode = /* @type {import('jsdoc-type-pratt-parser').NameResult} / (\n /* @type {unknown} /\n (newNode)\n );\n nameNode.type = 'JsdocTypeName';\n nameNode.value = matchingName;\n } else {\n const newNode = /* @type {import('jsdoc-type-pratt-parser').NameResult} / (\n /* @type {unknown} /\n (node)\n );\n newNode.type = 'JsdocTypeName';\n newNode.value = matchingName;\n }\n\n for (const src of tag.source) {\n if (src.tokens.type) {\n src.tokens.type = `{${stringify(parsedType)}}`;\n break;\n }\n }\n };\n };\n\n /* @type {string[]} /\n let unusedPathSegments = [];\n\n const findMatchingTypedef = () => {\n // Don't want typedefs to find themselves\n if (!exemptTypedefs) {\n return undefined;\n }\n\n const pthSegments = [\n ...pathSegments,\n ];\n return typedefs.find((typedef) => {\n let typedefNode = typedef.parsedType;\n let namepathMatch;\n while (typedefNode && typedefNode.type === 'JsdocTypeNamePath') {\n const pathSegment = pthSegments.shift();\n if (!pathSegment) {\n namepathMatch = false;\n break;\n }\n\n if (\n (typedefNode.right.type === 'JsdocTypeIndexedAccessIndex' &&\n stringify(typedefNode.right.right) !== pathSegment) \|\|\n (typedefNode.right.type !== 'JsdocTypeIndexedAccessIndex' &&\n typedefNode.right.value !== pathSegment)\n ) {\n if (namepathMatch === true) {\n // It stopped matching, so stop\n break;\n }\n\n extraPathSegments.push(pathSegment);\n namepathMatch = false;\n continue;\n }\n\n namepathMatch = true;\n\n unusedPathSegments = pthSegments;\n\n typedefNode = typedefNode.left;\n }\n\n return namepathMatch &&\n // `import('eslint')` matches\n typedefNode &&\n typedefNode.type === 'JsdocTypeImport' &&\n typedefNode.element.value === element.value;\n });\n };\n\n // Check @typedef's first as should be longest match, allowing\n // for shorter abbreviations\n const matchingTypedef = findMatchingTypedef();\n if (matchingTypedef) {\n utils.reportJSDoc(\n 'Inline `import()` found; using `@typedef`',\n tag,\n enableFixer ? getFixer(matchingTypedef.name, [\n ...extraPathSegments,\n ...unusedPathSegments.slice(-1),\n ...unusedPathSegments.slice(0, -1),\n ]) : null,\n );\n return;\n }\n\n const findMatchingImport = () => {\n for (const imprt of imports) {\n const parsedImport = parseImportsExports(\n estreeToString(imprt).replace(/^\\s@/v, '').trim(),\n );\n\n const namedImportsModuleSpecifier = Object.keys(parsedImport.namedImports \|\| {})[0];\n\n const namedImports = Object.values(parsedImport.namedImports \|\| {})[0]?.[0];\n const namedImportNames = (namedImports && namedImports.names && Object.keys(namedImports.names)) ?? [];\n\n const namespaceImports = Object.values(parsedImport.namespaceImports \|\| {})[0]?.[0];\n\n const namespaceImportsDefault = namespaceImports && namespaceImports.default;\n const namespaceImportsNamespace = namespaceImports && namespaceImports.namespace;\n const namespaceImportsModuleSpecifier = Object.keys(parsedImport.namespaceImports \|\| {})[0];\n\n const lastPathSegment = pathSegments.at(-1);\n\n if (\n (namespaceImportsDefault &&\n namespaceImportsModuleSpecifier === element.value) \|\|\n (element.value === namedImportsModuleSpecifier && (\n (lastPathSegment && namedImportNames.includes(lastPathSegment)) \|\|\n lastPathSegment === 'default'\n )) \|\|\n (namespaceImportsNamespace &&\n namespaceImportsModuleSpecifier === element.value)\n ) {\n return {\n namedImportNames,\n namedImports,\n namedImportsModuleSpecifier,\n namespaceImports,\n namespaceImportsDefault,\n namespaceImportsModuleSpecifier,\n namespaceImportsNamespace,\n };\n }\n }\n\n return undefined;\n };\n\n const matchingImport = findMatchingImport();\n if (matchingImport) {\n const {\n namedImportNames,\n namedImports,\n namedImportsModuleSpecifier,\n namespaceImportsNamespace,\n } = matchingImport;\n if (!namedImportNames.length && namedImportsModuleSpecifier && namedImports.default) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? getFixer(namedImports.default, []) : null,\n );\n return;\n }\n\n const lastPthSegment = pathSegments.at(-1);\n if (lastPthSegment && namedImportNames.includes(lastPthSegment)) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? getFixer(lastPthSegment, pathSegments.slice(0, -1)) : null,\n );\n return;\n }\n\n if (namespaceImportsNamespace) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? getFixer(namespaceImportsNamespace, [\n ...pathSegments,\n ]) : null,\n );\n return;\n }\n }\n\n if (!pathSegments.length) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? (fixer) => {\n getFixer(element.value, [])();\n\n const programNode = sourceCode.ast;\n const commentNodes = sourceCode.getCommentsBefore(programNode);\n return fixer.insertTextBefore(\n // @ts-expect-error Ok\n commentNodes[0] ?? programNode,\n `/** @import * as ${toValidIdentifier(element.value)} from '${element.value}'; /${\n commentNodes[0] ? '\\n' + indent : ''\n }`,\n );\n } : null,\n );\n return;\n }\n\n const lstPathSegment = pathSegments.at(-1);\n if (lstPathSegment && lstPathSegment === 'default') {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? (fixer) => {\n getFixer(element.value, [])();\n\n const programNode = sourceCode.ast;\n const commentNodes = sourceCode.getCommentsBefore(programNode);\n\n return fixer.insertTextBefore(\n // @ts-expect-error Ok\n commentNodes[0] ?? programNode,\n `/* @import ${element.value} from '${element.value}'; /${\n commentNodes[0] ? '\\n' + indent : ''\n }`,\n );\n } : null,\n );\n return;\n }\n\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? (fixer) => {\n if (outputType === 'namespaced-import') {\n getFixer(element.value, [\n ...pathSegments,\n ])();\n } else {\n getFixer(\n /* @type {string} / (pathSegments.at(-1)),\n pathSegments.slice(0, -1),\n )();\n }\n\n const programNode = sourceCode.ast;\n const commentNodes = sourceCode.getCommentsBefore(programNode);\n return fixer.insertTextBefore(\n // @ts-expect-error Ok\n commentNodes[0] ?? programNode,\n outputType === 'namespaced-import' ?\n `/* @import * as ${toValidIdentifier(element.value)} from '${element.value}'; /${\n commentNodes[0] ? '\\n' + indent : ''\n }` :\n `/* @import { ${toValidIdentifier(\n /* c8 ignore next -- TS /\n pathSegments.at(-1) ?? '',\n )} } from '${element.value}'; /${\n commentNodes[0] ? '\\n' + indent : ''\n }`,\n );\n } : null,\n );\n });\n };\n\n for (const tag of jsdoc.tags) {\n const mightHaveTypePosition = utils.tagMightHaveTypePosition(tag.tag);\n const hasTypePosition = mightHaveTypePosition === true && Boolean(tag.type);\n if (hasTypePosition && (!exemptTypedefs \|\| !utils.isNameOrNamepathDefiningTag(tag.tag))) {\n iterateInlineImports(tag);\n }\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Prefer `@import` tags to inline `import()` statements.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/prefer-import-tag.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n enableFixer: {\n description: 'Whether or not to enable the fixer to add `@import` tags.',\n type: 'boolean',\n },\n exemptTypedefs: {\n description: 'Whether to allow `import()` statements within `@typedef`',\n type: 'boolean',\n },\n\n // We might add `typedef` and `typedef-local-only`, but also raises\n // question of how deep the generated typedef should be\n outputType: {\n description: 'What kind of `@import` to generate when no matching `@typedef` or `@import` is found',\n enum: [\n 'named-import',\n 'namespaced-import',\n ],\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,uBAAA,CAAAC,OAAA;AAGA,IAAAC,aAAA,GAAAD,OAAA;AASA,IAAAE,oBAAA,GAAAF,OAAA;AAGA,IAAAG,kBAAA,GAAAC,sBAAA,CAAAJ,OAAA;AAAoD,SAAAI,uBAAAC,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAN,wBAAAM,CAAA,EAAAG,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAV,uBAAA,YAAAA,CAAAM,CAAA,EAAAG,CAAA,SAAAA,CAAA,IAAAH,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAO,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAR,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAS,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAX,CAAA,UAAAO,CAAA,CAAAK,GAAA,CAAAZ,CAAA,GAAAO,CAAA,CAAAM,GAAA,CAAAb,CAAA,EAAAS,CAAA,gBAAAN,CAAA,IAAAH,CAAA,gBAAAG,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAG,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAG,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAH,CAAA,CAAAG,CAAA,WAAAM,CAAA,KAAAT,CAAA,EAAAG,CAAA;AAAA,IAAAgB,QAAA,GAAAC,OAAA,CAAAlB,OAAA,GAErC,IAAAmB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,MAAM;EACNC,KAAK;EACLC,QAAQ;EACRC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC;EACF,CAAC,GAAGH,QAAQ;EAEZ,MAAM;IACJI,WAAW,GAAG,IAAI;IAClBC,cAAc,GAAG,IAAI;IACrBC,UAAU,GAAG;EACf,CAAC,GAAGT,OAAO,CAACU,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAMC,WAAW,GAAGP,UAAU,CAACQ,cAAc,CAAC,CAAC;EAC/C,MAAMC,QAAQ,GAAGF,WAAW,CACzBG,MAAM,CAAEC,OAAO,IAAK;IACnB,OAAQ,YAAY,CAAEC,IAAI,CAACD,OAAO,CAACE,KAAK,CAAC;EAC3C,CAAC,CAAC,CACDC,GAAG,CAAEC,WAAW,IAAK;IACpB,OAAO,IAAAC,mCAAqB,EAC1B,IAAAC,0BAAY,EAACF,WAAW,EAAE,EAAE,CAAC,EAAEb,IAAI,KAAK,YAAY,GAAG,YAAY,GAAGA,IACxE,CAAC;EACH,CAAC,CAAC;EAEJ,MAAMgB,QAAQ,GAAGT,QAAQ,CACtBU,OAAO,CAAEC,GAAG,IAAK;IAChB,OAAOA,GAAG,CAACC,IAAI,CAACX,MAAM,CAAC,CAAC;MACtBY;IACF,CAAC,KAAK;MACJ,OAAOrB,KAAK,CAACsB,2BAA2B,CAACD,GAAG,CAAC;IAC/C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEJ,MAAME,OAAO,GAAGf,QAAQ,CACrBU,OAAO,CAAEC,GAAG,IAAK;IAChB,OAAOA,GAAG,CAACC,IAAI,CAACX,MAAM,CAAC,CAAC;MACtBY;IACF,CAAC,KAAK;MACJ,OAAOA,GAAG,KAAK,QAAQ;IACzB,CAAC,CAAC;EACJ,CAAC,CAAC,CAACR,GAAG,CAAEQ,GAAG,IAAK;IACd;IACAA,GAAG,CAACG,SAAS,GAAG,EAAE;IAClB,OAAOH,GAAG;EACZ,CAAC,CAAC;;EAEJ;AACF;AACA;EACE,MAAMI,oBAAoB,GAAIJ,GAAG,IAAK;IACpC,MAAMK,aAAa,GAAGL,GAAG,CAACM,IAAI;IAC9B,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAG3B,IAAI,KAAK,YAAY,GAChC,IAAA4B,sBAAY,EAAC,qBAAuBH,aAAc,CAAC,GACnD,IAAAI,mBAAS,EAAC,qBAAuBJ,aAAa,EAAGzB,IAAI,CAAC;IAC1D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAA8B,sBAAQ,EAACH,UAAU,EAAE,CAACI,GAAG,EAAEC,UAAU,KAAK;MACxC;MACAD,GAAG,CAACC,UAAU,GAAGA,UAAU;IAC7B,CAAC,CAAC;IAEF,IAAAF,sBAAQ,EAACH,UAAU,EAAGI,GAAG,IAAK;MAC5B,MAAM;QACJE,OAAO;QACPP;MACF,CAAC,GAAG,6DAA+DK,GAAI;MACvE,IAAIL,IAAI,KAAK,iBAAiB,EAAE;QAC9B;MACF;MAEA,IAAIQ,WAAW,GAAGH,GAAG;;MAErB;MACA,MAAMI,YAAY,GAAG,EAAE;;MAEvB;MACA,MAAMC,KAAK,GAAG,EAAE;;MAEhB;MACA,MAAMC,iBAAiB,GAAG,EAAE;;MAE5B;MACA,MAAMC,MAAM,GAAG,EAAE;MAEjB,MAAMC,kBAAkB,GAAG,6EAA+E,EAAG;;MAE7G;MACA,OAAOL,WAAW,IAAIA,WAAW,CAACF,UAAU,EAAE;QAC5C;QACAE,WAAW,GAAGA,WAAW,CAACF,UAAU;QACpC;QACA,IAAIE,WAAW,CAACR,IAAI,KAAK,mBAAmB,EAAE;UAC5C;QACF;QAEAS,YAAY,CAACK,OAAO,CAClBN,WAAW,CAACO,KAAK,CAACf,IAAI,KAAK,6BAA6B,GACtD,IAAAgB,uBAAS,EAACR,WAAW,CAACO,KAAK,CAACA,KAAK,CAAC,GAClCP,WAAW,CAACO,KAAK,CAAC9B,KACtB,CAAC;QACDyB,KAAK,CAACI,OAAO,CAACN,WAAW,CAAC;QAC1BK,kBAAkB,CAACC,OAAO,CAACN,WAAW,CAACS,QAAQ,CAAC;QAChDL,MAAM,CAACE,OAAO,CACZN,WAAW,CAACO,KAAK,CAACf,IAAI,KAAK,6BAA6B,GACtDkB,SAAS,GACTV,WAAW,CAACO,KAAK,CAACI,IAAI,CAACC,KAC3B,CAAC;MACH;;MAEA;AACN;AACA;AACA;MACM,MAAMC,QAAQ,GAAGA,CAACC,IAAI,EAAEC,gBAAgB,KAAK;QAC3C,MAAMC,YAAY,GAAG,IAAAC,0BAAiB,EAACH,IAAI,CAAC;QAC5C,OAAO,MAAM;UACX;UACA,IAAII,IAAI,GAAGhB,KAAK,CAACiB,EAAE,CAAC,CAAC,CAAC;UACtB,IAAI,CAACD,IAAI,EAAE;YACT;YACAA,IAAI,GAAG;YACL;YACCrB,GACF;UACH;UAEA,MAAMuB,IAAI,GAAG;UACXlE,MAAM,CAACkE,IAAI,CAACF,IAAI,CACjB;UAED,KAAK,MAAMG,GAAG,IAAID,IAAI,EAAE;YACtB,OAAOF,IAAI,CAACG,GAAG,CAAC;UAClB;UAEA,IAAIN,gBAAgB,CAACO,MAAM,EAAE;YAC3B,IAAIC,OAAO,GAAG;YACZ;YACCL,IACF;YACD,OAAOH,gBAAgB,CAACO,MAAM,IAAIC,OAAO,EAAE;cACzCA,OAAO,CAAC/B,IAAI,GAAG,mBAAmB;cAClC+B,OAAO,CAAChB,KAAK,GAAG;gBACdI,IAAI,EAAE;kBACJC,KAAK,EAAER,MAAM,CAACoB,KAAK,CAAC;gBACtB,CAAC;gBACDhC,IAAI,EAAE,mBAAmB;gBACzBf,KAAK,GAAE,qBAAuBsC,gBAAgB,CAACS,KAAK,CAAC,CAAC;cACxD,CAAC;cAEDD,OAAO,CAACd,QAAQ,GAAG;cACjBJ,kBAAkB,CAACmB,KAAK,CAAC,CAC1B;cACD;cACAD,OAAO,CAACE,IAAI,GAAG,CAAC,CAAC;cACjBF,OAAO,GAAG;cACRA,OAAO,CAACE,IACT;YACH;YAEA,MAAMC,QAAQ,GAAG;YACf;YACCH,OACF;YACDG,QAAQ,CAAClC,IAAI,GAAG,eAAe;YAC/BkC,QAAQ,CAACjD,KAAK,GAAGuC,YAAY;UAC/B,CAAC,MAAM;YACL,MAAMO,OAAO,GAAG;YACd;YACCL,IACF;YACDK,OAAO,CAAC/B,IAAI,GAAG,eAAe;YAC9B+B,OAAO,CAAC9C,KAAK,GAAGuC,YAAY;UAC9B;UAEA,KAAK,MAAMW,GAAG,IAAIzC,GAAG,CAAC0C,MAAM,EAAE;YAC5B,IAAID,GAAG,CAACE,MAAM,CAACrC,IAAI,EAAE;cACnBmC,GAAG,CAACE,MAAM,CAACrC,IAAI,GAAG,IAAI,IAAAgB,uBAAS,EAACf,UAAU,CAAC,GAAG;cAC9C;YACF;UACF;QACF,CAAC;MACH,CAAC;;MAED;MACA,IAAIqC,kBAAkB,GAAG,EAAE;MAE3B,MAAMC,mBAAmB,GAAGA,CAAA,KAAM;QAChC;QACA,IAAI,CAAC/D,cAAc,EAAE;UACnB,OAAO0C,SAAS;QAClB;QAEA,MAAMsB,WAAW,GAAG,CAClB,GAAG/B,YAAY,CAChB;QACD,OAAOnB,QAAQ,CAACmD,IAAI,CAAEC,OAAO,IAAK;UAChC,IAAIC,WAAW,GAAGD,OAAO,CAACzC,UAAU;UACpC,IAAI2C,aAAa;UACjB,OAAOD,WAAW,IAAIA,WAAW,CAAC3C,IAAI,KAAK,mBAAmB,EAAE;YAC9D,MAAM6C,WAAW,GAAGL,WAAW,CAACR,KAAK,CAAC,CAAC;YACvC,IAAI,CAACa,WAAW,EAAE;cAChBD,aAAa,GAAG,KAAK;cACrB;YACF;YAEA,IACGD,WAAW,CAAC5B,KAAK,CAACf,IAAI,KAAK,6BAA6B,IACvD,IAAAgB,uBAAS,EAAC2B,WAAW,CAAC5B,KAAK,CAACA,KAAK,CAAC,KAAK8B,WAAW,IACnDF,WAAW,CAAC5B,KAAK,CAACf,IAAI,KAAK,6BAA6B,IACvD2C,WAAW,CAAC5B,KAAK,CAAC9B,KAAK,KAAK4D,WAAY,EAC1C;cACA,IAAID,aAAa,KAAK,IAAI,EAAE;gBAC1B;gBACA;cACF;cAEAjC,iBAAiB,CAACmC,IAAI,CAACD,WAAW,CAAC;cACnCD,aAAa,GAAG,KAAK;cACrB;YACF;YAEAA,aAAa,GAAG,IAAI;YAEpBN,kBAAkB,GAAGE,WAAW;YAEhCG,WAAW,GAAGA,WAAW,CAACV,IAAI;UAChC;UAEA,OAAOW,aAAa;UAClB;UACAD,WAAW,IACXA,WAAW,CAAC3C,IAAI,KAAK,iBAAiB,IACtC2C,WAAW,CAACpC,OAAO,CAACtB,KAAK,KAAKsB,OAAO,CAACtB,KAAK;QAC/C,CAAC,CAAC;MACJ,CAAC;;MAED;MACA;MACA,MAAM8D,eAAe,GAAGR,mBAAmB,CAAC,CAAC;MAC7C,IAAIQ,eAAe,EAAE;QACnB1E,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAG8C,QAAQ,CAAC0B,eAAe,CAACzB,IAAI,EAAE,CAC3C,GAAGX,iBAAiB,EACpB,GAAG2B,kBAAkB,CAACW,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/B,GAAGX,kBAAkB,CAACW,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACnC,CAAC,GAAG,IACP,CAAC;QACD;MACF;MAEA,MAAMC,kBAAkB,GAAGA,CAAA,KAAM;QAC/B,KAAK,MAAMC,KAAK,IAAIvD,OAAO,EAAE;UAC3B,MAAMwD,YAAY,GAAG,IAAAC,wCAAmB,EACtC,IAAAC,4BAAc,EAACH,KAAK,CAAC,CAACI,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAACC,IAAI,CAAC,CACnD,CAAC;UAED,MAAMC,2BAA2B,GAAG/F,MAAM,CAACkE,IAAI,CAACwB,YAAY,CAACM,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;UAEnF,MAAMA,YAAY,GAAGhG,MAAM,CAACiG,MAAM,CAACP,YAAY,CAACM,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;UAC3E,MAAME,gBAAgB,GAAG,CAACF,YAAY,IAAIA,YAAY,CAACG,KAAK,IAAInG,MAAM,CAACkE,IAAI,CAAC8B,YAAY,CAACG,KAAK,CAAC,KAAK,EAAE;UAEtG,MAAMC,gBAAgB,GAAGpG,MAAM,CAACiG,MAAM,CAACP,YAAY,CAACU,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;UAEnF,MAAMC,uBAAuB,GAAGD,gBAAgB,IAAIA,gBAAgB,CAAClH,OAAO;UAC5E,MAAMoH,yBAAyB,GAAGF,gBAAgB,IAAIA,gBAAgB,CAACG,SAAS;UAChF,MAAMC,+BAA+B,GAAGxG,MAAM,CAACkE,IAAI,CAACwB,YAAY,CAACU,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;UAE3F,MAAMK,eAAe,GAAG1D,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC;UAE3C,IACGoC,uBAAuB,IACpBG,+BAA+B,KAAK3D,OAAO,CAACtB,KAAK,IAClDsB,OAAO,CAACtB,KAAK,KAAKwE,2BAA2B,KAC3CU,eAAe,IAAIP,gBAAgB,CAACQ,QAAQ,CAACD,eAAe,CAAC,IAC9DA,eAAe,KAAK,SAAS,CAC7B,IACDH,yBAAyB,IACxBE,+BAA+B,KAAK3D,OAAO,CAACtB,KAAM,EACtD;YACA,OAAO;cACL2E,gBAAgB;cAChBF,YAAY;cACZD,2BAA2B;cAC3BK,gBAAgB;cAChBC,uBAAuB;cACvBG,+BAA+B;cAC/BF;YACF,CAAC;UACH;QACF;QAEA,OAAO9C,SAAS;MAClB,CAAC;MAED,MAAMmD,cAAc,GAAGnB,kBAAkB,CAAC,CAAC;MAC3C,IAAImB,cAAc,EAAE;QAClB,MAAM;UACJT,gBAAgB;UAChBF,YAAY;UACZD,2BAA2B;UAC3BO;QACF,CAAC,GAAGK,cAAc;QAClB,IAAI,CAACT,gBAAgB,CAAC9B,MAAM,IAAI2B,2BAA2B,IAAIC,YAAY,CAAC9G,OAAO,EAAE;UACnFyB,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAG8C,QAAQ,CAACqC,YAAY,CAAC9G,OAAO,EAAE,EAAE,CAAC,GAAG,IACrD,CAAC;UACD;QACF;QAEA,MAAM0H,cAAc,GAAG7D,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI2C,cAAc,IAAIV,gBAAgB,CAACQ,QAAQ,CAACE,cAAc,CAAC,EAAE;UAC/DjG,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAG8C,QAAQ,CAACiD,cAAc,EAAE7D,YAAY,CAACwC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IACtE,CAAC;UACD;QACF;QAEA,IAAIe,yBAAyB,EAAE;UAC7B3F,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAG8C,QAAQ,CAAC2C,yBAAyB,EAAE,CAChD,GAAGvD,YAAY,CAChB,CAAC,GAAG,IACP,CAAC;UACD;QACF;MACF;MAEA,IAAI,CAACA,YAAY,CAACqB,MAAM,EAAE;QACxBzD,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAIgG,KAAK,IAAK;UACvBlD,QAAQ,CAACd,OAAO,CAACtB,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;UAE7B,MAAMuF,WAAW,GAAGpG,UAAU,CAACqG,GAAG;UAClC,MAAMC,YAAY,GAAGtG,UAAU,CAACuG,iBAAiB,CAACH,WAAW,CAAC;UAC9D,OAAOD,KAAK,CAACK,gBAAgB;UAC3B;UACAF,YAAY,CAAC,CAAC,CAAC,IAAIF,WAAW,EAC9B,oBAAoB,IAAA/C,0BAAiB,EAAClB,OAAO,CAACtB,KAAK,CAAC,UAAUsB,OAAO,CAACtB,KAAK,QACzEyF,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAGzG,MAAM,GAAG,EAAE,EAExC,CAAC;QACH,CAAC,GAAG,IACN,CAAC;QACD;MACF;MAEA,MAAM4G,cAAc,GAAGpE,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC;MAC1C,IAAIkD,cAAc,IAAIA,cAAc,KAAK,SAAS,EAAE;QAClDxG,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAIgG,KAAK,IAAK;UACvBlD,QAAQ,CAACd,OAAO,CAACtB,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;UAE7B,MAAMuF,WAAW,GAAGpG,UAAU,CAACqG,GAAG;UAClC,MAAMC,YAAY,GAAGtG,UAAU,CAACuG,iBAAiB,CAACH,WAAW,CAAC;UAE9D,OAAOD,KAAK,CAACK,gBAAgB;UAC3B;UACAF,YAAY,CAAC,CAAC,CAAC,IAAIF,WAAW,EAC9B,eAAejE,OAAO,CAACtB,KAAK,UAAUsB,OAAO,CAACtB,KAAK,QACjDyF,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAGzG,MAAM,GAAG,EAAE,EAExC,CAAC;QACH,CAAC,GAAG,IACN,CAAC;QACD;MACF;MAEAI,KAAK,CAAC2E,WAAW,CACf,2CAA2C,EAC3CtD,GAAG,EACHnB,WAAW,GAAIgG,KAAK,IAAK;QACvB,IAAI9F,UAAU,KAAK,mBAAmB,EAAE;UACtC4C,QAAQ,CAACd,OAAO,CAACtB,KAAK,EAAE,CACtB,GAAGwB,YAAY,CAChB,CAAC,CAAC,CAAC;QACN,CAAC,MAAM;UACLY,QAAQ,CACN,qBAAuBZ,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC,EAC1ClB,YAAY,CAACwC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAC1B,CAAC,CAAC,CAAC;QACL;QAEA,MAAMuB,WAAW,GAAGpG,UAAU,CAACqG,GAAG;QAClC,MAAMC,YAAY,GAAGtG,UAAU,CAACuG,iBAAiB,CAACH,WAAW,CAAC;QAC9D,OAAOD,KAAK,CAACK,gBAAgB;QAC3B;QACAF,YAAY,CAAC,CAAC,CAAC,IAAIF,WAAW,EAC9B/F,UAAU,KAAK,mBAAmB,GAChC,oBAAoB,IAAAgD,0BAAiB,EAAClB,OAAO,CAACtB,KAAK,CAAC,UAAUsB,OAAO,CAACtB,KAAK,QACzEyF,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAGzG,MAAM,GAAG,EAAE,EACpC,GACF,iBAAiB,IAAAwD,0BAAiB,EAChC;QACAhB,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EACzB,CAAC,YAAYpB,OAAO,CAACtB,KAAK,QACxByF,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAGzG,MAAM,GAAG,EAAE,EAE1C,CAAC;MACH,CAAC,GAAG,IACN,CAAC;IACH,CAAC,CAAC;EACJ,CAAC;EAED,KAAK,MAAMyB,GAAG,IAAIxB,KAAK,CAACuB,IAAI,EAAE;IAC5B,MAAMqF,qBAAqB,GAAGzG,KAAK,CAAC0G,wBAAwB,CAACrF,GAAG,CAACA,GAAG,CAAC;IACrE,MAAMsF,eAAe,GAAGF,qBAAqB,KAAK,IAAI,IAAIG,OAAO,CAACvF,GAAG,CAACM,IAAI,CAAC;IAC3E,IAAIgF,eAAe,KAAK,CAACxG,cAAc,IAAI,CAACH,KAAK,CAACsB,2BAA2B,CAACD,GAAG,CAACA,GAAG,CAAC,CAAC,EAAE;MACvFI,oBAAoB,CAACJ,GAAG,CAAC;IAC3B;EACF;AACF,CAAC,EAAE;EACDwF,gBAAgB,EAAE,IAAI;EACtB/D,IAAI,EAAE;IACJgE,IAAI,EAAE;MACJC,WAAW,EAAE,wDAAwD;MACrEC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVlH,WAAW,EAAE;UACX6G,WAAW,EAAE,2DAA2D;UACxEpF,IAAI,EAAE;QACR,CAAC;QACDxB,cAAc,EAAE;UACd4G,WAAW,EAAE,0DAA0D;UACvEpF,IAAI,EAAE;QACR,CAAC;QAED;QACA;QACAvB,UAAU,EAAE;UACV2G,WAAW,EAAE,sFAAsF;UACnGM,IAAI,EAAE,CACJ,cAAc,EACd,mBAAmB,CACpB;UACD1F,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA2F,MAAA,CAAA7H,OAAA,GAAAA,OAAA,CAAAlB,OAAA","ignoreList":[]}
1	+ {"version":3,"file":"preferImportTag.cjs","names":["_iterateJsdoc","_interopRequireWildcard","require","_jsdoccomment","_eslint","_parseImportsExports","_semver","_interopRequireDefault","_toValidIdentifier","e","__esModule","default","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","_default","exports","iterateJsdoc","context","indent","jsdoc","settings","sourceCode","utils","mode","enableFixer","exemptTypedefs","outputType","options","allComments","getAllComments","comments","filter","comment","test","value","map","commentNode","commentParserToESTree","parseComment","typedefs","flatMap","doc","tags","tag","isNameOrNamepathDefiningTag","imports","delimiter","createImportInserter","importText","fixer","programNode","ast","commentNodes","getCommentsBefore","insertTextBefore","semver","lt","Linter","version","sourceText","getText","hasCode","body","length","leadingMatch","match","leading","replaceTextRange","slice","startsWithNewline","iterateInlineImports","potentialType","type","parsedType","tryParseType","parseType","traverse","nde","parentNode","element","currentNode","pathSegments","nodes","extraPathSegments","quotes","propertyOrBrackets","unshift","right","stringify","pathType","undefined","meta","quote","getFixer","name","extrPathSegments","matchingName","toValidIdentifier","node","at","keys","key","newNode","shift","left","nameNode","src","source","tokens","unusedPathSegments","findMatchingTypedef","pthSegments","find","typedef","typedefNode","namepathMatch","pathSegment","push","matchingTypedef","reportJSDoc","findMatchingImport","imprt","parsedImport","parseImportsExports","estreeToString","replace","trim","namedImportsModuleSpecifier","namedImports","values","namedImportNames","names","namespaceImports","namespaceImportsDefault","namespaceImportsNamespace","namespace","namespaceImportsModuleSpecifier","lastPathSegment","includes","matchingImport","lastPthSegment","lstPathSegment","mightHaveTypePosition","tagMightHaveTypePosition","hasTypePosition","Boolean","iterateAllJsdocs","docs","description","url","fixable","schema","additionalProperties","properties","enum","module"],"sources":["../../src/rules/preferImportTag.js"],"sourcesContent":["import iterateJsdoc, {\n parseComment,\n} from '../iterateJsdoc.js';\nimport {\n commentParserToESTree,\n estreeToString,\n // getJSDocComment,\n parse as parseType,\n stringify,\n traverse,\n tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\nimport {\n Linter,\n} from 'eslint';\nimport {\n parseImportsExports,\n} from 'parse-imports-exports';\nimport semver from 'semver';\nimport toValidIdentifier from 'to-valid-identifier';\n\nexport default iterateJsdoc(({\n context,\n indent,\n jsdoc,\n settings,\n sourceCode,\n utils,\n}) => {\n const {\n mode,\n } = settings;\n\n const {\n enableFixer = true,\n exemptTypedefs = true,\n outputType = 'namespaced-import',\n } = context.options[0] \|\| {};\n\n const allComments = sourceCode.getAllComments();\n const comments = allComments\n .filter((comment) => {\n return (/^\\(?!\\)/v).test(comment.value);\n })\n .map((commentNode) => {\n return commentParserToESTree(\n parseComment(commentNode, ''), mode === 'permissive' ? 'typescript' : mode,\n );\n });\n\n const typedefs = comments\n .flatMap((doc) => {\n return doc.tags.filter(({\n tag,\n }) => {\n return utils.isNameOrNamepathDefiningTag(tag);\n });\n });\n\n const imports = comments\n .flatMap((doc) => {\n return doc.tags.filter(({\n tag,\n }) => {\n return tag === 'import';\n });\n }).map((tag) => {\n // Causes problems with stringification otherwise\n tag.delimiter = '';\n return tag;\n });\n\n /*\n Helper to insert an import statement at the top of the file.\n * @param {string} importText - The import statement text (without newline)\n * @returns {((fixer: import('eslint').Rule.RuleFixer) => import('eslint').Rule.Fix\|void)} - Fixer function for ESLint\n /\n const createImportInserter = (importText) => {\n return (fixer) => {\n const programNode = sourceCode.ast;\n const commentNodes = sourceCode.getCommentsBefore(programNode);\n\n / c8 ignore start -- ESLint < 10 /\n if (commentNodes[0]) {\n return fixer.insertTextBefore(\n // @ts-expect-error - Comment is compatible with Node in practice\n commentNodes[0],\n `${importText}\\n${indent}`,\n );\n }\n\n // For ESLint < 10, use the simple approach of inserting before programNode\n if (semver.lt(Linter.version, '10.0.0')) {\n return fixer.insertTextBefore(\n programNode,\n importText,\n );\n }\n\n // For ESLint 10+, handle the changed Program node range\n const sourceText = sourceCode.getText();\n const hasCode = programNode.body && programNode.body.length > 0;\n const leadingMatch = hasCode ? sourceText.match(/^(\\n[ \\t])/v) : null;\n if (leadingMatch) {\n const leading = leadingMatch[1];\n return fixer.replaceTextRange(\n [\n leading.length, leading.length,\n ],\n `${importText}\\n${leading.slice(1)}`,\n );\n }\n\n const startsWithNewline = sourceText[0] === '\\n';\n return fixer.replaceTextRange(\n startsWithNewline ? [\n 0, 1,\n ] : [\n 0, 0,\n ],\n `${importText}\\n`,\n );\n /* c8 ignore end -- ESLint < 10 /\n };\n };\n\n /\n @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n /\n const iterateInlineImports = (tag) => {\n const potentialType = tag.type;\n let parsedType;\n try {\n parsedType = mode === 'permissive' ?\n tryParseType(/* @type {string} / (potentialType)) :\n parseType(/* @type {string} / (potentialType), mode);\n } catch {\n return;\n }\n\n traverse(parsedType, (nde, parentNode) => {\n // @ts-expect-error Adding our own property for use below\n nde.parentNode = parentNode;\n });\n\n traverse(parsedType, (nde) => {\n const {\n element,\n type,\n } = /* @type {import('jsdoc-type-pratt-parser').ImportResult} / (nde);\n if (type !== 'JsdocTypeImport') {\n return;\n }\n\n let currentNode = nde;\n\n /* @type {string[]} /\n const pathSegments = [];\n\n /* @type {import('jsdoc-type-pratt-parser').NamePathResult[]} /\n const nodes = [];\n\n /* @type {string[]} /\n const extraPathSegments = [];\n\n /* @type {(import('jsdoc-type-pratt-parser').QuoteStyle\|undefined)[]} /\n const quotes = [];\n\n const propertyOrBrackets = /* @type {import('jsdoc-type-pratt-parser').NamePathResult['pathType'][]} / ([]);\n\n // @ts-expect-error Referencing our own property added above\n while (currentNode && currentNode.parentNode) {\n // @ts-expect-error Referencing our own property added above\n currentNode = currentNode.parentNode;\n / c8 ignore next 3 -- Guard /\n if (currentNode.type !== 'JsdocTypeNamePath') {\n break;\n }\n\n pathSegments.unshift(\n currentNode.right.type === 'JsdocTypeIndexedAccessIndex' ?\n stringify(currentNode.right.right) :\n currentNode.right.value,\n );\n nodes.unshift(currentNode);\n propertyOrBrackets.unshift(currentNode.pathType);\n quotes.unshift(\n currentNode.right.type === 'JsdocTypeIndexedAccessIndex' ?\n undefined :\n currentNode.right.meta.quote,\n );\n }\n\n /\n @param {string} name\n * @param {string[]} extrPathSegments\n /\n const getFixer = (name, extrPathSegments) => {\n const matchingName = toValidIdentifier(name);\n return () => {\n /* @type {import('jsdoc-type-pratt-parser').NamePathResult\|undefined} /\n let node = nodes.at(0);\n if (!node) {\n // Not really a NamePathResult, but will be converted later anyways\n node = /* @type {import('jsdoc-type-pratt-parser').NamePathResult} / (\n /* @type {unknown} /\n (nde)\n );\n }\n\n const keys = /* @type {(keyof import('jsdoc-type-pratt-parser').NamePathResult)[]} / (\n Object.keys(node)\n );\n\n for (const key of keys) {\n delete node[key];\n }\n\n if (extrPathSegments.length) {\n let newNode = /* @type {import('jsdoc-type-pratt-parser').NamePathResult} / (\n /* @type {unknown} /\n (node)\n );\n while (extrPathSegments.length && newNode) {\n newNode.type = 'JsdocTypeNamePath';\n newNode.right = {\n meta: {\n quote: quotes.shift(),\n },\n type: 'JsdocTypeProperty',\n value: /* @type {string} / (extrPathSegments.shift()),\n };\n\n newNode.pathType = /* @type {import('jsdoc-type-pratt-parser').NamePathResult['pathType']} / (\n propertyOrBrackets.shift()\n );\n // @ts-expect-error Temporary\n newNode.left = {};\n newNode = /* @type {import('jsdoc-type-pratt-parser').NamePathResult} / (\n newNode.left\n );\n }\n\n const nameNode = /* @type {import('jsdoc-type-pratt-parser').NameResult} / (\n /* @type {unknown} /\n (newNode)\n );\n nameNode.type = 'JsdocTypeName';\n nameNode.value = matchingName;\n } else {\n const newNode = /* @type {import('jsdoc-type-pratt-parser').NameResult} / (\n /* @type {unknown} /\n (node)\n );\n newNode.type = 'JsdocTypeName';\n newNode.value = matchingName;\n }\n\n for (const src of tag.source) {\n if (src.tokens.type) {\n src.tokens.type = `{${stringify(parsedType)}}`;\n break;\n }\n }\n };\n };\n\n /* @type {string[]} /\n let unusedPathSegments = [];\n\n const findMatchingTypedef = () => {\n // Don't want typedefs to find themselves\n if (!exemptTypedefs) {\n return undefined;\n }\n\n const pthSegments = [\n ...pathSegments,\n ];\n return typedefs.find((typedef) => {\n let typedefNode = typedef.parsedType;\n let namepathMatch;\n while (typedefNode && typedefNode.type === 'JsdocTypeNamePath') {\n const pathSegment = pthSegments.shift();\n if (!pathSegment) {\n namepathMatch = false;\n break;\n }\n\n if (\n (typedefNode.right.type === 'JsdocTypeIndexedAccessIndex' &&\n stringify(typedefNode.right.right) !== pathSegment) \|\|\n (typedefNode.right.type !== 'JsdocTypeIndexedAccessIndex' &&\n typedefNode.right.value !== pathSegment)\n ) {\n if (namepathMatch === true) {\n // It stopped matching, so stop\n break;\n }\n\n extraPathSegments.push(pathSegment);\n namepathMatch = false;\n continue;\n }\n\n namepathMatch = true;\n\n unusedPathSegments = pthSegments;\n\n typedefNode = typedefNode.left;\n }\n\n return namepathMatch &&\n // `import('eslint')` matches\n typedefNode &&\n typedefNode.type === 'JsdocTypeImport' &&\n typedefNode.element.value === element.value;\n });\n };\n\n // Check @typedef's first as should be longest match, allowing\n // for shorter abbreviations\n const matchingTypedef = findMatchingTypedef();\n if (matchingTypedef) {\n utils.reportJSDoc(\n 'Inline `import()` found; using `@typedef`',\n tag,\n enableFixer ? getFixer(matchingTypedef.name, [\n ...extraPathSegments,\n ...unusedPathSegments.slice(-1),\n ...unusedPathSegments.slice(0, -1),\n ]) : null,\n );\n return;\n }\n\n const findMatchingImport = () => {\n for (const imprt of imports) {\n const parsedImport = parseImportsExports(\n estreeToString(imprt).replace(/^\\s@/v, '').trim(),\n );\n\n const namedImportsModuleSpecifier = Object.keys(parsedImport.namedImports \|\| {})[0];\n\n const namedImports = Object.values(parsedImport.namedImports \|\| {})[0]?.[0];\n const namedImportNames = (namedImports && namedImports.names && Object.keys(namedImports.names)) ?? [];\n\n const namespaceImports = Object.values(parsedImport.namespaceImports \|\| {})[0]?.[0];\n\n const namespaceImportsDefault = namespaceImports && namespaceImports.default;\n const namespaceImportsNamespace = namespaceImports && namespaceImports.namespace;\n const namespaceImportsModuleSpecifier = Object.keys(parsedImport.namespaceImports \|\| {})[0];\n\n const lastPathSegment = pathSegments.at(-1);\n\n if (\n (namespaceImportsDefault &&\n namespaceImportsModuleSpecifier === element.value) \|\|\n (element.value === namedImportsModuleSpecifier && (\n (lastPathSegment && namedImportNames.includes(lastPathSegment)) \|\|\n lastPathSegment === 'default'\n )) \|\|\n (namespaceImportsNamespace &&\n namespaceImportsModuleSpecifier === element.value)\n ) {\n return {\n namedImportNames,\n namedImports,\n namedImportsModuleSpecifier,\n namespaceImports,\n namespaceImportsDefault,\n namespaceImportsModuleSpecifier,\n namespaceImportsNamespace,\n };\n }\n }\n\n return undefined;\n };\n\n const matchingImport = findMatchingImport();\n if (matchingImport) {\n const {\n namedImportNames,\n namedImports,\n namedImportsModuleSpecifier,\n namespaceImportsNamespace,\n } = matchingImport;\n if (!namedImportNames.length && namedImportsModuleSpecifier && namedImports.default) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? getFixer(namedImports.default, []) : null,\n );\n return;\n }\n\n const lastPthSegment = pathSegments.at(-1);\n if (lastPthSegment && namedImportNames.includes(lastPthSegment)) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? getFixer(lastPthSegment, pathSegments.slice(0, -1)) : null,\n );\n return;\n }\n\n if (namespaceImportsNamespace) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? getFixer(namespaceImportsNamespace, [\n ...pathSegments,\n ]) : null,\n );\n return;\n }\n }\n\n if (!pathSegments.length) {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? (fixer) => {\n getFixer(element.value, [])();\n return createImportInserter(\n `/** @import * as ${toValidIdentifier(element.value)} from '${element.value}'; /`,\n )(fixer);\n } : null,\n );\n return;\n }\n\n const lstPathSegment = pathSegments.at(-1);\n if (lstPathSegment && lstPathSegment === 'default') {\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? (fixer) => {\n getFixer(element.value, [])();\n return createImportInserter(\n `/* @import ${element.value} from '${element.value}'; /`,\n )(fixer);\n } : null,\n );\n return;\n }\n\n utils.reportJSDoc(\n 'Inline `import()` found; prefer `@import`',\n tag,\n enableFixer ? (fixer) => {\n if (outputType === 'namespaced-import') {\n getFixer(element.value, [\n ...pathSegments,\n ])();\n } else {\n getFixer(\n /* @type {string} / (pathSegments.at(-1)),\n pathSegments.slice(0, -1),\n )();\n }\n\n const importText = outputType === 'namespaced-import' ?\n `/* @import * as ${toValidIdentifier(element.value)} from '${element.value}'; /` :\n `/* @import { ${toValidIdentifier(\n /* c8 ignore next -- TS /\n pathSegments.at(-1) ?? '',\n )} } from '${element.value}'; /`;\n\n return createImportInserter(importText)(fixer);\n } : null,\n );\n });\n };\n\n for (const tag of jsdoc.tags) {\n const mightHaveTypePosition = utils.tagMightHaveTypePosition(tag.tag);\n const hasTypePosition = mightHaveTypePosition === true && Boolean(tag.type);\n if (hasTypePosition && (!exemptTypedefs \|\| !utils.isNameOrNamepathDefiningTag(tag.tag))) {\n iterateInlineImports(tag);\n }\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Prefer `@import` tags to inline `import()` statements.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/prefer-import-tag.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n enableFixer: {\n description: 'Whether or not to enable the fixer to add `@import` tags.',\n type: 'boolean',\n },\n exemptTypedefs: {\n description: 'Whether to allow `import()` statements within `@typedef`',\n type: 'boolean',\n },\n\n // We might add `typedef` and `typedef-local-only`, but also raises\n // question of how deep the generated typedef should be\n outputType: {\n description: 'What kind of `@import` to generate when no matching `@typedef` or `@import` is found',\n enum: [\n 'named-import',\n 'namespaced-import',\n ],\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,uBAAA,CAAAC,OAAA;AAGA,IAAAC,aAAA,GAAAD,OAAA;AASA,IAAAE,OAAA,GAAAF,OAAA;AAGA,IAAAG,oBAAA,GAAAH,OAAA;AAGA,IAAAI,OAAA,GAAAC,sBAAA,CAAAL,OAAA;AACA,IAAAM,kBAAA,GAAAD,sBAAA,CAAAL,OAAA;AAAoD,SAAAK,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAR,wBAAAQ,CAAA,EAAAG,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAZ,uBAAA,YAAAA,CAAAQ,CAAA,EAAAG,CAAA,SAAAA,CAAA,IAAAH,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAO,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAR,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAS,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAX,CAAA,UAAAO,CAAA,CAAAK,GAAA,CAAAZ,CAAA,GAAAO,CAAA,CAAAM,GAAA,CAAAb,CAAA,EAAAS,CAAA,gBAAAN,CAAA,IAAAH,CAAA,gBAAAG,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAG,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAG,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAH,CAAA,CAAAG,CAAA,WAAAM,CAAA,KAAAT,CAAA,EAAAG,CAAA;AAAA,IAAAgB,QAAA,GAAAC,OAAA,CAAAlB,OAAA,GAErC,IAAAmB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,MAAM;EACNC,KAAK;EACLC,QAAQ;EACRC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC;EACF,CAAC,GAAGH,QAAQ;EAEZ,MAAM;IACJI,WAAW,GAAG,IAAI;IAClBC,cAAc,GAAG,IAAI;IACrBC,UAAU,GAAG;EACf,CAAC,GAAGT,OAAO,CAACU,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAMC,WAAW,GAAGP,UAAU,CAACQ,cAAc,CAAC,CAAC;EAC/C,MAAMC,QAAQ,GAAGF,WAAW,CACzBG,MAAM,CAAEC,OAAO,IAAK;IACnB,OAAQ,YAAY,CAAEC,IAAI,CAACD,OAAO,CAACE,KAAK,CAAC;EAC3C,CAAC,CAAC,CACDC,GAAG,CAAEC,WAAW,IAAK;IACpB,OAAO,IAAAC,mCAAqB,EAC1B,IAAAC,0BAAY,EAACF,WAAW,EAAE,EAAE,CAAC,EAAEb,IAAI,KAAK,YAAY,GAAG,YAAY,GAAGA,IACxE,CAAC;EACH,CAAC,CAAC;EAEJ,MAAMgB,QAAQ,GAAGT,QAAQ,CACtBU,OAAO,CAAEC,GAAG,IAAK;IAChB,OAAOA,GAAG,CAACC,IAAI,CAACX,MAAM,CAAC,CAAC;MACtBY;IACF,CAAC,KAAK;MACJ,OAAOrB,KAAK,CAACsB,2BAA2B,CAACD,GAAG,CAAC;IAC/C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEJ,MAAME,OAAO,GAAGf,QAAQ,CACrBU,OAAO,CAAEC,GAAG,IAAK;IAChB,OAAOA,GAAG,CAACC,IAAI,CAACX,MAAM,CAAC,CAAC;MACtBY;IACF,CAAC,KAAK;MACJ,OAAOA,GAAG,KAAK,QAAQ;IACzB,CAAC,CAAC;EACJ,CAAC,CAAC,CAACR,GAAG,CAAEQ,GAAG,IAAK;IACd;IACAA,GAAG,CAACG,SAAS,GAAG,EAAE;IAClB,OAAOH,GAAG;EACZ,CAAC,CAAC;;EAEJ;AACF;AACA;AACA;AACA;EACE,MAAMI,oBAAoB,GAAIC,UAAU,IAAK;IAC3C,OAAQC,KAAK,IAAK;MAChB,MAAMC,WAAW,GAAG7B,UAAU,CAAC8B,GAAG;MAClC,MAAMC,YAAY,GAAG/B,UAAU,CAACgC,iBAAiB,CAACH,WAAW,CAAC;;MAE9D;MACA,IAAIE,YAAY,CAAC,CAAC,CAAC,EAAE;QACnB,OAAOH,KAAK,CAACK,gBAAgB;QAC3B;QACAF,YAAY,CAAC,CAAC,CAAC,EACf,GAAGJ,UAAU,KAAK9B,MAAM,EAC1B,CAAC;MACH;;MAEA;MACA,IAAIqC,eAAM,CAACC,EAAE,CAACC,cAAM,CAACC,OAAO,EAAE,QAAQ,CAAC,EAAE;QACvC,OAAOT,KAAK,CAACK,gBAAgB,CAC3BJ,WAAW,EACXF,UACF,CAAC;MACH;;MAEA;MACA,MAAMW,UAAU,GAAGtC,UAAU,CAACuC,OAAO,CAAC,CAAC;MACvC,MAAMC,OAAO,GAAGX,WAAW,CAACY,IAAI,IAAIZ,WAAW,CAACY,IAAI,CAACC,MAAM,GAAG,CAAC;MAC/D,MAAMC,YAAY,GAAGH,OAAO,GAAGF,UAAU,CAACM,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI;MACtE,IAAID,YAAY,EAAE;QAChB,MAAME,OAAO,GAAGF,YAAY,CAAC,CAAC,CAAC;QAC/B,OAAOf,KAAK,CAACkB,gBAAgB,CAC3B,CACED,OAAO,CAACH,MAAM,EAAEG,OAAO,CAACH,MAAM,CAC/B,EACD,GAAGf,UAAU,KAAKkB,OAAO,CAACE,KAAK,CAAC,CAAC,CAAC,EACpC,CAAC;MACH;MAEA,MAAMC,iBAAiB,GAAGV,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI;MAChD,OAAOV,KAAK,CAACkB,gBAAgB,CAC3BE,iBAAiB,GAAG,CAClB,CAAC,EAAE,CAAC,CACL,GAAG,CACF,CAAC,EAAE,CAAC,CACL,EACD,GAAGrB,UAAU,IACf,CAAC;MACD;IACF,CAAC;EACH,CAAC;;EAED;AACF;AACA;EACE,MAAMsB,oBAAoB,GAAI3B,GAAG,IAAK;IACpC,MAAM4B,aAAa,GAAG5B,GAAG,CAAC6B,IAAI;IAC9B,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAGlD,IAAI,KAAK,YAAY,GAChC,IAAAmD,sBAAY,EAAC,qBAAuBH,aAAc,CAAC,GACnD,IAAAI,mBAAS,EAAC,qBAAuBJ,aAAa,EAAGhD,IAAI,CAAC;IAC1D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAqD,sBAAQ,EAACH,UAAU,EAAE,CAACI,GAAG,EAAEC,UAAU,KAAK;MACxC;MACAD,GAAG,CAACC,UAAU,GAAGA,UAAU;IAC7B,CAAC,CAAC;IAEF,IAAAF,sBAAQ,EAACH,UAAU,EAAGI,GAAG,IAAK;MAC5B,MAAM;QACJE,OAAO;QACPP;MACF,CAAC,GAAG,6DAA+DK,GAAI;MACvE,IAAIL,IAAI,KAAK,iBAAiB,EAAE;QAC9B;MACF;MAEA,IAAIQ,WAAW,GAAGH,GAAG;;MAErB;MACA,MAAMI,YAAY,GAAG,EAAE;;MAEvB;MACA,MAAMC,KAAK,GAAG,EAAE;;MAEhB;MACA,MAAMC,iBAAiB,GAAG,EAAE;;MAE5B;MACA,MAAMC,MAAM,GAAG,EAAE;MAEjB,MAAMC,kBAAkB,GAAG,6EAA+E,EAAG;;MAE7G;MACA,OAAOL,WAAW,IAAIA,WAAW,CAACF,UAAU,EAAE;QAC5C;QACAE,WAAW,GAAGA,WAAW,CAACF,UAAU;QACpC;QACA,IAAIE,WAAW,CAACR,IAAI,KAAK,mBAAmB,EAAE;UAC5C;QACF;QAEAS,YAAY,CAACK,OAAO,CAClBN,WAAW,CAACO,KAAK,CAACf,IAAI,KAAK,6BAA6B,GACtD,IAAAgB,uBAAS,EAACR,WAAW,CAACO,KAAK,CAACA,KAAK,CAAC,GAClCP,WAAW,CAACO,KAAK,CAACrD,KACtB,CAAC;QACDgD,KAAK,CAACI,OAAO,CAACN,WAAW,CAAC;QAC1BK,kBAAkB,CAACC,OAAO,CAACN,WAAW,CAACS,QAAQ,CAAC;QAChDL,MAAM,CAACE,OAAO,CACZN,WAAW,CAACO,KAAK,CAACf,IAAI,KAAK,6BAA6B,GACtDkB,SAAS,GACTV,WAAW,CAACO,KAAK,CAACI,IAAI,CAACC,KAC3B,CAAC;MACH;;MAEA;AACN;AACA;AACA;MACM,MAAMC,QAAQ,GAAGA,CAACC,IAAI,EAAEC,gBAAgB,KAAK;QAC3C,MAAMC,YAAY,GAAG,IAAAC,0BAAiB,EAACH,IAAI,CAAC;QAC5C,OAAO,MAAM;UACX;UACA,IAAII,IAAI,GAAGhB,KAAK,CAACiB,EAAE,CAAC,CAAC,CAAC;UACtB,IAAI,CAACD,IAAI,EAAE;YACT;YACAA,IAAI,GAAG;YACL;YACCrB,GACF;UACH;UAEA,MAAMuB,IAAI,GAAG;UACXzF,MAAM,CAACyF,IAAI,CAACF,IAAI,CACjB;UAED,KAAK,MAAMG,GAAG,IAAID,IAAI,EAAE;YACtB,OAAOF,IAAI,CAACG,GAAG,CAAC;UAClB;UAEA,IAAIN,gBAAgB,CAAChC,MAAM,EAAE;YAC3B,IAAIuC,OAAO,GAAG;YACZ;YACCJ,IACF;YACD,OAAOH,gBAAgB,CAAChC,MAAM,IAAIuC,OAAO,EAAE;cACzCA,OAAO,CAAC9B,IAAI,GAAG,mBAAmB;cAClC8B,OAAO,CAACf,KAAK,GAAG;gBACdI,IAAI,EAAE;kBACJC,KAAK,EAAER,MAAM,CAACmB,KAAK,CAAC;gBACtB,CAAC;gBACD/B,IAAI,EAAE,mBAAmB;gBACzBtC,KAAK,GAAE,qBAAuB6D,gBAAgB,CAACQ,KAAK,CAAC,CAAC;cACxD,CAAC;cAEDD,OAAO,CAACb,QAAQ,GAAG;cACjBJ,kBAAkB,CAACkB,KAAK,CAAC,CAC1B;cACD;cACAD,OAAO,CAACE,IAAI,GAAG,CAAC,CAAC;cACjBF,OAAO,GAAG;cACRA,OAAO,CAACE,IACT;YACH;YAEA,MAAMC,QAAQ,GAAG;YACf;YACCH,OACF;YACDG,QAAQ,CAACjC,IAAI,GAAG,eAAe;YAC/BiC,QAAQ,CAACvE,KAAK,GAAG8D,YAAY;UAC/B,CAAC,MAAM;YACL,MAAMM,OAAO,GAAG;YACd;YACCJ,IACF;YACDI,OAAO,CAAC9B,IAAI,GAAG,eAAe;YAC9B8B,OAAO,CAACpE,KAAK,GAAG8D,YAAY;UAC9B;UAEA,KAAK,MAAMU,GAAG,IAAI/D,GAAG,CAACgE,MAAM,EAAE;YAC5B,IAAID,GAAG,CAACE,MAAM,CAACpC,IAAI,EAAE;cACnBkC,GAAG,CAACE,MAAM,CAACpC,IAAI,GAAG,IAAI,IAAAgB,uBAAS,EAACf,UAAU,CAAC,GAAG;cAC9C;YACF;UACF;QACF,CAAC;MACH,CAAC;;MAED;MACA,IAAIoC,kBAAkB,GAAG,EAAE;MAE3B,MAAMC,mBAAmB,GAAGA,CAAA,KAAM;QAChC;QACA,IAAI,CAACrF,cAAc,EAAE;UACnB,OAAOiE,SAAS;QAClB;QAEA,MAAMqB,WAAW,GAAG,CAClB,GAAG9B,YAAY,CAChB;QACD,OAAO1C,QAAQ,CAACyE,IAAI,CAAEC,OAAO,IAAK;UAChC,IAAIC,WAAW,GAAGD,OAAO,CAACxC,UAAU;UACpC,IAAI0C,aAAa;UACjB,OAAOD,WAAW,IAAIA,WAAW,CAAC1C,IAAI,KAAK,mBAAmB,EAAE;YAC9D,MAAM4C,WAAW,GAAGL,WAAW,CAACR,KAAK,CAAC,CAAC;YACvC,IAAI,CAACa,WAAW,EAAE;cAChBD,aAAa,GAAG,KAAK;cACrB;YACF;YAEA,IACGD,WAAW,CAAC3B,KAAK,CAACf,IAAI,KAAK,6BAA6B,IACvD,IAAAgB,uBAAS,EAAC0B,WAAW,CAAC3B,KAAK,CAACA,KAAK,CAAC,KAAK6B,WAAW,IACnDF,WAAW,CAAC3B,KAAK,CAACf,IAAI,KAAK,6BAA6B,IACvD0C,WAAW,CAAC3B,KAAK,CAACrD,KAAK,KAAKkF,WAAY,EAC1C;cACA,IAAID,aAAa,KAAK,IAAI,EAAE;gBAC1B;gBACA;cACF;cAEAhC,iBAAiB,CAACkC,IAAI,CAACD,WAAW,CAAC;cACnCD,aAAa,GAAG,KAAK;cACrB;YACF;YAEAA,aAAa,GAAG,IAAI;YAEpBN,kBAAkB,GAAGE,WAAW;YAEhCG,WAAW,GAAGA,WAAW,CAACV,IAAI;UAChC;UAEA,OAAOW,aAAa;UAClB;UACAD,WAAW,IACXA,WAAW,CAAC1C,IAAI,KAAK,iBAAiB,IACtC0C,WAAW,CAACnC,OAAO,CAAC7C,KAAK,KAAK6C,OAAO,CAAC7C,KAAK;QAC/C,CAAC,CAAC;MACJ,CAAC;;MAED;MACA;MACA,MAAMoF,eAAe,GAAGR,mBAAmB,CAAC,CAAC;MAC7C,IAAIQ,eAAe,EAAE;QACnBhG,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAGqE,QAAQ,CAACyB,eAAe,CAACxB,IAAI,EAAE,CAC3C,GAAGX,iBAAiB,EACpB,GAAG0B,kBAAkB,CAACzC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/B,GAAGyC,kBAAkB,CAACzC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACnC,CAAC,GAAG,IACP,CAAC;QACD;MACF;MAEA,MAAMoD,kBAAkB,GAAGA,CAAA,KAAM;QAC/B,KAAK,MAAMC,KAAK,IAAI5E,OAAO,EAAE;UAC3B,MAAM6E,YAAY,GAAG,IAAAC,wCAAmB,EACtC,IAAAC,4BAAc,EAACH,KAAK,CAAC,CAACI,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAACC,IAAI,CAAC,CACnD,CAAC;UAED,MAAMC,2BAA2B,GAAGpH,MAAM,CAACyF,IAAI,CAACsB,YAAY,CAACM,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;UAEnF,MAAMA,YAAY,GAAGrH,MAAM,CAACsH,MAAM,CAACP,YAAY,CAACM,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;UAC3E,MAAME,gBAAgB,GAAG,CAACF,YAAY,IAAIA,YAAY,CAACG,KAAK,IAAIxH,MAAM,CAACyF,IAAI,CAAC4B,YAAY,CAACG,KAAK,CAAC,KAAK,EAAE;UAEtG,MAAMC,gBAAgB,GAAGzH,MAAM,CAACsH,MAAM,CAACP,YAAY,CAACU,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;UAEnF,MAAMC,uBAAuB,GAAGD,gBAAgB,IAAIA,gBAAgB,CAACvI,OAAO;UAC5E,MAAMyI,yBAAyB,GAAGF,gBAAgB,IAAIA,gBAAgB,CAACG,SAAS;UAChF,MAAMC,+BAA+B,GAAG7H,MAAM,CAACyF,IAAI,CAACsB,YAAY,CAACU,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;UAE3F,MAAMK,eAAe,GAAGxD,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC;UAE3C,IACGkC,uBAAuB,IACpBG,+BAA+B,KAAKzD,OAAO,CAAC7C,KAAK,IAClD6C,OAAO,CAAC7C,KAAK,KAAK6F,2BAA2B,KAC3CU,eAAe,IAAIP,gBAAgB,CAACQ,QAAQ,CAACD,eAAe,CAAC,IAC9DA,eAAe,KAAK,SAAS,CAC7B,IACDH,yBAAyB,IACxBE,+BAA+B,KAAKzD,OAAO,CAAC7C,KAAM,EACtD;YACA,OAAO;cACLgG,gBAAgB;cAChBF,YAAY;cACZD,2BAA2B;cAC3BK,gBAAgB;cAChBC,uBAAuB;cACvBG,+BAA+B;cAC/BF;YACF,CAAC;UACH;QACF;QAEA,OAAO5C,SAAS;MAClB,CAAC;MAED,MAAMiD,cAAc,GAAGnB,kBAAkB,CAAC,CAAC;MAC3C,IAAImB,cAAc,EAAE;QAClB,MAAM;UACJT,gBAAgB;UAChBF,YAAY;UACZD,2BAA2B;UAC3BO;QACF,CAAC,GAAGK,cAAc;QAClB,IAAI,CAACT,gBAAgB,CAACnE,MAAM,IAAIgE,2BAA2B,IAAIC,YAAY,CAACnI,OAAO,EAAE;UACnFyB,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAGqE,QAAQ,CAACmC,YAAY,CAACnI,OAAO,EAAE,EAAE,CAAC,GAAG,IACrD,CAAC;UACD;QACF;QAEA,MAAM+I,cAAc,GAAG3D,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAIyC,cAAc,IAAIV,gBAAgB,CAACQ,QAAQ,CAACE,cAAc,CAAC,EAAE;UAC/DtH,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAGqE,QAAQ,CAAC+C,cAAc,EAAE3D,YAAY,CAACb,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IACtE,CAAC;UACD;QACF;QAEA,IAAIkE,yBAAyB,EAAE;UAC7BhH,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAGqE,QAAQ,CAACyC,yBAAyB,EAAE,CAChD,GAAGrD,YAAY,CAChB,CAAC,GAAG,IACP,CAAC;UACD;QACF;MACF;MAEA,IAAI,CAACA,YAAY,CAAClB,MAAM,EAAE;QACxBzC,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAIyB,KAAK,IAAK;UACvB4C,QAAQ,CAACd,OAAO,CAAC7C,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;UAC7B,OAAOa,oBAAoB,CACzB,oBAAoB,IAAAkD,0BAAiB,EAAClB,OAAO,CAAC7C,KAAK,CAAC,UAAU6C,OAAO,CAAC7C,KAAK,OAC7E,CAAC,CAACe,KAAK,CAAC;QACV,CAAC,GAAG,IACN,CAAC;QACD;MACF;MAEA,MAAM4F,cAAc,GAAG5D,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC;MAC1C,IAAI0C,cAAc,IAAIA,cAAc,KAAK,SAAS,EAAE;QAClDvH,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAIyB,KAAK,IAAK;UACvB4C,QAAQ,CAACd,OAAO,CAAC7C,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;UAC7B,OAAOa,oBAAoB,CACzB,eAAegC,OAAO,CAAC7C,KAAK,UAAU6C,OAAO,CAAC7C,KAAK,OACrD,CAAC,CAACe,KAAK,CAAC;QACV,CAAC,GAAG,IACN,CAAC;QACD;MACF;MAEA3B,KAAK,CAACiG,WAAW,CACf,2CAA2C,EAC3C5E,GAAG,EACHnB,WAAW,GAAIyB,KAAK,IAAK;QACvB,IAAIvB,UAAU,KAAK,mBAAmB,EAAE;UACtCmE,QAAQ,CAACd,OAAO,CAAC7C,KAAK,EAAE,CACtB,GAAG+C,YAAY,CAChB,CAAC,CAAC,CAAC;QACN,CAAC,MAAM;UACLY,QAAQ,CACN,qBAAuBZ,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC,EAC1ClB,YAAY,CAACb,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAC1B,CAAC,CAAC,CAAC;QACL;QAEA,MAAMpB,UAAU,GAAGtB,UAAU,KAAK,mBAAmB,GACnD,oBAAoB,IAAAuE,0BAAiB,EAAClB,OAAO,CAAC7C,KAAK,CAAC,UAAU6C,OAAO,CAAC7C,KAAK,OAAO,GAClF,iBAAiB,IAAA+D,0BAAiB,EAChC;QACAhB,YAAY,CAACkB,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EACzB,CAAC,YAAYpB,OAAO,CAAC7C,KAAK,OAAO;QAEnC,OAAOa,oBAAoB,CAACC,UAAU,CAAC,CAACC,KAAK,CAAC;MAChD,CAAC,GAAG,IACN,CAAC;IACH,CAAC,CAAC;EACJ,CAAC;EAED,KAAK,MAAMN,GAAG,IAAIxB,KAAK,CAACuB,IAAI,EAAE;IAC5B,MAAMoG,qBAAqB,GAAGxH,KAAK,CAACyH,wBAAwB,CAACpG,GAAG,CAACA,GAAG,CAAC;IACrE,MAAMqG,eAAe,GAAGF,qBAAqB,KAAK,IAAI,IAAIG,OAAO,CAACtG,GAAG,CAAC6B,IAAI,CAAC;IAC3E,IAAIwE,eAAe,KAAK,CAACvH,cAAc,IAAI,CAACH,KAAK,CAACsB,2BAA2B,CAACD,GAAG,CAACA,GAAG,CAAC,CAAC,EAAE;MACvF2B,oBAAoB,CAAC3B,GAAG,CAAC;IAC3B;EACF;AACF,CAAC,EAAE;EACDuG,gBAAgB,EAAE,IAAI;EACtBvD,IAAI,EAAE;IACJwD,IAAI,EAAE;MACJC,WAAW,EAAE,wDAAwD;MACrEC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVjI,WAAW,EAAE;UACX4H,WAAW,EAAE,2DAA2D;UACxE5E,IAAI,EAAE;QACR,CAAC;QACD/C,cAAc,EAAE;UACd2H,WAAW,EAAE,0DAA0D;UACvE5E,IAAI,EAAE;QACR,CAAC;QAED;QACA;QACA9C,UAAU,EAAE;UACV0H,WAAW,EAAE,sFAAsF;UACnGM,IAAI,EAAE,CACJ,cAAc,EACd,mBAAmB,CACpB;UACDlF,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAmF,MAAA,CAAA5I,OAAA,GAAAA,OAAA,CAAAlB,OAAA","ignoreList":[]}

package/dist/rules/requireJsdoc.cjs CHANGED Viewed

@@ -443,6 +443,7 @@ var _default = exports.default = {
   create(context) {
     /* c8 ignore next -- Fallback to deprecated method */
     const {
+      // @ts-expect-error ESLint < 10
       sourceCode = context.getSourceCode()
     } = context;
     const settings = (0, _iterateJsdoc.getSettings)(context);
@@ -705,7 +706,6 @@ var _default = exports.default = {
   },
   meta: {
     docs: {
-      category: 'Stylistic Issues',
       description: 'Checks for presence of JSDoc comments, on functions and potentially other contexts (optionally limited to exports).',
       recommended: true,
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md#repos-sticky-header'

package/dist/rules/requireJsdoc.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"requireJsdoc.cjs","names":["_exportParser","_interopRequireDefault","require","_iterateJsdoc","_jsdocUtils","_jsdoccomment","e","__esModule","default","OPTIONS_SCHEMA","additionalProperties","description","properties","checkAllFunctionExpressions","type","checkConstructors","checkGetters","anyOf","enum","checkSetters","contexts","items","context","inlineCommentBlock","minLineCount","enableFixer","exemptEmptyConstructors","exemptEmptyFunctions","exemptOverloadedImplementations","fixerMessage","publicOnly","oneOf","ancestorsOnly","cjs","esm","window","ArrowFunctionExpression","ClassDeclaration","ClassExpression","FunctionDeclaration","FunctionExpression","MethodDefinition","skipInterveningOverloadedDeclarations","getMethodOnInterface","interfaceName","methodName","scope","scp","identifiers","name","variables","identifier","interfaceDeclaration","parent","bodyItem","body","methodSig","key","upper","isExemptedImplementer","node","sourceCode","settings","implments","implements","impl","expression","interfaceMethodNode","getScope","comment","getJSDocComment","getOption","baseObject","option","options","getOptions","undefined","baseObj","prop","Object","keys","opt","isFunctionWithOverload","child","functionName","id","idx","indexOf","prevSibling","declaration","_default","exports","create","getSourceCode","getSettings","opts","requireOption","checkJsDoc","info","_handler","some","ctxt","count","underMinLine","getText","match","length","contextMinLineCount","find","ctx","selector","jsDocNode","checkOverloads","exemptSpeciaMethods","inlineTags","problems","source","tags","isFunctionContext","isConstructor","functionParameterNames","getFunctionParameterNames","hasReturnValue","fix","fixer","lines","minLines","maxLines","baseNode","getReducedASTNode","decorator","getDecorator","indent","getIndent","text","loc","start","column","contxt","insertion","repeat","slice","insertTextBefore","report","end","line","messageId","Boolean","initModuleExports","initWindow","exported","exportParser","isUncommentedExport","hasOption","getContextObject","enforcedContexts","includes","value","meta","docs","category","recommended","url","fixable","messages","missingJsDoc","schema","module"],"sources":["../../src/rules/requireJsdoc.js"],"sourcesContent":["import exportParser from '../exportParser.js';\nimport {\n getSettings,\n} from '../iterateJsdoc.js';\nimport {\n enforcedContexts,\n exemptSpeciaMethods,\n getContextObject,\n getFunctionParameterNames,\n getIndent,\n hasReturnValue,\n isConstructor,\n} from '../jsdocUtils.js';\nimport {\n getDecorator,\n getJSDocComment,\n getReducedASTNode,\n} from '@es-joy/jsdoccomment';\n\n/*\n @typedef {{\n * ancestorsOnly: boolean,\n * esm: boolean,\n * initModuleExports: boolean,\n * initWindow: boolean\n * }} RequireJsdocOpts\n /\n\n/\n @typedef {import('eslint').Rule.Node\|\n * import('@typescript-eslint/types').TSESTree.Node} ESLintOrTSNode\n /\n\n/* @type {import('json-schema').JSONSchema4} /\nconst OPTIONS_SCHEMA = {\n additionalProperties: false,\n description: 'Has the following optional keys.\\n',\n properties: {\n checkAllFunctionExpressions: {\n default: false,\n description: `Normally, when \\`FunctionExpression\\` is checked, additional checks are\nadded to check the parent contexts where reporting is likely to be desired. If you really\nwant to check all* function expressions, then set this to \\`true\\`.`,\n type: 'boolean',\n },\n checkConstructors: {\n default: true,\n description: `A value indicating whether \\`constructor\\`s should be checked. Defaults to\n\\`true\\`. When \\`true\\`, \\`exemptEmptyConstructors\\` may still avoid reporting when\nno parameters or return values are found.`,\n type: 'boolean',\n },\n checkGetters: {\n anyOf: [\n {\n type: 'boolean',\n },\n {\n enum: [\n 'no-setter',\n ],\n type: 'string',\n },\n ],\n default: true,\n description: `A value indicating whether getters should be checked. Besides setting as a\nboolean, this option can be set to the string \\`\"no-setter\"\\` to indicate that\ngetters should be checked but only when there is no setter. This may be useful\nif one only wishes documentation on one of the two accessors. Defaults to\n\\`false\\`.`,\n },\n checkSetters: {\n anyOf: [\n {\n type: 'boolean',\n },\n {\n enum: [\n 'no-getter',\n ],\n type: 'string',\n },\n ],\n default: true,\n description: `A value indicating whether setters should be checked. Besides setting as a\nboolean, this option can be set to the string \\`\"no-getter\"\\` to indicate that\nsetters should be checked but only when there is no getter. This may be useful\nif one only wishes documentation on one of the two accessors. Defaults to\n\\`false\\`.`,\n },\n contexts: {\n description: `Set this to an array of strings or objects representing the additional AST\ncontexts where you wish the rule to be applied (e.g., \\`Property\\` for\nproperties). If specified as an object, it should have a \\`context\\` property\nand can have an \\`inlineCommentBlock\\` property which, if set to \\`true\\`, will\nadd an inline \\`/** /\\` instead of the regular, multi-line, indented jsdoc\nblock which will otherwise be added. Defaults to an empty array. Contexts\nmay also have their own \\`minLineCount\\` property which is an integer\nindicating a minimum number of lines expected for a node in order\nfor it to require documentation.\n\nNote that you may need to disable \\`require\\` items (e.g., \\`MethodDefinition\\`)\nif you are specifying a more precise form in \\`contexts\\` (e.g., \\`MethodDefinition:not([accessibility=\"private\"] > FunctionExpression\\`).\n\nSee the [\"AST and Selectors\"](../#advanced-ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n context: {\n type: 'string',\n },\n inlineCommentBlock: {\n type: 'boolean',\n },\n minLineCount: {\n type: 'integer',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n enableFixer: {\n default: true,\n description: `A boolean on whether to enable the fixer (which adds an empty JSDoc block).\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n exemptEmptyConstructors: {\n default: false,\n description: `When \\`true\\`, the rule will not report missing JSDoc blocks above constructors\nwith no parameters or return values (this is enabled by default as the class\nname or description should be seen as sufficient to convey intent).\n\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n exemptEmptyFunctions: {\n default: false,\n description: `When \\`true\\`, the rule will not report missing JSDoc blocks above\nfunctions/methods with no parameters or return values (intended where\nfunction/method names are sufficient for themselves as documentation).\n\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n exemptOverloadedImplementations: {\n default: false,\n description: `If set to \\`true\\` will avoid checking an overloaded function's implementation.\n\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n fixerMessage: {\n default: '',\n description: `An optional message to add to the inserted JSDoc block. Defaults to the\nempty string.`,\n type: 'string',\n },\n minLineCount: {\n description: `An integer to indicate a minimum number of lines expected for a node in order\nfor it to require documentation. Defaults to \\`undefined\\`. This option will\napply to any context; see \\`contexts\\` for line counts specific to a context.`,\n type: 'integer',\n },\n publicOnly: {\n description: `This option will insist that missing JSDoc blocks are only reported for\nfunction bodies / class declarations that are exported from the module.\nMay be a boolean or object. If set to \\`true\\`, the defaults below will be\nused. If unset, JSDoc block reporting will not be limited to exports.\n\nThis object supports the following optional boolean keys (\\`false\\` unless\notherwise noted):\n\n- \\`ancestorsOnly\\` - Optimization to only check node ancestors to check if node is exported\n- \\`esm\\` - ESM exports are checked for JSDoc comments (Defaults to \\`true\\`)\n- \\`cjs\\` - CommonJS exports are checked for JSDoc comments (Defaults to \\`true\\`)\n- \\`window\\` - Window global exports are checked for JSDoc comments`,\n oneOf: [\n {\n default: false,\n type: 'boolean',\n },\n {\n additionalProperties: false,\n default: {},\n properties: {\n ancestorsOnly: {\n type: 'boolean',\n },\n cjs: {\n type: 'boolean',\n },\n esm: {\n type: 'boolean',\n },\n window: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n require: {\n additionalProperties: false,\n default: {},\n description: `An object with the following optional boolean keys which all default to\n\\`false\\` except for \\`FunctionDeclaration\\` which defaults to \\`true\\`.`,\n properties: {\n ArrowFunctionExpression: {\n default: false,\n description: 'Whether to check arrow functions like `() => {}`',\n type: 'boolean',\n },\n ClassDeclaration: {\n default: false,\n description: 'Whether to check declarations like `class A {}`',\n type: 'boolean',\n },\n ClassExpression: {\n default: false,\n description: 'Whether to check class expressions like `const myClass = class {}`',\n type: 'boolean',\n },\n FunctionDeclaration: {\n default: true,\n description: 'Whether to check function declarations like `function a {}`',\n type: 'boolean',\n },\n FunctionExpression: {\n default: false,\n description: 'Whether to check function expressions like `const a = function {}`',\n type: 'boolean',\n },\n MethodDefinition: {\n default: false,\n description: 'Whether to check method definitions like `class A { someMethodDefinition () {} }`',\n type: 'boolean',\n },\n },\n type: 'object',\n },\n skipInterveningOverloadedDeclarations: {\n default: true,\n description: `If \\`true\\`, will skip above uncommented overloaded functions to check\nfor a comment block (e.g., at the top of a set of overloaded functions).\n\nIf \\`false\\`, will force each overloaded function to be checked for a\ncomment block.\n\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n },\n type: 'object',\n};\n\n/\n @param {string} interfaceName\n * @param {string} methodName\n * @param {import(\"eslint\").Scope.Scope \| null} scope\n * @returns {import('@typescript-eslint/types').TSESTree.TSMethodSignature\|null}\n /\nconst getMethodOnInterface = (interfaceName, methodName, scope) => {\n let scp = scope;\n while (scp) {\n for (const {\n identifiers,\n name,\n } of scp.variables) {\n if (interfaceName !== name) {\n continue;\n }\n\n for (const identifier of identifiers) {\n const interfaceDeclaration = /* @type {import('@typescript-eslint/types').TSESTree.Identifier & {parent: import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration}} / (\n identifier\n ).parent;\n / c8 ignore next 3 -- TS /\n if (interfaceDeclaration.type !== 'TSInterfaceDeclaration') {\n continue;\n }\n\n for (const bodyItem of interfaceDeclaration.body.body) {\n const methodSig = /* @type {import('@typescript-eslint/types').TSESTree.TSMethodSignature} / (\n bodyItem\n );\n if (methodName === /* @type {import('@typescript-eslint/types').TSESTree.Identifier} / (\n methodSig.key\n ).name) {\n return methodSig;\n }\n }\n }\n }\n\n scp = scp.upper;\n }\n\n return null;\n};\n\n/\n @param {import('eslint').Rule.Node} node\n * @param {import('eslint').SourceCode} sourceCode\n * @param {import('eslint').Rule.RuleContext} context\n * @param {import('../iterateJsdoc.js').Settings} settings\n /\nconst isExemptedImplementer = (node, sourceCode, context, settings) => {\n if (node.type === 'FunctionExpression' &&\n node.parent.type === 'MethodDefinition' &&\n node.parent.parent.type === 'ClassBody' &&\n node.parent.parent.parent.type === 'ClassDeclaration' &&\n 'implements' in node.parent.parent.parent\n ) {\n const implments = /* @type {import('@typescript-eslint/types').TSESTree.TSClassImplements[]} / (\n node.parent.parent.parent.implements\n );\n\n const {\n name: methodName,\n } = /* @type {import('@typescript-eslint/types').TSESTree.Identifier} / (\n node.parent.key\n );\n\n for (const impl of implments) {\n const {\n name: interfaceName,\n } = /* @type {import('@typescript-eslint/types').TSESTree.Identifier} / (\n impl.expression\n );\n\n const interfaceMethodNode = getMethodOnInterface(interfaceName, methodName, node && (\n (sourceCode.getScope &&\n / c8 ignore next 3 /\n sourceCode.getScope(node)) \|\|\n // @ts-expect-error ESLint 8\n context.getScope()\n ));\n if (interfaceMethodNode) {\n // @ts-expect-error Ok\n const comment = getJSDocComment(sourceCode, interfaceMethodNode, settings);\n if (comment) {\n return true;\n }\n }\n }\n }\n\n return false;\n};\n\n/\n @param {import('eslint').Rule.RuleContext} context\n * @param {import('json-schema').JSONSchema4Object} baseObject\n * @param {string} option\n * @param {string} key\n * @returns {boolean\|undefined}\n /\nconst getOption = (context, baseObject, option, key) => {\n if (context.options[0] && option in context.options[0] &&\n // Todo: boolean shouldn't be returning property, but\n // tests currently require\n (typeof context.options[0][option] === 'boolean' \|\|\n key in context.options[0][option])\n ) {\n return context.options[0][option][key];\n }\n\n return /* @type {{[key: string]: {default?: boolean\|undefined}}} / (\n baseObject.properties\n )[key].default;\n};\n\n/\n @param {import('eslint').Rule.RuleContext} context\n * @param {import('../iterateJsdoc.js').Settings} settings\n * @returns {{\n * checkAllFunctionExpressions: boolean,\n * contexts: (string\|{\n * context: string,\n * inlineCommentBlock: boolean,\n * minLineCount: import('../iterateJsdoc.js').Integer\n * })[],\n * enableFixer: boolean,\n * exemptEmptyConstructors: boolean,\n * exemptEmptyFunctions: boolean,\n * skipInterveningOverloadedDeclarations: boolean,\n * exemptOverloadedImplementations: boolean,\n * fixerMessage: string,\n * minLineCount: undefined\|import('../iterateJsdoc.js').Integer,\n * publicOnly: boolean\|{[key: string]: boolean\|undefined}\n * require: {[key: string]: boolean\|undefined}\n * }}\n /\nconst getOptions = (context, settings) => {\n const {\n checkAllFunctionExpressions = false,\n contexts = settings.contexts \|\| [],\n enableFixer = true,\n exemptEmptyConstructors = true,\n exemptEmptyFunctions = false,\n exemptOverloadedImplementations = false,\n fixerMessage = '',\n minLineCount = undefined,\n publicOnly,\n skipInterveningOverloadedDeclarations = true,\n } = context.options[0] \|\| {};\n\n return {\n checkAllFunctionExpressions,\n contexts,\n enableFixer,\n exemptEmptyConstructors,\n exemptEmptyFunctions,\n exemptOverloadedImplementations,\n fixerMessage,\n minLineCount,\n publicOnly: ((baseObj) => {\n if (!publicOnly) {\n return false;\n }\n\n /* @type {{[key: string]: boolean\|undefined}} /\n const properties = {};\n for (const prop of Object.keys(\n /* @type {import('json-schema').JSONSchema4Object} / (\n /* @type {import('json-schema').JSONSchema4Object} / (\n baseObj\n ).properties),\n )) {\n const opt = getOption(\n context,\n /* @type {import('json-schema').JSONSchema4Object} / (baseObj),\n 'publicOnly',\n prop,\n );\n\n properties[prop] = opt;\n }\n\n return properties;\n })(\n /* @type {import('json-schema').JSONSchema4Object} /\n (\n /* @type {import('json-schema').JSONSchema4Object} /\n (\n /* @type {import('json-schema').JSONSchema4Object} /\n (\n OPTIONS_SCHEMA.properties\n ).publicOnly\n ).oneOf\n )[1],\n ),\n require: ((baseObj) => {\n /* @type {{[key: string]: boolean\|undefined}} /\n const properties = {};\n for (const prop of Object.keys(\n /* @type {import('json-schema').JSONSchema4Object} / (\n /* @type {import('json-schema').JSONSchema4Object} / (\n baseObj\n ).properties),\n )) {\n const opt = getOption(\n context,\n /* @type {import('json-schema').JSONSchema4Object} /\n (baseObj),\n 'require',\n prop,\n );\n properties[prop] = opt;\n }\n\n return properties;\n })(\n /* @type {import('json-schema').JSONSchema4Object} /\n (OPTIONS_SCHEMA.properties).require,\n ),\n skipInterveningOverloadedDeclarations,\n };\n};\n\n/\n @param {ESLintOrTSNode} node\n /\nconst isFunctionWithOverload = (node) => {\n if (node.type !== 'FunctionDeclaration') {\n return false;\n }\n\n let parent;\n let child;\n\n if (node.parent?.type === 'Program') {\n parent = node.parent;\n child = node;\n } else if (node.parent?.type === 'ExportNamedDeclaration' &&\n node.parent?.parent.type === 'Program') {\n parent = node.parent?.parent;\n child = node.parent;\n }\n\n if (!child \|\| !parent) {\n return false;\n }\n\n const functionName = node.id?.name;\n\n const idx = parent.body.indexOf(child);\n const prevSibling = parent.body[idx - 1];\n\n return (\n // @ts-expect-error Should be ok\n (prevSibling?.type === 'TSDeclareFunction' &&\n // @ts-expect-error Should be ok\n functionName === prevSibling.id.name) \|\|\n (prevSibling?.type === 'ExportNamedDeclaration' &&\n // @ts-expect-error Should be ok\n prevSibling.declaration?.type === 'TSDeclareFunction' &&\n // @ts-expect-error Should be ok\n prevSibling.declaration?.id?.name === functionName)\n );\n};\n\n/* @type {import('eslint').Rule.RuleModule} /\nexport default {\n create (context) {\n / c8 ignore next -- Fallback to deprecated method /\n const {\n sourceCode = context.getSourceCode(),\n } = context;\n const settings = getSettings(context);\n if (!settings) {\n return {};\n }\n\n const opts = getOptions(context, settings);\n\n const {\n checkAllFunctionExpressions,\n contexts,\n enableFixer,\n exemptEmptyConstructors,\n exemptEmptyFunctions,\n exemptOverloadedImplementations,\n fixerMessage,\n minLineCount,\n require: requireOption,\n skipInterveningOverloadedDeclarations,\n } = opts;\n\n const publicOnly =\n\n /\n @type {{\n * [key: string]: boolean \| undefined;\n * }}\n / (\n opts.publicOnly\n );\n\n /\n @type {import('../iterateJsdoc.js').CheckJsdoc}\n /\n const checkJsDoc = (info, _handler, node) => {\n if (\n // Optimize\n minLineCount !== undefined \|\| contexts.some((ctxt) => {\n if (typeof ctxt === 'string') {\n return false;\n }\n\n const {\n minLineCount: count,\n } = ctxt;\n return count !== undefined;\n })\n ) {\n /\n @param {undefined\|import('../iterateJsdoc.js').Integer} count\n /\n const underMinLine = (count) => {\n return count !== undefined && count >\n (sourceCode.getText(node).match(/\\n/gv)?.length ?? 0) + 1;\n };\n\n if (underMinLine(minLineCount)) {\n return;\n }\n\n const {\n minLineCount: contextMinLineCount,\n } =\n /\n @type {{\n * context: string;\n * inlineCommentBlock: boolean;\n * minLineCount: number;\n * }}\n / (contexts.find((ctxt) => {\n if (typeof ctxt === 'string') {\n return false;\n }\n\n const {\n context: ctx,\n } = ctxt;\n return ctx === (info.selector \|\| node.type);\n })) \|\| {};\n if (underMinLine(contextMinLineCount)) {\n return;\n }\n }\n\n if (exemptOverloadedImplementations && isFunctionWithOverload(node)) {\n return;\n }\n\n const jsDocNode = getJSDocComment(\n sourceCode, node, settings, {\n checkOverloads: skipInterveningOverloadedDeclarations,\n },\n );\n\n if (jsDocNode) {\n return;\n }\n\n // For those who have options configured against ANY constructors (or\n // setters or getters) being reported\n if (exemptSpeciaMethods(\n {\n description: '',\n inlineTags: [],\n problems: [],\n source: [],\n tags: [],\n },\n node,\n context,\n [\n OPTIONS_SCHEMA,\n ],\n )) {\n return;\n }\n\n if (\n // Avoid reporting param-less, return-less functions (when\n // `exemptEmptyFunctions` option is set)\n exemptEmptyFunctions && info.isFunctionContext \|\|\n\n // Avoid reporting param-less, return-less constructor methods (when\n // `exemptEmptyConstructors` option is set)\n exemptEmptyConstructors && isConstructor(node)\n ) {\n const functionParameterNames = getFunctionParameterNames(node);\n if (!functionParameterNames.length && !hasReturnValue(node)) {\n return;\n }\n }\n\n if (isExemptedImplementer(node, sourceCode, context, settings)) {\n return;\n }\n\n const fix = /* @type {import('eslint').Rule.ReportFixer} / (fixer) => {\n // Default to one line break if the `minLines`/`maxLines` settings allow\n const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;\n /* @type {ESLintOrTSNode\|import('@typescript-eslint/types').TSESTree.Decorator} /\n let baseNode = getReducedASTNode(node, sourceCode);\n\n const decorator = getDecorator(\n /* @type {import('eslint').Rule.Node} /\n (baseNode),\n );\n if (decorator) {\n baseNode = decorator;\n }\n\n const indent = getIndent({\n text: sourceCode.getText(\n /* @type {import('eslint').Rule.Node} / (baseNode),\n /* @type {import('eslint').AST.SourceLocation} /\n (\n /* @type {import('eslint').Rule.Node} / (baseNode).loc\n ).start.column,\n ),\n });\n\n const {\n inlineCommentBlock,\n } =\n /\n @type {{\n * context: string,\n * inlineCommentBlock: boolean,\n * minLineCount: import('../iterateJsdoc.js').Integer\n * }}\n / (contexts.find((contxt) => {\n if (typeof contxt === 'string') {\n return false;\n }\n\n const {\n context: ctxt,\n } = contxt;\n return ctxt === node.type;\n })) \|\| {};\n const insertion = (inlineCommentBlock ?\n `/* ${fixerMessage}` :\n `/*\\n${indent}${fixerMessage}\\n${indent}`) +\n `/${'\\n'.repeat(lines)}${indent.slice(0, -1)}`;\n\n return fixer.insertTextBefore(\n /* @type {import('eslint').Rule.Node} /\n (baseNode),\n insertion,\n );\n };\n\n const report = () => {\n const {\n start,\n } = /* @type {import('eslint').AST.SourceLocation} / (node.loc);\n const loc = {\n end: {\n column: 0,\n line: start.line + 1,\n },\n start,\n };\n context.report({\n fix: enableFixer ? fix : null,\n loc,\n messageId: 'missingJsDoc',\n node,\n });\n };\n\n if (publicOnly) {\n /* @type {RequireJsdocOpts} /\n const opt = {\n ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),\n esm: Boolean(publicOnly?.esm ?? true),\n initModuleExports: Boolean(publicOnly?.cjs ?? true),\n initWindow: Boolean(publicOnly?.window ?? false),\n };\n const exported = exportParser.isUncommentedExport(node, sourceCode, opt, settings);\n\n if (exported) {\n report();\n }\n } else {\n report();\n }\n };\n\n /\n @param {string} prop\n * @returns {boolean}\n /\n const hasOption = (prop) => {\n return requireOption[prop] \|\| contexts.some((ctxt) => {\n return typeof ctxt === 'object' ? ctxt.context === prop : ctxt === prop;\n });\n };\n\n return {\n ...getContextObject(\n enforcedContexts(context, [], settings),\n checkJsDoc,\n ),\n ArrowFunctionExpression (node) {\n if (!hasOption('ArrowFunctionExpression')) {\n return;\n }\n\n if (\n [\n 'AssignmentExpression', 'ExportDefaultDeclaration', 'VariableDeclarator',\n ].includes(node.parent.type) \|\|\n [\n 'ClassProperty', 'ObjectProperty', 'Property', 'PropertyDefinition',\n ].includes(node.parent.type) &&\n node ===\n /\n @type {import('@typescript-eslint/types').TSESTree.Property\|\n * import('@typescript-eslint/types').TSESTree.PropertyDefinition\n * }\n /\n (node.parent).value\n ) {\n checkJsDoc({\n isFunctionContext: true,\n }, null, node);\n }\n },\n\n ClassDeclaration (node) {\n if (!hasOption('ClassDeclaration')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: false,\n }, null, node);\n },\n\n ClassExpression (node) {\n if (!hasOption('ClassExpression')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: false,\n }, null, node);\n },\n\n FunctionDeclaration (node) {\n if (!hasOption('FunctionDeclaration')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: true,\n }, null, node);\n },\n\n FunctionExpression (node) {\n if (!hasOption('FunctionExpression')) {\n return;\n }\n\n if (checkAllFunctionExpressions \|\|\n [\n 'AssignmentExpression', 'ExportDefaultDeclaration', 'VariableDeclarator',\n ].includes(node.parent.type) \|\|\n [\n 'ClassProperty', 'ObjectProperty', 'Property', 'PropertyDefinition',\n ].includes(node.parent.type) &&\n node ===\n /\n @type {import('@typescript-eslint/types').TSESTree.Property\|\n * import('@typescript-eslint/types').TSESTree.PropertyDefinition\n * }\n /\n (node.parent).value\n ) {\n checkJsDoc({\n isFunctionContext: true,\n }, null, node);\n }\n },\n\n MethodDefinition (node) {\n if (!hasOption('MethodDefinition')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: true,\n selector: 'MethodDefinition',\n }, null, /* @type {import('eslint').Rule.Node} */ (node.value));\n },\n };\n },\n meta: {\n docs: {\n category: 'Stylistic Issues',\n description: 'Checks for presence of JSDoc comments, on functions and potentially other contexts (optionally limited to exports).',\n recommended: true,\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md#repos-sticky-header',\n },\n\n fixable: 'code',\n\n messages: {\n missingJsDoc: 'Missing JSDoc comment.',\n },\n\n schema: [\n OPTIONS_SCHEMA,\n ],\n\n type: 'suggestion',\n },\n};\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAGA,IAAAE,WAAA,GAAAF,OAAA;AASA,IAAAG,aAAA,GAAAH,OAAA;AAI8B,SAAAD,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA,MAAMG,cAAc,GAAG;EACrBC,oBAAoB,EAAE,KAAK;EAC3BC,WAAW,EAAE,oCAAoC;EACjDC,UAAU,EAAE;IACVC,2BAA2B,EAAE;MAC3BL,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA,qEAAqE;MAC/DG,IAAI,EAAE;IACR,CAAC;IACDC,iBAAiB,EAAE;MACjBP,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA,0CAA0C;MACpCG,IAAI,EAAE;IACR,CAAC;IACDE,YAAY,EAAE;MACZC,KAAK,EAAE,CACL;QACEH,IAAI,EAAE;MACR,CAAC,EACD;QACEI,IAAI,EAAE,CACJ,WAAW,CACZ;QACDJ,IAAI,EAAE;MACR,CAAC,CACF;MACDN,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;IACI,CAAC;IACDQ,YAAY,EAAE;MACZF,KAAK,EAAE,CACL;QACEH,IAAI,EAAE;MACR,CAAC,EACD;QACEI,IAAI,EAAE,CACJ,WAAW,CACZ;QACDJ,IAAI,EAAE;MACR,CAAC,CACF;MACDN,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;IACI,CAAC;IACDS,QAAQ,EAAE;MACRT,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;MACxDU,KAAK,EAAE;QACLJ,KAAK,EAAE,CACL;UACEH,IAAI,EAAE;QACR,CAAC,EACD;UACEJ,oBAAoB,EAAE,KAAK;UAC3BE,UAAU,EAAE;YACVU,OAAO,EAAE;cACPR,IAAI,EAAE;YACR,CAAC;YACDS,kBAAkB,EAAE;cAClBT,IAAI,EAAE;YACR,CAAC;YACDU,YAAY,EAAE;cACZV,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;MAEL,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACDW,WAAW,EAAE;MACXjB,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB,sBAAsB;MAChBG,IAAI,EAAE;IACR,CAAC;IACDY,uBAAuB,EAAE;MACvBlB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA;AACA;AACA,sBAAsB;MAChBG,IAAI,EAAE;IACR,CAAC;IACDa,oBAAoB,EAAE;MACpBnB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA;AACA;AACA,uBAAuB;MACjBG,IAAI,EAAE;IACR,CAAC;IACDc,+BAA+B,EAAE;MAC/BpB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA,uBAAuB;MACjBG,IAAI,EAAE;IACR,CAAC;IACDe,YAAY,EAAE;MACZrB,OAAO,EAAE,EAAE;MACXG,WAAW,EAAE;AACnB,cAAc;MACRG,IAAI,EAAE;IACR,CAAC;IACDU,YAAY,EAAE;MACZb,WAAW,EAAE;AACnB;AACA,8EAA8E;MACxEG,IAAI,EAAE;IACR,CAAC;IACDgB,UAAU,EAAE;MACVnB,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,oEAAoE;MAC9DoB,KAAK,EAAE,CACL;QACEvB,OAAO,EAAE,KAAK;QACdM,IAAI,EAAE;MACR,CAAC,EACD;QACEJ,oBAAoB,EAAE,KAAK;QAC3BF,OAAO,EAAE,CAAC,CAAC;QACXI,UAAU,EAAE;UACVoB,aAAa,EAAE;YACblB,IAAI,EAAE;UACR,CAAC;UACDmB,GAAG,EAAE;YACHnB,IAAI,EAAE;UACR,CAAC;UACDoB,GAAG,EAAE;YACHpB,IAAI,EAAE;UACR,CAAC;UACDqB,MAAM,EAAE;YACNrB,IAAI,EAAE;UACR;QACF,CAAC;QACDA,IAAI,EAAE;MACR,CAAC;IAEL,CAAC;IACDZ,OAAO,EAAE;MACPQ,oBAAoB,EAAE,KAAK;MAC3BF,OAAO,EAAE,CAAC,CAAC;MACXG,WAAW,EAAE;AACnB,yEAAyE;MACnEC,UAAU,EAAE;QACVwB,uBAAuB,EAAE;UACvB5B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,kDAAkD;UAC/DG,IAAI,EAAE;QACR,CAAC;QACDuB,gBAAgB,EAAE;UAChB7B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,iDAAiD;UAC9DG,IAAI,EAAE;QACR,CAAC;QACDwB,eAAe,EAAE;UACf9B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,oEAAoE;UACjFG,IAAI,EAAE;QACR,CAAC;QACDyB,mBAAmB,EAAE;UACnB/B,OAAO,EAAE,IAAI;UACbG,WAAW,EAAE,6DAA6D;UAC1EG,IAAI,EAAE;QACR,CAAC;QACD0B,kBAAkB,EAAE;UAClBhC,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,oEAAoE;UACjFG,IAAI,EAAE;QACR,CAAC;QACD2B,gBAAgB,EAAE;UAChBjC,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,mFAAmF;UAChGG,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACD4B,qCAAqC,EAAE;MACrClC,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA,sBAAsB;MAChBG,IAAI,EAAE;IACR;EACF,CAAC;EACDA,IAAI,EAAE;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM6B,oBAAoB,GAAGA,CAACC,aAAa,EAAEC,UAAU,EAAEC,KAAK,KAAK;EACjE,IAAIC,GAAG,GAAGD,KAAK;EACf,OAAOC,GAAG,EAAE;IACV,KAAK,MAAM;MACTC,WAAW;MACXC;IACF,CAAC,IAAIF,GAAG,CAACG,SAAS,EAAE;MAClB,IAAIN,aAAa,KAAKK,IAAI,EAAE;QAC1B;MACF;MAEA,KAAK,MAAME,UAAU,IAAIH,WAAW,EAAE;QACpC,MAAMI,oBAAoB,GAAG,oJAC3BD,UAAU,CACVE,MAAM;QACR;QACA,IAAID,oBAAoB,CAACtC,IAAI,KAAK,wBAAwB,EAAE;UAC1D;QACF;QAEA,KAAK,MAAMwC,QAAQ,IAAIF,oBAAoB,CAACG,IAAI,CAACA,IAAI,EAAE;UACrD,MAAMC,SAAS,GAAG;UAChBF,QACD;UACD,IAAIT,UAAU,KAAK,qEACjBW,SAAS,CAACC,GAAG,CACbR,IAAI,EAAE;YACN,OAAOO,SAAS;UAClB;QACF;MACF;IACF;IAEAT,GAAG,GAAGA,GAAG,CAACW,KAAK;EACjB;EAEA,OAAO,IAAI;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,qBAAqB,GAAGA,CAACC,IAAI,EAAEC,UAAU,EAAEvC,OAAO,EAAEwC,QAAQ,KAAK;EACrE,IAAIF,IAAI,CAAC9C,IAAI,KAAK,oBAAoB,IACpC8C,IAAI,CAACP,MAAM,CAACvC,IAAI,KAAK,kBAAkB,IACvC8C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACvC,IAAI,KAAK,WAAW,IACvC8C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,CAACvC,IAAI,KAAK,kBAAkB,IACrD,YAAY,IAAI8C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,EACzC;IACA,MAAMU,SAAS,GAAG;IAChBH,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,CAACW,UAC3B;IAED,MAAM;MACJf,IAAI,EAAEJ;IACR,CAAC,GAAG;IACFe,IAAI,CAACP,MAAM,CAACI,GACb;IAED,KAAK,MAAMQ,IAAI,IAAIF,SAAS,EAAE;MAC5B,MAAM;QACJd,IAAI,EAAEL;MACR,CAAC,GAAG;MACFqB,IAAI,CAACC,UACN;MAED,MAAMC,mBAAmB,GAAGxB,oBAAoB,CAACC,aAAa,EAAEC,UAAU,EAAEe,IAAI,KAC7EC,UAAU,CAACO,QAAQ,IACpB;MACAP,UAAU,CAACO,QAAQ,CAACR,IAAI,CAAC;MACzB;MACAtC,OAAO,CAAC8C,QAAQ,CAAC,CAAC,CACnB,CAAC;MACF,IAAID,mBAAmB,EAAE;QACvB;QACA,MAAME,OAAO,GAAG,IAAAC,6BAAe,EAACT,UAAU,EAAEM,mBAAmB,EAAEL,QAAQ,CAAC;QAC1E,IAAIO,OAAO,EAAE;UACX,OAAO,IAAI;QACb;MACF;IACF;EACF;EAEA,OAAO,KAAK;AACd,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,SAAS,GAAGA,CAACjD,OAAO,EAAEkD,UAAU,EAAEC,MAAM,EAAEhB,GAAG,KAAK;EACtD,IAAInC,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,IAAID,MAAM,IAAInD,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC;EACpD;EACA;EACC,OAAOpD,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,CAACD,MAAM,CAAC,KAAK,SAAS,IAChDhB,GAAG,IAAInC,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,CAACD,MAAM,CAAC,CAAC,EAClC;IACA,OAAOnD,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,CAACD,MAAM,CAAC,CAAChB,GAAG,CAAC;EACxC;EAEA,OAAO,6DACLe,UAAU,CAAC5D,UAAU,CACrB6C,GAAG,CAAC,CAACjD,OAAO;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMmE,UAAU,GAAGA,CAACrD,OAAO,EAAEwC,QAAQ,KAAK;EACxC,MAAM;IACJjD,2BAA2B,GAAG,KAAK;IACnCO,QAAQ,GAAG0C,QAAQ,CAAC1C,QAAQ,IAAI,EAAE;IAClCK,WAAW,GAAG,IAAI;IAClBC,uBAAuB,GAAG,IAAI;IAC9BC,oBAAoB,GAAG,KAAK;IAC5BC,+BAA+B,GAAG,KAAK;IACvCC,YAAY,GAAG,EAAE;IACjBL,YAAY,GAAGoD,SAAS;IACxB9C,UAAU;IACVY,qCAAqC,GAAG;EAC1C,CAAC,GAAGpB,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,OAAO;IACL7D,2BAA2B;IAC3BO,QAAQ;IACRK,WAAW;IACXC,uBAAuB;IACvBC,oBAAoB;IACpBC,+BAA+B;IAC/BC,YAAY;IACZL,YAAY;IACZM,UAAU,EAAE,CAAE+C,OAAO,IAAK;MACxB,IAAI,CAAC/C,UAAU,EAAE;QACf,OAAO,KAAK;MACd;;MAEA;MACA,MAAMlB,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMkE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPjE,UACN,CAAC,EAAE;QACD,MAAMqE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP,sDAAwDuD,OAAO,EAC/D,YAAY,EACZC,IACF,CAAC;QAEDlE,UAAU,CAACkE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOrE,UAAU;IACnB,CAAC,EACC;IACA,CACE;IACA,CACE;IAEEH,cAAc,CAACG,UAAU,CACzBkB,UAAU,EACZC,KAAK,EACP,CAAC,CACL,CAAC;IACD7B,OAAO,EAAE,CAAE2E,OAAO,IAAK;MACrB;MACA,MAAMjE,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMkE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPjE,UACN,CAAC,EAAE;QACD,MAAMqE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP;QACCuD,OAAO,EACR,SAAS,EACTC,IACF,CAAC;QACDlE,UAAU,CAACkE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOrE,UAAU;IACnB,CAAC,EACC;IACCH,cAAc,CAACG,UAAU,CAAEV,OAC9B,CAAC;IACDwC;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA,MAAMwC,sBAAsB,GAAItB,IAAI,IAAK;EACvC,IAAIA,IAAI,CAAC9C,IAAI,KAAK,qBAAqB,EAAE;IACvC,OAAO,KAAK;EACd;EAEA,IAAIuC,MAAM;EACV,IAAI8B,KAAK;EAET,IAAIvB,IAAI,CAACP,MAAM,EAAEvC,IAAI,KAAK,SAAS,EAAE;IACnCuC,MAAM,GAAGO,IAAI,CAACP,MAAM;IACpB8B,KAAK,GAAGvB,IAAI;EACd,CAAC,MAAM,IAAIA,IAAI,CAACP,MAAM,EAAEvC,IAAI,KAAK,wBAAwB,IACrD8C,IAAI,CAACP,MAAM,EAAEA,MAAM,CAACvC,IAAI,KAAK,SAAS,EAAE;IAC1CuC,MAAM,GAAGO,IAAI,CAACP,MAAM,EAAEA,MAAM;IAC5B8B,KAAK,GAAGvB,IAAI,CAACP,MAAM;EACrB;EAEA,IAAI,CAAC8B,KAAK,IAAI,CAAC9B,MAAM,EAAE;IACrB,OAAO,KAAK;EACd;EAEA,MAAM+B,YAAY,GAAGxB,IAAI,CAACyB,EAAE,EAAEpC,IAAI;EAElC,MAAMqC,GAAG,GAAGjC,MAAM,CAACE,IAAI,CAACgC,OAAO,CAACJ,KAAK,CAAC;EACtC,MAAMK,WAAW,GAAGnC,MAAM,CAACE,IAAI,CAAC+B,GAAG,GAAG,CAAC,CAAC;EAExC;IACE;IACCE,WAAW,EAAE1E,IAAI,KAAK,mBAAmB;IACxC;IACAsE,YAAY,KAAKI,WAAW,CAACH,EAAE,CAACpC,IAAI,IACrCuC,WAAW,EAAE1E,IAAI,KAAK,wBAAwB;IAC7C;IACA0E,WAAW,CAACC,WAAW,EAAE3E,IAAI,KAAK,mBAAmB;IACrD;IACA0E,WAAW,CAACC,WAAW,EAAEJ,EAAE,EAAEpC,IAAI,KAAKmC;EAAa;AAEzD,CAAC;;AAED;AAAA,IAAAM,QAAA,GAAAC,OAAA,CAAAnF,OAAA,GACe;EACboF,MAAMA,CAAEtE,OAAO,EAAE;IACf;IACA,MAAM;MACJuC,UAAU,GAAGvC,OAAO,CAACuE,aAAa,CAAC;IACrC,CAAC,GAAGvE,OAAO;IACX,MAAMwC,QAAQ,GAAG,IAAAgC,yBAAW,EAACxE,OAAO,CAAC;IACrC,IAAI,CAACwC,QAAQ,EAAE;MACb,OAAO,CAAC,CAAC;IACX;IAEA,MAAMiC,IAAI,GAAGpB,UAAU,CAACrD,OAAO,EAAEwC,QAAQ,CAAC;IAE1C,MAAM;MACJjD,2BAA2B;MAC3BO,QAAQ;MACRK,WAAW;MACXC,uBAAuB;MACvBC,oBAAoB;MACpBC,+BAA+B;MAC/BC,YAAY;MACZL,YAAY;MACZtB,OAAO,EAAE8F,aAAa;MACtBtD;IACF,CAAC,GAAGqD,IAAI;IAER,MAAMjE,UAAU;IAEd;AACN;AACA;AACA;AACA;IACQiE,IAAI,CAACjE,UACN;;IAEH;AACJ;AACA;IACI,MAAMmE,UAAU,GAAGA,CAACC,IAAI,EAAEC,QAAQ,EAAEvC,IAAI,KAAK;MAC3C;MACE;MACApC,YAAY,KAAKoD,SAAS,IAAIxD,QAAQ,CAACgF,IAAI,CAAEC,IAAI,IAAK;QACpD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;UAC5B,OAAO,KAAK;QACd;QAEA,MAAM;UACJ7E,YAAY,EAAE8E;QAChB,CAAC,GAAGD,IAAI;QACR,OAAOC,KAAK,KAAK1B,SAAS;MAC5B,CAAC,CAAC,EACF;QACA;AACR;AACA;QACQ,MAAM2B,YAAY,GAAID,KAAK,IAAK;UAC9B,OAAOA,KAAK,KAAK1B,SAAS,IAAI0B,KAAK,GACjC,CAACzC,UAAU,CAAC2C,OAAO,CAAC5C,IAAI,CAAC,CAAC6C,KAAK,CAAC,MAAM,CAAC,EAAEC,MAAM,IAAI,CAAC,IAAI,CAAC;QAC7D,CAAC;QAED,IAAIH,YAAY,CAAC/E,YAAY,CAAC,EAAE;UAC9B;QACF;QAEA,MAAM;UACJA,YAAY,EAAEmF;QAChB,CAAC;QACC;AACV;AACA;AACA;AACA;AACA;AACA;QAAevF,QAAQ,CAACwF,IAAI,CAAEP,IAAI,IAAK;UAC3B,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,KAAK;UACd;UAEA,MAAM;YACJ/E,OAAO,EAAEuF;UACX,CAAC,GAAGR,IAAI;UACR,OAAOQ,GAAG,MAAMX,IAAI,CAACY,QAAQ,IAAIlD,IAAI,CAAC9C,IAAI,CAAC;QAC7C,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,IAAIyF,YAAY,CAACI,mBAAmB,CAAC,EAAE;UACrC;QACF;MACF;MAEA,IAAI/E,+BAA+B,IAAIsD,sBAAsB,CAACtB,IAAI,CAAC,EAAE;QACnE;MACF;MAEA,MAAMmD,SAAS,GAAG,IAAAzC,6BAAe,EAC/BT,UAAU,EAAED,IAAI,EAAEE,QAAQ,EAAE;QAC1BkD,cAAc,EAAEtE;MAClB,CACF,CAAC;MAED,IAAIqE,SAAS,EAAE;QACb;MACF;;MAEA;MACA;MACA,IAAI,IAAAE,+BAAmB,EACrB;QACEtG,WAAW,EAAE,EAAE;QACfuG,UAAU,EAAE,EAAE;QACdC,QAAQ,EAAE,EAAE;QACZC,MAAM,EAAE,EAAE;QACVC,IAAI,EAAE;MACR,CAAC,EACDzD,IAAI,EACJtC,OAAO,EACP,CACEb,cAAc,CAElB,CAAC,EAAE;QACD;MACF;MAEA;MACE;MACA;MACAkB,oBAAoB,IAAIuE,IAAI,CAACoB,iBAAiB;MAE9C;MACA;MACA5F,uBAAuB,IAAI,IAAA6F,yBAAa,EAAC3D,IAAI,CAAC,EAC9C;QACA,MAAM4D,sBAAsB,GAAG,IAAAC,qCAAyB,EAAC7D,IAAI,CAAC;QAC9D,IAAI,CAAC4D,sBAAsB,CAACd,MAAM,IAAI,CAAC,IAAAgB,0BAAc,EAAC9D,IAAI,CAAC,EAAE;UAC3D;QACF;MACF;MAEA,IAAID,qBAAqB,CAACC,IAAI,EAAEC,UAAU,EAAEvC,OAAO,EAAEwC,QAAQ,CAAC,EAAE;QAC9D;MACF;MAEA,MAAM6D,GAAG,GAAG,gDAAkDC,KAAK,IAAK;QACtE;QACA,MAAMC,KAAK,GAAG/D,QAAQ,CAACgE,QAAQ,KAAK,CAAC,IAAIhE,QAAQ,CAACiE,QAAQ,IAAI,CAAC,GAAG,CAAC,GAAGjE,QAAQ,CAACgE,QAAQ;QACvF;QACA,IAAIE,QAAQ,GAAG,IAAAC,+BAAiB,EAACrE,IAAI,EAAEC,UAAU,CAAC;QAElD,MAAMqE,SAAS,GAAG,IAAAC,0BAAY,EAC5B;QACCH,QACH,CAAC;QACD,IAAIE,SAAS,EAAE;UACbF,QAAQ,GAAGE,SAAS;QACtB;QAEA,MAAME,MAAM,GAAG,IAAAC,qBAAS,EAAC;UACvBC,IAAI,EAAEzE,UAAU,CAAC2C,OAAO,CACtB,yCAA2CwB,QAAQ,EACnD;UACA,CACE,yCAA2CA,QAAQ,CAAEO,GAAG,EACxDC,KAAK,CAACC,MACV;QACF,CAAC,CAAC;QAEF,MAAM;UACJlH;QACF,CAAC;QACC;AACV;AACA;AACA;AACA;AACA;AACA;QAAeH,QAAQ,CAACwF,IAAI,CAAE8B,MAAM,IAAK;UAC7B,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,KAAK;UACd;UAEA,MAAM;YACJpH,OAAO,EAAE+E;UACX,CAAC,GAAGqC,MAAM;UACV,OAAOrC,IAAI,KAAKzC,IAAI,CAAC9C,IAAI;QAC3B,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,MAAM6H,SAAS,GAAG,CAACpH,kBAAkB,GACnC,OAAOM,YAAY,EAAE,GACrB,QAAQuG,MAAM,IAAIvG,YAAY,KAAKuG,MAAM,EAAE,IACzC,KAAK,IAAI,CAACQ,MAAM,CAACf,KAAK,CAAC,GAAGO,MAAM,CAACS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QAEnD,OAAOjB,KAAK,CAACkB,gBAAgB,CAC3B;QACCd,QAAQ,EACTW,SACF,CAAC;MACH,CAAC;MAED,MAAMI,MAAM,GAAGA,CAAA,KAAM;QACnB,MAAM;UACJP;QACF,CAAC,GAAG,kDAAoD5E,IAAI,CAAC2E,GAAI;QACjE,MAAMA,GAAG,GAAG;UACVS,GAAG,EAAE;YACHP,MAAM,EAAE,CAAC;YACTQ,IAAI,EAAET,KAAK,CAACS,IAAI,GAAG;UACrB,CAAC;UACDT;QACF,CAAC;QACDlH,OAAO,CAACyH,MAAM,CAAC;UACbpB,GAAG,EAAElG,WAAW,GAAGkG,GAAG,GAAG,IAAI;UAC7BY,GAAG;UACHW,SAAS,EAAE,cAAc;UACzBtF;QACF,CAAC,CAAC;MACJ,CAAC;MAED,IAAI9B,UAAU,EAAE;QACd;QACA,MAAMmD,GAAG,GAAG;UACVjD,aAAa,EAAEmH,OAAO,CAACrH,UAAU,EAAEE,aAAa,IAAI,KAAK,CAAC;UAC1DE,GAAG,EAAEiH,OAAO,CAACrH,UAAU,EAAEI,GAAG,IAAI,IAAI,CAAC;UACrCkH,iBAAiB,EAAED,OAAO,CAACrH,UAAU,EAAEG,GAAG,IAAI,IAAI,CAAC;UACnDoH,UAAU,EAAEF,OAAO,CAACrH,UAAU,EAAEK,MAAM,IAAI,KAAK;QACjD,CAAC;QACD,MAAMmH,QAAQ,GAAGC,qBAAY,CAACC,mBAAmB,CAAC5F,IAAI,EAAEC,UAAU,EAAEoB,GAAG,EAAEnB,QAAQ,CAAC;QAElF,IAAIwF,QAAQ,EAAE;UACZP,MAAM,CAAC,CAAC;QACV;MACF,CAAC,MAAM;QACLA,MAAM,CAAC,CAAC;MACV;IACF,CAAC;;IAED;AACJ;AACA;AACA;IACI,MAAMU,SAAS,GAAI3E,IAAI,IAAK;MAC1B,OAAOkB,aAAa,CAAClB,IAAI,CAAC,IAAI1D,QAAQ,CAACgF,IAAI,CAAEC,IAAI,IAAK;QACpD,OAAO,OAAOA,IAAI,KAAK,QAAQ,GAAGA,IAAI,CAAC/E,OAAO,KAAKwD,IAAI,GAAGuB,IAAI,KAAKvB,IAAI;MACzE,CAAC,CAAC;IACJ,CAAC;IAED,OAAO;MACL,GAAG,IAAA4E,4BAAgB,EACjB,IAAAC,4BAAgB,EAACrI,OAAO,EAAE,EAAE,EAAEwC,QAAQ,CAAC,EACvCmC,UACF,CAAC;MACD7D,uBAAuBA,CAAEwB,IAAI,EAAE;QAC7B,IAAI,CAAC6F,SAAS,CAAC,yBAAyB,CAAC,EAAE;UACzC;QACF;QAEA,IACE,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAACG,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC8I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC1B8C,IAAI;QACF;AACd;AACA;AACA;AACA;QACeA,IAAI,CAACP,MAAM,CAAEwG,KAAK,EACvB;UACA5D,UAAU,CAAC;YACTqB,iBAAiB,EAAE;UACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;QAChB;MACF,CAAC;MAEDvB,gBAAgBA,CAAEuB,IAAI,EAAE;QACtB,IAAI,CAAC6F,SAAS,CAAC,kBAAkB,CAAC,EAAE;UAClC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;MAChB,CAAC;MAEDtB,eAAeA,CAAEsB,IAAI,EAAE;QACrB,IAAI,CAAC6F,SAAS,CAAC,iBAAiB,CAAC,EAAE;UACjC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;MAChB,CAAC;MAEDrB,mBAAmBA,CAAEqB,IAAI,EAAE;QACzB,IAAI,CAAC6F,SAAS,CAAC,qBAAqB,CAAC,EAAE;UACrC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;MAChB,CAAC;MAEDpB,kBAAkBA,CAAEoB,IAAI,EAAE;QACxB,IAAI,CAAC6F,SAAS,CAAC,oBAAoB,CAAC,EAAE;UACpC;QACF;QAEA,IAAI5I,2BAA2B,IAC7B,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAAC+I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC8I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC1B8C,IAAI;QACF;AACd;AACA;AACA;AACA;QACeA,IAAI,CAACP,MAAM,CAAEwG,KAAK,EACvB;UACA5D,UAAU,CAAC;YACTqB,iBAAiB,EAAE;UACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;QAChB;MACF,CAAC;MAEDnB,gBAAgBA,CAAEmB,IAAI,EAAE;QACtB,IAAI,CAAC6F,SAAS,CAAC,kBAAkB,CAAC,EAAE;UAClC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE,IAAI;UACvBR,QAAQ,EAAE;QACZ,CAAC,EAAE,IAAI,EAAE,yCAA2ClD,IAAI,CAACiG,KAAM,CAAC;MAClE;IACF,CAAC;EACH,CAAC;EACDC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,QAAQ,EAAE,kBAAkB;MAC5BrJ,WAAW,EAAE,qHAAqH;MAClIsJ,WAAW,EAAE,IAAI;MACjBC,GAAG,EAAE;IACP,CAAC;IAEDC,OAAO,EAAE,MAAM;IAEfC,QAAQ,EAAE;MACRC,YAAY,EAAE;IAChB,CAAC;IAEDC,MAAM,EAAE,CACN7J,cAAc,CACf;IAEDK,IAAI,EAAE;EACR;AACF,CAAC;AAAAyJ,MAAA,CAAA5E,OAAA,GAAAA,OAAA,CAAAnF,OAAA","ignoreList":[]}
1	+ {"version":3,"file":"requireJsdoc.cjs","names":["_exportParser","_interopRequireDefault","require","_iterateJsdoc","_jsdocUtils","_jsdoccomment","e","__esModule","default","OPTIONS_SCHEMA","additionalProperties","description","properties","checkAllFunctionExpressions","type","checkConstructors","checkGetters","anyOf","enum","checkSetters","contexts","items","context","inlineCommentBlock","minLineCount","enableFixer","exemptEmptyConstructors","exemptEmptyFunctions","exemptOverloadedImplementations","fixerMessage","publicOnly","oneOf","ancestorsOnly","cjs","esm","window","ArrowFunctionExpression","ClassDeclaration","ClassExpression","FunctionDeclaration","FunctionExpression","MethodDefinition","skipInterveningOverloadedDeclarations","getMethodOnInterface","interfaceName","methodName","scope","scp","identifiers","name","variables","identifier","interfaceDeclaration","parent","bodyItem","body","methodSig","key","upper","isExemptedImplementer","node","sourceCode","settings","implments","implements","impl","expression","interfaceMethodNode","getScope","comment","getJSDocComment","getOption","baseObject","option","options","getOptions","undefined","baseObj","prop","Object","keys","opt","isFunctionWithOverload","child","functionName","id","idx","indexOf","prevSibling","declaration","_default","exports","create","getSourceCode","getSettings","opts","requireOption","checkJsDoc","info","_handler","some","ctxt","count","underMinLine","getText","match","length","contextMinLineCount","find","ctx","selector","jsDocNode","checkOverloads","exemptSpeciaMethods","inlineTags","problems","source","tags","isFunctionContext","isConstructor","functionParameterNames","getFunctionParameterNames","hasReturnValue","fix","fixer","lines","minLines","maxLines","baseNode","getReducedASTNode","decorator","getDecorator","indent","getIndent","text","loc","start","column","contxt","insertion","repeat","slice","insertTextBefore","report","end","line","messageId","Boolean","initModuleExports","initWindow","exported","exportParser","isUncommentedExport","hasOption","getContextObject","enforcedContexts","includes","value","meta","docs","recommended","url","fixable","messages","missingJsDoc","schema","module"],"sources":["../../src/rules/requireJsdoc.js"],"sourcesContent":["import exportParser from '../exportParser.js';\nimport {\n getSettings,\n} from '../iterateJsdoc.js';\nimport {\n enforcedContexts,\n exemptSpeciaMethods,\n getContextObject,\n getFunctionParameterNames,\n getIndent,\n hasReturnValue,\n isConstructor,\n} from '../jsdocUtils.js';\nimport {\n getDecorator,\n getJSDocComment,\n getReducedASTNode,\n} from '@es-joy/jsdoccomment';\n\n/*\n @typedef {{\n * ancestorsOnly: boolean,\n * esm: boolean,\n * initModuleExports: boolean,\n * initWindow: boolean\n * }} RequireJsdocOpts\n /\n\n/\n @typedef {import('eslint').Rule.Node\|\n * import('@typescript-eslint/types').TSESTree.Node} ESLintOrTSNode\n /\n\n/* @type {import('json-schema').JSONSchema4} /\nconst OPTIONS_SCHEMA = {\n additionalProperties: false,\n description: 'Has the following optional keys.\\n',\n properties: {\n checkAllFunctionExpressions: {\n default: false,\n description: `Normally, when \\`FunctionExpression\\` is checked, additional checks are\nadded to check the parent contexts where reporting is likely to be desired. If you really\nwant to check all* function expressions, then set this to \\`true\\`.`,\n type: 'boolean',\n },\n checkConstructors: {\n default: true,\n description: `A value indicating whether \\`constructor\\`s should be checked. Defaults to\n\\`true\\`. When \\`true\\`, \\`exemptEmptyConstructors\\` may still avoid reporting when\nno parameters or return values are found.`,\n type: 'boolean',\n },\n checkGetters: {\n anyOf: [\n {\n type: 'boolean',\n },\n {\n enum: [\n 'no-setter',\n ],\n type: 'string',\n },\n ],\n default: true,\n description: `A value indicating whether getters should be checked. Besides setting as a\nboolean, this option can be set to the string \\`\"no-setter\"\\` to indicate that\ngetters should be checked but only when there is no setter. This may be useful\nif one only wishes documentation on one of the two accessors. Defaults to\n\\`false\\`.`,\n },\n checkSetters: {\n anyOf: [\n {\n type: 'boolean',\n },\n {\n enum: [\n 'no-getter',\n ],\n type: 'string',\n },\n ],\n default: true,\n description: `A value indicating whether setters should be checked. Besides setting as a\nboolean, this option can be set to the string \\`\"no-getter\"\\` to indicate that\nsetters should be checked but only when there is no getter. This may be useful\nif one only wishes documentation on one of the two accessors. Defaults to\n\\`false\\`.`,\n },\n contexts: {\n description: `Set this to an array of strings or objects representing the additional AST\ncontexts where you wish the rule to be applied (e.g., \\`Property\\` for\nproperties). If specified as an object, it should have a \\`context\\` property\nand can have an \\`inlineCommentBlock\\` property which, if set to \\`true\\`, will\nadd an inline \\`/** /\\` instead of the regular, multi-line, indented jsdoc\nblock which will otherwise be added. Defaults to an empty array. Contexts\nmay also have their own \\`minLineCount\\` property which is an integer\nindicating a minimum number of lines expected for a node in order\nfor it to require documentation.\n\nNote that you may need to disable \\`require\\` items (e.g., \\`MethodDefinition\\`)\nif you are specifying a more precise form in \\`contexts\\` (e.g., \\`MethodDefinition:not([accessibility=\"private\"] > FunctionExpression\\`).\n\nSee the [\"AST and Selectors\"](../#advanced-ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n context: {\n type: 'string',\n },\n inlineCommentBlock: {\n type: 'boolean',\n },\n minLineCount: {\n type: 'integer',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n enableFixer: {\n default: true,\n description: `A boolean on whether to enable the fixer (which adds an empty JSDoc block).\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n exemptEmptyConstructors: {\n default: false,\n description: `When \\`true\\`, the rule will not report missing JSDoc blocks above constructors\nwith no parameters or return values (this is enabled by default as the class\nname or description should be seen as sufficient to convey intent).\n\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n exemptEmptyFunctions: {\n default: false,\n description: `When \\`true\\`, the rule will not report missing JSDoc blocks above\nfunctions/methods with no parameters or return values (intended where\nfunction/method names are sufficient for themselves as documentation).\n\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n exemptOverloadedImplementations: {\n default: false,\n description: `If set to \\`true\\` will avoid checking an overloaded function's implementation.\n\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n fixerMessage: {\n default: '',\n description: `An optional message to add to the inserted JSDoc block. Defaults to the\nempty string.`,\n type: 'string',\n },\n minLineCount: {\n description: `An integer to indicate a minimum number of lines expected for a node in order\nfor it to require documentation. Defaults to \\`undefined\\`. This option will\napply to any context; see \\`contexts\\` for line counts specific to a context.`,\n type: 'integer',\n },\n publicOnly: {\n description: `This option will insist that missing JSDoc blocks are only reported for\nfunction bodies / class declarations that are exported from the module.\nMay be a boolean or object. If set to \\`true\\`, the defaults below will be\nused. If unset, JSDoc block reporting will not be limited to exports.\n\nThis object supports the following optional boolean keys (\\`false\\` unless\notherwise noted):\n\n- \\`ancestorsOnly\\` - Optimization to only check node ancestors to check if node is exported\n- \\`esm\\` - ESM exports are checked for JSDoc comments (Defaults to \\`true\\`)\n- \\`cjs\\` - CommonJS exports are checked for JSDoc comments (Defaults to \\`true\\`)\n- \\`window\\` - Window global exports are checked for JSDoc comments`,\n oneOf: [\n {\n default: false,\n type: 'boolean',\n },\n {\n additionalProperties: false,\n default: {},\n properties: {\n ancestorsOnly: {\n type: 'boolean',\n },\n cjs: {\n type: 'boolean',\n },\n esm: {\n type: 'boolean',\n },\n window: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n require: {\n additionalProperties: false,\n default: {},\n description: `An object with the following optional boolean keys which all default to\n\\`false\\` except for \\`FunctionDeclaration\\` which defaults to \\`true\\`.`,\n properties: {\n ArrowFunctionExpression: {\n default: false,\n description: 'Whether to check arrow functions like `() => {}`',\n type: 'boolean',\n },\n ClassDeclaration: {\n default: false,\n description: 'Whether to check declarations like `class A {}`',\n type: 'boolean',\n },\n ClassExpression: {\n default: false,\n description: 'Whether to check class expressions like `const myClass = class {}`',\n type: 'boolean',\n },\n FunctionDeclaration: {\n default: true,\n description: 'Whether to check function declarations like `function a {}`',\n type: 'boolean',\n },\n FunctionExpression: {\n default: false,\n description: 'Whether to check function expressions like `const a = function {}`',\n type: 'boolean',\n },\n MethodDefinition: {\n default: false,\n description: 'Whether to check method definitions like `class A { someMethodDefinition () {} }`',\n type: 'boolean',\n },\n },\n type: 'object',\n },\n skipInterveningOverloadedDeclarations: {\n default: true,\n description: `If \\`true\\`, will skip above uncommented overloaded functions to check\nfor a comment block (e.g., at the top of a set of overloaded functions).\n\nIf \\`false\\`, will force each overloaded function to be checked for a\ncomment block.\n\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n },\n type: 'object',\n};\n\n/\n @param {string} interfaceName\n * @param {string} methodName\n * @param {import(\"eslint\").Scope.Scope \| null} scope\n * @returns {import('@typescript-eslint/types').TSESTree.TSMethodSignature\|null}\n /\nconst getMethodOnInterface = (interfaceName, methodName, scope) => {\n let scp = scope;\n while (scp) {\n for (const {\n identifiers,\n name,\n } of scp.variables) {\n if (interfaceName !== name) {\n continue;\n }\n\n for (const identifier of identifiers) {\n const interfaceDeclaration = /* @type {import('@typescript-eslint/types').TSESTree.Identifier & {parent: import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration}} / (\n identifier\n ).parent;\n / c8 ignore next 3 -- TS /\n if (interfaceDeclaration.type !== 'TSInterfaceDeclaration') {\n continue;\n }\n\n for (const bodyItem of interfaceDeclaration.body.body) {\n const methodSig = /* @type {import('@typescript-eslint/types').TSESTree.TSMethodSignature} / (\n bodyItem\n );\n if (methodName === /* @type {import('@typescript-eslint/types').TSESTree.Identifier} / (\n methodSig.key\n ).name) {\n return methodSig;\n }\n }\n }\n }\n\n scp = scp.upper;\n }\n\n return null;\n};\n\n/\n @param {import('eslint').Rule.Node} node\n * @param {import('eslint').SourceCode} sourceCode\n * @param {import('eslint').Rule.RuleContext} context\n * @param {import('../iterateJsdoc.js').Settings} settings\n /\nconst isExemptedImplementer = (node, sourceCode, context, settings) => {\n if (node.type === 'FunctionExpression' &&\n node.parent.type === 'MethodDefinition' &&\n node.parent.parent.type === 'ClassBody' &&\n node.parent.parent.parent.type === 'ClassDeclaration' &&\n 'implements' in node.parent.parent.parent\n ) {\n const implments = /* @type {import('@typescript-eslint/types').TSESTree.TSClassImplements[]} / (\n node.parent.parent.parent.implements\n );\n\n const {\n name: methodName,\n } = /* @type {import('@typescript-eslint/types').TSESTree.Identifier} / (\n node.parent.key\n );\n\n for (const impl of implments) {\n const {\n name: interfaceName,\n } = /* @type {import('@typescript-eslint/types').TSESTree.Identifier} / (\n impl.expression\n );\n\n const interfaceMethodNode = getMethodOnInterface(interfaceName, methodName, node && (\n (sourceCode.getScope &&\n / c8 ignore next 3 /\n sourceCode.getScope(node)) \|\|\n // @ts-expect-error ESLint 8\n context.getScope()\n ));\n if (interfaceMethodNode) {\n // @ts-expect-error Ok\n const comment = getJSDocComment(sourceCode, interfaceMethodNode, settings);\n if (comment) {\n return true;\n }\n }\n }\n }\n\n return false;\n};\n\n/\n @param {import('eslint').Rule.RuleContext} context\n * @param {import('json-schema').JSONSchema4Object} baseObject\n * @param {string} option\n * @param {string} key\n * @returns {boolean\|undefined}\n /\nconst getOption = (context, baseObject, option, key) => {\n if (context.options[0] && option in context.options[0] &&\n // Todo: boolean shouldn't be returning property, but\n // tests currently require\n (typeof context.options[0][option] === 'boolean' \|\|\n key in context.options[0][option])\n ) {\n return context.options[0][option][key];\n }\n\n return /* @type {{[key: string]: {default?: boolean\|undefined}}} / (\n baseObject.properties\n )[key].default;\n};\n\n/\n @param {import('eslint').Rule.RuleContext} context\n * @param {import('../iterateJsdoc.js').Settings} settings\n * @returns {{\n * checkAllFunctionExpressions: boolean,\n * contexts: (string\|{\n * context: string,\n * inlineCommentBlock: boolean,\n * minLineCount: import('../iterateJsdoc.js').Integer\n * })[],\n * enableFixer: boolean,\n * exemptEmptyConstructors: boolean,\n * exemptEmptyFunctions: boolean,\n * skipInterveningOverloadedDeclarations: boolean,\n * exemptOverloadedImplementations: boolean,\n * fixerMessage: string,\n * minLineCount: undefined\|import('../iterateJsdoc.js').Integer,\n * publicOnly: boolean\|{[key: string]: boolean\|undefined}\n * require: {[key: string]: boolean\|undefined}\n * }}\n /\nconst getOptions = (context, settings) => {\n const {\n checkAllFunctionExpressions = false,\n contexts = settings.contexts \|\| [],\n enableFixer = true,\n exemptEmptyConstructors = true,\n exemptEmptyFunctions = false,\n exemptOverloadedImplementations = false,\n fixerMessage = '',\n minLineCount = undefined,\n publicOnly,\n skipInterveningOverloadedDeclarations = true,\n } = context.options[0] \|\| {};\n\n return {\n checkAllFunctionExpressions,\n contexts,\n enableFixer,\n exemptEmptyConstructors,\n exemptEmptyFunctions,\n exemptOverloadedImplementations,\n fixerMessage,\n minLineCount,\n publicOnly: ((baseObj) => {\n if (!publicOnly) {\n return false;\n }\n\n /* @type {{[key: string]: boolean\|undefined}} /\n const properties = {};\n for (const prop of Object.keys(\n /* @type {import('json-schema').JSONSchema4Object} / (\n /* @type {import('json-schema').JSONSchema4Object} / (\n baseObj\n ).properties),\n )) {\n const opt = getOption(\n context,\n /* @type {import('json-schema').JSONSchema4Object} / (baseObj),\n 'publicOnly',\n prop,\n );\n\n properties[prop] = opt;\n }\n\n return properties;\n })(\n /* @type {import('json-schema').JSONSchema4Object} /\n (\n /* @type {import('json-schema').JSONSchema4Object} /\n (\n /* @type {import('json-schema').JSONSchema4Object} /\n (\n OPTIONS_SCHEMA.properties\n ).publicOnly\n ).oneOf\n )[1],\n ),\n require: ((baseObj) => {\n /* @type {{[key: string]: boolean\|undefined}} /\n const properties = {};\n for (const prop of Object.keys(\n /* @type {import('json-schema').JSONSchema4Object} / (\n /* @type {import('json-schema').JSONSchema4Object} / (\n baseObj\n ).properties),\n )) {\n const opt = getOption(\n context,\n /* @type {import('json-schema').JSONSchema4Object} /\n (baseObj),\n 'require',\n prop,\n );\n properties[prop] = opt;\n }\n\n return properties;\n })(\n /* @type {import('json-schema').JSONSchema4Object} /\n (OPTIONS_SCHEMA.properties).require,\n ),\n skipInterveningOverloadedDeclarations,\n };\n};\n\n/\n @param {ESLintOrTSNode} node\n /\nconst isFunctionWithOverload = (node) => {\n if (node.type !== 'FunctionDeclaration') {\n return false;\n }\n\n let parent;\n let child;\n\n if (node.parent?.type === 'Program') {\n parent = node.parent;\n child = node;\n } else if (node.parent?.type === 'ExportNamedDeclaration' &&\n node.parent?.parent.type === 'Program') {\n parent = node.parent?.parent;\n child = node.parent;\n }\n\n if (!child \|\| !parent) {\n return false;\n }\n\n const functionName = node.id?.name;\n\n const idx = parent.body.indexOf(child);\n const prevSibling = parent.body[idx - 1];\n\n return (\n // @ts-expect-error Should be ok\n (prevSibling?.type === 'TSDeclareFunction' &&\n // @ts-expect-error Should be ok\n functionName === prevSibling.id.name) \|\|\n (prevSibling?.type === 'ExportNamedDeclaration' &&\n // @ts-expect-error Should be ok\n prevSibling.declaration?.type === 'TSDeclareFunction' &&\n // @ts-expect-error Should be ok\n prevSibling.declaration?.id?.name === functionName)\n );\n};\n\n/* @type {import('eslint').Rule.RuleModule} /\nexport default {\n create (context) {\n / c8 ignore next -- Fallback to deprecated method /\n const {\n // @ts-expect-error ESLint < 10\n sourceCode = context.getSourceCode(),\n } = context;\n const settings = getSettings(context);\n if (!settings) {\n return {};\n }\n\n const opts = getOptions(context, settings);\n\n const {\n checkAllFunctionExpressions,\n contexts,\n enableFixer,\n exemptEmptyConstructors,\n exemptEmptyFunctions,\n exemptOverloadedImplementations,\n fixerMessage,\n minLineCount,\n require: requireOption,\n skipInterveningOverloadedDeclarations,\n } = opts;\n\n const publicOnly =\n\n /\n @type {{\n * [key: string]: boolean \| undefined;\n * }}\n / (\n opts.publicOnly\n );\n\n /\n @type {import('../iterateJsdoc.js').CheckJsdoc}\n /\n const checkJsDoc = (info, _handler, node) => {\n if (\n // Optimize\n minLineCount !== undefined \|\| contexts.some((ctxt) => {\n if (typeof ctxt === 'string') {\n return false;\n }\n\n const {\n minLineCount: count,\n } = ctxt;\n return count !== undefined;\n })\n ) {\n /\n @param {undefined\|import('../iterateJsdoc.js').Integer} count\n /\n const underMinLine = (count) => {\n return count !== undefined && count >\n (sourceCode.getText(node).match(/\\n/gv)?.length ?? 0) + 1;\n };\n\n if (underMinLine(minLineCount)) {\n return;\n }\n\n const {\n minLineCount: contextMinLineCount,\n } =\n /\n @type {{\n * context: string;\n * inlineCommentBlock: boolean;\n * minLineCount: number;\n * }}\n / (contexts.find((ctxt) => {\n if (typeof ctxt === 'string') {\n return false;\n }\n\n const {\n context: ctx,\n } = ctxt;\n return ctx === (info.selector \|\| node.type);\n })) \|\| {};\n if (underMinLine(contextMinLineCount)) {\n return;\n }\n }\n\n if (exemptOverloadedImplementations && isFunctionWithOverload(node)) {\n return;\n }\n\n const jsDocNode = getJSDocComment(\n sourceCode, node, settings, {\n checkOverloads: skipInterveningOverloadedDeclarations,\n },\n );\n\n if (jsDocNode) {\n return;\n }\n\n // For those who have options configured against ANY constructors (or\n // setters or getters) being reported\n if (exemptSpeciaMethods(\n {\n description: '',\n inlineTags: [],\n problems: [],\n source: [],\n tags: [],\n },\n node,\n context,\n [\n OPTIONS_SCHEMA,\n ],\n )) {\n return;\n }\n\n if (\n // Avoid reporting param-less, return-less functions (when\n // `exemptEmptyFunctions` option is set)\n exemptEmptyFunctions && info.isFunctionContext \|\|\n\n // Avoid reporting param-less, return-less constructor methods (when\n // `exemptEmptyConstructors` option is set)\n exemptEmptyConstructors && isConstructor(node)\n ) {\n const functionParameterNames = getFunctionParameterNames(node);\n if (!functionParameterNames.length && !hasReturnValue(node)) {\n return;\n }\n }\n\n if (isExemptedImplementer(node, sourceCode, context, settings)) {\n return;\n }\n\n const fix = /* @type {import('eslint').Rule.ReportFixer} / (fixer) => {\n // Default to one line break if the `minLines`/`maxLines` settings allow\n const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;\n /* @type {ESLintOrTSNode\|import('@typescript-eslint/types').TSESTree.Decorator} /\n let baseNode = getReducedASTNode(node, sourceCode);\n\n const decorator = getDecorator(\n /* @type {import('eslint').Rule.Node} /\n (baseNode),\n );\n if (decorator) {\n baseNode = decorator;\n }\n\n const indent = getIndent({\n text: sourceCode.getText(\n /* @type {import('eslint').Rule.Node} / (baseNode),\n /* @type {import('eslint').AST.SourceLocation} /\n (\n /* @type {import('eslint').Rule.Node} / (baseNode).loc\n ).start.column,\n ),\n });\n\n const {\n inlineCommentBlock,\n } =\n /\n @type {{\n * context: string,\n * inlineCommentBlock: boolean,\n * minLineCount: import('../iterateJsdoc.js').Integer\n * }}\n / (contexts.find((contxt) => {\n if (typeof contxt === 'string') {\n return false;\n }\n\n const {\n context: ctxt,\n } = contxt;\n return ctxt === node.type;\n })) \|\| {};\n const insertion = (inlineCommentBlock ?\n `/* ${fixerMessage}` :\n `/*\\n${indent}${fixerMessage}\\n${indent}`) +\n `/${'\\n'.repeat(lines)}${indent.slice(0, -1)}`;\n\n return fixer.insertTextBefore(\n /* @type {import('eslint').Rule.Node} /\n (baseNode),\n insertion,\n );\n };\n\n const report = () => {\n const {\n start,\n } = /* @type {import('eslint').AST.SourceLocation} / (node.loc);\n const loc = {\n end: {\n column: 0,\n line: start.line + 1,\n },\n start,\n };\n context.report({\n fix: enableFixer ? fix : null,\n loc,\n messageId: 'missingJsDoc',\n node,\n });\n };\n\n if (publicOnly) {\n /* @type {RequireJsdocOpts} /\n const opt = {\n ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),\n esm: Boolean(publicOnly?.esm ?? true),\n initModuleExports: Boolean(publicOnly?.cjs ?? true),\n initWindow: Boolean(publicOnly?.window ?? false),\n };\n const exported = exportParser.isUncommentedExport(node, sourceCode, opt, settings);\n\n if (exported) {\n report();\n }\n } else {\n report();\n }\n };\n\n /\n @param {string} prop\n * @returns {boolean}\n /\n const hasOption = (prop) => {\n return requireOption[prop] \|\| contexts.some((ctxt) => {\n return typeof ctxt === 'object' ? ctxt.context === prop : ctxt === prop;\n });\n };\n\n return {\n ...getContextObject(\n enforcedContexts(context, [], settings),\n checkJsDoc,\n ),\n ArrowFunctionExpression (node) {\n if (!hasOption('ArrowFunctionExpression')) {\n return;\n }\n\n if (\n [\n 'AssignmentExpression', 'ExportDefaultDeclaration', 'VariableDeclarator',\n ].includes(node.parent.type) \|\|\n [\n 'ClassProperty', 'ObjectProperty', 'Property', 'PropertyDefinition',\n ].includes(node.parent.type) &&\n node ===\n /\n @type {import('@typescript-eslint/types').TSESTree.Property\|\n * import('@typescript-eslint/types').TSESTree.PropertyDefinition\n * }\n /\n (node.parent).value\n ) {\n checkJsDoc({\n isFunctionContext: true,\n }, null, node);\n }\n },\n\n ClassDeclaration (node) {\n if (!hasOption('ClassDeclaration')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: false,\n }, null, node);\n },\n\n ClassExpression (node) {\n if (!hasOption('ClassExpression')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: false,\n }, null, node);\n },\n\n FunctionDeclaration (node) {\n if (!hasOption('FunctionDeclaration')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: true,\n }, null, node);\n },\n\n FunctionExpression (node) {\n if (!hasOption('FunctionExpression')) {\n return;\n }\n\n if (checkAllFunctionExpressions \|\|\n [\n 'AssignmentExpression', 'ExportDefaultDeclaration', 'VariableDeclarator',\n ].includes(node.parent.type) \|\|\n [\n 'ClassProperty', 'ObjectProperty', 'Property', 'PropertyDefinition',\n ].includes(node.parent.type) &&\n node ===\n /\n @type {import('@typescript-eslint/types').TSESTree.Property\|\n * import('@typescript-eslint/types').TSESTree.PropertyDefinition\n * }\n /\n (node.parent).value\n ) {\n checkJsDoc({\n isFunctionContext: true,\n }, null, node);\n }\n },\n\n MethodDefinition (node) {\n if (!hasOption('MethodDefinition')) {\n return;\n }\n\n checkJsDoc({\n isFunctionContext: true,\n selector: 'MethodDefinition',\n }, null, /* @type {import('eslint').Rule.Node} */ (node.value));\n },\n };\n },\n meta: {\n docs: {\n description: 'Checks for presence of JSDoc comments, on functions and potentially other contexts (optionally limited to exports).',\n recommended: true,\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md#repos-sticky-header',\n },\n\n fixable: 'code',\n\n messages: {\n missingJsDoc: 'Missing JSDoc comment.',\n },\n\n schema: [\n OPTIONS_SCHEMA,\n ],\n\n type: 'suggestion',\n },\n};\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAGA,IAAAE,WAAA,GAAAF,OAAA;AASA,IAAAG,aAAA,GAAAH,OAAA;AAI8B,SAAAD,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA,MAAMG,cAAc,GAAG;EACrBC,oBAAoB,EAAE,KAAK;EAC3BC,WAAW,EAAE,oCAAoC;EACjDC,UAAU,EAAE;IACVC,2BAA2B,EAAE;MAC3BL,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA,qEAAqE;MAC/DG,IAAI,EAAE;IACR,CAAC;IACDC,iBAAiB,EAAE;MACjBP,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA,0CAA0C;MACpCG,IAAI,EAAE;IACR,CAAC;IACDE,YAAY,EAAE;MACZC,KAAK,EAAE,CACL;QACEH,IAAI,EAAE;MACR,CAAC,EACD;QACEI,IAAI,EAAE,CACJ,WAAW,CACZ;QACDJ,IAAI,EAAE;MACR,CAAC,CACF;MACDN,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;IACI,CAAC;IACDQ,YAAY,EAAE;MACZF,KAAK,EAAE,CACL;QACEH,IAAI,EAAE;MACR,CAAC,EACD;QACEI,IAAI,EAAE,CACJ,WAAW,CACZ;QACDJ,IAAI,EAAE;MACR,CAAC,CACF;MACDN,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;IACI,CAAC;IACDS,QAAQ,EAAE;MACRT,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;MACxDU,KAAK,EAAE;QACLJ,KAAK,EAAE,CACL;UACEH,IAAI,EAAE;QACR,CAAC,EACD;UACEJ,oBAAoB,EAAE,KAAK;UAC3BE,UAAU,EAAE;YACVU,OAAO,EAAE;cACPR,IAAI,EAAE;YACR,CAAC;YACDS,kBAAkB,EAAE;cAClBT,IAAI,EAAE;YACR,CAAC;YACDU,YAAY,EAAE;cACZV,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;MAEL,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACDW,WAAW,EAAE;MACXjB,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB,sBAAsB;MAChBG,IAAI,EAAE;IACR,CAAC;IACDY,uBAAuB,EAAE;MACvBlB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA;AACA;AACA,sBAAsB;MAChBG,IAAI,EAAE;IACR,CAAC;IACDa,oBAAoB,EAAE;MACpBnB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA;AACA;AACA,uBAAuB;MACjBG,IAAI,EAAE;IACR,CAAC;IACDc,+BAA+B,EAAE;MAC/BpB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA,uBAAuB;MACjBG,IAAI,EAAE;IACR,CAAC;IACDe,YAAY,EAAE;MACZrB,OAAO,EAAE,EAAE;MACXG,WAAW,EAAE;AACnB,cAAc;MACRG,IAAI,EAAE;IACR,CAAC;IACDU,YAAY,EAAE;MACZb,WAAW,EAAE;AACnB;AACA,8EAA8E;MACxEG,IAAI,EAAE;IACR,CAAC;IACDgB,UAAU,EAAE;MACVnB,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,oEAAoE;MAC9DoB,KAAK,EAAE,CACL;QACEvB,OAAO,EAAE,KAAK;QACdM,IAAI,EAAE;MACR,CAAC,EACD;QACEJ,oBAAoB,EAAE,KAAK;QAC3BF,OAAO,EAAE,CAAC,CAAC;QACXI,UAAU,EAAE;UACVoB,aAAa,EAAE;YACblB,IAAI,EAAE;UACR,CAAC;UACDmB,GAAG,EAAE;YACHnB,IAAI,EAAE;UACR,CAAC;UACDoB,GAAG,EAAE;YACHpB,IAAI,EAAE;UACR,CAAC;UACDqB,MAAM,EAAE;YACNrB,IAAI,EAAE;UACR;QACF,CAAC;QACDA,IAAI,EAAE;MACR,CAAC;IAEL,CAAC;IACDZ,OAAO,EAAE;MACPQ,oBAAoB,EAAE,KAAK;MAC3BF,OAAO,EAAE,CAAC,CAAC;MACXG,WAAW,EAAE;AACnB,yEAAyE;MACnEC,UAAU,EAAE;QACVwB,uBAAuB,EAAE;UACvB5B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,kDAAkD;UAC/DG,IAAI,EAAE;QACR,CAAC;QACDuB,gBAAgB,EAAE;UAChB7B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,iDAAiD;UAC9DG,IAAI,EAAE;QACR,CAAC;QACDwB,eAAe,EAAE;UACf9B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,oEAAoE;UACjFG,IAAI,EAAE;QACR,CAAC;QACDyB,mBAAmB,EAAE;UACnB/B,OAAO,EAAE,IAAI;UACbG,WAAW,EAAE,6DAA6D;UAC1EG,IAAI,EAAE;QACR,CAAC;QACD0B,kBAAkB,EAAE;UAClBhC,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,oEAAoE;UACjFG,IAAI,EAAE;QACR,CAAC;QACD2B,gBAAgB,EAAE;UAChBjC,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,mFAAmF;UAChGG,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACD4B,qCAAqC,EAAE;MACrClC,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA,sBAAsB;MAChBG,IAAI,EAAE;IACR;EACF,CAAC;EACDA,IAAI,EAAE;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM6B,oBAAoB,GAAGA,CAACC,aAAa,EAAEC,UAAU,EAAEC,KAAK,KAAK;EACjE,IAAIC,GAAG,GAAGD,KAAK;EACf,OAAOC,GAAG,EAAE;IACV,KAAK,MAAM;MACTC,WAAW;MACXC;IACF,CAAC,IAAIF,GAAG,CAACG,SAAS,EAAE;MAClB,IAAIN,aAAa,KAAKK,IAAI,EAAE;QAC1B;MACF;MAEA,KAAK,MAAME,UAAU,IAAIH,WAAW,EAAE;QACpC,MAAMI,oBAAoB,GAAG,oJAC3BD,UAAU,CACVE,MAAM;QACR;QACA,IAAID,oBAAoB,CAACtC,IAAI,KAAK,wBAAwB,EAAE;UAC1D;QACF;QAEA,KAAK,MAAMwC,QAAQ,IAAIF,oBAAoB,CAACG,IAAI,CAACA,IAAI,EAAE;UACrD,MAAMC,SAAS,GAAG;UAChBF,QACD;UACD,IAAIT,UAAU,KAAK,qEACjBW,SAAS,CAACC,GAAG,CACbR,IAAI,EAAE;YACN,OAAOO,SAAS;UAClB;QACF;MACF;IACF;IAEAT,GAAG,GAAGA,GAAG,CAACW,KAAK;EACjB;EAEA,OAAO,IAAI;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,qBAAqB,GAAGA,CAACC,IAAI,EAAEC,UAAU,EAAEvC,OAAO,EAAEwC,QAAQ,KAAK;EACrE,IAAIF,IAAI,CAAC9C,IAAI,KAAK,oBAAoB,IACpC8C,IAAI,CAACP,MAAM,CAACvC,IAAI,KAAK,kBAAkB,IACvC8C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACvC,IAAI,KAAK,WAAW,IACvC8C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,CAACvC,IAAI,KAAK,kBAAkB,IACrD,YAAY,IAAI8C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,EACzC;IACA,MAAMU,SAAS,GAAG;IAChBH,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,CAACW,UAC3B;IAED,MAAM;MACJf,IAAI,EAAEJ;IACR,CAAC,GAAG;IACFe,IAAI,CAACP,MAAM,CAACI,GACb;IAED,KAAK,MAAMQ,IAAI,IAAIF,SAAS,EAAE;MAC5B,MAAM;QACJd,IAAI,EAAEL;MACR,CAAC,GAAG;MACFqB,IAAI,CAACC,UACN;MAED,MAAMC,mBAAmB,GAAGxB,oBAAoB,CAACC,aAAa,EAAEC,UAAU,EAAEe,IAAI,KAC7EC,UAAU,CAACO,QAAQ,IACpB;MACAP,UAAU,CAACO,QAAQ,CAACR,IAAI,CAAC;MACzB;MACAtC,OAAO,CAAC8C,QAAQ,CAAC,CAAC,CACnB,CAAC;MACF,IAAID,mBAAmB,EAAE;QACvB;QACA,MAAME,OAAO,GAAG,IAAAC,6BAAe,EAACT,UAAU,EAAEM,mBAAmB,EAAEL,QAAQ,CAAC;QAC1E,IAAIO,OAAO,EAAE;UACX,OAAO,IAAI;QACb;MACF;IACF;EACF;EAEA,OAAO,KAAK;AACd,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,SAAS,GAAGA,CAACjD,OAAO,EAAEkD,UAAU,EAAEC,MAAM,EAAEhB,GAAG,KAAK;EACtD,IAAInC,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,IAAID,MAAM,IAAInD,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC;EACpD;EACA;EACC,OAAOpD,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,CAACD,MAAM,CAAC,KAAK,SAAS,IAChDhB,GAAG,IAAInC,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,CAACD,MAAM,CAAC,CAAC,EAClC;IACA,OAAOnD,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,CAACD,MAAM,CAAC,CAAChB,GAAG,CAAC;EACxC;EAEA,OAAO,6DACLe,UAAU,CAAC5D,UAAU,CACrB6C,GAAG,CAAC,CAACjD,OAAO;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMmE,UAAU,GAAGA,CAACrD,OAAO,EAAEwC,QAAQ,KAAK;EACxC,MAAM;IACJjD,2BAA2B,GAAG,KAAK;IACnCO,QAAQ,GAAG0C,QAAQ,CAAC1C,QAAQ,IAAI,EAAE;IAClCK,WAAW,GAAG,IAAI;IAClBC,uBAAuB,GAAG,IAAI;IAC9BC,oBAAoB,GAAG,KAAK;IAC5BC,+BAA+B,GAAG,KAAK;IACvCC,YAAY,GAAG,EAAE;IACjBL,YAAY,GAAGoD,SAAS;IACxB9C,UAAU;IACVY,qCAAqC,GAAG;EAC1C,CAAC,GAAGpB,OAAO,CAACoD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,OAAO;IACL7D,2BAA2B;IAC3BO,QAAQ;IACRK,WAAW;IACXC,uBAAuB;IACvBC,oBAAoB;IACpBC,+BAA+B;IAC/BC,YAAY;IACZL,YAAY;IACZM,UAAU,EAAE,CAAE+C,OAAO,IAAK;MACxB,IAAI,CAAC/C,UAAU,EAAE;QACf,OAAO,KAAK;MACd;;MAEA;MACA,MAAMlB,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMkE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPjE,UACN,CAAC,EAAE;QACD,MAAMqE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP,sDAAwDuD,OAAO,EAC/D,YAAY,EACZC,IACF,CAAC;QAEDlE,UAAU,CAACkE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOrE,UAAU;IACnB,CAAC,EACC;IACA,CACE;IACA,CACE;IAEEH,cAAc,CAACG,UAAU,CACzBkB,UAAU,EACZC,KAAK,EACP,CAAC,CACL,CAAC;IACD7B,OAAO,EAAE,CAAE2E,OAAO,IAAK;MACrB;MACA,MAAMjE,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMkE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPjE,UACN,CAAC,EAAE;QACD,MAAMqE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP;QACCuD,OAAO,EACR,SAAS,EACTC,IACF,CAAC;QACDlE,UAAU,CAACkE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOrE,UAAU;IACnB,CAAC,EACC;IACCH,cAAc,CAACG,UAAU,CAAEV,OAC9B,CAAC;IACDwC;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA,MAAMwC,sBAAsB,GAAItB,IAAI,IAAK;EACvC,IAAIA,IAAI,CAAC9C,IAAI,KAAK,qBAAqB,EAAE;IACvC,OAAO,KAAK;EACd;EAEA,IAAIuC,MAAM;EACV,IAAI8B,KAAK;EAET,IAAIvB,IAAI,CAACP,MAAM,EAAEvC,IAAI,KAAK,SAAS,EAAE;IACnCuC,MAAM,GAAGO,IAAI,CAACP,MAAM;IACpB8B,KAAK,GAAGvB,IAAI;EACd,CAAC,MAAM,IAAIA,IAAI,CAACP,MAAM,EAAEvC,IAAI,KAAK,wBAAwB,IACrD8C,IAAI,CAACP,MAAM,EAAEA,MAAM,CAACvC,IAAI,KAAK,SAAS,EAAE;IAC1CuC,MAAM,GAAGO,IAAI,CAACP,MAAM,EAAEA,MAAM;IAC5B8B,KAAK,GAAGvB,IAAI,CAACP,MAAM;EACrB;EAEA,IAAI,CAAC8B,KAAK,IAAI,CAAC9B,MAAM,EAAE;IACrB,OAAO,KAAK;EACd;EAEA,MAAM+B,YAAY,GAAGxB,IAAI,CAACyB,EAAE,EAAEpC,IAAI;EAElC,MAAMqC,GAAG,GAAGjC,MAAM,CAACE,IAAI,CAACgC,OAAO,CAACJ,KAAK,CAAC;EACtC,MAAMK,WAAW,GAAGnC,MAAM,CAACE,IAAI,CAAC+B,GAAG,GAAG,CAAC,CAAC;EAExC;IACE;IACCE,WAAW,EAAE1E,IAAI,KAAK,mBAAmB;IACxC;IACAsE,YAAY,KAAKI,WAAW,CAACH,EAAE,CAACpC,IAAI,IACrCuC,WAAW,EAAE1E,IAAI,KAAK,wBAAwB;IAC7C;IACA0E,WAAW,CAACC,WAAW,EAAE3E,IAAI,KAAK,mBAAmB;IACrD;IACA0E,WAAW,CAACC,WAAW,EAAEJ,EAAE,EAAEpC,IAAI,KAAKmC;EAAa;AAEzD,CAAC;;AAED;AAAA,IAAAM,QAAA,GAAAC,OAAA,CAAAnF,OAAA,GACe;EACboF,MAAMA,CAAEtE,OAAO,EAAE;IACf;IACA,MAAM;MACJ;MACAuC,UAAU,GAAGvC,OAAO,CAACuE,aAAa,CAAC;IACrC,CAAC,GAAGvE,OAAO;IACX,MAAMwC,QAAQ,GAAG,IAAAgC,yBAAW,EAACxE,OAAO,CAAC;IACrC,IAAI,CAACwC,QAAQ,EAAE;MACb,OAAO,CAAC,CAAC;IACX;IAEA,MAAMiC,IAAI,GAAGpB,UAAU,CAACrD,OAAO,EAAEwC,QAAQ,CAAC;IAE1C,MAAM;MACJjD,2BAA2B;MAC3BO,QAAQ;MACRK,WAAW;MACXC,uBAAuB;MACvBC,oBAAoB;MACpBC,+BAA+B;MAC/BC,YAAY;MACZL,YAAY;MACZtB,OAAO,EAAE8F,aAAa;MACtBtD;IACF,CAAC,GAAGqD,IAAI;IAER,MAAMjE,UAAU;IAEd;AACN;AACA;AACA;AACA;IACQiE,IAAI,CAACjE,UACN;;IAEH;AACJ;AACA;IACI,MAAMmE,UAAU,GAAGA,CAACC,IAAI,EAAEC,QAAQ,EAAEvC,IAAI,KAAK;MAC3C;MACE;MACApC,YAAY,KAAKoD,SAAS,IAAIxD,QAAQ,CAACgF,IAAI,CAAEC,IAAI,IAAK;QACpD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;UAC5B,OAAO,KAAK;QACd;QAEA,MAAM;UACJ7E,YAAY,EAAE8E;QAChB,CAAC,GAAGD,IAAI;QACR,OAAOC,KAAK,KAAK1B,SAAS;MAC5B,CAAC,CAAC,EACF;QACA;AACR;AACA;QACQ,MAAM2B,YAAY,GAAID,KAAK,IAAK;UAC9B,OAAOA,KAAK,KAAK1B,SAAS,IAAI0B,KAAK,GACjC,CAACzC,UAAU,CAAC2C,OAAO,CAAC5C,IAAI,CAAC,CAAC6C,KAAK,CAAC,MAAM,CAAC,EAAEC,MAAM,IAAI,CAAC,IAAI,CAAC;QAC7D,CAAC;QAED,IAAIH,YAAY,CAAC/E,YAAY,CAAC,EAAE;UAC9B;QACF;QAEA,MAAM;UACJA,YAAY,EAAEmF;QAChB,CAAC;QACC;AACV;AACA;AACA;AACA;AACA;AACA;QAAevF,QAAQ,CAACwF,IAAI,CAAEP,IAAI,IAAK;UAC3B,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,KAAK;UACd;UAEA,MAAM;YACJ/E,OAAO,EAAEuF;UACX,CAAC,GAAGR,IAAI;UACR,OAAOQ,GAAG,MAAMX,IAAI,CAACY,QAAQ,IAAIlD,IAAI,CAAC9C,IAAI,CAAC;QAC7C,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,IAAIyF,YAAY,CAACI,mBAAmB,CAAC,EAAE;UACrC;QACF;MACF;MAEA,IAAI/E,+BAA+B,IAAIsD,sBAAsB,CAACtB,IAAI,CAAC,EAAE;QACnE;MACF;MAEA,MAAMmD,SAAS,GAAG,IAAAzC,6BAAe,EAC/BT,UAAU,EAAED,IAAI,EAAEE,QAAQ,EAAE;QAC1BkD,cAAc,EAAEtE;MAClB,CACF,CAAC;MAED,IAAIqE,SAAS,EAAE;QACb;MACF;;MAEA;MACA;MACA,IAAI,IAAAE,+BAAmB,EACrB;QACEtG,WAAW,EAAE,EAAE;QACfuG,UAAU,EAAE,EAAE;QACdC,QAAQ,EAAE,EAAE;QACZC,MAAM,EAAE,EAAE;QACVC,IAAI,EAAE;MACR,CAAC,EACDzD,IAAI,EACJtC,OAAO,EACP,CACEb,cAAc,CAElB,CAAC,EAAE;QACD;MACF;MAEA;MACE;MACA;MACAkB,oBAAoB,IAAIuE,IAAI,CAACoB,iBAAiB;MAE9C;MACA;MACA5F,uBAAuB,IAAI,IAAA6F,yBAAa,EAAC3D,IAAI,CAAC,EAC9C;QACA,MAAM4D,sBAAsB,GAAG,IAAAC,qCAAyB,EAAC7D,IAAI,CAAC;QAC9D,IAAI,CAAC4D,sBAAsB,CAACd,MAAM,IAAI,CAAC,IAAAgB,0BAAc,EAAC9D,IAAI,CAAC,EAAE;UAC3D;QACF;MACF;MAEA,IAAID,qBAAqB,CAACC,IAAI,EAAEC,UAAU,EAAEvC,OAAO,EAAEwC,QAAQ,CAAC,EAAE;QAC9D;MACF;MAEA,MAAM6D,GAAG,GAAG,gDAAkDC,KAAK,IAAK;QACtE;QACA,MAAMC,KAAK,GAAG/D,QAAQ,CAACgE,QAAQ,KAAK,CAAC,IAAIhE,QAAQ,CAACiE,QAAQ,IAAI,CAAC,GAAG,CAAC,GAAGjE,QAAQ,CAACgE,QAAQ;QACvF;QACA,IAAIE,QAAQ,GAAG,IAAAC,+BAAiB,EAACrE,IAAI,EAAEC,UAAU,CAAC;QAElD,MAAMqE,SAAS,GAAG,IAAAC,0BAAY,EAC5B;QACCH,QACH,CAAC;QACD,IAAIE,SAAS,EAAE;UACbF,QAAQ,GAAGE,SAAS;QACtB;QAEA,MAAME,MAAM,GAAG,IAAAC,qBAAS,EAAC;UACvBC,IAAI,EAAEzE,UAAU,CAAC2C,OAAO,CACtB,yCAA2CwB,QAAQ,EACnD;UACA,CACE,yCAA2CA,QAAQ,CAAEO,GAAG,EACxDC,KAAK,CAACC,MACV;QACF,CAAC,CAAC;QAEF,MAAM;UACJlH;QACF,CAAC;QACC;AACV;AACA;AACA;AACA;AACA;AACA;QAAeH,QAAQ,CAACwF,IAAI,CAAE8B,MAAM,IAAK;UAC7B,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,KAAK;UACd;UAEA,MAAM;YACJpH,OAAO,EAAE+E;UACX,CAAC,GAAGqC,MAAM;UACV,OAAOrC,IAAI,KAAKzC,IAAI,CAAC9C,IAAI;QAC3B,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,MAAM6H,SAAS,GAAG,CAACpH,kBAAkB,GACnC,OAAOM,YAAY,EAAE,GACrB,QAAQuG,MAAM,IAAIvG,YAAY,KAAKuG,MAAM,EAAE,IACzC,KAAK,IAAI,CAACQ,MAAM,CAACf,KAAK,CAAC,GAAGO,MAAM,CAACS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QAEnD,OAAOjB,KAAK,CAACkB,gBAAgB,CAC3B;QACCd,QAAQ,EACTW,SACF,CAAC;MACH,CAAC;MAED,MAAMI,MAAM,GAAGA,CAAA,KAAM;QACnB,MAAM;UACJP;QACF,CAAC,GAAG,kDAAoD5E,IAAI,CAAC2E,GAAI;QACjE,MAAMA,GAAG,GAAG;UACVS,GAAG,EAAE;YACHP,MAAM,EAAE,CAAC;YACTQ,IAAI,EAAET,KAAK,CAACS,IAAI,GAAG;UACrB,CAAC;UACDT;QACF,CAAC;QACDlH,OAAO,CAACyH,MAAM,CAAC;UACbpB,GAAG,EAAElG,WAAW,GAAGkG,GAAG,GAAG,IAAI;UAC7BY,GAAG;UACHW,SAAS,EAAE,cAAc;UACzBtF;QACF,CAAC,CAAC;MACJ,CAAC;MAED,IAAI9B,UAAU,EAAE;QACd;QACA,MAAMmD,GAAG,GAAG;UACVjD,aAAa,EAAEmH,OAAO,CAACrH,UAAU,EAAEE,aAAa,IAAI,KAAK,CAAC;UAC1DE,GAAG,EAAEiH,OAAO,CAACrH,UAAU,EAAEI,GAAG,IAAI,IAAI,CAAC;UACrCkH,iBAAiB,EAAED,OAAO,CAACrH,UAAU,EAAEG,GAAG,IAAI,IAAI,CAAC;UACnDoH,UAAU,EAAEF,OAAO,CAACrH,UAAU,EAAEK,MAAM,IAAI,KAAK;QACjD,CAAC;QACD,MAAMmH,QAAQ,GAAGC,qBAAY,CAACC,mBAAmB,CAAC5F,IAAI,EAAEC,UAAU,EAAEoB,GAAG,EAAEnB,QAAQ,CAAC;QAElF,IAAIwF,QAAQ,EAAE;UACZP,MAAM,CAAC,CAAC;QACV;MACF,CAAC,MAAM;QACLA,MAAM,CAAC,CAAC;MACV;IACF,CAAC;;IAED;AACJ;AACA;AACA;IACI,MAAMU,SAAS,GAAI3E,IAAI,IAAK;MAC1B,OAAOkB,aAAa,CAAClB,IAAI,CAAC,IAAI1D,QAAQ,CAACgF,IAAI,CAAEC,IAAI,IAAK;QACpD,OAAO,OAAOA,IAAI,KAAK,QAAQ,GAAGA,IAAI,CAAC/E,OAAO,KAAKwD,IAAI,GAAGuB,IAAI,KAAKvB,IAAI;MACzE,CAAC,CAAC;IACJ,CAAC;IAED,OAAO;MACL,GAAG,IAAA4E,4BAAgB,EACjB,IAAAC,4BAAgB,EAACrI,OAAO,EAAE,EAAE,EAAEwC,QAAQ,CAAC,EACvCmC,UACF,CAAC;MACD7D,uBAAuBA,CAAEwB,IAAI,EAAE;QAC7B,IAAI,CAAC6F,SAAS,CAAC,yBAAyB,CAAC,EAAE;UACzC;QACF;QAEA,IACE,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAACG,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC8I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC1B8C,IAAI;QACF;AACd;AACA;AACA;AACA;QACeA,IAAI,CAACP,MAAM,CAAEwG,KAAK,EACvB;UACA5D,UAAU,CAAC;YACTqB,iBAAiB,EAAE;UACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;QAChB;MACF,CAAC;MAEDvB,gBAAgBA,CAAEuB,IAAI,EAAE;QACtB,IAAI,CAAC6F,SAAS,CAAC,kBAAkB,CAAC,EAAE;UAClC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;MAChB,CAAC;MAEDtB,eAAeA,CAAEsB,IAAI,EAAE;QACrB,IAAI,CAAC6F,SAAS,CAAC,iBAAiB,CAAC,EAAE;UACjC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;MAChB,CAAC;MAEDrB,mBAAmBA,CAAEqB,IAAI,EAAE;QACzB,IAAI,CAAC6F,SAAS,CAAC,qBAAqB,CAAC,EAAE;UACrC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;MAChB,CAAC;MAEDpB,kBAAkBA,CAAEoB,IAAI,EAAE;QACxB,IAAI,CAAC6F,SAAS,CAAC,oBAAoB,CAAC,EAAE;UACpC;QACF;QAEA,IAAI5I,2BAA2B,IAC7B,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAAC+I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC8I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACvC,IAAI,CAAC,IAC1B8C,IAAI;QACF;AACd;AACA;AACA;AACA;QACeA,IAAI,CAACP,MAAM,CAAEwG,KAAK,EACvB;UACA5D,UAAU,CAAC;YACTqB,iBAAiB,EAAE;UACrB,CAAC,EAAE,IAAI,EAAE1D,IAAI,CAAC;QAChB;MACF,CAAC;MAEDnB,gBAAgBA,CAAEmB,IAAI,EAAE;QACtB,IAAI,CAAC6F,SAAS,CAAC,kBAAkB,CAAC,EAAE;UAClC;QACF;QAEAxD,UAAU,CAAC;UACTqB,iBAAiB,EAAE,IAAI;UACvBR,QAAQ,EAAE;QACZ,CAAC,EAAE,IAAI,EAAE,yCAA2ClD,IAAI,CAACiG,KAAM,CAAC;MAClE;IACF,CAAC;EACH,CAAC;EACDC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJpJ,WAAW,EAAE,qHAAqH;MAClIqJ,WAAW,EAAE,IAAI;MACjBC,GAAG,EAAE;IACP,CAAC;IAEDC,OAAO,EAAE,MAAM;IAEfC,QAAQ,EAAE;MACRC,YAAY,EAAE;IAChB,CAAC;IAEDC,MAAM,EAAE,CACN5J,cAAc,CACf;IAEDK,IAAI,EAAE;EACR;AACF,CAAC;AAAAwJ,MAAA,CAAA3E,OAAA,GAAAA,OAAA,CAAAnF,OAAA","ignoreList":[]}

package/dist/rules/requireJsdoc.d.ts CHANGED Viewed

@@ -2,7 +2,6 @@ declare const _default: {
     create(context: import("eslint").Rule.RuleContext): {};
     meta: {
         docs: {
-            category: string;
             description: string;
             recommended: boolean;
             url: string;

package/dist/rules/requireProperty.cjs CHANGED Viewed

@@ -7,6 +7,7 @@ exports.default = void 0;
 var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 var _default = exports.default = (0, _iterateJsdoc.default)(({
+  context,
   utils
 }) => {
   const propertyAssociatedTags = utils.filterTags(({
@@ -20,6 +21,22 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
   const targetTagName = /** @type {string} */utils.getPreferredTagName({
     tagName: 'property'
   });
+  if (!targetTagName) {
+    context.report({
+      loc: {
+        end: {
+          column: 1,
+          line: 1
+        },
+        start: {
+          column: 1,
+          line: 1
+        }
+      },
+      message: 'Cannot prohibit `@property` in the `tagNamePreference` setting while using the `require-property` rule.'
+    });
+    return;
+  }
   if (utils.hasATag([targetTagName])) {
     return;
   }

package/dist/rules/requireProperty.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"requireProperty.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","utils","propertyAssociatedTags","filterTags","tag","includes","length","targetTagName","getPreferredTagName","tagName","hasATag","propertyAssociatedTag","type","reportJSDoc","addTag","iterateAllJsdocs","meta","docs","description","url","fixable","module"],"sources":["../../src/rules/requireProperty.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n utils,\n}) => {\n const propertyAssociatedTags = utils.filterTags(({\n tag,\n }) => {\n return [\n 'namespace', 'typedef',\n ].includes(tag);\n });\n if (!propertyAssociatedTags.length) {\n return;\n }\n\n const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n tagName: 'property',\n }));\n\n if (utils.hasATag([\n targetTagName,\n ])) {\n return;\n }\n\n for (const propertyAssociatedTag of propertyAssociatedTags) {\n if (![\n 'object', 'Object', 'PlainObject',\n ].includes(propertyAssociatedTag.type)) {\n continue;\n }\n\n utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {\n utils.addTag(targetTagName);\n });\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header',\n },\n fixable: 'code',\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC;AACF,CAAC,KAAK;EACJ,MAAMC,sBAAsB,GAAGD,KAAK,CAACE,UAAU,CAAC,CAAC;IAC/CC;EACF,CAAC,KAAK;IACJ,OAAO,CACL,WAAW,EAAE,SAAS,CACvB,CAACC,QAAQ,CAACD,GAAG,CAAC;EACjB,CAAC,CAAC;EACF,IAAI,CAACF,sBAAsB,CAACI,MAAM,EAAE;IAClC;EACF;EAEA,MAAMC,aAAa,GAAG,qBAAuBN,KAAK,CAACO,mBAAmB,CAAC;IACrEC,OAAO,EAAE;EACX,CAAC,CAAE;EAEH,~~IAAIR~~,KAAK,~~CAACS~~,OAAO,CAAC,~~CAChBH~~,aAAa,CACd,CAAC,EAAE;IACF;EACF;EAEA,KAAK,~~MAAMI~~,qBAAqB,~~IAAIT~~,sBAAsB,EAAE;IAC1D,IAAI,CAAC,CACH,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAClC,CAACG,QAAQ,~~CAACM~~,qBAAqB,CAACC,IAAI,CAAC,EAAE;MACtC;IACF;~~IAEAX~~,KAAK,~~CAACY~~,WAAW,CAAC,~~kBAAkBN~~,aAAa,GAAG,EAAE,IAAI,EAAE,MAAM;MAChEN,KAAK,~~CAACa~~,MAAM,~~CAACP~~,aAAa,CAAC;IAC7B,CAAC,CAAC;EACJ;AACF,CAAC,EAAE;~~EACDQ~~,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,sIAAsI;MACnJC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfR,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAS,MAAA,~~CAAAtB~~,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
1	+ {"version":3,"file":"requireProperty.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","utils","propertyAssociatedTags","filterTags","tag","includes","length","targetTagName","getPreferredTagName","tagName","report","loc","end","column","line","start","message","hasATag","propertyAssociatedTag","type","reportJSDoc","addTag","iterateAllJsdocs","meta","docs","description","url","fixable","module"],"sources":["../../src/rules/requireProperty.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n const propertyAssociatedTags = utils.filterTags(({\n tag,\n }) => {\n return [\n 'namespace', 'typedef',\n ].includes(tag);\n });\n if (!propertyAssociatedTags.length) {\n return;\n }\n\n const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n tagName: 'property',\n }));\n\n if (!targetTagName) {\n context.report({\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message: 'Cannot prohibit `@property` in the `tagNamePreference` setting while using the `require-property` rule.',\n });\n return;\n }\n\n if (utils.hasATag([\n targetTagName,\n ])) {\n return;\n }\n\n for (const propertyAssociatedTag of propertyAssociatedTags) {\n if (![\n 'object', 'Object', 'PlainObject',\n ].includes(propertyAssociatedTag.type)) {\n continue;\n }\n\n utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {\n utils.addTag(targetTagName);\n });\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header',\n },\n fixable: 'code',\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC;AACF,CAAC,KAAK;EACJ,MAAMC,sBAAsB,GAAGD,KAAK,CAACE,UAAU,CAAC,CAAC;IAC/CC;EACF,CAAC,KAAK;IACJ,OAAO,CACL,WAAW,EAAE,SAAS,CACvB,CAACC,QAAQ,CAACD,GAAG,CAAC;EACjB,CAAC,CAAC;EACF,IAAI,CAACF,sBAAsB,CAACI,MAAM,EAAE;IAClC;EACF;EAEA,MAAMC,aAAa,GAAG,qBAAuBN,KAAK,CAACO,mBAAmB,CAAC;IACrEC,OAAO,EAAE;EACX,CAAC,CAAE;EAEH,IAAI,CAACF,aAAa,EAAE;IAClBP,OAAO,CAACU,MAAM,CAAC;MACbC,GAAG,EAAE;QACHC,GAAG,EAAE;UACHC,MAAM,EAAE,CAAC;UACTC,IAAI,EAAE;QACR,CAAC;QACDC,KAAK,EAAE;UACLF,MAAM,EAAE,CAAC;UACTC,IAAI,EAAE;QACR;MACF,CAAC;MACDE,OAAO,EAAE;IACX,CAAC,CAAC;IACF;EACF;EAEA,IAAIf,KAAK,CAACgB,OAAO,CAAC,CAChBV,aAAa,CACd,CAAC,EAAE;IACF;EACF;EAEA,KAAK,MAAMW,qBAAqB,IAAIhB,sBAAsB,EAAE;IAC1D,IAAI,CAAC,CACH,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAClC,CAACG,QAAQ,CAACa,qBAAqB,CAACC,IAAI,CAAC,EAAE;MACtC;IACF;IAEAlB,KAAK,CAACmB,WAAW,CAAC,kBAAkBb,aAAa,GAAG,EAAE,IAAI,EAAE,MAAM;MAChEN,KAAK,CAACoB,MAAM,CAACd,aAAa,CAAC;IAC7B,CAAC,CAAC;EACJ;AACF,CAAC,EAAE;EACDe,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,sIAAsI;MACnJC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfR,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAS,MAAA,CAAA9B,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/requireReturns.cjs CHANGED Viewed

@@ -96,6 +96,7 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
       };
       /* c8 ignore next -- Fallback to deprecated method */
       const {
+        // @ts-expect-error ESLint < 10
         sourceCode = context.getSourceCode()
       } = context;
       const exported = _exportParser.default.isUncommentedExport(/** @type {import('eslint').Rule.Node} */node, sourceCode, opt, settings);

package/dist/rules/requireReturns.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"requireReturns.cjs","names":["_exportParser","_interopRequireDefault","require","_iterateJsdoc","e","__esModule","default","canSkip","utils","hasATag","avoidDocs","_default","exports","iterateJsdoc","context","info","comment","node","report","settings","contexts","enableFixer","forceRequireReturn","forceReturnsWithAsync","publicOnly","options","forceRequireReturnContext","foundContext","findContext","tagName","getPreferredTagName","tags","getTags","length","iteratingFunction","isIteratingFunction","tag","missingReturnTag","shouldReport","opt","ancestorsOnly","Boolean","esm","initModuleExports","cjs","initWindow","window","sourceCode","getSourceCode","exported","exportParser","isUncommentedExport","isVirtualFunction","isAsync","hasTag","hasValueOrExecutorHasNonEmptyResolveValue","reportJSDoc","addTag","contextDefaults","meta","docs","description","url","fixable","schema","additionalProperties","properties","checkConstructors","type","checkGetters","items","anyOf","exemptedBy","oneOf","module"],"sources":["../../src/rules/requireReturns.js"],"sourcesContent":["import exportParser from '../exportParser.js';\nimport iterateJsdoc from '../iterateJsdoc.js';\n\n/*\n We can skip checking for a return value, in case the documentation is inherited\n * or the method is either a constructor or an abstract method.\n \n In either of these cases the return value is optional or not defined.\n * @param {import('../iterateJsdoc.js').Utils} utils\n * a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean}\n * true in case deep checking can be skipped; otherwise false.\n /\nconst canSkip = (utils) => {\n return utils.hasATag([\n // inheritdoc implies that all documentation is inherited\n // see https://jsdoc.app/tags-inheritdoc.html\n //\n // Abstract methods are by definition incomplete,\n // so it is not an error if it declares a return value but does not implement it.\n 'abstract',\n 'virtual',\n\n // Constructors do not have a return value by definition (https://jsdoc.app/tags-class.html)\n // So we can bail out here, too.\n 'class',\n 'constructor',\n\n // Return type is specified by type in @type\n 'type',\n\n // This seems to imply a class as well\n 'interface',\n ]) \|\|\n utils.avoidDocs();\n};\n\nexport default iterateJsdoc(({\n context,\n info: {\n comment,\n },\n node,\n report,\n settings,\n utils,\n}) => {\n const {\n contexts,\n enableFixer = false,\n forceRequireReturn = false,\n forceReturnsWithAsync = false,\n publicOnly = false,\n } = context.options[0] \|\| {};\n\n // A preflight check. We do not need to run a deep check\n // in case the @returns comment is optional or undefined.\n if (canSkip(utils)) {\n return;\n }\n\n /* @type {boolean\|undefined} /\n let forceRequireReturnContext;\n if (contexts) {\n const {\n foundContext,\n } = utils.findContext(contexts, comment);\n if (typeof foundContext === 'object') {\n forceRequireReturnContext = foundContext.forceRequireReturn;\n }\n }\n\n const tagName = /* @type {string} / (utils.getPreferredTagName({\n tagName: 'returns',\n }));\n if (!tagName) {\n return;\n }\n\n const tags = utils.getTags(tagName);\n\n if (tags.length > 1) {\n report(`Found more than one @${tagName} declaration.`);\n }\n\n const iteratingFunction = utils.isIteratingFunction();\n\n // In case the code returns something, we expect a return value in JSDoc.\n const [\n tag,\n ] = tags;\n const missingReturnTag = typeof tag === 'undefined' \|\| tag === null;\n\n const shouldReport = () => {\n if (!missingReturnTag) {\n return false;\n }\n\n if (publicOnly) {\n /* @type {import('./requireJsdoc.js').RequireJsdocOpts} /\n const opt = {\n ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),\n esm: Boolean(publicOnly?.esm ?? true),\n initModuleExports: Boolean(publicOnly?.cjs ?? true),\n initWindow: Boolean(publicOnly?.window ?? false),\n };\n / c8 ignore next -- Fallback to deprecated method /\n const {\n sourceCode = context.getSourceCode(),\n } = context;\n const exported = exportParser.isUncommentedExport(\n /* @type {import('eslint').Rule.Node} */ (node), sourceCode, opt, settings,\n );\n\n if (!exported) {\n return false;\n }\n }\n\n if ((forceRequireReturn \|\| forceRequireReturnContext) && (\n iteratingFunction \|\| utils.isVirtualFunction()\n )) {\n return true;\n }\n\n const isAsync = !iteratingFunction && utils.hasTag('async') \|\|\n iteratingFunction && utils.isAsync();\n\n if (forceReturnsWithAsync && isAsync) {\n return true;\n }\n\n return iteratingFunction && utils.hasValueOrExecutorHasNonEmptyResolveValue(\n forceReturnsWithAsync,\n );\n };\n\n if (shouldReport()) {\n utils.reportJSDoc(`Missing JSDoc @${tagName} declaration.`, null, enableFixer ? () => {\n utils.addTag(tagName);\n } : null);\n }\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'Requires that returns are documented with `@returns`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n checkConstructors: {\n default: false,\n description: `A value indicating whether \\`constructor\\`s should\nbe checked for \\`@returns\\` tags. Defaults to \\`false\\`.`,\n type: 'boolean',\n },\n checkGetters: {\n default: true,\n description: `Boolean to determine whether getter methods should\nbe checked for \\`@returns\\` tags. Defaults to \\`true\\`.`,\n type: 'boolean',\n },\n contexts: {\n description: `Set this to an array of strings representing the AST context\n(or objects with optional \\`context\\` and \\`comment\\` properties) where you wish\nthe rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`, \\`FunctionDeclaration\\`,\n\\`FunctionExpression\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`). This\nrule will only apply on non-default contexts when there is such a tag\npresent and the \\`forceRequireReturn\\` option is set or if the\n\\`forceReturnsWithAsync\\` option is set with a present \\`@async\\` tag\n(since we are not checking against the actual \\`return\\` values in these\ncases).`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n forceRequireReturn: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n enableFixer: {\n description: `Whether to enable the fixer to add a blank \\`@returns\\`.\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n exemptedBy: {\n description: `Array of tags (e.g., \\`['type']\\`) whose presence on the\ndocument block avoids the need for a \\`@returns\\`. Defaults to an array\nwith \\`inheritdoc\\`. If you set this array, it will overwrite the default,\nso be sure to add back \\`inheritdoc\\` if you wish its presence to cause\nexemption of the rule.`,\n items: {\n type: 'string',\n },\n type: 'array',\n },\n forceRequireReturn: {\n default: false,\n description: `Set to \\`true\\` to always insist on\n\\`@returns\\` documentation regardless of implicit or explicit \\`return\\`'s\nin the function. May be desired to flag that a project is aware of an\n\\`undefined\\`/\\`void\\` return. Defaults to \\`false\\`.`,\n type: 'boolean',\n },\n forceReturnsWithAsync: {\n default: false,\n description: `By default \\`async\\` functions that do not explicitly\nreturn a value pass this rule as an \\`async\\` function will always return a\n\\`Promise\\`, even if the \\`Promise\\` resolves to void. You can force all\n\\`async\\` functions (including ones with an explicit \\`Promise\\` but no\ndetected non-\\`undefined\\` \\`resolve\\` value) to require \\`@return\\`\ndocumentation by setting \\`forceReturnsWithAsync\\` to \\`true\\` on the options\nobject. This may be useful for flagging that there has been consideration\nof return type. Defaults to \\`false\\`.`,\n type: 'boolean',\n },\n publicOnly: {\n description: `This option will insist that missing \\`@returns\\` are only reported for\nfunction bodies / class declarations that are exported from the module.\nMay be a boolean or object. If set to \\`true\\`, the defaults below will be\nused. If unset, \\`@returns\\` reporting will not be limited to exports.\n\nThis object supports the following optional boolean keys (\\`false\\` unless\notherwise noted):\n\n- \\`ancestorsOnly\\` - Optimization to only check node ancestors to check if node is exported\n- \\`esm\\` - ESM exports are checked for \\`@returns\\` JSDoc comments (Defaults to \\`true\\`)\n- \\`cjs\\` - CommonJS exports are checked for \\`@returns\\` JSDoc comments (Defaults to \\`true\\`)\n- \\`window\\` - Window global exports are checked for \\`@returns\\` JSDoc comments`,\n oneOf: [\n {\n default: false,\n type: 'boolean',\n },\n {\n additionalProperties: false,\n default: {},\n properties: {\n ancestorsOnly: {\n type: 'boolean',\n },\n cjs: {\n type: 'boolean',\n },\n esm: {\n type: 'boolean',\n },\n window: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAF,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,OAAO,GAAIC,KAAK,IAAK;EACzB,OAAOA,KAAK,CAACC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA;EACA,OAAO,EACP,aAAa;EAEb;EACA,MAAM;EAEN;EACA,WAAW,CACZ,CAAC,IACAD,KAAK,CAACE,SAAS,CAAC,CAAC;AACrB,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAN,OAAA,GAEa,IAAAO,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI,EAAE;IACJC;EACF,CAAC;EACDC,IAAI;EACJC,MAAM;EACNC,QAAQ;EACRX;AACF,CAAC,KAAK;EACJ,MAAM;IACJY,QAAQ;IACRC,WAAW,GAAG,KAAK;IACnBC,kBAAkB,GAAG,KAAK;IAC1BC,qBAAqB,GAAG,KAAK;IAC7BC,UAAU,GAAG;EACf,CAAC,GAAGV,OAAO,CAACW,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA;EACA,IAAIlB,OAAO,CAACC,KAAK,CAAC,EAAE;IAClB;EACF;;EAEA;EACA,IAAIkB,yBAAyB;EAC7B,IAAIN,QAAQ,EAAE;IACZ,MAAM;MACJO;IACF,CAAC,GAAGnB,KAAK,CAACoB,WAAW,CAACR,QAAQ,EAAEJ,OAAO,CAAC;IACxC,IAAI,OAAOW,YAAY,KAAK,QAAQ,EAAE;MACpCD,yBAAyB,GAAGC,YAAY,CAACL,kBAAkB;IAC7D;EACF;EAEA,MAAMO,OAAO,GAAG,qBAAuBrB,KAAK,CAACsB,mBAAmB,CAAC;IAC/DD,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAACA,OAAO,EAAE;IACZ;EACF;EAEA,MAAME,IAAI,GAAGvB,KAAK,CAACwB,OAAO,CAACH,OAAO,CAAC;EAEnC,IAAIE,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBf,MAAM,CAAC,wBAAwBW,OAAO,eAAe,CAAC;EACxD;EAEA,MAAMK,iBAAiB,GAAG1B,KAAK,CAAC2B,mBAAmB,CAAC,CAAC;;EAErD;EACA,MAAM,CACJC,GAAG,CACJ,GAAGL,IAAI;EACR,MAAMM,gBAAgB,GAAG,OAAOD,GAAG,KAAK,WAAW,IAAIA,GAAG,KAAK,IAAI;EAEnE,MAAME,YAAY,GAAGA,CAAA,KAAM;IACzB,IAAI,CAACD,gBAAgB,EAAE;MACrB,OAAO,KAAK;IACd;IAEA,IAAIb,UAAU,EAAE;MACd;MACA,MAAMe,GAAG,GAAG;QACVC,aAAa,EAAEC,OAAO,CAACjB,UAAU,EAAEgB,aAAa,IAAI,KAAK,CAAC;QAC1DE,GAAG,EAAED,OAAO,CAACjB,UAAU,EAAEkB,GAAG,IAAI,IAAI,CAAC;QACrCC,iBAAiB,EAAEF,OAAO,CAACjB,UAAU,EAAEoB,GAAG,IAAI,IAAI,CAAC;QACnDC,UAAU,EAAEJ,OAAO,CAACjB,UAAU,EAAEsB,MAAM,IAAI,KAAK;MACjD,CAAC;MACD;MACA,MAAM;QACJC,UAAU,GAAGjC,OAAO,CAACkC,aAAa,CAAC;MACrC,CAAC,GAAGlC,OAAO;MACX,MAAMmC,QAAQ,GAAGC,qBAAY,CAACC,mBAAmB,CAC/C,yCAA2ClC,IAAI,EAAG8B,UAAU,EAAER,GAAG,EAAEpB,QACrE,CAAC;MAED,IAAI,CAAC8B,QAAQ,EAAE;QACb,OAAO,KAAK;MACd;IACF;IAEA,IAAI,CAAC3B,kBAAkB,IAAII,yBAAyB,MAClDQ,iBAAiB,IAAI1B,KAAK,CAAC4C,iBAAiB,CAAC,CAAC,CAC/C,EAAE;MACD,OAAO,IAAI;IACb;IAEA,MAAMC,OAAO,GAAG,CAACnB,iBAAiB,IAAI1B,KAAK,CAAC8C,MAAM,CAAC,OAAO,CAAC,IACzDpB,iBAAiB,IAAI1B,KAAK,CAAC6C,OAAO,CAAC,CAAC;IAEtC,IAAI9B,qBAAqB,IAAI8B,OAAO,EAAE;MACpC,OAAO,IAAI;IACb;IAEA,OAAOnB,iBAAiB,IAAI1B,KAAK,CAAC+C,yCAAyC,CACzEhC,qBACF,CAAC;EACH,CAAC;EAED,IAAIe,YAAY,CAAC,CAAC,EAAE;IAClB9B,KAAK,CAACgD,WAAW,CAAC,kBAAkB3B,OAAO,eAAe,EAAE,IAAI,EAAER,WAAW,GAAG,MAAM;MACpFb,KAAK,CAACiD,MAAM,CAAC5B,OAAO,CAAC;IACvB,CAAC,GAAG,IAAI,CAAC;EACX;AACF,CAAC,EAAE;EACD6B,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,uDAAuD;MACpEC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,iBAAiB,EAAE;UACjB7D,OAAO,EAAE,KAAK;UACduD,WAAW,EAAE;AACzB,yDAAyD;UAC7CO,IAAI,EAAE;QACR,CAAC;QACDC,YAAY,EAAE;UACZ/D,OAAO,EAAE,IAAI;UACbuD,WAAW,EAAE;AACzB,wDAAwD;UAC5CO,IAAI,EAAE;QACR,CAAC;QACDhD,QAAQ,EAAE;UACRyC,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;UACIS,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEH,IAAI,EAAE;YACR,CAAC,EACD;cACEH,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVlD,OAAO,EAAE;kBACPoD,IAAI,EAAE;gBACR,CAAC;gBACDtD,OAAO,EAAE;kBACPsD,IAAI,EAAE;gBACR,CAAC;gBACD9C,kBAAkB,EAAE;kBAClB8C,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD/C,WAAW,EAAE;UACXwC,WAAW,EAAE;AACzB,uBAAuB;UACXO,IAAI,EAAE;QACR,CAAC;QACDI,UAAU,EAAE;UACVX,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACXS,KAAK,EAAE;YACLF,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD9C,kBAAkB,EAAE;UAClBhB,OAAO,EAAE,KAAK;UACduD,WAAW,EAAE;AACzB;AACA;AACA,sDAAsD;UAC1CO,IAAI,EAAE;QACR,CAAC;QACD7C,qBAAqB,EAAE;UACrBjB,OAAO,EAAE,KAAK;UACduD,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA,uCAAuC;UAC3BO,IAAI,EAAE;QACR,CAAC;QACD5C,UAAU,EAAE;UACVqC,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,iFAAiF;UACrEY,KAAK,EAAE,CACL;YACEnE,OAAO,EAAE,KAAK;YACd8D,IAAI,EAAE;UACR,CAAC,EACD;YACEH,oBAAoB,EAAE,KAAK;YAC3B3D,OAAO,EAAE,CAAC,CAAC;YACX4D,UAAU,EAAE;cACV1B,aAAa,EAAE;gBACb4B,IAAI,EAAE;cACR,CAAC;cACDxB,GAAG,EAAE;gBACHwB,IAAI,EAAE;cACR,CAAC;cACD1B,GAAG,EAAE;gBACH0B,IAAI,EAAE;cACR,CAAC;cACDtB,MAAM,EAAE;gBACNsB,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;QAEL;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAM,MAAA,CAAA9D,OAAA,GAAAA,OAAA,CAAAN,OAAA","ignoreList":[]}
1	+ {"version":3,"file":"requireReturns.cjs","names":["_exportParser","_interopRequireDefault","require","_iterateJsdoc","e","__esModule","default","canSkip","utils","hasATag","avoidDocs","_default","exports","iterateJsdoc","context","info","comment","node","report","settings","contexts","enableFixer","forceRequireReturn","forceReturnsWithAsync","publicOnly","options","forceRequireReturnContext","foundContext","findContext","tagName","getPreferredTagName","tags","getTags","length","iteratingFunction","isIteratingFunction","tag","missingReturnTag","shouldReport","opt","ancestorsOnly","Boolean","esm","initModuleExports","cjs","initWindow","window","sourceCode","getSourceCode","exported","exportParser","isUncommentedExport","isVirtualFunction","isAsync","hasTag","hasValueOrExecutorHasNonEmptyResolveValue","reportJSDoc","addTag","contextDefaults","meta","docs","description","url","fixable","schema","additionalProperties","properties","checkConstructors","type","checkGetters","items","anyOf","exemptedBy","oneOf","module"],"sources":["../../src/rules/requireReturns.js"],"sourcesContent":["import exportParser from '../exportParser.js';\nimport iterateJsdoc from '../iterateJsdoc.js';\n\n/*\n We can skip checking for a return value, in case the documentation is inherited\n * or the method is either a constructor or an abstract method.\n \n In either of these cases the return value is optional or not defined.\n * @param {import('../iterateJsdoc.js').Utils} utils\n * a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean}\n * true in case deep checking can be skipped; otherwise false.\n /\nconst canSkip = (utils) => {\n return utils.hasATag([\n // inheritdoc implies that all documentation is inherited\n // see https://jsdoc.app/tags-inheritdoc.html\n //\n // Abstract methods are by definition incomplete,\n // so it is not an error if it declares a return value but does not implement it.\n 'abstract',\n 'virtual',\n\n // Constructors do not have a return value by definition (https://jsdoc.app/tags-class.html)\n // So we can bail out here, too.\n 'class',\n 'constructor',\n\n // Return type is specified by type in @type\n 'type',\n\n // This seems to imply a class as well\n 'interface',\n ]) \|\|\n utils.avoidDocs();\n};\n\nexport default iterateJsdoc(({\n context,\n info: {\n comment,\n },\n node,\n report,\n settings,\n utils,\n}) => {\n const {\n contexts,\n enableFixer = false,\n forceRequireReturn = false,\n forceReturnsWithAsync = false,\n publicOnly = false,\n } = context.options[0] \|\| {};\n\n // A preflight check. We do not need to run a deep check\n // in case the @returns comment is optional or undefined.\n if (canSkip(utils)) {\n return;\n }\n\n /* @type {boolean\|undefined} /\n let forceRequireReturnContext;\n if (contexts) {\n const {\n foundContext,\n } = utils.findContext(contexts, comment);\n if (typeof foundContext === 'object') {\n forceRequireReturnContext = foundContext.forceRequireReturn;\n }\n }\n\n const tagName = /* @type {string} / (utils.getPreferredTagName({\n tagName: 'returns',\n }));\n if (!tagName) {\n return;\n }\n\n const tags = utils.getTags(tagName);\n\n if (tags.length > 1) {\n report(`Found more than one @${tagName} declaration.`);\n }\n\n const iteratingFunction = utils.isIteratingFunction();\n\n // In case the code returns something, we expect a return value in JSDoc.\n const [\n tag,\n ] = tags;\n const missingReturnTag = typeof tag === 'undefined' \|\| tag === null;\n\n const shouldReport = () => {\n if (!missingReturnTag) {\n return false;\n }\n\n if (publicOnly) {\n /* @type {import('./requireJsdoc.js').RequireJsdocOpts} /\n const opt = {\n ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),\n esm: Boolean(publicOnly?.esm ?? true),\n initModuleExports: Boolean(publicOnly?.cjs ?? true),\n initWindow: Boolean(publicOnly?.window ?? false),\n };\n / c8 ignore next -- Fallback to deprecated method /\n const {\n // @ts-expect-error ESLint < 10\n sourceCode = context.getSourceCode(),\n } = context;\n const exported = exportParser.isUncommentedExport(\n /* @type {import('eslint').Rule.Node} */ (node), sourceCode, opt, settings,\n );\n\n if (!exported) {\n return false;\n }\n }\n\n if ((forceRequireReturn \|\| forceRequireReturnContext) && (\n iteratingFunction \|\| utils.isVirtualFunction()\n )) {\n return true;\n }\n\n const isAsync = !iteratingFunction && utils.hasTag('async') \|\|\n iteratingFunction && utils.isAsync();\n\n if (forceReturnsWithAsync && isAsync) {\n return true;\n }\n\n return iteratingFunction && utils.hasValueOrExecutorHasNonEmptyResolveValue(\n forceReturnsWithAsync,\n );\n };\n\n if (shouldReport()) {\n utils.reportJSDoc(`Missing JSDoc @${tagName} declaration.`, null, enableFixer ? () => {\n utils.addTag(tagName);\n } : null);\n }\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'Requires that returns are documented with `@returns`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n checkConstructors: {\n default: false,\n description: `A value indicating whether \\`constructor\\`s should\nbe checked for \\`@returns\\` tags. Defaults to \\`false\\`.`,\n type: 'boolean',\n },\n checkGetters: {\n default: true,\n description: `Boolean to determine whether getter methods should\nbe checked for \\`@returns\\` tags. Defaults to \\`true\\`.`,\n type: 'boolean',\n },\n contexts: {\n description: `Set this to an array of strings representing the AST context\n(or objects with optional \\`context\\` and \\`comment\\` properties) where you wish\nthe rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`, \\`FunctionDeclaration\\`,\n\\`FunctionExpression\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`). This\nrule will only apply on non-default contexts when there is such a tag\npresent and the \\`forceRequireReturn\\` option is set or if the\n\\`forceReturnsWithAsync\\` option is set with a present \\`@async\\` tag\n(since we are not checking against the actual \\`return\\` values in these\ncases).`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n forceRequireReturn: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n enableFixer: {\n description: `Whether to enable the fixer to add a blank \\`@returns\\`.\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n exemptedBy: {\n description: `Array of tags (e.g., \\`['type']\\`) whose presence on the\ndocument block avoids the need for a \\`@returns\\`. Defaults to an array\nwith \\`inheritdoc\\`. If you set this array, it will overwrite the default,\nso be sure to add back \\`inheritdoc\\` if you wish its presence to cause\nexemption of the rule.`,\n items: {\n type: 'string',\n },\n type: 'array',\n },\n forceRequireReturn: {\n default: false,\n description: `Set to \\`true\\` to always insist on\n\\`@returns\\` documentation regardless of implicit or explicit \\`return\\`'s\nin the function. May be desired to flag that a project is aware of an\n\\`undefined\\`/\\`void\\` return. Defaults to \\`false\\`.`,\n type: 'boolean',\n },\n forceReturnsWithAsync: {\n default: false,\n description: `By default \\`async\\` functions that do not explicitly\nreturn a value pass this rule as an \\`async\\` function will always return a\n\\`Promise\\`, even if the \\`Promise\\` resolves to void. You can force all\n\\`async\\` functions (including ones with an explicit \\`Promise\\` but no\ndetected non-\\`undefined\\` \\`resolve\\` value) to require \\`@return\\`\ndocumentation by setting \\`forceReturnsWithAsync\\` to \\`true\\` on the options\nobject. This may be useful for flagging that there has been consideration\nof return type. Defaults to \\`false\\`.`,\n type: 'boolean',\n },\n publicOnly: {\n description: `This option will insist that missing \\`@returns\\` are only reported for\nfunction bodies / class declarations that are exported from the module.\nMay be a boolean or object. If set to \\`true\\`, the defaults below will be\nused. If unset, \\`@returns\\` reporting will not be limited to exports.\n\nThis object supports the following optional boolean keys (\\`false\\` unless\notherwise noted):\n\n- \\`ancestorsOnly\\` - Optimization to only check node ancestors to check if node is exported\n- \\`esm\\` - ESM exports are checked for \\`@returns\\` JSDoc comments (Defaults to \\`true\\`)\n- \\`cjs\\` - CommonJS exports are checked for \\`@returns\\` JSDoc comments (Defaults to \\`true\\`)\n- \\`window\\` - Window global exports are checked for \\`@returns\\` JSDoc comments`,\n oneOf: [\n {\n default: false,\n type: 'boolean',\n },\n {\n additionalProperties: false,\n default: {},\n properties: {\n ancestorsOnly: {\n type: 'boolean',\n },\n cjs: {\n type: 'boolean',\n },\n esm: {\n type: 'boolean',\n },\n window: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAF,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,OAAO,GAAIC,KAAK,IAAK;EACzB,OAAOA,KAAK,CAACC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA;EACA,OAAO,EACP,aAAa;EAEb;EACA,MAAM;EAEN;EACA,WAAW,CACZ,CAAC,IACAD,KAAK,CAACE,SAAS,CAAC,CAAC;AACrB,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAN,OAAA,GAEa,IAAAO,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI,EAAE;IACJC;EACF,CAAC;EACDC,IAAI;EACJC,MAAM;EACNC,QAAQ;EACRX;AACF,CAAC,KAAK;EACJ,MAAM;IACJY,QAAQ;IACRC,WAAW,GAAG,KAAK;IACnBC,kBAAkB,GAAG,KAAK;IAC1BC,qBAAqB,GAAG,KAAK;IAC7BC,UAAU,GAAG;EACf,CAAC,GAAGV,OAAO,CAACW,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA;EACA,IAAIlB,OAAO,CAACC,KAAK,CAAC,EAAE;IAClB;EACF;;EAEA;EACA,IAAIkB,yBAAyB;EAC7B,IAAIN,QAAQ,EAAE;IACZ,MAAM;MACJO;IACF,CAAC,GAAGnB,KAAK,CAACoB,WAAW,CAACR,QAAQ,EAAEJ,OAAO,CAAC;IACxC,IAAI,OAAOW,YAAY,KAAK,QAAQ,EAAE;MACpCD,yBAAyB,GAAGC,YAAY,CAACL,kBAAkB;IAC7D;EACF;EAEA,MAAMO,OAAO,GAAG,qBAAuBrB,KAAK,CAACsB,mBAAmB,CAAC;IAC/DD,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAACA,OAAO,EAAE;IACZ;EACF;EAEA,MAAME,IAAI,GAAGvB,KAAK,CAACwB,OAAO,CAACH,OAAO,CAAC;EAEnC,IAAIE,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBf,MAAM,CAAC,wBAAwBW,OAAO,eAAe,CAAC;EACxD;EAEA,MAAMK,iBAAiB,GAAG1B,KAAK,CAAC2B,mBAAmB,CAAC,CAAC;;EAErD;EACA,MAAM,CACJC,GAAG,CACJ,GAAGL,IAAI;EACR,MAAMM,gBAAgB,GAAG,OAAOD,GAAG,KAAK,WAAW,IAAIA,GAAG,KAAK,IAAI;EAEnE,MAAME,YAAY,GAAGA,CAAA,KAAM;IACzB,IAAI,CAACD,gBAAgB,EAAE;MACrB,OAAO,KAAK;IACd;IAEA,IAAIb,UAAU,EAAE;MACd;MACA,MAAMe,GAAG,GAAG;QACVC,aAAa,EAAEC,OAAO,CAACjB,UAAU,EAAEgB,aAAa,IAAI,KAAK,CAAC;QAC1DE,GAAG,EAAED,OAAO,CAACjB,UAAU,EAAEkB,GAAG,IAAI,IAAI,CAAC;QACrCC,iBAAiB,EAAEF,OAAO,CAACjB,UAAU,EAAEoB,GAAG,IAAI,IAAI,CAAC;QACnDC,UAAU,EAAEJ,OAAO,CAACjB,UAAU,EAAEsB,MAAM,IAAI,KAAK;MACjD,CAAC;MACD;MACA,MAAM;QACJ;QACAC,UAAU,GAAGjC,OAAO,CAACkC,aAAa,CAAC;MACrC,CAAC,GAAGlC,OAAO;MACX,MAAMmC,QAAQ,GAAGC,qBAAY,CAACC,mBAAmB,CAC/C,yCAA2ClC,IAAI,EAAG8B,UAAU,EAAER,GAAG,EAAEpB,QACrE,CAAC;MAED,IAAI,CAAC8B,QAAQ,EAAE;QACb,OAAO,KAAK;MACd;IACF;IAEA,IAAI,CAAC3B,kBAAkB,IAAII,yBAAyB,MAClDQ,iBAAiB,IAAI1B,KAAK,CAAC4C,iBAAiB,CAAC,CAAC,CAC/C,EAAE;MACD,OAAO,IAAI;IACb;IAEA,MAAMC,OAAO,GAAG,CAACnB,iBAAiB,IAAI1B,KAAK,CAAC8C,MAAM,CAAC,OAAO,CAAC,IACzDpB,iBAAiB,IAAI1B,KAAK,CAAC6C,OAAO,CAAC,CAAC;IAEtC,IAAI9B,qBAAqB,IAAI8B,OAAO,EAAE;MACpC,OAAO,IAAI;IACb;IAEA,OAAOnB,iBAAiB,IAAI1B,KAAK,CAAC+C,yCAAyC,CACzEhC,qBACF,CAAC;EACH,CAAC;EAED,IAAIe,YAAY,CAAC,CAAC,EAAE;IAClB9B,KAAK,CAACgD,WAAW,CAAC,kBAAkB3B,OAAO,eAAe,EAAE,IAAI,EAAER,WAAW,GAAG,MAAM;MACpFb,KAAK,CAACiD,MAAM,CAAC5B,OAAO,CAAC;IACvB,CAAC,GAAG,IAAI,CAAC;EACX;AACF,CAAC,EAAE;EACD6B,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,uDAAuD;MACpEC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,iBAAiB,EAAE;UACjB7D,OAAO,EAAE,KAAK;UACduD,WAAW,EAAE;AACzB,yDAAyD;UAC7CO,IAAI,EAAE;QACR,CAAC;QACDC,YAAY,EAAE;UACZ/D,OAAO,EAAE,IAAI;UACbuD,WAAW,EAAE;AACzB,wDAAwD;UAC5CO,IAAI,EAAE;QACR,CAAC;QACDhD,QAAQ,EAAE;UACRyC,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;UACIS,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEH,IAAI,EAAE;YACR,CAAC,EACD;cACEH,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVlD,OAAO,EAAE;kBACPoD,IAAI,EAAE;gBACR,CAAC;gBACDtD,OAAO,EAAE;kBACPsD,IAAI,EAAE;gBACR,CAAC;gBACD9C,kBAAkB,EAAE;kBAClB8C,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD/C,WAAW,EAAE;UACXwC,WAAW,EAAE;AACzB,uBAAuB;UACXO,IAAI,EAAE;QACR,CAAC;QACDI,UAAU,EAAE;UACVX,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACXS,KAAK,EAAE;YACLF,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD9C,kBAAkB,EAAE;UAClBhB,OAAO,EAAE,KAAK;UACduD,WAAW,EAAE;AACzB;AACA;AACA,sDAAsD;UAC1CO,IAAI,EAAE;QACR,CAAC;QACD7C,qBAAqB,EAAE;UACrBjB,OAAO,EAAE,KAAK;UACduD,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA,uCAAuC;UAC3BO,IAAI,EAAE;QACR,CAAC;QACD5C,UAAU,EAAE;UACVqC,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,iFAAiF;UACrEY,KAAK,EAAE,CACL;YACEnE,OAAO,EAAE,KAAK;YACd8D,IAAI,EAAE;UACR,CAAC,EACD;YACEH,oBAAoB,EAAE,KAAK;YAC3B3D,OAAO,EAAE,CAAC,CAAC;YACX4D,UAAU,EAAE;cACV1B,aAAa,EAAE;gBACb4B,IAAI,EAAE;cACR,CAAC;cACDxB,GAAG,EAAE;gBACHwB,IAAI,EAAE;cACR,CAAC;cACD1B,GAAG,EAAE;gBACH0B,IAAI,EAAE;cACR,CAAC;cACDtB,MAAM,EAAE;gBACNsB,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;QAEL;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAM,MAAA,CAAA9D,OAAA,GAAAA,OAAA,CAAAN,OAAA","ignoreList":[]}