eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/rules/convertToJsdocComments.js

@@ -1,231 +0,0 @@
-import { enforcedContexts, getContextObject, getIndent } from "../jsdocUtils.js";
-import { getSettings } from "../iterateJsdoc.js";
-import { getDecorator, getFollowingComment, getNonJsdocComment, getReducedASTNode } from "@es-joy/jsdoccomment";
-
-//#region src/rules/convertToJsdocComments.js
-/** @type {import('eslint').Rule.RuleModule} */
-var convertToJsdocComments_default = {
-	create(context) {
-		/**
-		* @typedef {import('eslint').AST.Token | import('estree').Comment | {
-		*   type: import('eslint').AST.TokenType|"Line"|"Block"|"Shebang",
-		*   range: [number, number],
-		*   value: string
-		* }} Token
-		*/
-		/**
-		* @callback AddComment
-		* @param {boolean|undefined} inlineCommentBlock
-		* @param {Token} comment
-		* @param {string} indent
-		* @param {number} lines
-		* @param {import('eslint').Rule.RuleFixer} fixer
-		*/
-		/* c8 ignore next -- Fallback to deprecated method */
-		const { sourceCode = context.getSourceCode() } = context;
-		const settings = getSettings(context);
-		if (!settings) return {};
-		const { allowedPrefixes = [
-			"@ts-",
-			"istanbul ",
-			"c8 ",
-			"v8 ",
-			"eslint",
-			"prettier-"
-		], contexts = settings.contexts || [], contextsAfter = [], contextsBeforeAndAfter = [
-			"VariableDeclarator",
-			"TSPropertySignature",
-			"PropertyDefinition"
-		], enableFixer = true, enforceJsdocLineStyle = "multi", lineOrBlockStyle = "both" } = context.options[0] ?? {};
-		let reportingNonJsdoc = false;
-		/**
-		* @param {string} messageId
-		* @param {import('estree').Comment|Token} comment
-		* @param {import('eslint').Rule.Node} node
-		* @param {import('eslint').Rule.ReportFixer} fixer
-		*/
-		const report = (messageId, comment, node, fixer) => {
-			const loc = {
-				end: {
-					column: 0,
-					line: comment.loc?.start?.line ?? 1
-				},
-				start: {
-					column: 0,
-					line: comment.loc?.start?.line ?? 1
-				}
-			};
-			context.report({
-				fix: enableFixer ? fixer : null,
-				loc,
-				messageId,
-				node
-			});
-		};
-		/**
-		* @param {import('eslint').Rule.Node} node
-		* @param {import('eslint').AST.Token | import('estree').Comment | {
-		*   type: import('eslint').AST.TokenType|"Line"|"Block"|"Shebang",
-		*   range: [number, number],
-		*   value: string
-		* }} comment
-		* @param {AddComment} addComment
-		* @param {import('../iterateJsdoc.js').Context[]} ctxts
-		*/
-		const getFixer = (node, comment, addComment, ctxts) => {
-			return (fixer) => {
-				const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;
-				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 } = ctxts.find((contxt) => {
-					if (typeof contxt === "string") return false;
-					const { context: ctxt } = contxt;
-					return ctxt === node.type;
-				}) || {};
-				return addComment(inlineCommentBlock, comment, indent, lines, fixer);
-			};
-		};
-		/**
-		* @param {import('eslint').AST.Token | import('estree').Comment | {
-		*   type: import('eslint').AST.TokenType|"Line"|"Block"|"Shebang",
-		*   range: [number, number],
-		*   value: string
-		* }} comment
-		* @param {import('eslint').Rule.Node} node
-		* @param {AddComment} addComment
-		* @param {import('../iterateJsdoc.js').Context[]} ctxts
-		*/
-		const reportings = (comment, node, addComment, ctxts) => {
-			const fixer = getFixer(node, comment, addComment, ctxts);
-			if (comment.type === "Block") {
-				if (lineOrBlockStyle === "line") return;
-				report("blockCommentsJsdocStyle", comment, node, fixer);
-				return;
-			}
-			if (comment.type === "Line") {
-				if (lineOrBlockStyle === "block") return;
-				report("lineCommentsJsdocStyle", comment, node, fixer);
-			}
-		};
-		/**
-		* @type {import('../iterateJsdoc.js').CheckJsdoc}
-		*/
-		const checkNonJsdoc = (_info, _handler, node) => {
-			const comment = getNonJsdocComment(sourceCode, node, settings);
-			if (!comment || allowedPrefixes.some((prefix) => {
-				return comment.value.trimStart().startsWith(prefix);
-			})) return;
-			reportingNonJsdoc = true;
-			/** @type {AddComment} */
-			const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {
-				const insertion = (inlineCommentBlock || enforceJsdocLineStyle === "single" ? `/** ${commentToAdd.value.trim()} ` : `/**\n${indent}*${commentToAdd.value.trimEnd()}\n${indent}`) + `*/${"\n".repeat((lines || 1) - 1)}`;
-				return fixer.replaceText(commentToAdd, insertion);
-			};
-			reportings(comment, node, addComment, contexts);
-		};
-		/**
-		* @param {import('eslint').Rule.Node} node
-		* @param {import('../iterateJsdoc.js').Context[]} ctxts
-		*/
-		const checkNonJsdocAfter = (node, ctxts) => {
-			const comment = getFollowingComment(sourceCode, node);
-			if (!comment || comment.value.startsWith("*") || allowedPrefixes.some((prefix) => {
-				return comment.value.trimStart().startsWith(prefix);
-			})) return;
-			/** @type {AddComment} */
-			const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {
-				const insertion = (inlineCommentBlock || enforceJsdocLineStyle === "single" ? `/** ${commentToAdd.value.trim()} ` : `/**\n${indent}*${commentToAdd.value.trimEnd()}\n${indent}`) + `*/${"\n".repeat((lines || 1) - 1)}${lines ? `\n${indent.slice(1)}` : " "}`;
-				return [fixer.remove(commentToAdd), fixer.insertTextBefore(node.type === "VariableDeclarator" ? node.parent : node, insertion)];
-			};
-			reportings(comment, node, addComment, ctxts);
-		};
-		return {
-			...getContextObject(enforcedContexts(context, true, settings), checkNonJsdoc),
-			...getContextObject(contextsAfter, (_info, _handler, node) => {
-				checkNonJsdocAfter(node, contextsAfter);
-			}),
-			...getContextObject(contextsBeforeAndAfter, (_info, _handler, node) => {
-				checkNonJsdoc({}, null, node);
-				if (!reportingNonJsdoc) checkNonJsdocAfter(node, contextsBeforeAndAfter);
-			})
-		};
-	},
-	meta: {
-		docs: {
-			description: "Converts non-JSDoc comments preceding or following nodes into JSDoc ones",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md#repos-sticky-header"
-		},
-		fixable: "code",
-		messages: {
-			blockCommentsJsdocStyle: "Block comments should be JSDoc-style.",
-			lineCommentsJsdocStyle: "Line comments should be JSDoc-style."
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				allowedPrefixes: {
-					items: { type: "string" },
-					type: "array"
-				},
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							context: { type: "string" },
-							inlineCommentBlock: { type: "boolean" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				contextsAfter: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							context: { type: "string" },
-							inlineCommentBlock: { type: "boolean" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				contextsBeforeAndAfter: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							context: { type: "string" },
-							inlineCommentBlock: { type: "boolean" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				enableFixer: { type: "boolean" },
-				enforceJsdocLineStyle: {
-					enum: ["multi", "single"],
-					type: "string"
-				},
-				lineOrBlockStyle: {
-					enum: [
-						"block",
-						"line",
-						"both"
-					],
-					type: "string"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-};
-
-//#endregion
-export { convertToJsdocComments_default as default };
-//# sourceMappingURL=convertToJsdocComments.js.map

package/dist/rules/convertToJsdocComments.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"convertToJsdocComments.js","names":[],"sources":["../../src/rules/convertToJsdocComments.js"],"sourcesContent":["import {\n  getSettings,\n} from '../iterateJsdoc.js';\nimport {\n  enforcedContexts,\n  getContextObject,\n  getIndent,\n} from '../jsdocUtils.js';\nimport {\n  getDecorator,\n  getFollowingComment,\n  getNonJsdocComment,\n  getReducedASTNode,\n} from '@es-joy/jsdoccomment';\n\n/** @type {import('eslint').Rule.RuleModule} */\nexport default {\n  create (context) {\n    /**\n     * @typedef {import('eslint').AST.Token | import('estree').Comment | {\n     *   type: import('eslint').AST.TokenType|\"Line\"|\"Block\"|\"Shebang\",\n     *   range: [number, number],\n     *   value: string\n     * }} Token\n     */\n\n    /**\n     * @callback AddComment\n     * @param {boolean|undefined} inlineCommentBlock\n     * @param {Token} comment\n     * @param {string} indent\n     * @param {number} lines\n     * @param {import('eslint').Rule.RuleFixer} fixer\n     */\n\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 {\n      allowedPrefixes = [\n        '@ts-', 'istanbul ', 'c8 ', 'v8 ', 'eslint', 'prettier-',\n      ],\n      contexts = settings.contexts || [],\n      contextsAfter = /** @type {string[]} */ ([]),\n      contextsBeforeAndAfter = [\n        'VariableDeclarator', 'TSPropertySignature', 'PropertyDefinition',\n      ],\n      enableFixer = true,\n      enforceJsdocLineStyle = 'multi',\n      lineOrBlockStyle = 'both',\n    } = context.options[0] ?? {};\n\n    let reportingNonJsdoc = false;\n\n    /**\n     * @param {string} messageId\n     * @param {import('estree').Comment|Token} comment\n     * @param {import('eslint').Rule.Node} node\n     * @param {import('eslint').Rule.ReportFixer} fixer\n     */\n    const report = (messageId, comment, node, fixer) => {\n      const loc = {\n        end: {\n          column: 0,\n          /* c8 ignore next 2 -- Guard */\n          // @ts-expect-error Ok\n          line: (comment.loc?.start?.line ?? 1),\n        },\n        start: {\n          column: 0,\n          /* c8 ignore next 2 -- Guard */\n          // @ts-expect-error Ok\n          line: (comment.loc?.start?.line ?? 1),\n        },\n      };\n\n      context.report({\n        fix: enableFixer ? fixer : null,\n        loc,\n        messageId,\n        node,\n      });\n    };\n\n    /**\n     * @param {import('eslint').Rule.Node} node\n     * @param {import('eslint').AST.Token | import('estree').Comment | {\n     *   type: import('eslint').AST.TokenType|\"Line\"|\"Block\"|\"Shebang\",\n     *   range: [number, number],\n     *   value: string\n     * }} comment\n     * @param {AddComment} addComment\n     * @param {import('../iterateJsdoc.js').Context[]} ctxts\n     */\n    const getFixer = (node, comment, addComment, ctxts) => {\n      return /** @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        let baseNode =\n          /**\n           * @type {import('@typescript-eslint/types').TSESTree.Node|import('eslint').Rule.Node}\n           */ (\n            getReducedASTNode(node, sourceCode)\n          );\n\n        const decorator = getDecorator(\n          /** @type {import('eslint').Rule.Node} */\n          (baseNode),\n        );\n        if (decorator) {\n          baseNode = /** @type {import('@typescript-eslint/types').TSESTree.Decorator} */ (\n            decorator\n          );\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           */ (ctxts).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\n        return addComment(inlineCommentBlock, comment, indent, lines, fixer);\n      };\n    };\n\n    /**\n     * @param {import('eslint').AST.Token | import('estree').Comment | {\n     *   type: import('eslint').AST.TokenType|\"Line\"|\"Block\"|\"Shebang\",\n     *   range: [number, number],\n     *   value: string\n     * }} comment\n     * @param {import('eslint').Rule.Node} node\n     * @param {AddComment} addComment\n     * @param {import('../iterateJsdoc.js').Context[]} ctxts\n     */\n    const reportings = (comment, node, addComment, ctxts) => {\n      const fixer = getFixer(node, comment, addComment, ctxts);\n\n      if (comment.type === 'Block') {\n        if (lineOrBlockStyle === 'line') {\n          return;\n        }\n\n        report('blockCommentsJsdocStyle', comment, node, fixer);\n        return;\n      }\n\n      if (comment.type === 'Line') {\n        if (lineOrBlockStyle === 'block') {\n          return;\n        }\n\n        report('lineCommentsJsdocStyle', comment, node, fixer);\n      }\n    };\n\n    /**\n     * @type {import('../iterateJsdoc.js').CheckJsdoc}\n     */\n    const checkNonJsdoc = (_info, _handler, node) => {\n      const comment = getNonJsdocComment(sourceCode, node, settings);\n\n      if (\n        !comment ||\n        /** @type {string[]} */\n        (allowedPrefixes).some((prefix) => {\n          return comment.value.trimStart().startsWith(prefix);\n        })\n      ) {\n        return;\n      }\n\n      reportingNonJsdoc = true;\n\n      /** @type {AddComment} */\n      // eslint-disable-next-line unicorn/consistent-function-scoping -- Avoid conflicts\n      const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {\n        const insertion = (\n          inlineCommentBlock || enforceJsdocLineStyle === 'single' ?\n            `/** ${commentToAdd.value.trim()} ` :\n            `/**\\n${indent}*${commentToAdd.value.trimEnd()}\\n${indent}`\n        ) +\n            `*/${'\\n'.repeat((lines || 1) - 1)}`;\n\n        return fixer.replaceText(\n          /** @type {import('eslint').AST.Token} */\n          (commentToAdd),\n          insertion,\n        );\n      };\n\n      reportings(comment, node, addComment, contexts);\n    };\n\n    /**\n     * @param {import('eslint').Rule.Node} node\n     * @param {import('../iterateJsdoc.js').Context[]} ctxts\n     */\n    const checkNonJsdocAfter = (node, ctxts) => {\n      const comment = getFollowingComment(sourceCode, node);\n\n      if (\n        !comment ||\n        comment.value.startsWith('*') ||\n        /** @type {string[]} */\n        (allowedPrefixes).some((prefix) => {\n          return comment.value.trimStart().startsWith(prefix);\n        })\n      ) {\n        return;\n      }\n\n      /** @type {AddComment} */\n      const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {\n        const insertion = (\n          inlineCommentBlock || enforceJsdocLineStyle === 'single' ?\n            `/** ${commentToAdd.value.trim()} ` :\n            `/**\\n${indent}*${commentToAdd.value.trimEnd()}\\n${indent}`\n        ) +\n            `*/${'\\n'.repeat((lines || 1) - 1)}${lines ? `\\n${indent.slice(1)}` : ' '}`;\n\n        return [\n          fixer.remove(\n          /** @type {import('eslint').AST.Token} */\n            (commentToAdd),\n          ), fixer.insertTextBefore(\n            node.type === 'VariableDeclarator' ? node.parent : node,\n            insertion,\n          ),\n        ];\n      };\n\n      reportings(comment, node, addComment, ctxts);\n    };\n\n    // Todo: add contexts to check after (and handle if want both before and after)\n    return {\n      ...getContextObject(\n        enforcedContexts(context, true, settings),\n        checkNonJsdoc,\n      ),\n      ...getContextObject(\n        contextsAfter,\n        (_info, _handler, node) => {\n          checkNonJsdocAfter(node, contextsAfter);\n        },\n      ),\n      ...getContextObject(\n        contextsBeforeAndAfter,\n        (_info, _handler, node) => {\n          checkNonJsdoc({}, null, node);\n          if (!reportingNonJsdoc) {\n            checkNonJsdocAfter(node, contextsBeforeAndAfter);\n          }\n        },\n      ),\n    };\n  },\n  meta: {\n    docs: {\n      description: 'Converts non-JSDoc comments preceding or following nodes into JSDoc ones',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md#repos-sticky-header',\n    },\n\n    fixable: 'code',\n\n    messages: {\n      blockCommentsJsdocStyle: 'Block comments should be JSDoc-style.',\n      lineCommentsJsdocStyle: 'Line comments should be JSDoc-style.',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowedPrefixes: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\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                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          contextsAfter: {\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                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          contextsBeforeAndAfter: {\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                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          enforceJsdocLineStyle: {\n            enum: [\n              'multi', 'single',\n            ],\n            type: 'string',\n          },\n          lineOrBlockStyle: {\n            enum: [\n              'block', 'line', 'both',\n            ],\n            type: 'string',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n};\n"],"mappings":";;;;;;AAgBA,qCAAe;CACb,OAAQ,SAAS;;;;;;;;;;;;;;;;;EAmBf,MAAM,EACJ,aAAa,QAAQ,eAAe,EACrC,GAAG;EACJ,MAAM,WAAW,YAAY,QAAQ;AACrC,MAAI,CAAC,SACH,QAAO,CAAE;EAGX,MAAM,EACJ,kBAAkB;GAChB;GAAQ;GAAa;GAAO;GAAO;GAAU;EAC9C,GACD,WAAW,SAAS,YAAY,CAAE,GAClC,gBAAyC,CAAE,GAC3C,yBAAyB;GACvB;GAAsB;GAAuB;EAC9C,GACD,cAAc,MACd,wBAAwB,SACxB,mBAAmB,QACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;EAE5B,IAAI,oBAAoB;;;;;;;EAQxB,MAAM,SAAS,CAAC,WAAW,SAAS,MAAM,UAAU;GAClD,MAAM,MAAM;IACV,KAAK;KACH,QAAQ;KAGR,MAAO,QAAQ,KAAK,OAAO,QAAQ;IACpC;IACD,OAAO;KACL,QAAQ;KAGR,MAAO,QAAQ,KAAK,OAAO,QAAQ;IACpC;GACF;GAED,QAAQ,OAAO;IACb,KAAK,cAAc,QAAQ;IAC3B;IACA;IACA;GACD,EAAC;EACH;;;;;;;;;;;EAYD,MAAM,WAAW,CAAC,MAAM,SAAS,YAAY,UAAU;AACrD,UAAwD,CAAC,UAAU;IAEjE,MAAM,QAAQ,SAAS,aAAa,KAAK,SAAS,YAAY,IAAI,IAAI,SAAS;IAC/E,IAAI,WAIA,kBAAkB,MAAM,WAAW;IAGvC,MAAM,YAAY,aAEf,SACF;AACD,QAAI,WACF,WACE;IAIJ,MAAM,SAAS,UAAU,EACvB,MAAM,WAAW;KAC4B;;KAGE,SAAU,IACrD,MAAM;KACT,CACF,EAAC;IAEF,MAAM,EACJ,oBACD,GAOM,MAAO,KAAK,CAAC,WAAW;AAC3B,SAAI,OAAO,WAAW,SACpB,QAAO;KAGT,MAAM,EACJ,SAAS,MACV,GAAG;AACJ,YAAO,SAAS,KAAK;IACtB,EAAC,IAAI,CAAE;AAEV,WAAO,WAAW,oBAAoB,SAAS,QAAQ,OAAO,MAAM;GACrE;EACF;;;;;;;;;;;EAYD,MAAM,aAAa,CAAC,SAAS,MAAM,YAAY,UAAU;GACvD,MAAM,QAAQ,SAAS,MAAM,SAAS,YAAY,MAAM;AAExD,OAAI,QAAQ,SAAS,SAAS;AAC5B,QAAI,qBAAqB,OACvB;IAGF,OAAO,2BAA2B,SAAS,MAAM,MAAM;AACvD;GACD;AAED,OAAI,QAAQ,SAAS,QAAQ;AAC3B,QAAI,qBAAqB,QACvB;IAGF,OAAO,0BAA0B,SAAS,MAAM,MAAM;GACvD;EACF;;;;EAKD,MAAM,gBAAgB,CAAC,OAAO,UAAU,SAAS;GAC/C,MAAM,UAAU,mBAAmB,YAAY,MAAM,SAAS;AAE9D,OACE,CAAC,WAEA,gBAAiB,KAAK,CAAC,WAAW;AACjC,WAAO,QAAQ,MAAM,WAAW,CAAC,WAAW,OAAO;GACpD,EAAC,CAEF;GAGF,oBAAoB;;GAIpB,MAAM,aAAa,CAAC,oBAAoB,cAAc,QAAQ,OAAO,UAAU;IAC7E,MAAM,aACJ,sBAAsB,0BAA0B,WAC9C,CAAC,IAAI,EAAE,aAAa,MAAM,MAAM,CAAC,CAAC,CAAC,GACnC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,aAAa,MAAM,SAAS,CAAC,EAAE,EAAE,QAAQ,IAE3D,CAAC,EAAE,EAAE,KAAK,QAAQ,SAAS,KAAK,EAAE,EAAE;AAExC,WAAO,MAAM,YAEV,cACD,UACD;GACF;GAED,WAAW,SAAS,MAAM,YAAY,SAAS;EAChD;;;;;EAMD,MAAM,qBAAqB,CAAC,MAAM,UAAU;GAC1C,MAAM,UAAU,oBAAoB,YAAY,KAAK;AAErD,OACE,CAAC,WACD,QAAQ,MAAM,WAAW,IAAI,IAE5B,gBAAiB,KAAK,CAAC,WAAW;AACjC,WAAO,QAAQ,MAAM,WAAW,CAAC,WAAW,OAAO;GACpD,EAAC,CAEF;;GAIF,MAAM,aAAa,CAAC,oBAAoB,cAAc,QAAQ,OAAO,UAAU;IAC7E,MAAM,aACJ,sBAAsB,0BAA0B,WAC9C,CAAC,IAAI,EAAE,aAAa,MAAM,MAAM,CAAC,CAAC,CAAC,GACnC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,aAAa,MAAM,SAAS,CAAC,EAAE,EAAE,QAAQ,IAE3D,CAAC,EAAE,EAAE,KAAK,QAAQ,SAAS,KAAK,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,OAAO,MAAM,EAAE,EAAE,GAAG,KAAK;AAE/E,WAAO,CACL,MAAM,OAEH,aACF,EAAE,MAAM,iBACP,KAAK,SAAS,uBAAuB,KAAK,SAAS,MACnD,UACD,AACF;GACF;GAED,WAAW,SAAS,MAAM,YAAY,MAAM;EAC7C;AAGD,SAAO;GACL,GAAG,iBACD,iBAAiB,SAAS,MAAM,SAAS,EACzC,cACD;GACD,GAAG,iBACD,eACA,CAAC,OAAO,UAAU,SAAS;IACzB,mBAAmB,MAAM,cAAc;GACxC,EACF;GACD,GAAG,iBACD,wBACA,CAAC,OAAO,UAAU,SAAS;IACzB,cAAc,CAAE,GAAE,MAAM,KAAK;AAC7B,QAAI,CAAC,mBACH,mBAAmB,MAAM,uBAAuB;GAEnD,EACF;EACF;CACF;CACD,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EAED,SAAS;EAET,UAAU;GACR,yBAAyB;GACzB,wBAAwB;EACzB;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,iBAAiB;KACf,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,eAAe;KACb,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,wBAAwB;KACtB,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,aAAa,EACX,MAAM,UACP;IACD,uBAAuB;KACrB,MAAM,CACJ,SAAS,QACV;KACD,MAAM;IACP;IACD,kBAAkB;KAChB,MAAM;MACJ;MAAS;MAAQ;KAClB;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF"}

package/dist/rules/emptyTags.js

@@ -1,67 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/emptyTags.js
-const defaultEmptyTags = new Set([
-	"abstract",
-	"async",
-	"generator",
-	"global",
-	"hideconstructor",
-	"ignore",
-	"inheritDoc",
-	"inner",
-	"instance",
-	"internal",
-	"overload",
-	"override",
-	"readonly"
-]);
-const emptyIfNotClosure = new Set([
-	"inheritdoc",
-	"package",
-	"private",
-	"protected",
-	"public",
-	"static"
-]);
-const emptyIfClosure = new Set(["interface"]);
-var emptyTags_default = iterateJsdoc(({ jsdoc, settings, utils }) => {
-	const emptyTags = utils.filterTags(({ tag: tagName }) => {
-		return defaultEmptyTags.has(tagName) || utils.hasOptionTag(tagName) && jsdoc.tags.some(({ tag }) => {
-			return tag === tagName;
-		}) || settings.mode === "closure" && emptyIfClosure.has(tagName) || settings.mode !== "closure" && emptyIfNotClosure.has(tagName);
-	});
-	for (const [key, tag] of emptyTags.entries()) {
-		const content = tag.name || tag.description || tag.type;
-		if (content.trim() && (key !== emptyTags.length - 1 || !/^\s*\*+$/v.test(content))) {
-			const fix = () => {
-				utils.setTag(tag);
-			};
-			utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);
-		}
-	}
-}, {
-	checkInternal: true,
-	checkPrivate: true,
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Expects specific tags to be empty of any content.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: { tags: {
-				items: { type: "string" },
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { emptyTags_default as default };
-//# sourceMappingURL=emptyTags.js.map

package/dist/rules/emptyTags.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"emptyTags.js","names":[],"sources":["../../src/rules/emptyTags.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultEmptyTags = new Set([\n  'abstract', 'async', 'generator', 'global', 'hideconstructor',\n\n  // jsdoc doesn't use this form in its docs, but allow for compatibility with\n  //  TypeScript which allows and Closure which requires\n  'ignore',\n\n  // jsdoc doesn't use but allow for TypeScript\n  'inheritDoc', 'inner', 'instance',\n  'internal',\n\n  'overload',\n\n  'override',\n  'readonly',\n]);\n\nconst emptyIfNotClosure = new Set([\n  // Closure doesn't allow with this casing\n  'inheritdoc', 'package', 'private', 'protected', 'public',\n\n  'static',\n]);\n\nconst emptyIfClosure = new Set([\n  'interface',\n]);\n\nexport default iterateJsdoc(({\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  const emptyTags = utils.filterTags(({\n    tag: tagName,\n  }) => {\n    return defaultEmptyTags.has(tagName) ||\n      utils.hasOptionTag(tagName) && jsdoc.tags.some(({\n        tag,\n      }) => {\n        return tag === tagName;\n      }) ||\n      settings.mode === 'closure' && emptyIfClosure.has(tagName) ||\n      settings.mode !== 'closure' && emptyIfNotClosure.has(tagName);\n  });\n\n  for (const [\n    key,\n    tag,\n  ] of emptyTags.entries()) {\n    const content = tag.name || tag.description || tag.type;\n    if (content.trim() && (\n      // Allow for JSDoc-block final asterisks\n      key !== emptyTags.length - 1 || !(/^\\s*\\*+$/v).test(content)\n    )) {\n      const fix = () => {\n        // By time of call in fixer, `tag` will have `line` added\n        utils.setTag(\n          /**\n           * @type {import('comment-parser').Spec & {\n           *   line: import('../iterateJsdoc.js').Integer\n           * }}\n           */ (tag),\n        );\n      };\n\n      utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);\n    }\n  }\n}, {\n  checkInternal: true,\n  checkPrivate: true,\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Expects specific tags to be empty of any content.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,MAAM,mBAAmB,IAAI,IAAI;CAC/B;CAAY;CAAS;CAAa;CAAU;CAI5C;CAGA;CAAc;CAAS;CACvB;CAEA;CAEA;CACA;AACD;AAED,MAAM,oBAAoB,IAAI,IAAI;CAEhC;CAAc;CAAW;CAAW;CAAa;CAEjD;AACD;AAED,MAAM,iBAAiB,IAAI,IAAI,CAC7B,WACD;AAED,wBAAe,aAAa,CAAC,EAC3B,OACA,UACA,OACD,KAAK;CACJ,MAAM,YAAY,MAAM,WAAW,CAAC,EAClC,KAAK,SACN,KAAK;AACJ,SAAO,iBAAiB,IAAI,QAAQ,IAClC,MAAM,aAAa,QAAQ,IAAI,MAAM,KAAK,KAAK,CAAC,EAC9C,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC,IACF,SAAS,SAAS,aAAa,eAAe,IAAI,QAAQ,IAC1D,SAAS,SAAS,aAAa,kBAAkB,IAAI,QAAQ;CAChE,EAAC;AAEF,MAAK,MAAM,CACT,KACA,IACD,IAAI,UAAU,SAAS,EAAE;EACxB,MAAM,UAAU,IAAI,QAAQ,IAAI,eAAe,IAAI;AACnD,MAAI,QAAQ,MAAM,KAEhB,QAAQ,UAAU,SAAS,KAAK,CAAE,YAAa,KAAK,QAAQ,GAC3D;GACD,MAAM,MAAM,MAAM;IAEhB,MAAM,OAKC,IACN;GACF;GAED,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,IAAI,iBAAiB,CAAC,EAAE,KAAK,KAAK,KAAK;EAClE;CACF;AACF,GAAE;CACD,eAAe;CACf,cAAc;CACd,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,OAAO,EACL,MAAM,SACP;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/implementsOnClasses.js

@@ -1,40 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/implementsOnClasses.js
-var implementsOnClasses_default = iterateJsdoc(({ report, utils }) => {
-	const iteratingFunction = utils.isIteratingFunctionOrVariable();
-	if (iteratingFunction) {
-		if (utils.hasATag(["class", "constructor"]) || utils.isConstructor()) return;
-	} else if (!utils.isVirtualFunction()) return;
-	utils.forEachPreferredTag("implements", (tag) => {
-		report("@implements used on a non-constructor function", null, tag);
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Reports an issue with any non-constructor function using `@implements`.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { contexts: {
-				items: { anyOf: [{ type: "string" }, {
-					additionalProperties: false,
-					properties: {
-						comment: { type: "string" },
-						context: { type: "string" }
-					},
-					type: "object"
-				}] },
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { implementsOnClasses_default as default };
-//# sourceMappingURL=implementsOnClasses.js.map

package/dist/rules/implementsOnClasses.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"implementsOnClasses.js","names":[],"sources":["../../src/rules/implementsOnClasses.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  const iteratingFunction = utils.isIteratingFunctionOrVariable();\n\n  if (iteratingFunction) {\n    if (utils.hasATag([\n      'class',\n      'constructor',\n    ]) ||\n      utils.isConstructor()\n    ) {\n      return;\n    }\n  } else if (!utils.isVirtualFunction()) {\n    return;\n  }\n\n  utils.forEachPreferredTag('implements', (tag) => {\n    report('@implements used on a non-constructor function', null, tag);\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Reports an issue with any non-constructor function using `@implements`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\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        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,kCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,MAAM,+BAA+B;AAE/D,KAAI,mBACF;MAAI,MAAM,QAAQ,CAChB,SACA,aACD,EAAC,IACA,MAAM,eAAe,CAErB;CACD,WACQ,CAAC,MAAM,mBAAmB,CACnC;CAGF,MAAM,oBAAoB,cAAc,CAAC,QAAQ;EAC/C,OAAO,kDAAkD,MAAM,IAAI;CACpE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/importsAsDependencies.js

@@ -1,68 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import { isBuiltin } from "node:module";
-import { parse, traverse, tryParse } from "@es-joy/jsdoccomment";
-import { readFileSync } from "fs";
-import { join } from "path";
-
-//#region src/rules/importsAsDependencies.js
-/**
-* @type {Set<string>|null}
-*/
-let deps;
-const setDeps = function() {
-	try {
-		const pkg = JSON.parse(readFileSync(join(process.cwd(), "./package.json")));
-		deps = new Set([...pkg.dependencies ? Object.keys(pkg.dependencies) : [], ...pkg.devDependencies ? Object.keys(pkg.devDependencies) : []]);
-	} catch (error) {
-		/* c8 ignore next -- our package.json exists */
-		deps = null;
-		/* c8 ignore next 4 -- our package.json exists */
-		console.log(error);
-	}
-};
-const moduleCheck = /* @__PURE__ */ new Map();
-var importsAsDependencies_default = iterateJsdoc(({ jsdoc, settings, utils }) => {
-	if (deps === void 0) setDeps();
-	/* c8 ignore next 3 -- our package.json exists */
-	if (deps === null) return;
-	const { mode } = settings;
-	for (const tag of jsdoc.tags) {
-		let typeAst;
-		try {
-			typeAst = mode === "permissive" ? tryParse(tag.type) : parse(tag.type, mode);
-		} catch {
-			continue;
-		}
-		traverse(typeAst, (nde) => {
-			/* c8 ignore next 3 -- TS guard */
-			if (deps === null) return;
-			if (nde.type === "JsdocTypeImport") {
-				let mod = nde.element.value.replace(/^(@[^\/]+\/[^\/]+|[^\/]+).*$/v, "$1");
-				if (/^[.\/]/v.test(mod)) return;
-				if (isBuiltin(mod)) return;
-				else if (!moduleCheck.has(mod)) {
-					let pkg;
-					try {
-						pkg = JSON.parse(readFileSync(join(process.cwd(), "node_modules", mod, "./package.json")));
-					} catch {}
-					if (!pkg || !pkg.types && !pkg.typings) mod = `@types/${mod}`;
-					moduleCheck.set(mod, !deps.has(mod));
-				}
-				if (moduleCheck.get(mod)) utils.reportJSDoc("import points to package which is not found in dependencies", tag);
-			}
-		});
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header"
-		},
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { importsAsDependencies_default as default };
-//# sourceMappingURL=importsAsDependencies.js.map

package/dist/rules/importsAsDependencies.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"importsAsDependencies.js","names":["isBuiltinModule"],"sources":["../../src/rules/importsAsDependencies.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\nimport {\n  readFileSync,\n} from 'fs';\nimport {\n  isBuiltin as isBuiltinModule,\n} from 'node:module';\nimport {\n  join,\n} from 'path';\n\n/**\n * @type {Set<string>|null}\n */\nlet deps;\n\nconst setDeps = function () {\n  try {\n    const pkg = JSON.parse(\n      // @ts-expect-error It's ok\n      readFileSync(join(process.cwd(), './package.json')),\n    );\n    deps = new Set([\n      ...(pkg.dependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.dependencies) :\n        []),\n      ...(pkg.devDependencies ?\n        /* c8 ignore next 2 */\n        Object.keys(pkg.devDependencies) :\n        []),\n    ]);\n  /* c8 ignore next -- our package.json exists */\n  } catch (error) {\n    /* c8 ignore next -- our package.json exists */\n    deps = null;\n    /* c8 ignore next 4 -- our package.json exists */\n    /* eslint-disable no-console -- Inform user */\n    console.log(error);\n    /* eslint-enable no-console -- Inform user */\n  }\n};\n\nconst moduleCheck = new Map();\n\nexport default iterateJsdoc(({\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  if (deps === undefined) {\n    setDeps();\n  }\n\n  /* c8 ignore next 3 -- our package.json exists */\n  if (deps === null) {\n    return;\n  }\n\n  const {\n    mode,\n  } = settings;\n\n  for (const tag of jsdoc.tags) {\n    let typeAst;\n    try {\n      typeAst = mode === 'permissive' ? tryParse(tag.type) : parse(tag.type, mode);\n    } catch {\n      continue;\n    }\n\n    // eslint-disable-next-line no-loop-func -- Safe\n    traverse(typeAst, (nde) => {\n      /* c8 ignore next 3 -- TS guard */\n      if (deps === null) {\n        return;\n      }\n\n      if (nde.type === 'JsdocTypeImport') {\n        let mod = nde.element.value.replace(\n          /^(@[^\\/]+\\/[^\\/]+|[^\\/]+).*$/v, '$1',\n        );\n\n        if ((/^[.\\/]/v).test(mod)) {\n          return;\n        }\n\n        if (isBuiltinModule(mod)) {\n          // mod = '@types/node';\n          // moduleCheck.set(mod, !deps.has(mod));\n          return;\n        } else if (!moduleCheck.has(mod)) {\n          let pkg;\n          try {\n            pkg = JSON.parse(\n              // @ts-expect-error It's ok\n              readFileSync(join(process.cwd(), 'node_modules', mod, './package.json')),\n            );\n          } catch {\n            // Ignore\n          }\n\n          if (!pkg || (!pkg.types && !pkg.typings)) {\n            mod = `@types/${mod}`;\n          }\n\n          moduleCheck.set(mod, !deps.has(mod));\n        }\n\n        if (moduleCheck.get(mod)) {\n          utils.reportJSDoc(\n            'import points to package which is not found in dependencies',\n            tag,\n          );\n        }\n      }\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies`',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;AAmBA,IAAI;AAEJ,MAAM,UAAU,WAAY;AAC1B,KAAI;EACF,MAAM,MAAM,KAAK,MAEf,aAAa,KAAK,QAAQ,KAAK,EAAE,iBAAiB,CAAC,CACpD;EACD,OAAO,IAAI,IAAI,CACb,GAAI,IAAI,eAEN,OAAO,KAAK,IAAI,aAAa,GAC7B,CAAE,GACJ,GAAI,IAAI,kBAEN,OAAO,KAAK,IAAI,gBAAgB,GAChC,CAAE,CACL;CAEF,SAAQ,OAAO;;EAEd,OAAO;;EAGP,QAAQ,IAAI,MAAM;CAEnB;AACF;AAED,MAAM,8BAAc,IAAI;AAExB,oCAAe,aAAa,CAAC,EAC3B,OACA,UACA,OACD,KAAK;AACJ,KAAI,SAAS,QACX,SAAS;;AAIX,KAAI,SAAS,KACX;CAGF,MAAM,EACJ,MACD,GAAG;AAEJ,MAAK,MAAM,OAAO,MAAM,MAAM;EAC5B,IAAI;AACJ,MAAI;GACF,UAAU,SAAS,eAAe,SAAS,IAAI,KAAK,GAAG,MAAM,IAAI,MAAM,KAAK;EAC7E,QAAO;AACN;EACD;EAGD,SAAS,SAAS,CAAC,QAAQ;;AAEzB,OAAI,SAAS,KACX;AAGF,OAAI,IAAI,SAAS,mBAAmB;IAClC,IAAI,MAAM,IAAI,QAAQ,MAAM,QAC1B,iCAAiC,KAClC;AAED,QAAK,UAAW,KAAK,IAAI,CACvB;AAGF,QAAIA,UAAgB,IAAI,CAGtB;aACS,CAAC,YAAY,IAAI,IAAI,EAAE;KAChC,IAAI;AACJ,SAAI;MACF,MAAM,KAAK,MAET,aAAa,KAAK,QAAQ,KAAK,EAAE,gBAAgB,KAAK,iBAAiB,CAAC,CACzE;KACF,QAAO,CAEP;AAED,SAAI,CAAC,OAAQ,CAAC,IAAI,SAAS,CAAC,IAAI,SAC9B,MAAM,CAAC,OAAO,EAAE,KAAK;KAGvB,YAAY,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC;IACrC;AAED,QAAI,YAAY,IAAI,IAAI,EACtB,MAAM,YACJ,+DACA,IACD;GAEJ;EACF,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/informativeDocs.js

@@ -1,110 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import { areDocsInformative } from "are-docs-informative";
-
-//#region src/rules/informativeDocs.js
-const defaultAliases = { a: ["an", "our"] };
-const defaultUselessWords = [
-	"a",
-	"an",
-	"i",
-	"in",
-	"of",
-	"s",
-	"the"
-];
-/**
-* @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node
-* @returns {string[]}
-*/
-const getNamesFromNode = (node) => {
-	switch (node?.type) {
-		case "AccessorProperty":
-		case "MethodDefinition":
-		case "PropertyDefinition":
-		case "TSAbstractAccessorProperty":
-		case "TSAbstractMethodDefinition":
-		case "TSAbstractPropertyDefinition": return [...getNamesFromNode(
-			/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-			node.parent.parent
-		), ...getNamesFromNode(node.key)];
-		case "ClassDeclaration":
-		case "ClassExpression":
-		case "FunctionDeclaration":
-		case "FunctionExpression":
-		case "TSDeclareFunction":
-		case "TSEnumDeclaration":
-		case "TSEnumMember":
-		case "TSInterfaceDeclaration":
-		case "TSMethodSignature":
-		case "TSModuleDeclaration":
-		case "TSTypeAliasDeclaration": return getNamesFromNode(
-			/** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */
-			node.id
-		);
-		case "ExportDefaultDeclaration":
-		case "ExportNamedDeclaration": return getNamesFromNode(
-			/** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */
-			node.declaration
-		);
-		case "Identifier": return [node.name];
-		case "Property": return getNamesFromNode(node.key);
-		case "VariableDeclaration": return getNamesFromNode(node.declarations[0]);
-		case "VariableDeclarator": return [...getNamesFromNode(node.id), ...getNamesFromNode(node.init)].filter(Boolean);
-		default: return [];
-	}
-};
-var informativeDocs_default = iterateJsdoc(({ context, jsdoc, node, report, utils }) => {
-	const { aliases = defaultAliases, excludedTags = [], uselessWords = defaultUselessWords } = context.options[0] || {};
-	const nodeNames = getNamesFromNode(node);
-	/**
-	* @param {string} text
-	* @param {string} extraName
-	* @returns {boolean}
-	*/
-	const descriptionIsRedundant = (text, extraName = "") => {
-		const textTrimmed = text.trim();
-		return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [extraName, nodeNames].filter(Boolean).join(" "), {
-			aliases,
-			uselessWords
-		});
-	};
-	const { description, lastDescriptionLine } = utils.getDescription();
-	let descriptionReported = false;
-	for (const tag of jsdoc.tags) {
-		if (excludedTags.includes(tag.tag)) continue;
-		if (descriptionIsRedundant(tag.description, tag.name)) utils.reportJSDoc("This tag description only repeats the name it describes.", tag);
-		descriptionReported ||= tag.description === description && tag.line === lastDescriptionLine;
-	}
-	if (!descriptionReported && descriptionIsRedundant(description)) report("This description only repeats the name it describes.");
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "This rule reports doc comments that only restate their attached name.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				aliases: { patternProperties: { ".*": {
-					items: { type: "string" },
-					type: "array"
-				} } },
-				excludedTags: {
-					items: { type: "string" },
-					type: "array"
-				},
-				uselessWords: {
-					items: { type: "string" },
-					type: "array"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { informativeDocs_default as default };
-//# sourceMappingURL=informativeDocs.js.map

package/dist/rules/informativeDocs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"informativeDocs.js","names":[],"sources":["../../src/rules/informativeDocs.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  areDocsInformative,\n} from 'are-docs-informative';\n\nconst defaultAliases = {\n  a: [\n    'an', 'our',\n  ],\n};\n\nconst defaultUselessWords = [\n  'a', 'an', 'i', 'in', 'of', 's', 'the',\n];\n\n/* eslint-disable complexity -- Temporary */\n\n/**\n * @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node\n * @returns {string[]}\n */\nconst getNamesFromNode = (node) => {\n  switch (node?.type) {\n    case 'AccessorProperty':\n    case 'MethodDefinition':\n    case 'PropertyDefinition':\n    case 'TSAbstractAccessorProperty':\n    case 'TSAbstractMethodDefinition':\n    case 'TSAbstractPropertyDefinition':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n            node.parent\n          ).parent,\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.key),\n        ),\n      ];\n\n    case 'ClassDeclaration':\n    case 'ClassExpression':\n    case 'FunctionDeclaration':\n    case 'FunctionExpression':\n    case 'TSDeclareFunction':\n    case 'TSEnumDeclaration':\n    case 'TSEnumMember':\n    case 'TSInterfaceDeclaration':\n    case 'TSMethodSignature':\n    case 'TSModuleDeclaration':\n    case 'TSTypeAliasDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */\n        (node).id,\n      );\n    case 'ExportDefaultDeclaration':\n    case 'ExportNamedDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */\n        (node).declaration,\n      );\n    case 'Identifier':\n      return [\n        node.name,\n      ];\n    case 'Property':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.key),\n      );\n    case 'VariableDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.declarations[0]),\n      );\n    case 'VariableDeclarator':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.id),\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.init),\n        ),\n      ].filter(Boolean);\n    default:\n      return [];\n  }\n};\n/* eslint-enable complexity -- Temporary */\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const /** @type {{aliases: {[key: string]: string[]}, excludedTags: string[], uselessWords: string[]}} */ {\n    aliases = defaultAliases,\n    excludedTags = [],\n    uselessWords = defaultUselessWords,\n  } = context.options[0] || {};\n  const nodeNames = getNamesFromNode(node);\n\n  /**\n   * @param {string} text\n   * @param {string} extraName\n   * @returns {boolean}\n   */\n  const descriptionIsRedundant = (text, extraName = '') => {\n    const textTrimmed = text.trim();\n    return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [\n      extraName, nodeNames,\n    ].filter(Boolean).join(' '), {\n      aliases,\n      uselessWords,\n    });\n  };\n\n  const {\n    description,\n    lastDescriptionLine,\n  } = utils.getDescription();\n  let descriptionReported = false;\n\n  for (const tag of jsdoc.tags) {\n    if (excludedTags.includes(tag.tag)) {\n      continue;\n    }\n\n    if (descriptionIsRedundant(tag.description, tag.name)) {\n      utils.reportJSDoc(\n        'This tag description only repeats the name it describes.',\n        tag,\n      );\n    }\n\n    descriptionReported ||= tag.description === description &&\n      /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */\n      (tag).line === lastDescriptionLine;\n  }\n\n  if (!descriptionReported && descriptionIsRedundant(description)) {\n    report('This description only repeats the name it describes.');\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'This rule reports doc comments that only restate their attached name.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          aliases: {\n            patternProperties: {\n              '.*': {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          uselessWords: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAKA,MAAM,iBAAiB,EACrB,GAAG,CACD,MAAM,KACP,EACF;AAED,MAAM,sBAAsB;CAC1B;CAAK;CAAM;CAAK;CAAM;CAAM;CAAK;AAClC;;;;;AAQD,MAAM,mBAAmB,CAAC,SAAS;AACjC,SAAQ,MAAM,MAAd;EACE,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,+BACH,QAAO,CACL,GAAG;;GAEC,KAAK,OACL;GACH,EACD,GAAG,iBAEA,KAAK,IACP,AACF;EAEH,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,yBACH,QAAO;;GAEJ,KAAM;GACR;EACH,KAAK;EACL,KAAK,yBACH,QAAO;;GAEJ,KAAM;GACR;EACH,KAAK,aACH,QAAO,CACL,KAAK,IACN;EACH,KAAK,WACH,QAAO,iBAEJ,KAAK,IACP;EACH,KAAK,sBACH,QAAO,iBAEJ,KAAK,aAAa,GACpB;EACH,KAAK,qBACH,QAAO,CACL,GAAG,iBAEA,KAAK,GACP,EACD,GAAG,iBAEA,KAAK,KACP,AACF,EAAC,OAAO,QAAQ;EACnB,QACE,QAAO,CAAE;CACZ;AACF;AAGD,8BAAe,aAAa,CAAC,EAC3B,SACA,OACA,MACA,QACA,OACD,KAAK;CACJ,MAA0G,EACxG,UAAU,gBACV,eAAe,CAAE,GACjB,eAAe,qBAChB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,YAAY,iBAAiB,KAAK;;;;;;CAOxC,MAAM,yBAAyB,CAAC,MAAM,YAAY,OAAO;EACvD,MAAM,cAAc,KAAK,MAAM;AAC/B,SAAO,QAAQ,YAAY,IAAI,CAAC,mBAAmB,aAAa,CAC9D,WAAW,SACZ,EAAC,OAAO,QAAQ,CAAC,KAAK,IAAI,EAAE;GAC3B;GACA;EACD,EAAC;CACH;CAED,MAAM,EACJ,aACA,qBACD,GAAG,MAAM,gBAAgB;CAC1B,IAAI,sBAAsB;AAE1B,MAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,MAAI,aAAa,SAAS,IAAI,IAAI,CAChC;AAGF,MAAI,uBAAuB,IAAI,aAAa,IAAI,KAAK,EACnD,MAAM,YACJ,4DACA,IACD;EAGH,wBAAwB,IAAI,gBAAgB,eAEzC,IAAK,SAAS;CAClB;AAED,KAAI,CAAC,uBAAuB,uBAAuB,YAAY,EAC7D,OAAO,uDAAuD;AAEjE,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aACE;GACF,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,SAAS,EACP,mBAAmB,EACjB,MAAM;KACJ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP,EACF,EACF;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}