eslint-plugin-jsdoc 58.1.1 → 59.0.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 (184) hide show
  1. package/README.md +87 -69
  2. package/dist/buildForbidRuleDefinition.cjs +0 -1
  3. package/dist/buildForbidRuleDefinition.cjs.map +1 -1
  4. package/dist/buildRejectOrPreferRuleDefinition.cjs +7 -2
  5. package/dist/buildRejectOrPreferRuleDefinition.cjs.map +1 -1
  6. package/dist/cjs/rules/convertToJsdocComments.d.ts +7 -0
  7. package/dist/generateDocs.cjs +129 -3
  8. package/dist/generateDocs.cjs.map +1 -1
  9. package/dist/generateRule.cjs +3 -1
  10. package/dist/generateRule.cjs.map +1 -1
  11. package/dist/generateRuleTypes.cjs +5 -5
  12. package/dist/generateRuleTypes.cjs.map +1 -1
  13. package/dist/index-cjs.cjs +30 -0
  14. package/dist/index-cjs.cjs.map +1 -1
  15. package/dist/index.cjs +30 -0
  16. package/dist/index.cjs.map +1 -1
  17. package/dist/rules/checkAccess.cjs +1 -1
  18. package/dist/rules/checkAccess.cjs.map +1 -1
  19. package/dist/rules/checkAlignment.cjs +4 -1
  20. package/dist/rules/checkAlignment.cjs.map +1 -1
  21. package/dist/rules/checkExamples.cjs +1 -1
  22. package/dist/rules/checkExamples.cjs.map +1 -1
  23. package/dist/rules/checkIndentation.cjs +19 -0
  24. package/dist/rules/checkIndentation.cjs.map +1 -1
  25. package/dist/rules/checkLineAlignment.cjs +25 -1
  26. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  27. package/dist/rules/checkParamNames.cjs +62 -1
  28. package/dist/rules/checkParamNames.cjs.map +1 -1
  29. package/dist/rules/checkPropertyNames.cjs +6 -0
  30. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  31. package/dist/rules/checkTagNames.cjs +71 -0
  32. package/dist/rules/checkTagNames.cjs.map +1 -1
  33. package/dist/rules/checkTypes.cjs +16 -1
  34. package/dist/rules/checkTypes.cjs.map +1 -1
  35. package/dist/rules/checkValues.cjs +17 -1
  36. package/dist/rules/checkValues.cjs.map +1 -1
  37. package/dist/rules/convertToJsdocComments.cjs +48 -0
  38. package/dist/rules/convertToJsdocComments.cjs.map +1 -1
  39. package/dist/rules/convertToJsdocComments.d.ts +7 -0
  40. package/dist/rules/emptyTags.cjs +10 -1
  41. package/dist/rules/emptyTags.cjs.map +1 -1
  42. package/dist/rules/implementsOnClasses.cjs +15 -1
  43. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  44. package/dist/rules/informativeDocs.cjs +45 -0
  45. package/dist/rules/informativeDocs.cjs.map +1 -1
  46. package/dist/rules/linesBeforeBlock.cjs +14 -0
  47. package/dist/rules/linesBeforeBlock.cjs.map +1 -1
  48. package/dist/rules/matchDescription.cjs +129 -0
  49. package/dist/rules/matchDescription.cjs.map +1 -1
  50. package/dist/rules/matchName.cjs +30 -0
  51. package/dist/rules/matchName.cjs.map +1 -1
  52. package/dist/rules/multilineBlocks.cjs +78 -6
  53. package/dist/rules/multilineBlocks.cjs.map +1 -1
  54. package/dist/rules/noBadBlocks.cjs +11 -2
  55. package/dist/rules/noBadBlocks.cjs.map +1 -1
  56. package/dist/rules/noBlankBlockDescriptions.cjs +1 -1
  57. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  58. package/dist/rules/noBlankBlocks.cjs +3 -1
  59. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  60. package/dist/rules/noDefaults.cjs +19 -0
  61. package/dist/rules/noDefaults.cjs.map +1 -1
  62. package/dist/rules/noMissingSyntax.cjs +22 -2
  63. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  64. package/dist/rules/noMultiAsterisks.cjs +29 -0
  65. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  66. package/dist/rules/noRestrictedSyntax.cjs +17 -1
  67. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  68. package/dist/rules/noTypes.cjs +17 -1
  69. package/dist/rules/noTypes.cjs.map +1 -1
  70. package/dist/rules/noUndefinedTypes.cjs +11 -1
  71. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  72. package/dist/rules/requireAsteriskPrefix.cjs +28 -0
  73. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  74. package/dist/rules/requireDescription.cjs +30 -1
  75. package/dist/rules/requireDescription.cjs.map +1 -1
  76. package/dist/rules/requireDescriptionCompleteSentence.cjs +27 -0
  77. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  78. package/dist/rules/requireExample.cjs +26 -1
  79. package/dist/rules/requireExample.cjs.map +1 -1
  80. package/dist/rules/requireFileOverview.cjs +61 -0
  81. package/dist/rules/requireFileOverview.cjs.map +1 -1
  82. package/dist/rules/requireHyphenBeforeParamDescription.cjs +20 -2
  83. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  84. package/dist/rules/requireJsdoc.cjs +82 -3
  85. package/dist/rules/requireJsdoc.cjs.map +1 -1
  86. package/dist/rules/requireParam.cjs +213 -1
  87. package/dist/rules/requireParam.cjs.map +1 -1
  88. package/dist/rules/requireParamDescription.cjs +21 -0
  89. package/dist/rules/requireParamDescription.cjs.map +1 -1
  90. package/dist/rules/requireParamName.cjs +16 -1
  91. package/dist/rules/requireParamName.cjs.map +1 -1
  92. package/dist/rules/requireParamType.cjs +21 -1
  93. package/dist/rules/requireParamType.cjs.map +1 -1
  94. package/dist/rules/requirePropertyName.cjs +1 -1
  95. package/dist/rules/requirePropertyName.cjs.map +1 -1
  96. package/dist/rules/requirePropertyType.cjs +1 -1
  97. package/dist/rules/requirePropertyType.cjs.map +1 -1
  98. package/dist/rules/requireReturns.cjs +54 -1
  99. package/dist/rules/requireReturns.cjs.map +1 -1
  100. package/dist/rules/requireReturnsCheck.cjs +22 -1
  101. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  102. package/dist/rules/requireReturnsDescription.cjs +15 -1
  103. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  104. package/dist/rules/requireReturnsType.cjs +15 -1
  105. package/dist/rules/requireReturnsType.cjs.map +1 -1
  106. package/dist/rules/requireTemplate.cjs +17 -1
  107. package/dist/rules/requireTemplate.cjs.map +1 -1
  108. package/dist/rules/requireThrows.cjs +18 -1
  109. package/dist/rules/requireThrows.cjs.map +1 -1
  110. package/dist/rules/requireYields.cjs +50 -1
  111. package/dist/rules/requireYields.cjs.map +1 -1
  112. package/dist/rules/requireYieldsCheck.cjs +25 -7
  113. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  114. package/dist/rules/sortTags.cjs +200 -1
  115. package/dist/rules/sortTags.cjs.map +1 -1
  116. package/dist/rules/tagLines.cjs +32 -2
  117. package/dist/rules/tagLines.cjs.map +1 -1
  118. package/dist/rules/textEscaping.cjs +5 -1
  119. package/dist/rules/textEscaping.cjs.map +1 -1
  120. package/dist/rules/typeFormatting.cjs +47 -10
  121. package/dist/rules/typeFormatting.cjs.map +1 -1
  122. package/dist/rules/validTypes.cjs +8 -1
  123. package/dist/rules/validTypes.cjs.map +1 -1
  124. package/dist/rules.d.ts +2130 -32
  125. package/package.json +2 -2
  126. package/src/buildForbidRuleDefinition.js +0 -1
  127. package/src/buildRejectOrPreferRuleDefinition.js +12 -2
  128. package/src/index-cjs.js +36 -0
  129. package/src/index.js +36 -0
  130. package/src/rules/checkAccess.js +1 -1
  131. package/src/rules/checkAlignment.js +3 -0
  132. package/src/rules/checkExamples.js +1 -1
  133. package/src/rules/checkIndentation.js +19 -0
  134. package/src/rules/checkLineAlignment.js +24 -0
  135. package/src/rules/checkParamNames.js +62 -1
  136. package/src/rules/checkPropertyNames.js +6 -0
  137. package/src/rules/checkTagNames.js +71 -0
  138. package/src/rules/checkTypes.js +16 -1
  139. package/src/rules/checkValues.js +16 -0
  140. package/src/rules/convertToJsdocComments.js +48 -0
  141. package/src/rules/emptyTags.js +10 -1
  142. package/src/rules/implementsOnClasses.js +15 -1
  143. package/src/rules/informativeDocs.js +45 -0
  144. package/src/rules/linesBeforeBlock.js +14 -0
  145. package/src/rules/matchDescription.js +129 -0
  146. package/src/rules/matchName.js +30 -0
  147. package/src/rules/multilineBlocks.js +77 -5
  148. package/src/rules/noBadBlocks.js +11 -2
  149. package/src/rules/noBlankBlockDescriptions.js +1 -1
  150. package/src/rules/noBlankBlocks.js +2 -0
  151. package/src/rules/noDefaults.js +19 -0
  152. package/src/rules/noMissingSyntax.js +22 -2
  153. package/src/rules/noMultiAsterisks.js +29 -0
  154. package/src/rules/noRestrictedSyntax.js +17 -1
  155. package/src/rules/noTypes.js +17 -1
  156. package/src/rules/noUndefinedTypes.js +11 -1
  157. package/src/rules/requireAsteriskPrefix.js +28 -0
  158. package/src/rules/requireDescription.js +30 -1
  159. package/src/rules/requireDescriptionCompleteSentence.js +27 -0
  160. package/src/rules/requireExample.js +26 -1
  161. package/src/rules/requireFileOverview.js +61 -0
  162. package/src/rules/requireHyphenBeforeParamDescription.js +19 -1
  163. package/src/rules/requireJsdoc.js +80 -1
  164. package/src/rules/requireParam.js +213 -1
  165. package/src/rules/requireParamDescription.js +21 -0
  166. package/src/rules/requireParamName.js +16 -1
  167. package/src/rules/requireParamType.js +21 -1
  168. package/src/rules/requirePropertyName.js +1 -1
  169. package/src/rules/requirePropertyType.js +1 -1
  170. package/src/rules/requireReturns.js +54 -1
  171. package/src/rules/requireReturnsCheck.js +22 -1
  172. package/src/rules/requireReturnsDescription.js +15 -1
  173. package/src/rules/requireReturnsType.js +15 -1
  174. package/src/rules/requireTemplate.js +17 -1
  175. package/src/rules/requireThrows.js +18 -1
  176. package/src/rules/requireYields.js +50 -1
  177. package/src/rules/requireYieldsCheck.js +25 -7
  178. package/src/rules/sortTags.js +200 -1
  179. package/src/rules/tagLines.js +30 -0
  180. package/src/rules/textEscaping.js +5 -1
  181. package/src/rules/typeFormatting.js +44 -7
  182. package/src/rules/validTypes.js +8 -1
  183. package/src/rules.d.ts +2130 -32
  184. package/typings/gitdown.d.ts +4 -0
@@ -1 +1 @@
1
- {"version":3,"file":"requireJsdoc.cjs","names":["_exportParser","_interopRequireDefault","require","_iterateJsdoc","_jsdocUtils","_jsdoccomment","e","__esModule","default","OPTIONS_SCHEMA","additionalProperties","properties","checkConstructors","type","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","description","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 properties: {\n checkConstructors: {\n default: true,\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 },\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 },\n contexts: {\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 type: 'boolean',\n },\n exemptEmptyConstructors: {\n default: false,\n type: 'boolean',\n },\n exemptEmptyFunctions: {\n default: false,\n type: 'boolean',\n },\n exemptOverloadedImplementations: {\n default: false,\n type: 'boolean',\n },\n fixerMessage: {\n default: '',\n type: 'string',\n },\n minLineCount: {\n type: 'integer',\n },\n publicOnly: {\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 properties: {\n ArrowFunctionExpression: {\n default: false,\n type: 'boolean',\n },\n ClassDeclaration: {\n default: false,\n type: 'boolean',\n },\n ClassExpression: {\n default: false,\n type: 'boolean',\n },\n FunctionDeclaration: {\n default: true,\n type: 'boolean',\n },\n FunctionExpression: {\n default: false,\n type: 'boolean',\n },\n MethodDefinition: {\n default: false,\n type: 'boolean',\n },\n },\n type: 'object',\n },\n skipInterveningOverloadedDeclarations: {\n default: 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 * 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 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 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 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 (\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: 'Require JSDoc comments',\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,UAAU,EAAE;IACVC,iBAAiB,EAAE;MACjBJ,OAAO,EAAE,IAAI;MACbK,IAAI,EAAE;IACR,CAAC;IACDC,YAAY,EAAE;MACZC,KAAK,EAAE,CACL;QACEF,IAAI,EAAE;MACR,CAAC,EACD;QACEG,IAAI,EAAE,CACJ,WAAW,CACZ;QACDH,IAAI,EAAE;MACR,CAAC,CACF;MACDL,OAAO,EAAE;IACX,CAAC;IACDS,YAAY,EAAE;MACZF,KAAK,EAAE,CACL;QACEF,IAAI,EAAE;MACR,CAAC,EACD;QACEG,IAAI,EAAE,CACJ,WAAW,CACZ;QACDH,IAAI,EAAE;MACR,CAAC,CACF;MACDL,OAAO,EAAE;IACX,CAAC;IACDU,QAAQ,EAAE;MACRC,KAAK,EAAE;QACLJ,KAAK,EAAE,CACL;UACEF,IAAI,EAAE;QACR,CAAC,EACD;UACEH,oBAAoB,EAAE,KAAK;UAC3BC,UAAU,EAAE;YACVS,OAAO,EAAE;cACPP,IAAI,EAAE;YACR,CAAC;YACDQ,kBAAkB,EAAE;cAClBR,IAAI,EAAE;YACR,CAAC;YACDS,YAAY,EAAE;cACZT,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;MAEL,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACDU,WAAW,EAAE;MACXf,OAAO,EAAE,IAAI;MACbK,IAAI,EAAE;IACR,CAAC;IACDW,uBAAuB,EAAE;MACvBhB,OAAO,EAAE,KAAK;MACdK,IAAI,EAAE;IACR,CAAC;IACDY,oBAAoB,EAAE;MACpBjB,OAAO,EAAE,KAAK;MACdK,IAAI,EAAE;IACR,CAAC;IACDa,+BAA+B,EAAE;MAC/BlB,OAAO,EAAE,KAAK;MACdK,IAAI,EAAE;IACR,CAAC;IACDc,YAAY,EAAE;MACZnB,OAAO,EAAE,EAAE;MACXK,IAAI,EAAE;IACR,CAAC;IACDS,YAAY,EAAE;MACZT,IAAI,EAAE;IACR,CAAC;IACDe,UAAU,EAAE;MACVC,KAAK,EAAE,CACL;QACErB,OAAO,EAAE,KAAK;QACdK,IAAI,EAAE;MACR,CAAC,EACD;QACEH,oBAAoB,EAAE,KAAK;QAC3BF,OAAO,EAAE,CAAC,CAAC;QACXG,UAAU,EAAE;UACVmB,aAAa,EAAE;YACbjB,IAAI,EAAE;UACR,CAAC;UACDkB,GAAG,EAAE;YACHlB,IAAI,EAAE;UACR,CAAC;UACDmB,GAAG,EAAE;YACHnB,IAAI,EAAE;UACR,CAAC;UACDoB,MAAM,EAAE;YACNpB,IAAI,EAAE;UACR;QACF,CAAC;QACDA,IAAI,EAAE;MACR,CAAC;IAEL,CAAC;IACDX,OAAO,EAAE;MACPQ,oBAAoB,EAAE,KAAK;MAC3BF,OAAO,EAAE,CAAC,CAAC;MACXG,UAAU,EAAE;QACVuB,uBAAuB,EAAE;UACvB1B,OAAO,EAAE,KAAK;UACdK,IAAI,EAAE;QACR,CAAC;QACDsB,gBAAgB,EAAE;UAChB3B,OAAO,EAAE,KAAK;UACdK,IAAI,EAAE;QACR,CAAC;QACDuB,eAAe,EAAE;UACf5B,OAAO,EAAE,KAAK;UACdK,IAAI,EAAE;QACR,CAAC;QACDwB,mBAAmB,EAAE;UACnB7B,OAAO,EAAE,IAAI;UACbK,IAAI,EAAE;QACR,CAAC;QACDyB,kBAAkB,EAAE;UAClB9B,OAAO,EAAE,KAAK;UACdK,IAAI,EAAE;QACR,CAAC;QACD0B,gBAAgB,EAAE;UAChB/B,OAAO,EAAE,KAAK;UACdK,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACD2B,qCAAqC,EAAE;MACrChC,OAAO,EAAE,IAAI;MACbK,IAAI,EAAE;IACR;EACF,CAAC;EACDA,IAAI,EAAE;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM4B,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,CAACrC,IAAI,KAAK,wBAAwB,EAAE;UAC1D;QACF;QAEA,KAAK,MAAMuC,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,CAAC7C,IAAI,KAAK,oBAAoB,IACpC6C,IAAI,CAACP,MAAM,CAACtC,IAAI,KAAK,kBAAkB,IACvC6C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACtC,IAAI,KAAK,WAAW,IACvC6C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,CAACtC,IAAI,KAAK,kBAAkB,IACrD,YAAY,IAAI6C,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,CAAC3D,UAAU,CACrB4C,GAAG,CAAC,CAAC/C,OAAO;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMiE,UAAU,GAAGA,CAACrD,OAAO,EAAEwC,QAAQ,KAAK;EACxC,MAAM;IACJ1C,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;IACLtD,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,MAAMjB,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMiE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPhE,UACN,CAAC,EAAE;QACD,MAAMoE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP,sDAAwDuD,OAAO,EAC/D,YAAY,EACZC,IACF,CAAC;QAEDjE,UAAU,CAACiE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOpE,UAAU;IACnB,CAAC,EACC;IACA,CACE;IACA,CACE;IAEEF,cAAc,CAACE,UAAU,CACzBiB,UAAU,EACZC,KAAK,EACP,CAAC,CACL,CAAC;IACD3B,OAAO,EAAE,CAAEyE,OAAO,IAAK;MACrB;MACA,MAAMhE,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMiE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPhE,UACN,CAAC,EAAE;QACD,MAAMoE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP;QACCuD,OAAO,EACR,SAAS,EACTC,IACF,CAAC;QACDjE,UAAU,CAACiE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOpE,UAAU;IACnB,CAAC,EACC;IACCF,cAAc,CAACE,UAAU,CAAET,OAC9B,CAAC;IACDsC;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA,MAAMwC,sBAAsB,GAAItB,IAAI,IAAK;EACvC,IAAIA,IAAI,CAAC7C,IAAI,KAAK,qBAAqB,EAAE;IACvC,OAAO,KAAK;EACd;EAEA,IAAIsC,MAAM;EACV,IAAI8B,KAAK;EAET,IAAIvB,IAAI,CAACP,MAAM,EAAEtC,IAAI,KAAK,SAAS,EAAE;IACnCsC,MAAM,GAAGO,IAAI,CAACP,MAAM;IACpB8B,KAAK,GAAGvB,IAAI;EACd,CAAC,MAAM,IAAIA,IAAI,CAACP,MAAM,EAAEtC,IAAI,KAAK,wBAAwB,IACrD6C,IAAI,CAACP,MAAM,EAAEA,MAAM,CAACtC,IAAI,KAAK,SAAS,EAAE;IAC1CsC,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,CAACpC,IAAI;EAEjC,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,EAAEzE,IAAI,KAAK,mBAAmB;IACxC;IACAqE,YAAY,KAAKI,WAAW,CAACH,EAAE,CAACpC,IAAI,IACrCuC,WAAW,EAAEzE,IAAI,KAAK,wBAAwB;IAC7C;IACAyE,WAAW,CAACC,WAAW,EAAE1E,IAAI,KAAK,mBAAmB;IACrD;IACAyE,WAAW,CAACC,WAAW,EAAEJ,EAAE,EAAEpC,IAAI,KAAKmC;EAAa;AAEzD,CAAC;;AAED;AAAA,IAAAM,QAAA,GAAAC,OAAA,CAAAjF,OAAA,GACe;EACbkF,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;MACJ1C,QAAQ;MACRK,WAAW;MACXC,uBAAuB;MACvBC,oBAAoB;MACpBC,+BAA+B;MAC/BC,YAAY;MACZL,YAAY;MACZpB,OAAO,EAAE4F,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,CAAC7C,IAAI,CAAC;QAC7C,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,IAAIwF,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;QACEC,WAAW,EAAE,EAAE;QACfC,UAAU,EAAE,EAAE;QACdC,QAAQ,EAAE,EAAE;QACZC,MAAM,EAAE,EAAE;QACVC,IAAI,EAAE;MACR,CAAC,EACD1D,IAAI,EACJtC,OAAO,EACP,CACEX,cAAc,CAElB,CAAC,EAAE;QACD;MACF;MAEA;MACE;MACA;MACAgB,oBAAoB,IAAIuE,IAAI,CAACqB,iBAAiB;MAE9C;MACA;MACA7F,uBAAuB,IAAI,IAAA8F,yBAAa,EAAC5D,IAAI,CAAC,EAC9C;QACA,MAAM6D,sBAAsB,GAAG,IAAAC,qCAAyB,EAAC9D,IAAI,CAAC;QAC9D,IAAI,CAAC6D,sBAAsB,CAACf,MAAM,IAAI,CAAC,IAAAiB,0BAAc,EAAC/D,IAAI,CAAC,EAAE;UAC3D;QACF;MACF;MAEA,IAAID,qBAAqB,CAACC,IAAI,EAAEC,UAAU,EAAEvC,OAAO,EAAEwC,QAAQ,CAAC,EAAE;QAC9D;MACF;MAEA,MAAM8D,GAAG,GAAG,gDAAkDC,KAAK,IAAK;QACtE;QACA,MAAMC,KAAK,GAAGhE,QAAQ,CAACiE,QAAQ,KAAK,CAAC,IAAIjE,QAAQ,CAACkE,QAAQ,IAAI,CAAC,GAAG,CAAC,GAAGlE,QAAQ,CAACiE,QAAQ;QACvF;QACA,IAAIE,QAAQ,GAAG,IAAAC,+BAAiB,EAACtE,IAAI,EAAEC,UAAU,CAAC;QAElD,MAAMsE,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,EAAE1E,UAAU,CAAC2C,OAAO,CACtB,yCAA2CyB,QAAQ,EACnD;UACA,CACE,yCAA2CA,QAAQ,CAAEO,GAAG,EACxDC,KAAK,CAACC,MACV;QACF,CAAC,CAAC;QAEF,MAAM;UACJnH;QACF,CAAC;QACC;AACV;AACA;AACA;AACA;AACA;AACA;QAAeH,QAAQ,CAACwF,IAAI,CAAE+B,MAAM,IAAK;UAC7B,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,KAAK;UACd;UAEA,MAAM;YACJrH,OAAO,EAAE+E;UACX,CAAC,GAAGsC,MAAM;UACV,OAAOtC,IAAI,KAAKzC,IAAI,CAAC7C,IAAI;QAC3B,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,MAAM6H,SAAS,GAAG,CAACrH,kBAAkB,GACnC,OAAOM,YAAY,EAAE,GACrB,QAAQwG,MAAM,IAAIxG,YAAY,KAAKwG,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,kDAAoD7E,IAAI,CAAC4E,GAAI;QACjE,MAAMA,GAAG,GAAG;UACVS,GAAG,EAAE;YACHP,MAAM,EAAE,CAAC;YACTQ,IAAI,EAAET,KAAK,CAACS,IAAI,GAAG;UACrB,CAAC;UACDT;QACF,CAAC;QACDnH,OAAO,CAAC0H,MAAM,CAAC;UACbpB,GAAG,EAAEnG,WAAW,GAAGmG,GAAG,GAAG,IAAI;UAC7BY,GAAG;UACHW,SAAS,EAAE,cAAc;UACzBvF;QACF,CAAC,CAAC;MACJ,CAAC;MAED,IAAI9B,UAAU,EAAE;QACd;QACA,MAAMmD,GAAG,GAAG;UACVjD,aAAa,EAAEoH,OAAO,CAACtH,UAAU,EAAEE,aAAa,IAAI,KAAK,CAAC;UAC1DE,GAAG,EAAEkH,OAAO,CAACtH,UAAU,EAAEI,GAAG,IAAI,IAAI,CAAC;UACrCmH,iBAAiB,EAAED,OAAO,CAACtH,UAAU,EAAEG,GAAG,IAAI,IAAI,CAAC;UACnDqH,UAAU,EAAEF,OAAO,CAACtH,UAAU,EAAEK,MAAM,IAAI,KAAK;QACjD,CAAC;QACD,MAAMoH,QAAQ,GAAGC,qBAAY,CAACC,mBAAmB,CAAC7F,IAAI,EAAEC,UAAU,EAAEoB,GAAG,EAAEnB,QAAQ,CAAC;QAElF,IAAIyF,QAAQ,EAAE;UACZP,MAAM,CAAC,CAAC;QACV;MACF,CAAC,MAAM;QACLA,MAAM,CAAC,CAAC;MACV;IACF,CAAC;;IAED;AACJ;AACA;AACA;IACI,MAAMU,SAAS,GAAI5E,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,IAAA6E,4BAAgB,EACjB,IAAAC,4BAAgB,EAACtI,OAAO,EAAE,EAAE,EAAEwC,QAAQ,CAAC,EACvCmC,UACF,CAAC;MACD7D,uBAAuBA,CAAEwB,IAAI,EAAE;QAC7B,IAAI,CAAC8F,SAAS,CAAC,yBAAyB,CAAC,EAAE;UACzC;QACF;QAEA,IACE,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAACG,QAAQ,CAACjG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC8I,QAAQ,CAACjG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC1B6C,IAAI;QACF;AACd;AACA;AACA;AACA;QACeA,IAAI,CAACP,MAAM,CAAEyG,KAAK,EACvB;UACA7D,UAAU,CAAC;YACTsB,iBAAiB,EAAE;UACrB,CAAC,EAAE,IAAI,EAAE3D,IAAI,CAAC;QAChB;MACF,CAAC;MAEDvB,gBAAgBA,CAAEuB,IAAI,EAAE;QACtB,IAAI,CAAC8F,SAAS,CAAC,kBAAkB,CAAC,EAAE;UAClC;QACF;QAEAzD,UAAU,CAAC;UACTsB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE3D,IAAI,CAAC;MAChB,CAAC;MAEDtB,eAAeA,CAAEsB,IAAI,EAAE;QACrB,IAAI,CAAC8F,SAAS,CAAC,iBAAiB,CAAC,EAAE;UACjC;QACF;QAEAzD,UAAU,CAAC;UACTsB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE3D,IAAI,CAAC;MAChB,CAAC;MAEDrB,mBAAmBA,CAAEqB,IAAI,EAAE;QACzB,IAAI,CAAC8F,SAAS,CAAC,qBAAqB,CAAC,EAAE;UACrC;QACF;QAEAzD,UAAU,CAAC;UACTsB,iBAAiB,EAAE;QACrB,CAAC,EAAE,IAAI,EAAE3D,IAAI,CAAC;MAChB,CAAC;MAEDpB,kBAAkBA,CAAEoB,IAAI,EAAE;QACxB,IAAI,CAAC8F,SAAS,CAAC,oBAAoB,CAAC,EAAE;UACpC;QACF;QAEA,IACE,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAACG,QAAQ,CAACjG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC8I,QAAQ,CAACjG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC1B6C,IAAI;QACF;AACd;AACA;AACA;AACA;QACeA,IAAI,CAACP,MAAM,CAAEyG,KAAK,EACvB;UACA7D,UAAU,CAAC;YACTsB,iBAAiB,EAAE;UACrB,CAAC,EAAE,IAAI,EAAE3D,IAAI,CAAC;QAChB;MACF,CAAC;MAEDnB,gBAAgBA,CAAEmB,IAAI,EAAE;QACtB,IAAI,CAAC8F,SAAS,CAAC,kBAAkB,CAAC,EAAE;UAClC;QACF;QAEAzD,UAAU,CAAC;UACTsB,iBAAiB,EAAE,IAAI;UACvBT,QAAQ,EAAE;QACZ,CAAC,EAAE,IAAI,EAAE,yCAA2ClD,IAAI,CAACkG,KAAM,CAAC;MAClE;IACF,CAAC;EACH,CAAC;EACDC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,QAAQ,EAAE,kBAAkB;MAC5B/C,WAAW,EAAE,wBAAwB;MACrCgD,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;IAEDI,IAAI,EAAE;EACR;AACF,CAAC;AAAAyJ,MAAA,CAAA7E,OAAA,GAAAA,OAAA,CAAAjF,OAAA","ignoreList":[]}
1
+ {"version":3,"file":"requireJsdoc.cjs","names":["_exportParser","_interopRequireDefault","require","_iterateJsdoc","_jsdocUtils","_jsdoccomment","e","__esModule","default","OPTIONS_SCHEMA","additionalProperties","description","properties","checkConstructors","type","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 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 },\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`,\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`,\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 * 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 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 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 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 (\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,iBAAiB,EAAE;MACjBL,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA,0CAA0C;MACpCG,IAAI,EAAE;IACR,CAAC;IACDC,YAAY,EAAE;MACZC,KAAK,EAAE,CACL;QACEF,IAAI,EAAE;MACR,CAAC,EACD;QACEG,IAAI,EAAE,CACJ,WAAW,CACZ;QACDH,IAAI,EAAE;MACR,CAAC,CACF;MACDN,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;IACI,CAAC;IACDO,YAAY,EAAE;MACZF,KAAK,EAAE,CACL;QACEF,IAAI,EAAE;MACR,CAAC,EACD;QACEG,IAAI,EAAE,CACJ,WAAW,CACZ;QACDH,IAAI,EAAE;MACR,CAAC,CACF;MACDN,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB;AACA;AACA;AACA;IACI,CAAC;IACDQ,QAAQ,EAAE;MACRR,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;MACxDS,KAAK,EAAE;QACLJ,KAAK,EAAE,CACL;UACEF,IAAI,EAAE;QACR,CAAC,EACD;UACEJ,oBAAoB,EAAE,KAAK;UAC3BE,UAAU,EAAE;YACVS,OAAO,EAAE;cACPP,IAAI,EAAE;YACR,CAAC;YACDQ,kBAAkB,EAAE;cAClBR,IAAI,EAAE;YACR,CAAC;YACDS,YAAY,EAAE;cACZT,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;MAEL,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACDU,WAAW,EAAE;MACXhB,OAAO,EAAE,IAAI;MACbG,WAAW,EAAE;AACnB,sBAAsB;MAChBG,IAAI,EAAE;IACR,CAAC;IACDW,uBAAuB,EAAE;MACvBjB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA;AACA;AACA,sBAAsB;MAChBG,IAAI,EAAE;IACR,CAAC;IACDY,oBAAoB,EAAE;MACpBlB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA,CAAC;MACKG,IAAI,EAAE;IACR,CAAC;IACDa,+BAA+B,EAAE;MAC/BnB,OAAO,EAAE,KAAK;MACdG,WAAW,EAAE;AACnB;AACA,uBAAuB;MACjBG,IAAI,EAAE;IACR,CAAC;IACDc,YAAY,EAAE;MACZpB,OAAO,EAAE,EAAE;MACXG,WAAW,EAAE;AACnB,cAAc;MACRG,IAAI,EAAE;IACR,CAAC;IACDS,YAAY,EAAE;MACZZ,WAAW,EAAE;AACnB;AACA,8EAA8E;MACxEG,IAAI,EAAE;IACR,CAAC;IACDe,UAAU,EAAE;MACVlB,WAAW,EAAE;AACnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;MACKmB,KAAK,EAAE,CACL;QACEtB,OAAO,EAAE,KAAK;QACdM,IAAI,EAAE;MACR,CAAC,EACD;QACEJ,oBAAoB,EAAE,KAAK;QAC3BF,OAAO,EAAE,CAAC,CAAC;QACXI,UAAU,EAAE;UACVmB,aAAa,EAAE;YACbjB,IAAI,EAAE;UACR,CAAC;UACDkB,GAAG,EAAE;YACHlB,IAAI,EAAE;UACR,CAAC;UACDmB,GAAG,EAAE;YACHnB,IAAI,EAAE;UACR,CAAC;UACDoB,MAAM,EAAE;YACNpB,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;QACVuB,uBAAuB,EAAE;UACvB3B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,kDAAkD;UAC/DG,IAAI,EAAE;QACR,CAAC;QACDsB,gBAAgB,EAAE;UAChB5B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,iDAAiD;UAC9DG,IAAI,EAAE;QACR,CAAC;QACDuB,eAAe,EAAE;UACf7B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,oEAAoE;UACjFG,IAAI,EAAE;QACR,CAAC;QACDwB,mBAAmB,EAAE;UACnB9B,OAAO,EAAE,IAAI;UACbG,WAAW,EAAE,6DAA6D;UAC1EG,IAAI,EAAE;QACR,CAAC;QACDyB,kBAAkB,EAAE;UAClB/B,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,oEAAoE;UACjFG,IAAI,EAAE;QACR,CAAC;QACD0B,gBAAgB,EAAE;UAChBhC,OAAO,EAAE,KAAK;UACdG,WAAW,EAAE,mFAAmF;UAChGG,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC;IACD2B,qCAAqC,EAAE;MACrCjC,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,MAAM4B,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,CAACrC,IAAI,KAAK,wBAAwB,EAAE;UAC1D;QACF;QAEA,KAAK,MAAMuC,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,CAAC7C,IAAI,KAAK,oBAAoB,IACpC6C,IAAI,CAACP,MAAM,CAACtC,IAAI,KAAK,kBAAkB,IACvC6C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACtC,IAAI,KAAK,WAAW,IACvC6C,IAAI,CAACP,MAAM,CAACA,MAAM,CAACA,MAAM,CAACtC,IAAI,KAAK,kBAAkB,IACrD,YAAY,IAAI6C,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,CAAC3D,UAAU,CACrB4C,GAAG,CAAC,CAAChD,OAAO;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMkE,UAAU,GAAGA,CAACrD,OAAO,EAAEwC,QAAQ,KAAK;EACxC,MAAM;IACJ1C,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;IACLtD,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,MAAMjB,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMiE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPhE,UACN,CAAC,EAAE;QACD,MAAMoE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP,sDAAwDuD,OAAO,EAC/D,YAAY,EACZC,IACF,CAAC;QAEDjE,UAAU,CAACiE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOpE,UAAU;IACnB,CAAC,EACC;IACA,CACE;IACA,CACE;IAEEH,cAAc,CAACG,UAAU,CACzBiB,UAAU,EACZC,KAAK,EACP,CAAC,CACL,CAAC;IACD5B,OAAO,EAAE,CAAE0E,OAAO,IAAK;MACrB;MACA,MAAMhE,UAAU,GAAG,CAAC,CAAC;MACrB,KAAK,MAAMiE,IAAI,IAAIC,MAAM,CAACC,IAAI,CAC5B;MACA,sDACIH,OAAO,CACPhE,UACN,CAAC,EAAE;QACD,MAAMoE,GAAG,GAAGV,SAAS,CACnBjD,OAAO,EACP;QACCuD,OAAO,EACR,SAAS,EACTC,IACF,CAAC;QACDjE,UAAU,CAACiE,IAAI,CAAC,GAAGG,GAAG;MACxB;MAEA,OAAOpE,UAAU;IACnB,CAAC,EACC;IACCH,cAAc,CAACG,UAAU,CAAEV,OAC9B,CAAC;IACDuC;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA,MAAMwC,sBAAsB,GAAItB,IAAI,IAAK;EACvC,IAAIA,IAAI,CAAC7C,IAAI,KAAK,qBAAqB,EAAE;IACvC,OAAO,KAAK;EACd;EAEA,IAAIsC,MAAM;EACV,IAAI8B,KAAK;EAET,IAAIvB,IAAI,CAACP,MAAM,EAAEtC,IAAI,KAAK,SAAS,EAAE;IACnCsC,MAAM,GAAGO,IAAI,CAACP,MAAM;IACpB8B,KAAK,GAAGvB,IAAI;EACd,CAAC,MAAM,IAAIA,IAAI,CAACP,MAAM,EAAEtC,IAAI,KAAK,wBAAwB,IACrD6C,IAAI,CAACP,MAAM,EAAEA,MAAM,CAACtC,IAAI,KAAK,SAAS,EAAE;IAC1CsC,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,CAACpC,IAAI;EAEjC,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,EAAEzE,IAAI,KAAK,mBAAmB;IACxC;IACAqE,YAAY,KAAKI,WAAW,CAACH,EAAE,CAACpC,IAAI,IACrCuC,WAAW,EAAEzE,IAAI,KAAK,wBAAwB;IAC7C;IACAyE,WAAW,CAACC,WAAW,EAAE1E,IAAI,KAAK,mBAAmB;IACrD;IACAyE,WAAW,CAACC,WAAW,EAAEJ,EAAE,EAAEpC,IAAI,KAAKmC;EAAa;AAEzD,CAAC;;AAED;AAAA,IAAAM,QAAA,GAAAC,OAAA,CAAAlF,OAAA,GACe;EACbmF,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;MACJ1C,QAAQ;MACRK,WAAW;MACXC,uBAAuB;MACvBC,oBAAoB;MACpBC,+BAA+B;MAC/BC,YAAY;MACZL,YAAY;MACZrB,OAAO,EAAE6F,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,CAAC7C,IAAI,CAAC;QAC7C,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,IAAIwF,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;QACErG,WAAW,EAAE,EAAE;QACfsG,UAAU,EAAE,EAAE;QACdC,QAAQ,EAAE,EAAE;QACZC,MAAM,EAAE,EAAE;QACVC,IAAI,EAAE;MACR,CAAC,EACDzD,IAAI,EACJtC,OAAO,EACP,CACEZ,cAAc,CAElB,CAAC,EAAE;QACD;MACF;MAEA;MACE;MACA;MACAiB,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,CAAC7C,IAAI;QAC3B,CAAC,CAAC,IAAK,CAAC,CAAC;QACX,MAAM4H,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,CAACtC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC6I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC1B6C,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,IACE,CACE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,CACzE,CAACG,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC5B,CACE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,oBAAoB,CACpE,CAAC6I,QAAQ,CAAChG,IAAI,CAACP,MAAM,CAACtC,IAAI,CAAC,IAC1B6C,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;MAC5BpJ,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,CAAA5E,OAAA,GAAAA,OAAA,CAAAlF,OAAA","ignoreList":[]}
@@ -446,7 +446,7 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
446
446
  contextDefaults: true,
447
447
  meta: {
448
448
  docs: {
449
- description: 'Requires that all function parameters are documented.',
449
+ description: 'Requires that all function parameters are documented with a `@param` tag.',
450
450
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header'
451
451
  },
452
452
  fixable: 'code',
@@ -455,36 +455,150 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
455
455
  properties: {
456
456
  autoIncrementBase: {
457
457
  default: 0,
458
+ description: `Numeric to indicate the number at which to begin auto-incrementing roots.
459
+ Defaults to \`0\`.
460
+ `,
458
461
  type: 'integer'
459
462
  },
460
463
  checkConstructors: {
461
464
  default: true,
465
+ description: `A value indicating whether \`constructor\`s should be checked. Defaults to
466
+ \`true\`.
467
+ `,
462
468
  type: 'boolean'
463
469
  },
464
470
  checkDestructured: {
465
471
  default: true,
472
+ description: 'Whether to require destructured properties. Defaults to `true`.',
466
473
  type: 'boolean'
467
474
  },
468
475
  checkDestructuredRoots: {
469
476
  default: true,
477
+ description: `Whether to check the existence of a corresponding \`@param\` for root objects
478
+ of destructured properties (e.g., that for \`function ({a, b}) {}\`, that there
479
+ is something like \`@param myRootObj\` defined that can correspond to
480
+ the \`{a, b}\` object parameter).
481
+
482
+ If \`checkDestructuredRoots\` is \`false\`, \`checkDestructured\` will also be
483
+ implied to be \`false\` (i.e., the inside of the roots will not be checked
484
+ either, e.g., it will also not complain if \`a\` or \`b\` do not have their own
485
+ documentation). Defaults to \`true\`.
486
+ `,
470
487
  type: 'boolean'
471
488
  },
472
489
  checkGetters: {
473
490
  default: false,
491
+ description: 'A value indicating whether getters should be checked. Defaults to `false`.',
474
492
  type: 'boolean'
475
493
  },
476
494
  checkRestProperty: {
477
495
  default: false,
496
+ description: `If set to \`true\`, will report (and add fixer insertions) for missing rest
497
+ properties. Defaults to \`false\`.
498
+
499
+ If set to \`true\`, note that you can still document the subproperties of the
500
+ rest property using other jsdoc features, e.g., \`@typedef\`:
501
+
502
+ \`\`\`js
503
+ /**
504
+ * @typedef ExtraOptions
505
+ * @property innerProp1
506
+ * @property innerProp2
507
+ */
508
+
509
+ /**
510
+ * @param cfg
511
+ * @param cfg.num
512
+ * @param {ExtraOptions} extra
513
+ */
514
+ function quux ({num, ...extra}) {
515
+ }
516
+ \`\`\`
517
+
518
+ Setting this option to \`false\` (the default) may be useful in cases where
519
+ you already have separate \`@param\` definitions for each of the properties
520
+ within the rest property.
521
+
522
+ For example, with the option disabled, this will not give an error despite
523
+ \`extra\` not having any definition:
524
+
525
+ \`\`\`js
526
+ /**
527
+ * @param cfg
528
+ * @param cfg.num
529
+ */
530
+ function quux ({num, ...extra}) {
531
+ }
532
+ \`\`\`
533
+
534
+ Nor will this:
535
+
536
+ \`\`\`js
537
+ /**
538
+ * @param cfg
539
+ * @param cfg.num
540
+ * @param cfg.innerProp1
541
+ * @param cfg.innerProp2
542
+ */
543
+ function quux ({num, ...extra}) {
544
+ }
545
+ \`\`\`
546
+ `,
478
547
  type: 'boolean'
479
548
  },
480
549
  checkSetters: {
481
550
  default: false,
551
+ description: 'A value indicating whether setters should be checked. Defaults to `false`.',
482
552
  type: 'boolean'
483
553
  },
484
554
  checkTypesPattern: {
555
+ description: `When one specifies a type, unless it is of a generic type, like \`object\`
556
+ or \`array\`, it may be considered unnecessary to have that object's
557
+ destructured components required, especially where generated docs will
558
+ link back to the specified type. For example:
559
+
560
+ \`\`\`js
561
+ /**
562
+ * @param {SVGRect} bbox - a SVGRect
563
+ */
564
+ export const bboxToObj = function ({x, y, width, height}) {
565
+ return {x, y, width, height};
566
+ };
567
+ \`\`\`
568
+
569
+ By default \`checkTypesPattern\` is set to
570
+ \`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/v\`,
571
+ meaning that destructuring will be required only if the type of the \`@param\`
572
+ (the text between curly brackets) is a match for "Object" or "Array" (with or
573
+ without initial caps), "PlainObject", or "GenericObject", "GenericArray" (or
574
+ if no type is present). So in the above example, the lack of a match will
575
+ mean that no complaint will be given about the undocumented destructured
576
+ parameters.
577
+
578
+ Note that the \`/\` delimiters are optional, but necessary to add flags.
579
+
580
+ Defaults to using (only) the \`v\` flag, so to add your own flags, encapsulate
581
+ your expression as a string, but like a literal, e.g., \`/^object$/vi\`.
582
+
583
+ You could set this regular expression to a more expansive list, or you
584
+ could restrict it such that even types matching those strings would not
585
+ need destructuring.`,
485
586
  type: 'string'
486
587
  },
487
588
  contexts: {
589
+ description: `Set this to an array of strings representing the AST context (or an object with
590
+ optional \`context\` and \`comment\` properties) where you wish the rule to be applied.
591
+
592
+ \`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
593
+
594
+ Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
595
+ \`FunctionExpression\`). May be useful for adding such as
596
+ \`TSMethodSignature\` in TypeScript or restricting the contexts
597
+ which are checked.
598
+
599
+ See the ["AST and Selectors"](../#advanced-ast-and-selectors)
600
+ section of our Advanced docs for more on the expected format.
601
+ `,
488
602
  items: {
489
603
  anyOf: [{
490
604
  type: 'string'
@@ -504,33 +618,131 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
504
618
  type: 'array'
505
619
  },
506
620
  enableFixer: {
621
+ description: 'Whether to enable the fixer. Defaults to `true`.',
507
622
  type: 'boolean'
508
623
  },
509
624
  enableRestElementFixer: {
625
+ description: `Whether to enable the rest element fixer.
626
+
627
+ The fixer will automatically report/insert
628
+ [JSDoc repeatable parameters](https://jsdoc.app/tags-param.html#multiple-types-and-repeatable-parameters)
629
+ if missing.
630
+
631
+ \`\`\`js
632
+ /**
633
+ * @param {GenericArray} cfg
634
+ * @param {number} cfg."0"
635
+ */
636
+ function baar ([a, ...extra]) {
637
+ //
638
+ }
639
+ \`\`\`
640
+
641
+ ...becomes:
642
+
643
+ \`\`\`js
644
+ /**
645
+ * @param {GenericArray} cfg
646
+ * @param {number} cfg."0"
647
+ * @param {...any} cfg."1"
648
+ */
649
+ function baar ([a, ...extra]) {
650
+ //
651
+ }
652
+ \`\`\`
653
+
654
+ Note that the type \`any\` is included since we don't know of any specific
655
+ type to use.
656
+
657
+ Defaults to \`true\`.
658
+ `,
510
659
  type: 'boolean'
511
660
  },
512
661
  enableRootFixer: {
662
+ description: `Whether to enable the auto-adding of incrementing roots.
663
+
664
+ The default behavior of \`true\` is for "root" to be auto-inserted for missing
665
+ roots, followed by a 0-based auto-incrementing number.
666
+
667
+ So for:
668
+
669
+ \`\`\`js
670
+ function quux ({foo}, {bar}, {baz}) {
671
+ }
672
+ \`\`\`
673
+
674
+ ...the default JSDoc that would be added if the fixer is enabled would be:
675
+
676
+ \`\`\`js
677
+ /**
678
+ * @param root0
679
+ * @param root0.foo
680
+ * @param root1
681
+ * @param root1.bar
682
+ * @param root2
683
+ * @param root2.baz
684
+ */
685
+ \`\`\`
686
+
687
+ Has no effect if \`enableFixer\` is set to \`false\`.`,
513
688
  type: 'boolean'
514
689
  },
515
690
  exemptedBy: {
691
+ description: `Array of tags (e.g., \`['type']\`) whose presence on the document block
692
+ avoids the need for a \`@param\`. Defaults to an array with
693
+ \`inheritdoc\`. If you set this array, it will overwrite the default,
694
+ so be sure to add back \`inheritdoc\` if you wish its presence to cause
695
+ exemption of the rule.`,
516
696
  items: {
517
697
  type: 'string'
518
698
  },
519
699
  type: 'array'
520
700
  },
521
701
  ignoreWhenAllParamsMissing: {
702
+ description: `Set to \`true\` to ignore reporting when all params are missing. Defaults to
703
+ \`false\`.`,
522
704
  type: 'boolean'
523
705
  },
524
706
  interfaceExemptsParamsCheck: {
707
+ description: `Set if you wish TypeScript interfaces to exempt checks for the existence of
708
+ \`@param\`'s.
709
+
710
+ Will check for a type defining the function itself (on a variable
711
+ declaration) or if there is a single destructured object with a type.
712
+ Defaults to \`false\`.`,
525
713
  type: 'boolean'
526
714
  },
527
715
  unnamedRootBase: {
716
+ description: `An array of root names to use in the fixer when roots are missing. Defaults
717
+ to \`['root']\`. Note that only when all items in the array besides the last
718
+ are exhausted will auto-incrementing occur. So, with
719
+ \`unnamedRootBase: ['arg', 'config']\`, the following:
720
+
721
+ \`\`\`js
722
+ function quux ({foo}, [bar], {baz}) {
723
+ }
724
+ \`\`\`
725
+
726
+ ...will get the following JSDoc block added:
727
+
728
+ \`\`\`js
729
+ /**
730
+ * @param arg
731
+ * @param arg.foo
732
+ * @param config0
733
+ * @param config0."0" (\`bar\`)
734
+ * @param config1
735
+ * @param config1.baz
736
+ */
737
+ \`\`\``,
528
738
  items: {
529
739
  type: 'string'
530
740
  },
531
741
  type: 'array'
532
742
  },
533
743
  useDefaultObjectProperties: {
744
+ description: `Set to \`true\` if you wish to expect documentation of properties on objects
745
+ supplied as default values. Defaults to \`false\`.`,
534
746
  type: 'boolean'
535
747
  }
536
748
  },