eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/rules/noUndefinedTypes.js

@@ -1,303 +0,0 @@
-import iterateJsdoc, { parseComment } from "../iterateJsdoc.js";
-import { getJSDocComment, parse, traverse, tryParse } from "@es-joy/jsdoccomment";
-import { parseImportsExports } from "parse-imports-exports";
-
-//#region src/rules/noUndefinedTypes.js
-const extraTypes = [
-	"null",
-	"undefined",
-	"void",
-	"string",
-	"boolean",
-	"object",
-	"function",
-	"symbol",
-	"number",
-	"bigint",
-	"NaN",
-	"Infinity",
-	"any",
-	"*",
-	"never",
-	"unknown",
-	"const",
-	"this",
-	"true",
-	"false",
-	"Array",
-	"Object",
-	"RegExp",
-	"Date",
-	"Function",
-	"Intl"
-];
-const typescriptGlobals = [
-	"Awaited",
-	"Partial",
-	"Required",
-	"Readonly",
-	"Record",
-	"Pick",
-	"Omit",
-	"Exclude",
-	"Extract",
-	"NonNullable",
-	"Parameters",
-	"ConstructorParameters",
-	"ReturnType",
-	"InstanceType",
-	"ThisParameterType",
-	"OmitThisParameter",
-	"ThisType",
-	"Uppercase",
-	"Lowercase",
-	"Capitalize",
-	"Uncapitalize"
-];
-/**
-* @param {string|false|undefined} [str]
-* @returns {undefined|string|false}
-*/
-const stripPseudoTypes = (str) => {
-	return str && str.replace(/(?:\.|<>|\.<>|\[\])$/v, "");
-};
-var noUndefinedTypes_default = iterateJsdoc(({ context, node, report, settings, sourceCode, utils }) => {
-	const { scopeManager } = sourceCode;
-	const globalScope = scopeManager.globalScope;
-	const { definedTypes = [], disableReporting = false, markVariablesAsUsed = true } = context.options[0] || {};
-	/** @type {(string|undefined)[]} */
-	let definedPreferredTypes = [];
-	const { mode, preferredTypes, structuredTags } = settings;
-	if (Object.keys(preferredTypes).length) definedPreferredTypes = Object.values(preferredTypes).map((preferredType) => {
-		if (typeof preferredType === "string") return stripPseudoTypes(preferredType);
-		if (!preferredType) return void 0;
-		if (typeof preferredType !== "object") utils.reportSettings("Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.");
-		return stripPseudoTypes(preferredType.replacement);
-	}).filter(Boolean);
-	const allComments = sourceCode.getAllComments();
-	const comments = allComments.filter((comment) => {
-		return /^\*\s/v.test(comment.value);
-	}).map((commentNode) => {
-		return parseComment(commentNode, "");
-	});
-	const globals = allComments.filter((comment) => {
-		return /^\s*globals/v.test(comment.value);
-	}).flatMap((commentNode) => {
-		return commentNode.value.replace(/^\s*globals/v, "").trim().split(/,\s*/v);
-	}).concat(Object.keys(context.languageOptions.globals ?? []));
-	const typedefDeclarations = comments.flatMap((doc) => {
-		return doc.tags.filter(({ tag }) => {
-			return utils.isNamepathDefiningTag(tag);
-		});
-	}).map((tag) => {
-		return tag.name;
-	});
-	const importTags = settings.mode === "typescript" ? comments.flatMap((doc) => {
-		return doc.tags.filter(({ tag }) => {
-			return tag === "import";
-		});
-	}).flatMap((tag) => {
-		const { description, name, type } = tag;
-		const typePart = type ? `{${type}} ` : "";
-		const imprt = "import " + (description ? `${typePart}${name} ${description}` : `${typePart}${name}`);
-		const importsExports = parseImportsExports(imprt.trim());
-		const types = [];
-		const namedImports = Object.values(importsExports.namedImports || {})[0]?.[0];
-		if (namedImports) {
-			if (namedImports.default) types.push(namedImports.default);
-			if (namedImports.names) types.push(...Object.keys(namedImports.names));
-		}
-		const namespaceImports = Object.values(importsExports.namespaceImports || {})[0]?.[0];
-		if (namespaceImports) {
-			if (namespaceImports.namespace) types.push(namespaceImports.namespace);
-			if (namespaceImports.default) types.push(namespaceImports.default);
-		}
-		return types;
-	}).filter(Boolean) : [];
-	const ancestorNodes = [];
-	let currentNode = node;
-	while (currentNode?.parent) {
-		ancestorNodes.push(currentNode);
-		currentNode = currentNode.parent;
-	}
-	/**
-	* @param {import('eslint').Rule.Node} ancestorNode
-	* @returns {import('comment-parser').Spec[]}
-	*/
-	const getTemplateTags = function(ancestorNode) {
-		const commentNode = getJSDocComment(sourceCode, ancestorNode, settings);
-		if (!commentNode) return [];
-		const jsdoc = parseComment(commentNode, "");
-		return jsdoc.tags.filter((tag) => {
-			return tag.tag === "template";
-		});
-	};
-	const templateTags = ancestorNodes.length ? ancestorNodes.flatMap((ancestorNode) => {
-		return getTemplateTags(ancestorNode);
-	}) : utils.getPresentTags(["template"]);
-	const closureGenericTypes = templateTags.flatMap((tag) => {
-		return utils.parseClosureTemplateTag(tag);
-	});
-	const cjsOrESMScope = globalScope.childScopes[0]?.block?.type === "Program";
-	/**
-	* @param {import("eslint").Scope.Scope | null} scope
-	* @returns {Set<string>}
-	*/
-	const getValidRuntimeIdentifiers = (scope) => {
-		const result = /* @__PURE__ */ new Set();
-		let scp = scope;
-		while (scp) {
-			for (const { name } of scp.variables) result.add(name);
-			scp = scp.upper;
-		}
-		return result;
-	};
-	/**
-	* We treat imports differently as we can't introspect their children.
-	* @type {string[]}
-	*/
-	const imports = [];
-	const allDefinedTypes = new Set(globalScope.variables.map(({ name }) => {
-		return name;
-	}).concat(cjsOrESMScope ? globalScope.childScopes.flatMap(({ variables }) => {
-		return variables;
-	}).flatMap(({ identifiers, name }) => {
-		const globalItem = (identifiers?.[0])?.parent;
-		switch (globalItem?.type) {
-			case "ClassDeclaration": return [name, ...globalItem.body.body.map((item) => {
-				const property = (item?.key)?.name;
-				/* c8 ignore next 3 -- Guard */
-				if (!property) return "";
-				return `${name}.${property}`;
-			}).filter(Boolean)];
-			case "ImportDefaultSpecifier":
-			case "ImportNamespaceSpecifier":
-			case "ImportSpecifier":
-				imports.push(name);
-				break;
-			case "TSInterfaceDeclaration": return [name, ...globalItem.body.body.map((item) => {
-				const property = (item?.key)?.name;
-				/* c8 ignore next 3 -- Guard */
-				if (!property) return "";
-				return `${name}.${property}`;
-			}).filter(Boolean)];
-			case "VariableDeclarator":
-				if (((globalItem?.init)?.callee)?.name === "require") {
-					imports.push(
-						/** @type {import('@typescript-eslint/types').TSESTree.Identifier} */
-						globalItem.id.name
-					);
-					break;
-				}
-				return [];
-		}
-		return [name];
-		/* c8 ignore next */
-	}) : []).concat(extraTypes).concat(typedefDeclarations).concat(importTags).concat(definedTypes).concat(definedPreferredTypes).concat((() => {
-		if (node?.type === "MethodDefinition") return node.parent.body.flatMap((methodOrProp) => {
-			if (methodOrProp.type === "MethodDefinition") {
-				if (methodOrProp.key.type === "Identifier") return [methodOrProp.key.name, `${(node.parent?.parent)?.id?.name}.${methodOrProp.key.name}`];
-			}
-			if (methodOrProp.type === "PropertyDefinition") {
-				if (methodOrProp.key.type === "Identifier") return [methodOrProp.key.name, `${(node.parent?.parent)?.id?.name}.${methodOrProp.key.name}`];
-			}
-			/* c8 ignore next 2 -- Not yet built */
-			return "";
-		}).filter(Boolean);
-		return [];
-	})()).concat(...getValidRuntimeIdentifiers(node && (sourceCode.getScope && sourceCode.getScope(node) || context.getScope()))).concat(settings.mode === "jsdoc" ? [] : [...settings.mode === "typescript" ? typescriptGlobals : [], ...closureGenericTypes]));
-	/**
-	* @typedef {{
-	*   parsedType: import('jsdoc-type-pratt-parser').RootResult;
-	*   tag: import('comment-parser').Spec|import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {
-	*     line?: import('../iterateJsdoc.js').Integer
-	*   }
-	* }} TypeAndTagInfo
-	*/
-	/**
-	* @param {string} propertyName
-	* @returns {(tag: (import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {
-	*     name?: string,
-	*     type?: string,
-	*     line?: import('../iterateJsdoc.js').Integer
-	*   })|import('comment-parser').Spec & {
-	*     namepathOrURL?: string
-	*   }
-	* ) => undefined|TypeAndTagInfo}
-	*/
-	const tagToParsedType = (propertyName) => {
-		return (tag) => {
-			try {
-				const potentialType = tag[propertyName];
-				return {
-					parsedType: mode === "permissive" ? tryParse(potentialType) : parse(potentialType, mode),
-					tag
-				};
-			} catch {
-				return void 0;
-			}
-		};
-	};
-	const typeTags = utils.filterTags(({ tag }) => {
-		return tag !== "import" && utils.tagMightHaveTypePosition(tag) && (tag !== "suppress" || settings.mode !== "closure");
-	}).map(tagToParsedType("type"));
-	const namepathReferencingTags = utils.filterTags(({ tag }) => {
-		return utils.isNamepathReferencingTag(tag);
-	}).map(tagToParsedType("name"));
-	const namepathOrUrlReferencingTags = utils.filterAllTags(({ tag }) => {
-		return utils.isNamepathOrUrlReferencingTag(tag);
-	}).map(tagToParsedType("namepathOrURL"));
-	const tagsWithTypes = [
-		...typeTags,
-		...namepathReferencingTags,
-		...namepathOrUrlReferencingTags
-	].filter(Boolean);
-	for (const { parsedType, tag } of tagsWithTypes) traverse(parsedType, (nde, parentNode) => {
-		/**
-		* @type {import('jsdoc-type-pratt-parser').NameResult & {
-		*   _parent?: import('jsdoc-type-pratt-parser').NonRootResult
-		* }}
-		*/
-		nde._parent = parentNode;
-		const { type, value } = nde;
-		let val = value;
-		/** @type {import('jsdoc-type-pratt-parser').NonRootResult|undefined} */
-		let currNode = nde;
-		do {
-			currNode = currNode._parent;
-			if (!imports.includes(val) && !globals.includes(val) && !importTags.includes(val) && !extraTypes.includes(val) && !typedefDeclarations.includes(val) && currNode && "right" in currNode && currNode.right?.type === "JsdocTypeProperty") val = val + "." + currNode.right.value;
-		} while (currNode?.type === "JsdocTypeNamePath");
-		if (type === "JsdocTypeName") {
-			const structuredTypes = structuredTags[tag.tag]?.type;
-			if (!allDefinedTypes.has(val) && (!Array.isArray(structuredTypes) || !structuredTypes.includes(val))) {
-				if (!disableReporting) report(`The type '${val}' is undefined.`, null, tag);
-			} else if (markVariablesAsUsed && !extraTypes.includes(val)) if (sourceCode.markVariableAsUsed) sourceCode.markVariableAsUsed(val);
-			else context.markVariableAsUsed(val);
-		}
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Checks that types in jsdoc comments are defined.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				definedTypes: {
-					items: { type: "string" },
-					type: "array"
-				},
-				disableReporting: { type: "boolean" },
-				markVariablesAsUsed: { type: "boolean" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { noUndefinedTypes_default as default };
-//# sourceMappingURL=noUndefinedTypes.js.map

package/dist/rules/noUndefinedTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"noUndefinedTypes.js","names":["tryParseType","parseType"],"sources":["../../src/rules/noUndefinedTypes.js"],"sourcesContent":["import iterateJsdoc, {\n  parseComment,\n} from '../iterateJsdoc.js';\nimport {\n  getJSDocComment,\n  parse as parseType,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\nimport {\n  parseImportsExports,\n} from 'parse-imports-exports';\n\nconst extraTypes = [\n  'null', 'undefined', 'void', 'string', 'boolean', 'object',\n  'function', 'symbol',\n  'number', 'bigint', 'NaN', 'Infinity',\n  'any', '*', 'never', 'unknown', 'const',\n  'this', 'true', 'false',\n  'Array', 'Object', 'RegExp', 'Date', 'Function', 'Intl',\n];\n\nconst typescriptGlobals = [\n  // https://www.typescriptlang.org/docs/handbook/utility-types.html\n  'Awaited',\n  'Partial',\n  'Required',\n  'Readonly',\n  'Record',\n  'Pick',\n  'Omit',\n  'Exclude',\n  'Extract',\n  'NonNullable',\n  'Parameters',\n  'ConstructorParameters',\n  'ReturnType',\n  'InstanceType',\n  'ThisParameterType',\n  'OmitThisParameter',\n  'ThisType',\n  'Uppercase',\n  'Lowercase',\n  'Capitalize',\n  'Uncapitalize',\n];\n\n/**\n * @param {string|false|undefined} [str]\n * @returns {undefined|string|false}\n */\nconst stripPseudoTypes = (str) => {\n  return str && str.replace(/(?:\\.|<>|\\.<>|\\[\\])$/v, '');\n};\n\nexport default iterateJsdoc(({\n  context,\n  node,\n  report,\n  settings,\n  sourceCode,\n  utils,\n}) => {\n  const {\n    scopeManager,\n  } = sourceCode;\n\n  // When is this ever `null`?\n  const globalScope = /** @type {import('eslint').Scope.Scope} */ (\n    scopeManager.globalScope\n  );\n\n  const\n    /**\n     * @type {{\n     *   definedTypes: string[],\n     *   disableReporting: boolean,\n     *   markVariablesAsUsed: boolean\n     * }}\n     */ {\n      definedTypes = [],\n      disableReporting = false,\n      markVariablesAsUsed = true,\n    } = context.options[0] || {};\n\n  /** @type {(string|undefined)[]} */\n  let definedPreferredTypes = [];\n  const {\n    mode,\n    preferredTypes,\n    structuredTags,\n  } = settings;\n  if (Object.keys(preferredTypes).length) {\n    definedPreferredTypes = /** @type {string[]} */ (Object.values(preferredTypes).map((preferredType) => {\n      if (typeof preferredType === 'string') {\n        // May become an empty string but will be filtered out below\n        return stripPseudoTypes(preferredType);\n      }\n\n      if (!preferredType) {\n        return undefined;\n      }\n\n      if (typeof preferredType !== 'object') {\n        utils.reportSettings(\n          'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.',\n        );\n      }\n\n      return stripPseudoTypes(preferredType.replacement);\n    })\n      .filter(Boolean));\n  }\n\n  const allComments = sourceCode.getAllComments();\n  const comments = allComments\n    .filter((comment) => {\n      return (/^\\*\\s/v).test(comment.value);\n    })\n    .map((commentNode) => {\n      return parseComment(commentNode, '');\n    });\n\n  const globals = allComments\n    .filter((comment) => {\n      return (/^\\s*globals/v).test(comment.value);\n    }).flatMap((commentNode) => {\n      return commentNode.value.replace(/^\\s*globals/v, '').trim().split(/,\\s*/v);\n    }).concat(Object.keys(context.languageOptions.globals ?? []));\n\n  const typedefDeclarations = comments\n    .flatMap((doc) => {\n      return doc.tags.filter(({\n        tag,\n      }) => {\n        return utils.isNamepathDefiningTag(tag);\n      });\n    })\n    .map((tag) => {\n      return tag.name;\n    });\n\n  const importTags = settings.mode === 'typescript' ? /** @type {string[]} */ (comments.flatMap((doc) => {\n    return doc.tags.filter(({\n      tag,\n    }) => {\n      return tag === 'import';\n    });\n  }).flatMap((tag) => {\n    const {\n      description,\n      name,\n      type,\n    } = tag;\n    const typePart = type ? `{${type}} ` : '';\n    const imprt = 'import ' + (description ?\n      `${typePart}${name} ${description}` :\n      `${typePart}${name}`);\n\n    const importsExports = parseImportsExports(imprt.trim());\n\n    const types = [];\n    const namedImports = Object.values(importsExports.namedImports || {})[0]?.[0];\n    if (namedImports) {\n      if (namedImports.default) {\n        types.push(namedImports.default);\n      }\n\n      if (namedImports.names) {\n        types.push(...Object.keys(namedImports.names));\n      }\n    }\n\n    const namespaceImports = Object.values(importsExports.namespaceImports || {})[0]?.[0];\n    if (namespaceImports) {\n      if (namespaceImports.namespace) {\n        types.push(namespaceImports.namespace);\n      }\n\n      if (namespaceImports.default) {\n        types.push(namespaceImports.default);\n      }\n    }\n\n    return types;\n  }).filter(Boolean)) : [];\n\n  const ancestorNodes = [];\n\n  let currentNode = node;\n  // No need for Program node?\n  while (currentNode?.parent) {\n    ancestorNodes.push(currentNode);\n    currentNode = currentNode.parent;\n  }\n\n  /**\n   * @param {import('eslint').Rule.Node} ancestorNode\n   * @returns {import('comment-parser').Spec[]}\n   */\n  const getTemplateTags = function (ancestorNode) {\n    const commentNode = getJSDocComment(sourceCode, ancestorNode, settings);\n    if (!commentNode) {\n      return [];\n    }\n\n    const jsdoc = parseComment(commentNode, '');\n\n    return jsdoc.tags.filter((tag) => {\n      return tag.tag === 'template';\n    });\n  };\n\n  // `currentScope` may be `null` or `Program`, so in such a case,\n  //  we look to present tags instead\n  const templateTags = ancestorNodes.length ?\n    ancestorNodes.flatMap((ancestorNode) => {\n      return getTemplateTags(ancestorNode);\n    }) :\n    utils.getPresentTags([\n      'template',\n    ]);\n\n  const closureGenericTypes = templateTags.flatMap((tag) => {\n    return utils.parseClosureTemplateTag(tag);\n  });\n\n  // In modules, including Node, there is a global scope at top with the\n  //  Program scope inside\n  const cjsOrESMScope = globalScope.childScopes[0]?.block?.type === 'Program';\n\n  /**\n   * @param {import(\"eslint\").Scope.Scope | null} scope\n   * @returns {Set<string>}\n   */\n  const getValidRuntimeIdentifiers = (scope) => {\n    const result = new Set();\n\n    let scp = scope;\n    while (scp) {\n      for (const {\n        name,\n      } of scp.variables) {\n        result.add(name);\n      }\n\n      scp = scp.upper;\n    }\n\n    return result;\n  };\n\n  /**\n   * We treat imports differently as we can't introspect their children.\n   * @type {string[]}\n   */\n  const imports = [];\n\n  const allDefinedTypes = new Set(globalScope.variables.map(({\n    name,\n  }) => {\n    return name;\n  })\n\n    // If the file is a module, concat the variables from the module scope.\n    .concat(\n      cjsOrESMScope ?\n        globalScope.childScopes.flatMap(({\n          variables,\n        }) => {\n          return variables;\n        }).flatMap(({\n          identifiers,\n          name,\n        }) => {\n          const globalItem = /** @type {import('estree').Identifier & {parent: import('@typescript-eslint/types').TSESTree.Node}} */ (\n            identifiers?.[0]\n          )?.parent;\n          switch (globalItem?.type) {\n            case 'ClassDeclaration':\n              return [\n                name,\n                ...globalItem.body.body.map((item) => {\n                  const property = /** @type {import('@typescript-eslint/types').TSESTree.Identifier} */ (\n                    /** @type {import('@typescript-eslint/types').TSESTree.PropertyDefinition} */ (\n                      item)?.key)?.name;\n                  /* c8 ignore next 3 -- Guard */\n                  if (!property) {\n                    return '';\n                  }\n\n                  return `${name}.${property}`;\n                }).filter(Boolean),\n              ];\n            case 'ImportDefaultSpecifier':\n            case 'ImportNamespaceSpecifier':\n            case 'ImportSpecifier':\n              imports.push(name);\n              break;\n            case 'TSInterfaceDeclaration':\n              return [\n                name,\n                ...globalItem.body.body.map((item) => {\n                  const property = /** @type {import('@typescript-eslint/types').TSESTree.Identifier} */ (\n                    /** @type {import('@typescript-eslint/types').TSESTree.TSPropertySignature} */ (\n                      item)?.key)?.name;\n                  /* c8 ignore next 3 -- Guard */\n                  if (!property) {\n                    return '';\n                  }\n\n                  return `${name}.${property}`;\n                }).filter(Boolean),\n              ];\n            case 'VariableDeclarator':\n              if (/** @type {import('@typescript-eslint/types').TSESTree.Identifier} */ (\n                /** @type {import('@typescript-eslint/types').TSESTree.CallExpression} */ (\n                  globalItem?.init\n                )?.callee)?.name === 'require'\n              ) {\n                imports.push(/** @type {import('@typescript-eslint/types').TSESTree.Identifier} */ (\n                  globalItem.id\n                ).name);\n                break;\n              }\n\n              return [];\n          }\n\n          return [\n            name,\n          ];\n        /* c8 ignore next */\n        }) : [],\n    )\n    .concat(extraTypes)\n    .concat(typedefDeclarations)\n    .concat(importTags)\n    .concat(definedTypes)\n    .concat(/** @type {string[]} */ (definedPreferredTypes))\n    .concat((() => {\n      // Other methods are not in scope, but we need them, and we grab them here\n      if (node?.type === 'MethodDefinition') {\n        return /** @type {import('estree').ClassBody} */ (node.parent).body.flatMap((methodOrProp) => {\n          if (methodOrProp.type === 'MethodDefinition') {\n            // eslint-disable-next-line unicorn/no-lonely-if -- Pattern\n            if (methodOrProp.key.type === 'Identifier') {\n              return [\n                methodOrProp.key.name,\n                `${/** @type {import('estree').ClassDeclaration} */ (\n                  node.parent?.parent\n                )?.id?.name}.${methodOrProp.key.name}`,\n              ];\n            }\n          }\n\n          if (methodOrProp.type === 'PropertyDefinition') {\n            // eslint-disable-next-line unicorn/no-lonely-if -- Pattern\n            if (methodOrProp.key.type === 'Identifier') {\n              return [\n                methodOrProp.key.name,\n                `${/** @type {import('estree').ClassDeclaration} */ (\n                  node.parent?.parent\n                )?.id?.name}.${methodOrProp.key.name}`,\n              ];\n            }\n          }\n          /* c8 ignore next 2 -- Not yet built */\n\n          return '';\n        }).filter(Boolean);\n      }\n\n      return [];\n    })())\n    .concat(...getValidRuntimeIdentifiers(node && (\n      (sourceCode.getScope &&\n      /* c8 ignore next 2 */\n      sourceCode.getScope(node)) ||\n      context.getScope()\n    )))\n    .concat(\n      settings.mode === 'jsdoc' ?\n        [] :\n        [\n          ...settings.mode === 'typescript' ? typescriptGlobals : [],\n          ...closureGenericTypes,\n        ],\n    ));\n\n  /**\n   * @typedef {{\n   *   parsedType: import('jsdoc-type-pratt-parser').RootResult;\n   *   tag: import('comment-parser').Spec|import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {\n   *     line?: import('../iterateJsdoc.js').Integer\n   *   }\n   * }} TypeAndTagInfo\n   */\n\n  /**\n   * @param {string} propertyName\n   * @returns {(tag: (import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {\n   *     name?: string,\n   *     type?: string,\n   *     line?: import('../iterateJsdoc.js').Integer\n   *   })|import('comment-parser').Spec & {\n   *     namepathOrURL?: string\n   *   }\n   * ) => undefined|TypeAndTagInfo}\n   */\n  const tagToParsedType = (propertyName) => {\n    return (tag) => {\n      try {\n        const potentialType = tag[\n          /** @type {\"type\"|\"name\"|\"namepathOrURL\"} */ (propertyName)\n        ];\n        return {\n          parsedType: mode === 'permissive' ?\n            tryParseType(/** @type {string} */ (potentialType)) :\n            parseType(/** @type {string} */ (potentialType), mode),\n          tag,\n        };\n      } catch {\n        return undefined;\n      }\n    };\n  };\n\n  const typeTags = utils.filterTags(({\n    tag,\n  }) => {\n    return tag !== 'import' && utils.tagMightHaveTypePosition(tag) && (tag !== 'suppress' || settings.mode !== 'closure');\n  }).map(tagToParsedType('type'));\n\n  const namepathReferencingTags = utils.filterTags(({\n    tag,\n  }) => {\n    return utils.isNamepathReferencingTag(tag);\n  }).map(tagToParsedType('name'));\n\n  const namepathOrUrlReferencingTags = utils.filterAllTags(({\n    tag,\n  }) => {\n    return utils.isNamepathOrUrlReferencingTag(tag);\n  }).map(tagToParsedType('namepathOrURL'));\n\n  const tagsWithTypes = /** @type {TypeAndTagInfo[]} */ ([\n    ...typeTags,\n    ...namepathReferencingTags,\n    ...namepathOrUrlReferencingTags,\n    // Remove types which failed to parse\n  ].filter(Boolean));\n\n  for (const {\n    parsedType,\n    tag,\n  } of tagsWithTypes) {\n    traverse(parsedType, (nde, parentNode) => {\n      /**\n       * @type {import('jsdoc-type-pratt-parser').NameResult & {\n       *   _parent?: import('jsdoc-type-pratt-parser').NonRootResult\n       * }}\n       */\n      // eslint-disable-next-line canonical/id-match -- Avoid clashes\n      (nde)._parent = parentNode;\n      const {\n        type,\n        value,\n      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);\n\n      let val = value;\n\n      /** @type {import('jsdoc-type-pratt-parser').NonRootResult|undefined} */\n      let currNode = nde;\n      do {\n        currNode =\n          /**\n           * @type {import('jsdoc-type-pratt-parser').NameResult & {\n           *   _parent?: import('jsdoc-type-pratt-parser').NonRootResult\n           * }}\n           */ (currNode)._parent;\n        if (\n          // Avoid appending for imports and globals since we don't want to\n          //  check their properties which may or may not exist\n          !imports.includes(val) && !globals.includes(val) &&\n          !importTags.includes(val) &&\n          !extraTypes.includes(val) &&\n          !typedefDeclarations.includes(val) &&\n          currNode && 'right' in currNode &&\n          currNode.right?.type === 'JsdocTypeProperty') {\n          val = val + '.' + currNode.right.value;\n        }\n      } while (currNode?.type === 'JsdocTypeNamePath');\n\n      if (type === 'JsdocTypeName') {\n        const structuredTypes = structuredTags[tag.tag]?.type;\n        if (!allDefinedTypes.has(val) &&\n          (!Array.isArray(structuredTypes) || !structuredTypes.includes(val))\n        ) {\n          if (!disableReporting) {\n            report(`The type '${val}' is undefined.`, null, tag);\n          }\n        } else if (markVariablesAsUsed && !extraTypes.includes(val)) {\n          if (sourceCode.markVariableAsUsed) {\n            sourceCode.markVariableAsUsed(val);\n          /* c8 ignore next 3 */\n          } else {\n            context.markVariableAsUsed(val);\n          }\n        }\n      }\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that types in jsdoc comments are defined.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          definedTypes: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          disableReporting: {\n            type: 'boolean',\n          },\n          markVariablesAsUsed: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;AAaA,MAAM,aAAa;CACjB;CAAQ;CAAa;CAAQ;CAAU;CAAW;CAClD;CAAY;CACZ;CAAU;CAAU;CAAO;CAC3B;CAAO;CAAK;CAAS;CAAW;CAChC;CAAQ;CAAQ;CAChB;CAAS;CAAU;CAAU;CAAQ;CAAY;AAClD;AAED,MAAM,oBAAoB;CAExB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;AAMD,MAAM,mBAAmB,CAAC,QAAQ;AAChC,QAAO,OAAO,IAAI,QAAQ,yBAAyB,GAAG;AACvD;AAED,+BAAe,aAAa,CAAC,EAC3B,SACA,MACA,QACA,UACA,YACA,OACD,KAAK;CACJ,MAAM,EACJ,cACD,GAAG;CAGJ,MAAM,cACJ,aAAa;CAGf,MAOM,EACF,eAAe,CAAE,GACjB,mBAAmB,OACnB,sBAAsB,MACvB,GAAG,QAAQ,QAAQ,MAAM,CAAE;;CAG9B,IAAI,wBAAwB,CAAE;CAC9B,MAAM,EACJ,MACA,gBACA,gBACD,GAAG;AACJ,KAAI,OAAO,KAAK,eAAe,CAAC,QAC9B,wBAAiD,OAAO,OAAO,eAAe,CAAC,IAAI,CAAC,kBAAkB;AACpG,MAAI,OAAO,kBAAkB,SAE3B,QAAO,iBAAiB,cAAc;AAGxC,MAAI,CAAC,cACH,QAAO;AAGT,MAAI,OAAO,kBAAkB,UAC3B,MAAM,eACJ,yFACD;AAGH,SAAO,iBAAiB,cAAc,YAAY;CACnD,EAAC,CACC,OAAO,QAAQ;CAGpB,MAAM,cAAc,WAAW,gBAAgB;CAC/C,MAAM,WAAW,YACd,OAAO,CAAC,YAAY;AACnB,SAAQ,SAAU,KAAK,QAAQ,MAAM;CACtC,EAAC,CACD,IAAI,CAAC,gBAAgB;AACpB,SAAO,aAAa,aAAa,GAAG;CACrC,EAAC;CAEJ,MAAM,UAAU,YACb,OAAO,CAAC,YAAY;AACnB,SAAQ,eAAgB,KAAK,QAAQ,MAAM;CAC5C,EAAC,CAAC,QAAQ,CAAC,gBAAgB;AAC1B,SAAO,YAAY,MAAM,QAAQ,gBAAgB,GAAG,CAAC,MAAM,CAAC,MAAM,QAAQ;CAC3E,EAAC,CAAC,OAAO,OAAO,KAAK,QAAQ,gBAAgB,WAAW,CAAE,EAAC,CAAC;CAE/D,MAAM,sBAAsB,SACzB,QAAQ,CAAC,QAAQ;AAChB,SAAO,IAAI,KAAK,OAAO,CAAC,EACtB,KACD,KAAK;AACJ,UAAO,MAAM,sBAAsB,IAAI;EACxC,EAAC;CACH,EAAC,CACD,IAAI,CAAC,QAAQ;AACZ,SAAO,IAAI;CACZ,EAAC;CAEJ,MAAM,aAAa,SAAS,SAAS,eAAwC,SAAS,QAAQ,CAAC,QAAQ;AACrG,SAAO,IAAI,KAAK,OAAO,CAAC,EACtB,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC;CACH,EAAC,CAAC,QAAQ,CAAC,QAAQ;EAClB,MAAM,EACJ,aACA,MACA,MACD,GAAG;EACJ,MAAM,WAAW,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG;EACvC,MAAM,QAAQ,aAAa,cACzB,GAAG,WAAW,KAAK,CAAC,EAAE,aAAa,GACnC,GAAG,WAAW,MAAM;EAEtB,MAAM,iBAAiB,oBAAoB,MAAM,MAAM,CAAC;EAExD,MAAM,QAAQ,CAAE;EAChB,MAAM,eAAe,OAAO,OAAO,eAAe,gBAAgB,CAAE,EAAC,CAAC,KAAK;AAC3E,MAAI,cAAc;AAChB,OAAI,aAAa,SACf,MAAM,KAAK,aAAa,QAAQ;AAGlC,OAAI,aAAa,OACf,MAAM,KAAK,GAAG,OAAO,KAAK,aAAa,MAAM,CAAC;EAEjD;EAED,MAAM,mBAAmB,OAAO,OAAO,eAAe,oBAAoB,CAAE,EAAC,CAAC,KAAK;AACnF,MAAI,kBAAkB;AACpB,OAAI,iBAAiB,WACnB,MAAM,KAAK,iBAAiB,UAAU;AAGxC,OAAI,iBAAiB,SACnB,MAAM,KAAK,iBAAiB,QAAQ;EAEvC;AAED,SAAO;CACR,EAAC,CAAC,OAAO,QAAQ,GAAI,CAAE;CAExB,MAAM,gBAAgB,CAAE;CAExB,IAAI,cAAc;AAElB,QAAO,aAAa,QAAQ;EAC1B,cAAc,KAAK,YAAY;EAC/B,cAAc,YAAY;CAC3B;;;;;CAMD,MAAM,kBAAkB,SAAU,cAAc;EAC9C,MAAM,cAAc,gBAAgB,YAAY,cAAc,SAAS;AACvE,MAAI,CAAC,YACH,QAAO,CAAE;EAGX,MAAM,QAAQ,aAAa,aAAa,GAAG;AAE3C,SAAO,MAAM,KAAK,OAAO,CAAC,QAAQ;AAChC,UAAO,IAAI,QAAQ;EACpB,EAAC;CACH;CAID,MAAM,eAAe,cAAc,SACjC,cAAc,QAAQ,CAAC,iBAAiB;AACtC,SAAO,gBAAgB,aAAa;CACrC,EAAC,GACF,MAAM,eAAe,CACnB,UACD,EAAC;CAEJ,MAAM,sBAAsB,aAAa,QAAQ,CAAC,QAAQ;AACxD,SAAO,MAAM,wBAAwB,IAAI;CAC1C,EAAC;CAIF,MAAM,gBAAgB,YAAY,YAAY,IAAI,OAAO,SAAS;;;;;CAMlE,MAAM,6BAA6B,CAAC,UAAU;EAC5C,MAAM,yBAAS,IAAI;EAEnB,IAAI,MAAM;AACV,SAAO,KAAK;AACV,QAAK,MAAM,EACT,MACD,IAAI,IAAI,WACP,OAAO,IAAI,KAAK;GAGlB,MAAM,IAAI;EACX;AAED,SAAO;CACR;;;;;CAMD,MAAM,UAAU,CAAE;CAElB,MAAM,kBAAkB,IAAI,IAAI,YAAY,UAAU,IAAI,CAAC,EACzD,MACD,KAAK;AACJ,SAAO;CACR,EAAC,CAGC,OACC,gBACE,YAAY,YAAY,QAAQ,CAAC,EAC/B,WACD,KAAK;AACJ,SAAO;CACR,EAAC,CAAC,QAAQ,CAAC,EACV,aACA,MACD,KAAK;EACJ,MAAM,cACJ,cAAc,KACb;AACH,UAAQ,YAAY,MAApB;GACE,KAAK,mBACH,QAAO,CACL,MACA,GAAG,WAAW,KAAK,KAAK,IAAI,CAAC,SAAS;IACpC,MAAM,YAEF,MAAO,MAAM;;AAEjB,QAAI,CAAC,SACH,QAAO;AAGT,WAAO,GAAG,KAAK,CAAC,EAAE,UAAU;GAC7B,EAAC,CAAC,OAAO,QAAQ,AACnB;GACH,KAAK;GACL,KAAK;GACL,KAAK;IACH,QAAQ,KAAK,KAAK;AAClB;GACF,KAAK,yBACH,QAAO,CACL,MACA,GAAG,WAAW,KAAK,KAAK,IAAI,CAAC,SAAS;IACpC,MAAM,YAEF,MAAO,MAAM;;AAEjB,QAAI,CAAC,SACH,QAAO;AAGT,WAAO,GAAG,KAAK,CAAC,EAAE,UAAU;GAC7B,EAAC,CAAC,OAAO,QAAQ,AACnB;GACH,KAAK;AACH,UAEI,YAAY,OACX,SAAS,SAAS,WACrB;KACA,QAAQ;;MACN,WAAW,GACX;MAAK;AACP;IACD;AAED,WAAO,CAAE;EACZ;AAED,SAAO,CACL,IACD;;CAEF,EAAC,GAAG,CAAE,EACV,CACA,OAAO,WAAW,CAClB,OAAO,oBAAoB,CAC3B,OAAO,WAAW,CAClB,OAAO,aAAa,CACpB,OAAgC,sBAAuB,CACvD,QAAQ,MAAM;AAEb,MAAI,MAAM,SAAS,mBACjB,QAAkD,KAAK,OAAQ,KAAK,QAAQ,CAAC,iBAAiB;AAC5F,OAAI,aAAa,SAAS,oBAExB;QAAI,aAAa,IAAI,SAAS,aAC5B,QAAO,CACL,aAAa,IAAI,MACjB,IACE,KAAK,QAAQ,SACZ,IAAI,KAAK,CAAC,EAAE,aAAa,IAAI,MAAM,AACvC;GACF;AAGH,OAAI,aAAa,SAAS,sBAExB;QAAI,aAAa,IAAI,SAAS,aAC5B,QAAO,CACL,aAAa,IAAI,MACjB,IACE,KAAK,QAAQ,SACZ,IAAI,KAAK,CAAC,EAAE,aAAa,IAAI,MAAM,AACvC;GACF;;AAIH,UAAO;EACR,EAAC,CAAC,OAAO,QAAQ;AAGpB,SAAO,CAAE;CACV,IAAG,CAAC,CACJ,OAAO,GAAG,2BAA2B,SACnC,WAAW,YAEZ,WAAW,SAAS,KAAK,IACzB,QAAQ,UAAU,EAClB,CAAC,CACF,OACC,SAAS,SAAS,UAChB,CAAE,IACF,CACE,GAAG,SAAS,SAAS,eAAe,oBAAoB,CAAE,GAC1D,GAAG,mBACJ,EACJ;;;;;;;;;;;;;;;;;;;;CAsBH,MAAM,kBAAkB,CAAC,iBAAiB;AACxC,SAAO,CAAC,QAAQ;AACd,OAAI;IACF,MAAM,gBAAgB,IAC0B;AAEhD,WAAO;KACL,YAAY,SAAS,eACnBA,SAAoC,cAAe,GACnDC,MAAiC,eAAgB,KAAK;KACxD;IACD;GACF,QAAO;AACN,WAAO;GACR;EACF;CACF;CAED,MAAM,WAAW,MAAM,WAAW,CAAC,EACjC,KACD,KAAK;AACJ,SAAO,QAAQ,YAAY,MAAM,yBAAyB,IAAI,KAAK,QAAQ,cAAc,SAAS,SAAS;CAC5G,EAAC,CAAC,IAAI,gBAAgB,OAAO,CAAC;CAE/B,MAAM,0BAA0B,MAAM,WAAW,CAAC,EAChD,KACD,KAAK;AACJ,SAAO,MAAM,yBAAyB,IAAI;CAC3C,EAAC,CAAC,IAAI,gBAAgB,OAAO,CAAC;CAE/B,MAAM,+BAA+B,MAAM,cAAc,CAAC,EACxD,KACD,KAAK;AACJ,SAAO,MAAM,8BAA8B,IAAI;CAChD,EAAC,CAAC,IAAI,gBAAgB,gBAAgB,CAAC;CAExC,MAAM,gBAAiD;EACrD,GAAG;EACH,GAAG;EACH,GAAG;CAEJ,EAAC,OAAO,QAAQ;AAEjB,MAAK,MAAM,EACT,YACA,KACD,IAAI,eACH,SAAS,YAAY,CAAC,KAAK,eAAe;;;;;;EAOvC,IAAK,UAAU;EAChB,MAAM,EACJ,MACA,OACD,GAAgE;EAEjE,IAAI,MAAM;;EAGV,IAAI,WAAW;AACf,KAAG;GACD,WAKO,SAAU;AACjB,OAGE,CAAC,QAAQ,SAAS,IAAI,IAAI,CAAC,QAAQ,SAAS,IAAI,IAChD,CAAC,WAAW,SAAS,IAAI,IACzB,CAAC,WAAW,SAAS,IAAI,IACzB,CAAC,oBAAoB,SAAS,IAAI,IAClC,YAAY,WAAW,YACvB,SAAS,OAAO,SAAS,qBACzB,MAAM,MAAM,MAAM,SAAS,MAAM;EAEpC,SAAQ,UAAU,SAAS;AAE5B,MAAI,SAAS,iBAAiB;GAC5B,MAAM,kBAAkB,eAAe,IAAI,MAAM;AACjD,OAAI,CAAC,gBAAgB,IAAI,IAAI,KAC1B,CAAC,MAAM,QAAQ,gBAAgB,IAAI,CAAC,gBAAgB,SAAS,IAAI,GAElE;QAAI,CAAC,kBACH,OAAO,CAAC,UAAU,EAAE,IAAI,eAAe,CAAC,EAAE,MAAM,IAAI;GACrD,WACQ,uBAAuB,CAAC,WAAW,SAAS,IAAI,CACzD,KAAI,WAAW,oBACb,WAAW,mBAAmB,IAAI;QAGlC,QAAQ,mBAAmB,IAAI;EAGpC;CACF,EAAC;AAEL,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,kBAAkB,EAChB,MAAM,UACP;IACD,qBAAqB,EACnB,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireAsteriskPrefix.js

@@ -1,112 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireAsteriskPrefix.js
-var requireAsteriskPrefix_default = iterateJsdoc(({ context, indent, jsdoc, utils }) => {
-	const [defaultRequireValue = "always", { tags: tagMap = {} } = {}] = context.options;
-	const { source } = jsdoc;
-	const always = defaultRequireValue === "always";
-	const never = defaultRequireValue === "never";
-	/** @type {string} */
-	let currentTag;
-	source.some(({ number, tokens }) => {
-		const { delimiter, description, end, tag } = tokens;
-		/**
-		* @returns {void}
-		*/
-		const neverFix = () => {
-			tokens.delimiter = "";
-			tokens.postDelimiter = "";
-		};
-		/**
-		* @param {string} checkValue
-		* @returns {boolean}
-		*/
-		const checkNever = (checkValue) => {
-			if (delimiter && delimiter !== "/**" && (never && !tagMap.always?.includes(checkValue) || tagMap.never?.includes(checkValue))) {
-				utils.reportJSDoc("Expected JSDoc line to have no prefix.", {
-					column: 0,
-					line: number
-				}, neverFix);
-				return true;
-			}
-			return false;
-		};
-		/**
-		* @returns {void}
-		*/
-		const alwaysFix = () => {
-			if (!tokens.start) tokens.start = indent + " ";
-			tokens.delimiter = "*";
-			tokens.postDelimiter = tag || description ? " " : "";
-		};
-		/**
-		* @param {string} checkValue
-		* @returns {boolean}
-		*/
-		const checkAlways = (checkValue) => {
-			if (!delimiter && (always && !tagMap.never?.includes(checkValue) || tagMap.always?.includes(checkValue))) {
-				utils.reportJSDoc("Expected JSDoc line to have the prefix.", {
-					column: 0,
-					line: number
-				}, alwaysFix);
-				return true;
-			}
-			return false;
-		};
-		if (tag) currentTag = tag.slice(1);
-		if (end && !tag) return false;
-		if (!currentTag) {
-			if (tagMap.any?.includes("*description")) return false;
-			if (checkNever("*description")) return true;
-			if (checkAlways("*description")) return true;
-			return false;
-		}
-		if (tagMap.any?.includes(currentTag)) return false;
-		if (checkNever(currentTag)) return true;
-		if (checkAlways(currentTag)) return true;
-		return false;
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires that each JSDoc line starts with an `*`.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			enum: [
-				"always",
-				"never",
-				"any"
-			],
-			type: "string"
-		}, {
-			additionalProperties: false,
-			properties: { tags: {
-				additionalProperties: false,
-				properties: {
-					always: {
-						items: { type: "string" },
-						type: "array"
-					},
-					any: {
-						items: { type: "string" },
-						type: "array"
-					},
-					never: {
-						items: { type: "string" },
-						type: "array"
-					}
-				},
-				type: "object"
-			} },
-			type: "object"
-		}],
-		type: "layout"
-	}
-});
-
-//#endregion
-export { requireAsteriskPrefix_default as default };
-//# sourceMappingURL=requireAsteriskPrefix.js.map

package/dist/rules/requireAsteriskPrefix.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireAsteriskPrefix.js","names":[],"sources":["../../src/rules/requireAsteriskPrefix.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    defaultRequireValue = 'always',\n    {\n      tags: tagMap = {},\n    } = {},\n  ] = context.options;\n\n  const {\n    source,\n  } = jsdoc;\n\n  const always = defaultRequireValue === 'always';\n  const never = defaultRequireValue === 'never';\n\n  /** @type {string} */\n  let currentTag;\n  source.some(({\n    number,\n    tokens,\n  }) => {\n    const {\n      delimiter,\n      description,\n      end,\n      tag,\n    } = tokens;\n\n    /**\n     * @returns {void}\n     */\n    const neverFix = () => {\n      tokens.delimiter = '';\n      tokens.postDelimiter = '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkNever = (checkValue) => {\n      if (delimiter && delimiter !== '/**' && (\n        never && !tagMap.always?.includes(checkValue) ||\n        tagMap.never?.includes(checkValue)\n      )) {\n        utils.reportJSDoc('Expected JSDoc line to have no prefix.', {\n          column: 0,\n          line: number,\n        }, neverFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    /**\n     * @returns {void}\n     */\n    const alwaysFix = () => {\n      if (!tokens.start) {\n        tokens.start = indent + ' ';\n      }\n\n      tokens.delimiter = '*';\n      tokens.postDelimiter = tag || description ? ' ' : '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkAlways = (checkValue) => {\n      if (\n        !delimiter && (\n          always && !tagMap.never?.includes(checkValue) ||\n          tagMap.always?.includes(checkValue)\n        )\n      ) {\n        utils.reportJSDoc('Expected JSDoc line to have the prefix.', {\n          column: 0,\n          line: number,\n        }, alwaysFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    if (tag) {\n      // Remove at sign\n      currentTag = tag.slice(1);\n    }\n\n    if (\n      // If this is the end but has a tag, the delimiter will also be\n      //  populated and will be safely ignored later\n      end && !tag\n    ) {\n      return false;\n    }\n\n    if (!currentTag) {\n      if (tagMap.any?.includes('*description')) {\n        return false;\n      }\n\n      if (checkNever('*description')) {\n        return true;\n      }\n\n      if (checkAlways('*description')) {\n        return true;\n      }\n\n      return false;\n    }\n\n    if (tagMap.any?.includes(currentTag)) {\n      return false;\n    }\n\n    if (checkNever(currentTag)) {\n      return true;\n    }\n\n    if (checkAlways(currentTag)) {\n      return true;\n    }\n\n    return false;\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'Requires that each JSDoc line starts with an `*`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never', 'any',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            additionalProperties: false,\n            properties: {\n              always: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              any: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              never: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;AAEA,oCAAe,aAAa,CAAC,EAC3B,SACA,QACA,OACA,OACD,KAAK;CACJ,MAAM,CACJ,sBAAsB,UACtB,EACE,MAAM,SAAS,CAAE,GAClB,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,MAAM,EACJ,QACD,GAAG;CAEJ,MAAM,SAAS,wBAAwB;CACvC,MAAM,QAAQ,wBAAwB;;CAGtC,IAAI;CACJ,OAAO,KAAK,CAAC,EACX,QACA,QACD,KAAK;EACJ,MAAM,EACJ,WACA,aACA,KACA,KACD,GAAG;;;;EAKJ,MAAM,WAAW,MAAM;GACrB,OAAO,YAAY;GACnB,OAAO,gBAAgB;EACxB;;;;;EAMD,MAAM,aAAa,CAAC,eAAe;AACjC,OAAI,aAAa,cAAc,UAC7B,SAAS,CAAC,OAAO,QAAQ,SAAS,WAAW,IAC7C,OAAO,OAAO,SAAS,WAAW,GACjC;IACD,MAAM,YAAY,0CAA0C;KAC1D,QAAQ;KACR,MAAM;IACP,GAAE,SAAS;AAEZ,WAAO;GACR;AAED,UAAO;EACR;;;;EAKD,MAAM,YAAY,MAAM;AACtB,OAAI,CAAC,OAAO,OACV,OAAO,QAAQ,SAAS;GAG1B,OAAO,YAAY;GACnB,OAAO,gBAAgB,OAAO,cAAc,MAAM;EACnD;;;;;EAMD,MAAM,cAAc,CAAC,eAAe;AAClC,OACE,CAAC,cACC,UAAU,CAAC,OAAO,OAAO,SAAS,WAAW,IAC7C,OAAO,QAAQ,SAAS,WAAW,GAErC;IACA,MAAM,YAAY,2CAA2C;KAC3D,QAAQ;KACR,MAAM;IACP,GAAE,UAAU;AAEb,WAAO;GACR;AAED,UAAO;EACR;AAED,MAAI,KAEF,aAAa,IAAI,MAAM,EAAE;AAG3B,MAGE,OAAO,CAAC,IAER,QAAO;AAGT,MAAI,CAAC,YAAY;AACf,OAAI,OAAO,KAAK,SAAS,eAAe,CACtC,QAAO;AAGT,OAAI,WAAW,eAAe,CAC5B,QAAO;AAGT,OAAI,YAAY,eAAe,CAC7B,QAAO;AAGT,UAAO;EACR;AAED,MAAI,OAAO,KAAK,SAAS,WAAW,CAClC,QAAO;AAGT,MAAI,WAAW,WAAW,CACxB,QAAO;AAGT,MAAI,YAAY,WAAW,CACzB,QAAO;AAGT,SAAO;CACR,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aACE;GACF,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM;IACJ;IAAU;IAAS;GACpB;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,sBAAsB;IACtB,YAAY;KACV,QAAQ;MACN,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;KACD,KAAK;MACH,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;KACD,OAAO;MACL,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;IACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireDescription.js

@@ -1,95 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireDescription.js
-/**
-* @param {string} description
-* @returns {import('../iterateJsdoc.js').Integer}
-*/
-const checkDescription = (description) => {
-	return description.trim().split("\n").filter(Boolean).length;
-};
-var requireDescription_default = iterateJsdoc(({ context, jsdoc, report, utils }) => {
-	if (utils.avoidDocs()) return;
-	const { descriptionStyle = "body" } = context.options[0] || {};
-	let targetTagName = utils.getPreferredTagName({
-		skipReportingBlockedTag: descriptionStyle !== "tag",
-		tagName: "description"
-	});
-	if (!targetTagName) return;
-	const isBlocked = typeof targetTagName === "object" && "blocked" in targetTagName && targetTagName.blocked;
-	if (isBlocked) targetTagName = targetTagName.tagName;
-	if (descriptionStyle !== "tag") {
-		const { description } = utils.getDescription();
-		if (checkDescription(description || "")) return;
-		if (descriptionStyle === "body") {
-			const descTags = utils.getPresentTags(["desc", "description"]);
-			if (descTags.length) {
-				const [{ tag: tagName }] = descTags;
-				report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);
-			} else report("Missing JSDoc block description.");
-			return;
-		}
-	}
-	const functionExamples = isBlocked ? [] : jsdoc.tags.filter(({ tag }) => {
-		return tag === targetTagName;
-	});
-	if (!functionExamples.length) {
-		report(descriptionStyle === "any" ? `Missing JSDoc block description or @${targetTagName} declaration.` : `Missing JSDoc @${targetTagName} declaration.`);
-		return;
-	}
-	for (const example of functionExamples) if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) report(`Missing JSDoc @${targetTagName} description.`, null, example);
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that all functions have a description.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				checkConstructors: {
-					default: true,
-					type: "boolean"
-				},
-				checkGetters: {
-					default: true,
-					type: "boolean"
-				},
-				checkSetters: {
-					default: true,
-					type: "boolean"
-				},
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				descriptionStyle: {
-					enum: [
-						"body",
-						"tag",
-						"any"
-					],
-					type: "string"
-				},
-				exemptedBy: {
-					items: { type: "string" },
-					type: "array"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireDescription_default as default };
-//# sourceMappingURL=requireDescription.js.map

package/dist/rules/requireDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireDescription.js","names":[],"sources":["../../src/rules/requireDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} description\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst checkDescription = (description) => {\n  return description\n    .trim()\n    .split('\\n')\n    .filter(Boolean)\n    .length;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  const {\n    descriptionStyle = 'body',\n  } = context.options[0] || {};\n\n  let targetTagName = utils.getPreferredTagName({\n    // We skip reporting except when `@description` is essential to the rule,\n    //  so user can block the tag and still meaningfully use this rule\n    //  even if the tag is present (and `check-tag-names` is the one to\n    //  normally report the fact that it is blocked but present)\n    skipReportingBlockedTag: descriptionStyle !== 'tag',\n    tagName: 'description',\n  });\n  if (!targetTagName) {\n    return;\n  }\n\n  const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;\n  if (isBlocked) {\n    targetTagName = /** @type {{blocked: true; tagName: string;}} */ (\n      targetTagName\n    ).tagName;\n  }\n\n  if (descriptionStyle !== 'tag') {\n    const {\n      description,\n    } = utils.getDescription();\n    if (checkDescription(description || '')) {\n      return;\n    }\n\n    if (descriptionStyle === 'body') {\n      const descTags = utils.getPresentTags([\n        'desc', 'description',\n      ]);\n      if (descTags.length) {\n        const [\n          {\n            tag: tagName,\n          },\n        ] = descTags;\n        report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);\n      } else {\n        report('Missing JSDoc block description.');\n      }\n\n      return;\n    }\n  }\n\n  const functionExamples = isBlocked ?\n    [] :\n    jsdoc.tags.filter(({\n      tag,\n    }) => {\n      return tag === targetTagName;\n    });\n\n  if (!functionExamples.length) {\n    report(\n      descriptionStyle === 'any' ?\n        `Missing JSDoc block description or @${targetTagName} declaration.` :\n        `Missing JSDoc @${targetTagName} declaration.`,\n    );\n\n    return;\n  }\n\n  for (const example of functionExamples) {\n    if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, example);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all functions have a description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: true,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: true,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          descriptionStyle: {\n            enum: [\n              'body', 'tag', 'any',\n            ],\n            type: 'string',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;AAMA,MAAM,mBAAmB,CAAC,gBAAgB;AACxC,QAAO,YACJ,MAAM,CACN,MAAM,KAAK,CACX,OAAO,QAAQ,CACf;AACJ;AAED,iCAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;AACJ,KAAI,MAAM,WAAW,CACnB;CAGF,MAAM,EACJ,mBAAmB,QACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,IAAI,gBAAgB,MAAM,oBAAoB;EAK5C,yBAAyB,qBAAqB;EAC9C,SAAS;CACV,EAAC;AACF,KAAI,CAAC,cACH;CAGF,MAAM,YAAY,OAAO,kBAAkB,YAAY,aAAa,iBAAiB,cAAc;AACnG,KAAI,WACF,gBACE,cACA;AAGJ,KAAI,qBAAqB,OAAO;EAC9B,MAAM,EACJ,aACD,GAAG,MAAM,gBAAgB;AAC1B,MAAI,iBAAiB,eAAe,GAAG,CACrC;AAGF,MAAI,qBAAqB,QAAQ;GAC/B,MAAM,WAAW,MAAM,eAAe,CACpC,QAAQ,aACT,EAAC;AACF,OAAI,SAAS,QAAQ;IACnB,MAAM,CACJ,EACE,KAAK,SACN,CACF,GAAG;IACJ,OAAO,CAAC,YAAY,EAAE,QAAQ,sFAAsF,EAAE,QAAQ,MAAM,CAAC,CAAC;GACvI,OACC,OAAO,mCAAmC;AAG5C;EACD;CACF;CAED,MAAM,mBAAmB,YACvB,CAAE,IACF,MAAM,KAAK,OAAO,CAAC,EACjB,KACD,KAAK;AACJ,SAAO,QAAQ;CAChB,EAAC;AAEJ,KAAI,CAAC,iBAAiB,QAAQ;EAC5B,OACE,qBAAqB,QACnB,CAAC,oCAAoC,EAAE,cAAc,aAAa,CAAC,GACnE,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,CACjD;AAED;CACD;AAED,MAAK,MAAM,WAAW,iBACpB,KAAI,CAAC,iBAAiB,GAAG,QAAQ,KAAK,CAAC,EAAE,MAAM,kBAAkB,QAAQ,EAAE,CAAC,EAC1E,OAAO,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,QAAQ;AAG1E,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,kBAAkB;KAChB,MAAM;MACJ;MAAQ;MAAO;KAChB;KACD,MAAM;IACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}