eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/requireJsdoc.js

@@ -1,404 +0,0 @@
-import { hasReturnValue } from "../utils/hasReturnValue.js";
-import { enforcedContexts, exemptSpeciaMethods, getContextObject, getFunctionParameterNames, getIndent, isConstructor } from "../jsdocUtils.js";
-import { getSettings } from "../iterateJsdoc.js";
-import exportParser_default from "../exportParser.js";
-import { getDecorator, getJSDocComment, getReducedASTNode } from "@es-joy/jsdoccomment";
-
-//#region src/rules/requireJsdoc.js
-/**
-* @typedef {{
-*   ancestorsOnly: boolean,
-*   esm: boolean,
-*   initModuleExports: boolean,
-*   initWindow: boolean
-* }} RequireJsdocOpts
-*/
-/**
-* @typedef {import('eslint').Rule.Node|
-*   import('@typescript-eslint/types').TSESTree.Node} ESLintOrTSNode
-*/
-/** @type {import('json-schema').JSONSchema4} */
-const OPTIONS_SCHEMA = {
-	additionalProperties: false,
-	properties: {
-		checkConstructors: {
-			default: true,
-			type: "boolean"
-		},
-		checkGetters: {
-			anyOf: [{ type: "boolean" }, {
-				enum: ["no-setter"],
-				type: "string"
-			}],
-			default: true
-		},
-		checkSetters: {
-			anyOf: [{ type: "boolean" }, {
-				enum: ["no-getter"],
-				type: "string"
-			}],
-			default: true
-		},
-		contexts: {
-			items: { anyOf: [{ type: "string" }, {
-				additionalProperties: false,
-				properties: {
-					context: { type: "string" },
-					inlineCommentBlock: { type: "boolean" },
-					minLineCount: { type: "integer" }
-				},
-				type: "object"
-			}] },
-			type: "array"
-		},
-		enableFixer: {
-			default: true,
-			type: "boolean"
-		},
-		exemptEmptyConstructors: {
-			default: false,
-			type: "boolean"
-		},
-		exemptEmptyFunctions: {
-			default: false,
-			type: "boolean"
-		},
-		fixerMessage: {
-			default: "",
-			type: "string"
-		},
-		minLineCount: { type: "integer" },
-		publicOnly: { oneOf: [{
-			default: false,
-			type: "boolean"
-		}, {
-			additionalProperties: false,
-			default: {},
-			properties: {
-				ancestorsOnly: { type: "boolean" },
-				cjs: { type: "boolean" },
-				esm: { type: "boolean" },
-				window: { type: "boolean" }
-			},
-			type: "object"
-		}] },
-		require: {
-			additionalProperties: false,
-			default: {},
-			properties: {
-				ArrowFunctionExpression: {
-					default: false,
-					type: "boolean"
-				},
-				ClassDeclaration: {
-					default: false,
-					type: "boolean"
-				},
-				ClassExpression: {
-					default: false,
-					type: "boolean"
-				},
-				FunctionDeclaration: {
-					default: true,
-					type: "boolean"
-				},
-				FunctionExpression: {
-					default: false,
-					type: "boolean"
-				},
-				MethodDefinition: {
-					default: false,
-					type: "boolean"
-				}
-			},
-			type: "object"
-		}
-	},
-	type: "object"
-};
-/**
-* @param {string} interfaceName
-* @param {string} methodName
-* @param {import("eslint").Scope.Scope | null} scope
-* @returns {import('@typescript-eslint/types').TSESTree.TSMethodSignature|null}
-*/
-const getMethodOnInterface = (interfaceName, methodName, scope) => {
-	let scp = scope;
-	while (scp) {
-		for (const { identifiers, name } of scp.variables) {
-			if (interfaceName !== name) continue;
-			for (const identifier of identifiers) {
-				const interfaceDeclaration = identifier.parent;
-				/* c8 ignore next 3 -- TS */
-				if (interfaceDeclaration.type !== "TSInterfaceDeclaration") continue;
-				for (const bodyItem of interfaceDeclaration.body.body) {
-					const methodSig = bodyItem;
-					if (methodName === methodSig.key.name) return methodSig;
-				}
-			}
-		}
-		scp = scp.upper;
-	}
-	return null;
-};
-/**
-* @param {import('eslint').Rule.Node} node
-* @param {import('eslint').SourceCode} sourceCode
-* @param {import('eslint').Rule.RuleContext} context
-* @param {import('../iterateJsdoc.js').Settings} settings
-*/
-const isExemptedImplementer = (node, sourceCode, context, settings) => {
-	if (node.type === "FunctionExpression" && node.parent.type === "MethodDefinition" && node.parent.parent.type === "ClassBody" && node.parent.parent.parent.type === "ClassDeclaration" && "implements" in node.parent.parent.parent) {
-		const implments = node.parent.parent.parent.implements;
-		const { name: methodName } = node.parent.key;
-		for (const impl of implments) {
-			const { name: interfaceName } = impl.expression;
-			const interfaceMethodNode = getMethodOnInterface(interfaceName, methodName, node && (sourceCode.getScope && sourceCode.getScope(node) || context.getScope()));
-			if (interfaceMethodNode) {
-				const comment = getJSDocComment(sourceCode, interfaceMethodNode, settings);
-				if (comment) return true;
-			}
-		}
-	}
-	return false;
-};
-/**
-* @param {import('eslint').Rule.RuleContext} context
-* @param {import('json-schema').JSONSchema4Object} baseObject
-* @param {string} option
-* @param {string} key
-* @returns {boolean|undefined}
-*/
-const getOption = (context, baseObject, option, key) => {
-	if (context.options[0] && option in context.options[0] && (typeof context.options[0][option] === "boolean" || key in context.options[0][option])) return context.options[0][option][key];
-	return baseObject.properties[key].default;
-};
-/**
-* @param {import('eslint').Rule.RuleContext} context
-* @param {import('../iterateJsdoc.js').Settings} settings
-* @returns {{
-*   contexts: (string|{
-*     context: string,
-*     inlineCommentBlock: boolean,
-*     minLineCount: import('../iterateJsdoc.js').Integer
-*   })[],
-*   enableFixer: boolean,
-*   exemptEmptyConstructors: boolean,
-*   exemptEmptyFunctions: boolean,
-*   fixerMessage: string,
-*   minLineCount: undefined|import('../iterateJsdoc.js').Integer,
-*   publicOnly: boolean|{[key: string]: boolean|undefined}
-*   require: {[key: string]: boolean|undefined}
-* }}
-*/
-const getOptions = (context, settings) => {
-	const { contexts = settings.contexts || [], enableFixer = true, exemptEmptyConstructors = true, exemptEmptyFunctions = false, fixerMessage = "", minLineCount = void 0, publicOnly } = context.options[0] || {};
-	return {
-		contexts,
-		enableFixer,
-		exemptEmptyConstructors,
-		exemptEmptyFunctions,
-		fixerMessage,
-		minLineCount,
-		publicOnly: ((baseObj) => {
-			if (!publicOnly) return false;
-			/** @type {{[key: string]: boolean|undefined}} */
-			const properties = {};
-			for (const prop of Object.keys(
-				/** @type {import('json-schema').JSONSchema4Object} */
-				baseObj.properties
-			)) {
-				const opt = getOption(context, baseObj, "publicOnly", prop);
-				properties[prop] = opt;
-			}
-			return properties;
-		})(
-			/** @type {import('json-schema').JSONSchema4Object} */
-			OPTIONS_SCHEMA.properties.publicOnly.oneOf[1]
-		),
-		require: ((baseObj) => {
-			/** @type {{[key: string]: boolean|undefined}} */
-			const properties = {};
-			for (const prop of Object.keys(
-				/** @type {import('json-schema').JSONSchema4Object} */
-				baseObj.properties
-			)) {
-				const opt = getOption(context, baseObj, "require", prop);
-				properties[prop] = opt;
-			}
-			return properties;
-		})(
-			/** @type {import('json-schema').JSONSchema4Object} */
-			OPTIONS_SCHEMA.properties.require
-		)
-	};
-};
-/** @type {import('eslint').Rule.RuleModule} */
-var requireJsdoc_default = {
-	create(context) {
-		/* c8 ignore next -- Fallback to deprecated method */
-		const { sourceCode = context.getSourceCode() } = context;
-		const settings = getSettings(context);
-		if (!settings) return {};
-		const opts = getOptions(context, settings);
-		const { contexts, enableFixer, exemptEmptyConstructors, exemptEmptyFunctions, fixerMessage, minLineCount, require: requireOption } = opts;
-		const publicOnly = opts.publicOnly;
-		/**
-		* @type {import('../iterateJsdoc.js').CheckJsdoc}
-		*/
-		const checkJsDoc = (info, _handler, node) => {
-			if (minLineCount !== void 0 || contexts.some((ctxt) => {
-				if (typeof ctxt === "string") return false;
-				const { minLineCount: count } = ctxt;
-				return count !== void 0;
-			})) {
-				/**
-				* @param {undefined|import('../iterateJsdoc.js').Integer} count
-				*/
-				const underMinLine = (count) => {
-					return count !== void 0 && count > (sourceCode.getText(node).match(/\n/gv)?.length ?? 0) + 1;
-				};
-				if (underMinLine(minLineCount)) return;
-				const { minLineCount: contextMinLineCount } = contexts.find((ctxt) => {
-					if (typeof ctxt === "string") return false;
-					const { context: ctx } = ctxt;
-					return ctx === (info.selector || node.type);
-				}) || {};
-				if (underMinLine(contextMinLineCount)) return;
-			}
-			const jsDocNode = getJSDocComment(sourceCode, node, settings);
-			if (jsDocNode) return;
-			if (exemptSpeciaMethods({
-				description: "",
-				inlineTags: [],
-				problems: [],
-				source: [],
-				tags: []
-			}, node, context, [OPTIONS_SCHEMA])) return;
-			if (exemptEmptyFunctions && info.isFunctionContext || exemptEmptyConstructors && isConstructor(node)) {
-				const functionParameterNames = getFunctionParameterNames(node);
-				if (!functionParameterNames.length && !hasReturnValue(node)) return;
-			}
-			if (isExemptedImplementer(node, sourceCode, context, settings)) return;
-			const fix = (fixer) => {
-				const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;
-				/** @type {ESLintOrTSNode|import('@typescript-eslint/types').TSESTree.Decorator} */
-				let baseNode = getReducedASTNode(node, sourceCode);
-				const decorator = getDecorator(baseNode);
-				if (decorator) baseNode = decorator;
-				const indent = getIndent({ text: sourceCode.getText(
-					baseNode,
-					/** @type {import('eslint').AST.SourceLocation} */
-					baseNode.loc.start.column
-				) });
-				const { inlineCommentBlock } = contexts.find((contxt) => {
-					if (typeof contxt === "string") return false;
-					const { context: ctxt } = contxt;
-					return ctxt === node.type;
-				}) || {};
-				const insertion = (inlineCommentBlock ? `/** ${fixerMessage}` : `/**\n${indent}*${fixerMessage}\n${indent}`) + `*/${"\n".repeat(lines)}${indent.slice(0, -1)}`;
-				return fixer.insertTextBefore(baseNode, insertion);
-			};
-			const report = () => {
-				const { start } = node.loc;
-				const loc = {
-					end: {
-						column: 0,
-						line: start.line + 1
-					},
-					start
-				};
-				context.report({
-					fix: enableFixer ? fix : null,
-					loc,
-					messageId: "missingJsDoc",
-					node
-				});
-			};
-			if (publicOnly) {
-				/** @type {RequireJsdocOpts} */
-				const opt = {
-					ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),
-					esm: Boolean(publicOnly?.esm ?? true),
-					initModuleExports: Boolean(publicOnly?.cjs ?? true),
-					initWindow: Boolean(publicOnly?.window ?? false)
-				};
-				const exported = exportParser_default.isUncommentedExport(node, sourceCode, opt, settings);
-				if (exported) report();
-			} else report();
-		};
-		/**
-		* @param {string} prop
-		* @returns {boolean}
-		*/
-		const hasOption = (prop) => {
-			return requireOption[prop] || contexts.some((ctxt) => {
-				return typeof ctxt === "object" ? ctxt.context === prop : ctxt === prop;
-			});
-		};
-		return {
-			...getContextObject(enforcedContexts(context, [], settings), checkJsDoc),
-			ArrowFunctionExpression(node) {
-				if (!hasOption("ArrowFunctionExpression")) return;
-				if ([
-					"AssignmentExpression",
-					"ExportDefaultDeclaration",
-					"VariableDeclarator"
-				].includes(node.parent.type) || [
-					"ClassProperty",
-					"ObjectProperty",
-					"Property",
-					"PropertyDefinition"
-				].includes(node.parent.type) && node === node.parent.value) checkJsDoc({ isFunctionContext: true }, null, node);
-			},
-			ClassDeclaration(node) {
-				if (!hasOption("ClassDeclaration")) return;
-				checkJsDoc({ isFunctionContext: false }, null, node);
-			},
-			ClassExpression(node) {
-				if (!hasOption("ClassExpression")) return;
-				checkJsDoc({ isFunctionContext: false }, null, node);
-			},
-			FunctionDeclaration(node) {
-				if (!hasOption("FunctionDeclaration")) return;
-				checkJsDoc({ isFunctionContext: true }, null, node);
-			},
-			FunctionExpression(node) {
-				if (!hasOption("FunctionExpression")) return;
-				if ([
-					"AssignmentExpression",
-					"ExportDefaultDeclaration",
-					"VariableDeclarator"
-				].includes(node.parent.type) || [
-					"ClassProperty",
-					"ObjectProperty",
-					"Property",
-					"PropertyDefinition"
-				].includes(node.parent.type) && node === node.parent.value) checkJsDoc({ isFunctionContext: true }, null, node);
-			},
-			MethodDefinition(node) {
-				if (!hasOption("MethodDefinition")) return;
-				checkJsDoc({
-					isFunctionContext: true,
-					selector: "MethodDefinition"
-				}, null, node.value);
-			}
-		};
-	},
-	meta: {
-		docs: {
-			category: "Stylistic Issues",
-			description: "Require JSDoc comments",
-			recommended: true,
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md#repos-sticky-header"
-		},
-		fixable: "code",
-		messages: { missingJsDoc: "Missing JSDoc comment." },
-		schema: [OPTIONS_SCHEMA],
-		type: "suggestion"
-	}
-};
-
-//#endregion
-export { requireJsdoc_default as default };
-//# sourceMappingURL=requireJsdoc.js.map

package/dist/rules/requireJsdoc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireJsdoc.js","names":["exportParser"],"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    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  },\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 2 */\n        sourceCode.getScope(node)) ||\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 *   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    fixerMessage = '',\n    minLineCount = undefined,\n    publicOnly,\n  } = context.options[0] || {};\n\n  return {\n    contexts,\n    enableFixer,\n    exemptEmptyConstructors,\n    exemptEmptyFunctions,\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  };\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      fixerMessage,\n      minLineCount,\n      require: requireOption,\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      const jsDocNode = getJSDocComment(sourceCode, node, settings);\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":";;;;;;;;;;;;;;;;;;;;AAkCA,MAAM,iBAAiB;CACrB,sBAAsB;CACtB,YAAY;EACV,mBAAmB;GACjB,SAAS;GACT,MAAM;EACP;EACD,cAAc;GACZ,OAAO,CACL,EACE,MAAM,UACP,GACD;IACE,MAAM,CACJ,WACD;IACD,MAAM;GACP,CACF;GACD,SAAS;EACV;EACD,cAAc;GACZ,OAAO,CACL,EACE,MAAM,UACP,GACD;IACE,MAAM,CACJ,WACD;IACD,MAAM;GACP,CACF;GACD,SAAS;EACV;EACD,UAAU;GACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;IACE,sBAAsB;IACtB,YAAY;KACV,SAAS,EACP,MAAM,SACP;KACD,oBAAoB,EAClB,MAAM,UACP;KACD,cAAc,EACZ,MAAM,UACP;IACF;IACD,MAAM;GACP,CACF,EACF;GACD,MAAM;EACP;EACD,aAAa;GACX,SAAS;GACT,MAAM;EACP;EACD,yBAAyB;GACvB,SAAS;GACT,MAAM;EACP;EACD,sBAAsB;GACpB,SAAS;GACT,MAAM;EACP;EACD,cAAc;GACZ,SAAS;GACT,MAAM;EACP;EACD,cAAc,EACZ,MAAM,UACP;EACD,YAAY,EACV,OAAO,CACL;GACE,SAAS;GACT,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,SAAS,CAAE;GACX,YAAY;IACV,eAAe,EACb,MAAM,UACP;IACD,KAAK,EACH,MAAM,UACP;IACD,KAAK,EACH,MAAM,UACP;IACD,QAAQ,EACN,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF,EACF;EACD,SAAS;GACP,sBAAsB;GACtB,SAAS,CAAE;GACX,YAAY;IACV,yBAAyB;KACvB,SAAS;KACT,MAAM;IACP;IACD,kBAAkB;KAChB,SAAS;KACT,MAAM;IACP;IACD,iBAAiB;KACf,SAAS;KACT,MAAM;IACP;IACD,qBAAqB;KACnB,SAAS;KACT,MAAM;IACP;IACD,oBAAoB;KAClB,SAAS;KACT,MAAM;IACP;IACD,kBAAkB;KAChB,SAAS;KACT,MAAM;IACP;GACF;GACD,MAAM;EACP;CACF;CACD,MAAM;AACP;;;;;;;AAQD,MAAM,uBAAuB,CAAC,eAAe,YAAY,UAAU;CACjE,IAAI,MAAM;AACV,QAAO,KAAK;AACV,OAAK,MAAM,EACT,aACA,MACD,IAAI,IAAI,WAAW;AAClB,OAAI,kBAAkB,KACpB;AAGF,QAAK,MAAM,cAAc,aAAa;IACpC,MAAM,uBACJ,WACA;;AAEF,QAAI,qBAAqB,SAAS,yBAChC;AAGF,SAAK,MAAM,YAAY,qBAAqB,KAAK,MAAM;KACrD,MAAM,YACJ;AAEF,SAAI,eACF,UAAU,IACV,KACA,QAAO;IAEV;GACF;EACF;EAED,MAAM,IAAI;CACX;AAED,QAAO;AACR;;;;;;;AAQD,MAAM,wBAAwB,CAAC,MAAM,YAAY,SAAS,aAAa;AACrE,KAAI,KAAK,SAAS,wBAChB,KAAK,OAAO,SAAS,sBACrB,KAAK,OAAO,OAAO,SAAS,eAC5B,KAAK,OAAO,OAAO,OAAO,SAAS,sBACnC,gBAAgB,KAAK,OAAO,OAAO,QACnC;EACA,MAAM,YACJ,KAAK,OAAO,OAAO,OAAO;EAG5B,MAAM,EACJ,MAAM,YACP,GACC,KAAK,OAAO;AAGd,OAAK,MAAM,QAAQ,WAAW;GAC5B,MAAM,EACJ,MAAM,eACP,GACC,KAAK;GAGP,MAAM,sBAAsB,qBAAqB,eAAe,YAAY,SACzE,WAAW,YAEZ,WAAW,SAAS,KAAK,IACzB,QAAQ,UAAU,EAClB;AACF,OAAI,qBAAqB;IAEvB,MAAM,UAAU,gBAAgB,YAAY,qBAAqB,SAAS;AAC1E,QAAI,QACF,QAAO;GAEV;EACF;CACF;AAED,QAAO;AACR;;;;;;;;AASD,MAAM,YAAY,CAAC,SAAS,YAAY,QAAQ,QAAQ;AACtD,KAAI,QAAQ,QAAQ,MAAM,UAAU,QAAQ,QAAQ,OAGjD,OAAO,QAAQ,QAAQ,GAAG,YAAY,aACvC,OAAO,QAAQ,QAAQ,GAAG,SAE1B,QAAO,QAAQ,QAAQ,GAAG,QAAQ;AAGpC,QACE,WAAW,WACX,KAAK;AACR;;;;;;;;;;;;;;;;;;;AAoBD,MAAM,aAAa,CAAC,SAAS,aAAa;CACxC,MAAM,EACJ,WAAW,SAAS,YAAY,CAAE,GAClC,cAAc,MACd,0BAA0B,MAC1B,uBAAuB,OACvB,eAAe,IACf,eAAe,QACf,YACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,QAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA,aAAa,CAAC,YAAY;AACxB,OAAI,CAAC,WACH,QAAO;;GAIT,MAAM,aAAa,CAAE;AACrB,QAAK,MAAM,QAAQ,OAAO;;IAGpB,QACA;IACL,EAAE;IACD,MAAM,MAAM,UACV,SACwD,SACxD,cACA,KACD;IAED,WAAW,QAAQ;GACpB;AAED,UAAO;EACR;;GAOO,eAAe,WACf,WACF,MACF;GACH;EACD,UAAU,CAAC,YAAY;;GAErB,MAAM,aAAa,CAAE;AACrB,QAAK,MAAM,QAAQ,OAAO;;IAGpB,QACA;IACL,EAAE;IACD,MAAM,MAAM,UACV,SAEC,SACD,WACA,KACD;IACD,WAAW,QAAQ;GACpB;AAED,UAAO;EACR;;GAEE,eAAe,WAAY;GAC7B;CACF;AACF;;AAGD,2BAAe;CACb,OAAQ,SAAS;;EAEf,MAAM,EACJ,aAAa,QAAQ,eAAe,EACrC,GAAG;EACJ,MAAM,WAAW,YAAY,QAAQ;AACrC,MAAI,CAAC,SACH,QAAO,CAAE;EAGX,MAAM,OAAO,WAAW,SAAS,SAAS;EAE1C,MAAM,EACJ,UACA,aACA,yBACA,sBACA,cACA,cACA,SAAS,eACV,GAAG;EAEJ,MAAM,aAOF,KAAK;;;;EAMT,MAAM,aAAa,CAAC,MAAM,UAAU,SAAS;AAC3C,OAEE,iBAAiB,UAAa,SAAS,KAAK,CAAC,SAAS;AACpD,QAAI,OAAO,SAAS,SAClB,QAAO;IAGT,MAAM,EACJ,cAAc,OACf,GAAG;AACJ,WAAO,UAAU;GAClB,EAAC,EACF;;;;IAIA,MAAM,eAAe,CAAC,UAAU;AAC9B,YAAO,UAAU,UAAa,SAC3B,WAAW,QAAQ,KAAK,CAAC,MAAM,OAAO,EAAE,UAAU,KAAK;IAC3D;AAED,QAAI,aAAa,aAAa,CAC5B;IAGF,MAAM,EACJ,cAAc,qBACf,GAOM,SAAS,KAAK,CAAC,SAAS;AAC3B,SAAI,OAAO,SAAS,SAClB,QAAO;KAGT,MAAM,EACJ,SAAS,KACV,GAAG;AACJ,YAAO,SAAS,KAAK,YAAY,KAAK;IACvC,EAAC,IAAK,CAAE;AACX,QAAI,aAAa,oBAAoB,CACnC;GAEH;GAED,MAAM,YAAY,gBAAgB,YAAY,MAAM,SAAS;AAE7D,OAAI,UACF;AAKF,OAAI,oBACF;IACE,aAAa;IACb,YAAY,CAAE;IACd,UAAU,CAAE;IACZ,QAAQ,CAAE;IACV,MAAM,CAAE;GACT,GACD,MACA,SACA,CACE,cACD,EACF,CACC;AAGF,OAGE,wBAAwB,KAAK,qBAI7B,2BAA2B,cAAc,KAAK,EAC9C;IACA,MAAM,yBAAyB,0BAA0B,KAAK;AAC9D,QAAI,CAAC,uBAAuB,UAAU,CAAC,eAAe,KAAK,CACzD;GAEH;AAED,OAAI,sBAAsB,MAAM,YAAY,SAAS,SAAS,CAC5D;GAGF,MAAM,MAAuD,CAAC,UAAU;IAEtE,MAAM,QAAQ,SAAS,aAAa,KAAK,SAAS,YAAY,IAAI,IAAI,SAAS;;IAE/E,IAAI,WAAW,kBAAkB,MAAM,WAAW;IAElD,MAAM,YAAY,aAEf,SACF;AACD,QAAI,WACF,WAAW;IAGb,MAAM,SAAS,UAAU,EACvB,MAAM,WAAW;KAC4B;;KAGE,SAAU,IACrD,MAAM;KACT,CACF,EAAC;IAEF,MAAM,EACJ,oBACD,GAOM,SAAS,KAAK,CAAC,WAAW;AAC7B,SAAI,OAAO,WAAW,SACpB,QAAO;KAGT,MAAM,EACJ,SAAS,MACV,GAAG;AACJ,YAAO,SAAS,KAAK;IACtB,EAAC,IAAK,CAAE;IACX,MAAM,aAAa,qBACjB,CAAC,IAAI,EAAE,cAAc,GACrB,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,EAAE,QAAQ,IACzC,CAAC,EAAE,EAAE,KAAK,OAAO,MAAM,GAAG,OAAO,MAAM,GAAG,GAAG,EAAE;AAEnD,WAAO,MAAM,iBAEV,UACD,UACD;GACF;GAED,MAAM,SAAS,MAAM;IACnB,MAAM,EACJ,OACD,GAAuD,KAAK;IAC7D,MAAM,MAAM;KACV,KAAK;MACH,QAAQ;MACR,MAAM,MAAM,OAAO;KACpB;KACD;IACD;IACD,QAAQ,OAAO;KACb,KAAK,cAAc,MAAM;KACzB;KACA,WAAW;KACX;IACD,EAAC;GACH;AAED,OAAI,YAAY;;IAEd,MAAM,MAAM;KACV,eAAe,QAAQ,YAAY,iBAAiB,MAAM;KAC1D,KAAK,QAAQ,YAAY,OAAO,KAAK;KACrC,mBAAmB,QAAQ,YAAY,OAAO,KAAK;KACnD,YAAY,QAAQ,YAAY,UAAU,MAAM;IACjD;IACD,MAAM,WAAWA,qBAAa,oBAAoB,MAAM,YAAY,KAAK,SAAS;AAElF,QAAI,UACF,QAAQ;GAEX,OACC,QAAQ;EAEX;;;;;EAMD,MAAM,YAAY,CAAC,SAAS;AAC1B,UAAO,cAAc,SAAS,SAAS,KAAK,CAAC,SAAS;AACpD,WAAO,OAAO,SAAS,WAAW,KAAK,YAAY,OAAO,SAAS;GACpE,EAAC;EACH;AAED,SAAO;GACL,GAAG,iBACD,iBAAiB,SAAS,CAAE,GAAE,SAAS,EACvC,WACD;GACD,wBAAyB,MAAM;AAC7B,QAAI,CAAC,UAAU,0BAA0B,CACvC;AAGF,QACE;KACE;KAAwB;KAA4B;IACrD,EAAC,SAAS,KAAK,OAAO,KAAK,IAC5B;KACE;KAAiB;KAAkB;KAAY;IAChD,EAAC,SAAS,KAAK,OAAO,KAAK,IAC1B,SAMG,KAAK,OAAQ,OAElB,WAAW,EACT,mBAAmB,KACpB,GAAE,MAAM,KAAK;GAEjB;GAED,iBAAkB,MAAM;AACtB,QAAI,CAAC,UAAU,mBAAmB,CAChC;IAGF,WAAW,EACT,mBAAmB,MACpB,GAAE,MAAM,KAAK;GACf;GAED,gBAAiB,MAAM;AACrB,QAAI,CAAC,UAAU,kBAAkB,CAC/B;IAGF,WAAW,EACT,mBAAmB,MACpB,GAAE,MAAM,KAAK;GACf;GAED,oBAAqB,MAAM;AACzB,QAAI,CAAC,UAAU,sBAAsB,CACnC;IAGF,WAAW,EACT,mBAAmB,KACpB,GAAE,MAAM,KAAK;GACf;GAED,mBAAoB,MAAM;AACxB,QAAI,CAAC,UAAU,qBAAqB,CAClC;AAGF,QACE;KACE;KAAwB;KAA4B;IACrD,EAAC,SAAS,KAAK,OAAO,KAAK,IAC5B;KACE;KAAiB;KAAkB;KAAY;IAChD,EAAC,SAAS,KAAK,OAAO,KAAK,IAC1B,SAMG,KAAK,OAAQ,OAElB,WAAW,EACT,mBAAmB,KACpB,GAAE,MAAM,KAAK;GAEjB;GAED,iBAAkB,MAAM;AACtB,QAAI,CAAC,UAAU,mBAAmB,CAChC;IAGF,WAAW;KACT,mBAAmB;KACnB,UAAU;IACX,GAAE,MAAiD,KAAK,MAAO;GACjE;EACF;CACF;CACD,MAAM;EACJ,MAAM;GACJ,UAAU;GACV,aAAa;GACb,aAAa;GACb,KAAK;EACN;EAED,SAAS;EAET,UAAU,EACR,cAAc,yBACf;EAED,QAAQ,CACN,cACD;EAED,MAAM;CACP;AACF"}