eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/rules/requireDescriptionCompleteSentence.js

@@ -1,220 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import escapeStringRegexp from "escape-string-regexp";
-
-//#region src/rules/requireDescriptionCompleteSentence.js
-const otherDescriptiveTags = new Set([
-	"classdesc",
-	"deprecated",
-	"exception",
-	"file",
-	"fileoverview",
-	"overview",
-	"summary",
-	"throws",
-	"todo",
-	"yield",
-	"yields"
-]);
-/**
-* @param {string} text
-* @returns {string[]}
-*/
-const extractParagraphs = (text) => {
-	return text.split(/(?<![;:])\n\n+/v);
-};
-/**
-* @param {string} text
-* @param {string|RegExp} abbreviationsRegex
-* @returns {string[]}
-*/
-const extractSentences = (text, abbreviationsRegex) => {
-	const txt = text.replaceAll(/(?<!^)\{[\s\S]*?\}\s*/gv, "").replace(abbreviationsRegex, "");
-	const sentenceEndGrouping = /([.?!])(?:\s+|$)/gv;
-	const puncts = [...txt.matchAll(sentenceEndGrouping)].map((sentEnd) => {
-		return sentEnd[0];
-	});
-	return txt.split(/[.?!](?:\s+|$)/v).map((sentence, idx) => {
-		return !puncts[idx] && /^\s*$/v.test(sentence) ? sentence : `${sentence}${puncts[idx] || ""}`;
-	});
-};
-/**
-* @param {string} text
-* @returns {boolean}
-*/
-const isNewLinePrecededByAPeriod = (text) => {
-	/** @type {boolean} */
-	let lastLineEndsSentence;
-	const lines = text.split("\n");
-	return !lines.some((line) => {
-		if (lastLineEndsSentence === false && /^[A-Z][a-z]/v.test(line)) return true;
-		lastLineEndsSentence = /[.:?!\|]$/v.test(line);
-		return false;
-	});
-};
-/**
-* @param {string} str
-* @returns {boolean}
-*/
-const isCapitalized = (str) => {
-	return str[0] === str[0].toUpperCase();
-};
-/**
-* @param {string} str
-* @returns {boolean}
-*/
-const isTable = (str) => {
-	return str.charAt(0) === "|";
-};
-/**
-* @param {string} str
-* @returns {string}
-*/
-const capitalize = (str) => {
-	return str.charAt(0).toUpperCase() + str.slice(1);
-};
-/**
-* @param {string} description
-* @param {import('../iterateJsdoc.js').Report} reportOrig
-* @param {import('eslint').Rule.Node} jsdocNode
-* @param {string|RegExp} abbreviationsRegex
-* @param {import('eslint').SourceCode} sourceCode
-* @param {import('comment-parser').Spec|{
-*   line: import('../iterateJsdoc.js').Integer
-* }} tag
-* @param {boolean} newlineBeforeCapsAssumesBadSentenceEnd
-* @returns {boolean}
-*/
-const validateDescription = (description, reportOrig, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd) => {
-	if (!description || /^\n+$/v.test(description)) return false;
-	const descriptionNoHeadings = description.replaceAll(/^\s*#[^\n]*(\n|$)/gmv, "");
-	const paragraphs = extractParagraphs(descriptionNoHeadings).filter(Boolean);
-	return paragraphs.some((paragraph, parIdx) => {
-		const sentences = extractSentences(paragraph, abbreviationsRegex);
-		const fix = (fixer) => {
-			let text = sourceCode.getText(jsdocNode);
-			if (!/[.:?!]$/v.test(paragraph)) {
-				const line = paragraph.split("\n").findLast(Boolean);
-				text = text.replace(new RegExp(`${escapeStringRegexp(line)}$`, "mv"), `${line}.`);
-			}
-			for (const sentence of sentences.filter((sentence_) => {
-				return !/^\s*$/v.test(sentence_) && !isCapitalized(sentence_) && !isTable(sentence_);
-			})) {
-				const beginning = sentence.split("\n")[0];
-				if ("tag" in tag && tag.tag) {
-					const reg = new RegExp(`(@${escapeStringRegexp(tag.tag)}.*)${escapeStringRegexp(beginning)}`, "v");
-					text = text.replace(reg, (_$0, $1) => {
-						return $1 + capitalize(beginning);
-					});
-				} else text = text.replace(new RegExp("((?:[.?!]|\\*|\\})\\s*)" + escapeStringRegexp(beginning), "v"), "$1" + capitalize(beginning));
-			}
-			return fixer.replaceText(jsdocNode, text);
-		};
-		/**
-		* @param {string} msg
-		* @param {import('eslint').Rule.ReportFixer | null | undefined} fixer
-		* @param {{
-		*   line?: number | undefined;
-		*   column?: number | undefined;
-		* } | (import('comment-parser').Spec & {
-		*   line?: number | undefined;
-		*   column?: number | undefined;
-		* })} tagObj
-		* @returns {void}
-		*/
-		const report = (msg, fixer, tagObj) => {
-			if ("line" in tagObj)
- /**
-			* @type {{
-			*   line: number;
-			* }}
-			*/ tagObj.line += parIdx * 2;
-			else
- /** @type {import('comment-parser').Spec} */ tagObj.source[0].number += parIdx * 2;
-			tagObj.column = 0;
-			reportOrig(msg, fixer, tagObj);
-		};
-		if (sentences.some((sentence) => {
-			return /^[.?!]$/v.test(sentence);
-		})) report("Sentences must be more than punctuation.", null, tag);
-		if (sentences.some((sentence) => {
-			return !/^\s*$/v.test(sentence) && !isCapitalized(sentence) && !isTable(sentence);
-		})) report("Sentences should start with an uppercase character.", fix, tag);
-		const paragraphNoAbbreviations = paragraph.replace(abbreviationsRegex, "");
-		if (!/(?:[.?!\|]|```)\s*$/v.test(paragraphNoAbbreviations)) {
-			report("Sentences must end with a period.", fix, tag);
-			return true;
-		}
-		if (newlineBeforeCapsAssumesBadSentenceEnd && !isNewLinePrecededByAPeriod(paragraphNoAbbreviations)) {
-			report("A line of text is started with an uppercase character, but the preceding line does not end the sentence.", null, tag);
-			return true;
-		}
-		return false;
-	});
-};
-var requireDescriptionCompleteSentence_default = iterateJsdoc(({ context, jsdoc, jsdocNode, report, sourceCode, utils }) => {
-	const { abbreviations = [], newlineBeforeCapsAssumesBadSentenceEnd = false } = context.options[0] || {};
-	const abbreviationsRegex = abbreviations.length ? new RegExp("\\b" + abbreviations.map((abbreviation) => {
-		return escapeStringRegexp(abbreviation.replaceAll(/\.$/gv, "") + ".");
-	}).join("|") + "(?:$|\\s)", "gv") : "";
-	let { description } = utils.getDescription();
-	const indices = [...description.matchAll(/```[\s\S]*```/gv)].map((match) => {
-		const { index } = match;
-		const [{ length }] = match;
-		return {
-			index,
-			length
-		};
-	}).reverse();
-	for (const { index, length } of indices) description = description.slice(0, index) + description.slice(
-		/** @type {import('../iterateJsdoc.js').Integer} */
-		index + length
-	);
-	if (validateDescription(description, report, jsdocNode, abbreviationsRegex, sourceCode, { line: jsdoc.source[0].number + 1 }, newlineBeforeCapsAssumesBadSentenceEnd)) return;
-	utils.forEachPreferredTag("description", (matchingJsdocTag) => {
-		const desc = `${matchingJsdocTag.name} ${utils.getTagDescription(matchingJsdocTag)}`.trim();
-		validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, matchingJsdocTag, newlineBeforeCapsAssumesBadSentenceEnd);
-	}, true);
-	const { tagsWithNames } = utils.getTagsByType(jsdoc.tags);
-	const tagsWithoutNames = utils.filterTags(({ tag: tagName }) => {
-		return otherDescriptiveTags.has(tagName) || utils.hasOptionTag(tagName) && !tagsWithNames.some(({ tag }) => {
-			return tag === tagName;
-		});
-	});
-	tagsWithNames.some((tag) => {
-		const desc = utils.getTagDescription(tag).replace(/^- /v, "").trimEnd();
-		return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);
-	});
-	tagsWithoutNames.some((tag) => {
-		const desc = `${tag.name} ${utils.getTagDescription(tag)}`.trim();
-		return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires that block description, explicit `@description`, and `@param`/`@returns` tag descriptions are written in complete sentences.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description-complete-sentence.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				abbreviations: {
-					items: { type: "string" },
-					type: "array"
-				},
-				newlineBeforeCapsAssumesBadSentenceEnd: { type: "boolean" },
-				tags: {
-					items: { type: "string" },
-					type: "array"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireDescriptionCompleteSentence_default as default };
-//# sourceMappingURL=requireDescriptionCompleteSentence.js.map

package/dist/rules/requireDescriptionCompleteSentence.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireDescriptionCompleteSentence.js","names":[],"sources":["../../src/rules/requireDescriptionCompleteSentence.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport escapeStringRegexp from 'escape-string-regexp';\n\nconst otherDescriptiveTags = new Set([\n  'classdesc', 'deprecated', 'exception', 'file', 'fileoverview', 'overview',\n  // 'copyright' and 'see' might be good addition, but as the former may be\n  //   sensitive text, and the latter may have just a link, they are not\n  //   included by default\n  'summary', 'throws', 'todo', 'yield', 'yields',\n]);\n\n/**\n * @param {string} text\n * @returns {string[]}\n */\nconst extractParagraphs = (text) => {\n  return text.split(/(?<![;:])\\n\\n+/v);\n};\n\n/**\n * @param {string} text\n * @param {string|RegExp} abbreviationsRegex\n * @returns {string[]}\n */\nconst extractSentences = (text, abbreviationsRegex) => {\n  const txt = text\n    // Remove all {} tags.\n    .replaceAll(/(?<!^)\\{[\\s\\S]*?\\}\\s*/gv, '')\n\n    // Remove custom abbreviations\n    .replace(abbreviationsRegex, '');\n\n  const sentenceEndGrouping = /([.?!])(?:\\s+|$)/gv;\n\n  const puncts = [\n    ...txt.matchAll(sentenceEndGrouping),\n  ].map((sentEnd) => {\n    return sentEnd[0];\n  });\n\n  return txt\n    .split(/[.?!](?:\\s+|$)/v)\n\n    // Re-add the dot.\n    .map((sentence, idx) => {\n      return !puncts[idx] && /^\\s*$/v.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;\n    });\n};\n\n/**\n * @param {string} text\n * @returns {boolean}\n */\nconst isNewLinePrecededByAPeriod = (text) => {\n  /** @type {boolean} */\n  let lastLineEndsSentence;\n\n  const lines = text.split('\\n');\n\n  return !lines.some((line) => {\n    if (lastLineEndsSentence === false && /^[A-Z][a-z]/v.test(line)) {\n      return true;\n    }\n\n    lastLineEndsSentence = /[.:?!\\|]$/v.test(line);\n\n    return false;\n  });\n};\n\n/**\n * @param {string} str\n * @returns {boolean}\n */\nconst isCapitalized = (str) => {\n  return str[0] === str[0].toUpperCase();\n};\n\n/**\n * @param {string} str\n * @returns {boolean}\n */\nconst isTable = (str) => {\n  return str.charAt(0) === '|';\n};\n\n/**\n * @param {string} str\n * @returns {string}\n */\nconst capitalize = (str) => {\n  return str.charAt(0).toUpperCase() + str.slice(1);\n};\n\n/**\n * @param {string} description\n * @param {import('../iterateJsdoc.js').Report} reportOrig\n * @param {import('eslint').Rule.Node} jsdocNode\n * @param {string|RegExp} abbreviationsRegex\n * @param {import('eslint').SourceCode} sourceCode\n * @param {import('comment-parser').Spec|{\n *   line: import('../iterateJsdoc.js').Integer\n * }} tag\n * @param {boolean} newlineBeforeCapsAssumesBadSentenceEnd\n * @returns {boolean}\n */\nconst validateDescription = (\n  description, reportOrig, jsdocNode, abbreviationsRegex,\n  sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd,\n) => {\n  if (!description || (/^\\n+$/v).test(description)) {\n    return false;\n  }\n\n  const descriptionNoHeadings = description.replaceAll(/^\\s*#[^\\n]*(\\n|$)/gmv, '');\n\n  const paragraphs = extractParagraphs(descriptionNoHeadings).filter(Boolean);\n\n  return paragraphs.some((paragraph, parIdx) => {\n    const sentences = extractSentences(paragraph, abbreviationsRegex);\n\n    const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n      let text = sourceCode.getText(jsdocNode);\n\n      if (!/[.:?!]$/v.test(paragraph)) {\n        const line = paragraph.split('\\n').findLast(Boolean);\n        text = text.replace(new RegExp(`${escapeStringRegexp(\n          /** @type {string} */\n          (line),\n        )}$`, 'mv'), `${line}.`);\n      }\n\n      for (const sentence of sentences.filter((sentence_) => {\n        return !(/^\\s*$/v).test(sentence_) && !isCapitalized(sentence_) &&\n          !isTable(sentence_);\n      })) {\n        const beginning = sentence.split('\\n')[0];\n\n        if ('tag' in tag && tag.tag) {\n          const reg = new RegExp(`(@${escapeStringRegexp(tag.tag)}.*)${escapeStringRegexp(beginning)}`, 'v');\n\n          text = text.replace(reg, (_$0, $1) => {\n            return $1 + capitalize(beginning);\n          });\n        } else {\n          text = text.replace(new RegExp('((?:[.?!]|\\\\*|\\\\})\\\\s*)' + escapeStringRegexp(beginning), 'v'), '$1' + capitalize(beginning));\n        }\n      }\n\n      return fixer.replaceText(jsdocNode, text);\n    };\n\n    /**\n     * @param {string} msg\n     * @param {import('eslint').Rule.ReportFixer | null | undefined} fixer\n     * @param {{\n     *   line?: number | undefined;\n     *   column?: number | undefined;\n     * } | (import('comment-parser').Spec & {\n     *   line?: number | undefined;\n     *   column?: number | undefined;\n     * })} tagObj\n     * @returns {void}\n     */\n    const report = (msg, fixer, tagObj) => {\n      if ('line' in tagObj) {\n        /**\n         * @type {{\n         *   line: number;\n         * }}\n         */ (tagObj).line += parIdx * 2;\n      } else {\n        /** @type {import('comment-parser').Spec} */ (\n          tagObj\n        ).source[0].number += parIdx * 2;\n      }\n\n      // Avoid errors if old column doesn't exist here\n      tagObj.column = 0;\n      reportOrig(msg, fixer, tagObj);\n    };\n\n    if (sentences.some((sentence) => {\n      return (/^[.?!]$/v).test(sentence);\n    })) {\n      report('Sentences must be more than punctuation.', null, tag);\n    }\n\n    if (sentences.some((sentence) => {\n      return !(/^\\s*$/v).test(sentence) && !isCapitalized(sentence) && !isTable(sentence);\n    })) {\n      report('Sentences should start with an uppercase character.', fix, tag);\n    }\n\n    const paragraphNoAbbreviations = paragraph.replace(abbreviationsRegex, '');\n\n    if (!/(?:[.?!\\|]|```)\\s*$/v.test(paragraphNoAbbreviations)) {\n      report('Sentences must end with a period.', fix, tag);\n      return true;\n    }\n\n    if (newlineBeforeCapsAssumesBadSentenceEnd && !isNewLinePrecededByAPeriod(paragraphNoAbbreviations)) {\n      report('A line of text is started with an uppercase character, but the preceding line does not end the sentence.', null, tag);\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  jsdocNode,\n  report,\n  sourceCode,\n  utils,\n}) => {\n  const /** @type {{abbreviations: string[], newlineBeforeCapsAssumesBadSentenceEnd: boolean}} */ {\n    abbreviations = [],\n    newlineBeforeCapsAssumesBadSentenceEnd = false,\n  } = context.options[0] || {};\n\n  const abbreviationsRegex = abbreviations.length ?\n    new RegExp('\\\\b' + abbreviations.map((abbreviation) => {\n      return escapeStringRegexp(abbreviation.replaceAll(/\\.$/gv, '') + '.');\n    }).join('|') + '(?:$|\\\\s)', 'gv') :\n    '';\n\n  let {\n    description,\n  } = utils.getDescription();\n\n  const indices = [\n    ...description.matchAll(/```[\\s\\S]*```/gv),\n  ].map((match) => {\n    const {\n      index,\n    } = match;\n    const [\n      {\n        length,\n      },\n    ] = match;\n    return {\n      index,\n      length,\n    };\n  }).reverse();\n\n  for (const {\n    index,\n    length,\n  } of indices) {\n    description = description.slice(0, index) +\n      description.slice(/** @type {import('../iterateJsdoc.js').Integer} */ (\n        index\n      ) + length);\n  }\n\n  if (validateDescription(description, report, jsdocNode, abbreviationsRegex, sourceCode, {\n    line: jsdoc.source[0].number + 1,\n  }, newlineBeforeCapsAssumesBadSentenceEnd)) {\n    return;\n  }\n\n  utils.forEachPreferredTag('description', (matchingJsdocTag) => {\n    const desc = `${matchingJsdocTag.name} ${utils.getTagDescription(matchingJsdocTag)}`.trim();\n    validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, matchingJsdocTag, newlineBeforeCapsAssumesBadSentenceEnd);\n  }, true);\n\n  const {\n    tagsWithNames,\n  } = utils.getTagsByType(jsdoc.tags);\n  const tagsWithoutNames = utils.filterTags(({\n    tag: tagName,\n  }) => {\n    return otherDescriptiveTags.has(tagName) ||\n      utils.hasOptionTag(tagName) && !tagsWithNames.some(({\n        tag,\n      }) => {\n        // If user accidentally adds tags with names (or like `returns`\n        //  get parsed as having names), do not add to this list\n        return tag === tagName;\n      });\n  });\n\n  tagsWithNames.some((tag) => {\n    const desc = /** @type {string} */ (\n      utils.getTagDescription(tag)\n    ).replace(/^- /v, '').trimEnd();\n\n    return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);\n  });\n\n  tagsWithoutNames.some((tag) => {\n    const desc = `${tag.name} ${utils.getTagDescription(tag)}`.trim();\n\n    return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires that block description, explicit `@description`, and `@param`/`@returns` tag descriptions are written in complete sentences.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description-complete-sentence.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          abbreviations: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          newlineBeforeCapsAssumesBadSentenceEnd: {\n            type: 'boolean',\n          },\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":";;;;AAGA,MAAM,uBAAuB,IAAI,IAAI;CACnC;CAAa;CAAc;CAAa;CAAQ;CAAgB;CAIhE;CAAW;CAAU;CAAQ;CAAS;AACvC;;;;;AAMD,MAAM,oBAAoB,CAAC,SAAS;AAClC,QAAO,KAAK,MAAM,kBAAkB;AACrC;;;;;;AAOD,MAAM,mBAAmB,CAAC,MAAM,uBAAuB;CACrD,MAAM,MAAM,KAET,WAAW,2BAA2B,GAAG,CAGzC,QAAQ,oBAAoB,GAAG;CAElC,MAAM,sBAAsB;CAE5B,MAAM,SAAS,CACb,GAAG,IAAI,SAAS,oBAAoB,AACrC,EAAC,IAAI,CAAC,YAAY;AACjB,SAAO,QAAQ;CAChB,EAAC;AAEF,QAAO,IACJ,MAAM,kBAAkB,CAGxB,IAAI,CAAC,UAAU,QAAQ;AACtB,SAAO,CAAC,OAAO,QAAQ,SAAS,KAAK,SAAS,GAAG,WAAW,GAAG,WAAW,OAAO,QAAQ,IAAI;CAC9F,EAAC;AACL;;;;;AAMD,MAAM,6BAA6B,CAAC,SAAS;;CAE3C,IAAI;CAEJ,MAAM,QAAQ,KAAK,MAAM,KAAK;AAE9B,QAAO,CAAC,MAAM,KAAK,CAAC,SAAS;AAC3B,MAAI,yBAAyB,SAAS,eAAe,KAAK,KAAK,CAC7D,QAAO;EAGT,uBAAuB,aAAa,KAAK,KAAK;AAE9C,SAAO;CACR,EAAC;AACH;;;;;AAMD,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,QAAO,IAAI,OAAO,IAAI,GAAG,aAAa;AACvC;;;;;AAMD,MAAM,UAAU,CAAC,QAAQ;AACvB,QAAO,IAAI,OAAO,EAAE,KAAK;AAC1B;;;;;AAMD,MAAM,aAAa,CAAC,QAAQ;AAC1B,QAAO,IAAI,OAAO,EAAE,CAAC,aAAa,GAAG,IAAI,MAAM,EAAE;AAClD;;;;;;;;;;;;;AAcD,MAAM,sBAAsB,CAC1B,aAAa,YAAY,WAAW,oBACpC,YAAY,KAAK,2CACd;AACH,KAAI,CAAC,eAAgB,SAAU,KAAK,YAAY,CAC9C,QAAO;CAGT,MAAM,wBAAwB,YAAY,WAAW,wBAAwB,GAAG;CAEhF,MAAM,aAAa,kBAAkB,sBAAsB,CAAC,OAAO,QAAQ;AAE3E,QAAO,WAAW,KAAK,CAAC,WAAW,WAAW;EAC5C,MAAM,YAAY,iBAAiB,WAAW,mBAAmB;EAEjE,MAAM,MAAuD,CAAC,UAAU;GACtE,IAAI,OAAO,WAAW,QAAQ,UAAU;AAExC,OAAI,CAAC,WAAW,KAAK,UAAU,EAAE;IAC/B,MAAM,OAAO,UAAU,MAAM,KAAK,CAAC,SAAS,QAAQ;IACpD,OAAO,KAAK,QAAQ,IAAI,OAAO,GAAG,mBAE/B,KACF,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC;GACzB;AAED,QAAK,MAAM,YAAY,UAAU,OAAO,CAAC,cAAc;AACrD,WAAO,CAAE,SAAU,KAAK,UAAU,IAAI,CAAC,cAAc,UAAU,IAC7D,CAAC,QAAQ,UAAU;GACtB,EAAC,EAAE;IACF,MAAM,YAAY,SAAS,MAAM,KAAK,CAAC;AAEvC,QAAI,SAAS,OAAO,IAAI,KAAK;KAC3B,MAAM,MAAM,IAAI,OAAO,CAAC,EAAE,EAAE,mBAAmB,IAAI,IAAI,CAAC,GAAG,EAAE,mBAAmB,UAAU,EAAE,EAAE;KAE9F,OAAO,KAAK,QAAQ,KAAK,CAAC,KAAK,OAAO;AACpC,aAAO,KAAK,WAAW,UAAU;KAClC,EAAC;IACH,OACC,OAAO,KAAK,QAAQ,IAAI,OAAO,4BAA4B,mBAAmB,UAAU,EAAE,MAAM,OAAO,WAAW,UAAU,CAAC;GAEhI;AAED,UAAO,MAAM,YAAY,WAAW,KAAK;EAC1C;;;;;;;;;;;;;EAcD,MAAM,SAAS,CAAC,KAAK,OAAO,WAAW;AACrC,OAAI,UAAU;;;;;MAKP,OAAQ,QAAQ,SAAS;;8CAG5B,OACA,OAAO,GAAG,UAAU,SAAS;GAIjC,OAAO,SAAS;GAChB,WAAW,KAAK,OAAO,OAAO;EAC/B;AAED,MAAI,UAAU,KAAK,CAAC,aAAa;AAC/B,UAAQ,WAAY,KAAK,SAAS;EACnC,EAAC,EACA,OAAO,4CAA4C,MAAM,IAAI;AAG/D,MAAI,UAAU,KAAK,CAAC,aAAa;AAC/B,UAAO,CAAE,SAAU,KAAK,SAAS,IAAI,CAAC,cAAc,SAAS,IAAI,CAAC,QAAQ,SAAS;EACpF,EAAC,EACA,OAAO,uDAAuD,KAAK,IAAI;EAGzE,MAAM,2BAA2B,UAAU,QAAQ,oBAAoB,GAAG;AAE1E,MAAI,CAAC,uBAAuB,KAAK,yBAAyB,EAAE;GAC1D,OAAO,qCAAqC,KAAK,IAAI;AACrD,UAAO;EACR;AAED,MAAI,0CAA0C,CAAC,2BAA2B,yBAAyB,EAAE;GACnG,OAAO,4GAA4G,MAAM,IAAI;AAE7H,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH;AAED,iDAAe,aAAa,CAAC,EAC3B,SACA,OACA,WACA,QACA,YACA,OACD,KAAK;CACJ,MAAgG,EAC9F,gBAAgB,CAAE,GAClB,yCAAyC,OAC1C,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,qBAAqB,cAAc,SACvC,IAAI,OAAO,QAAQ,cAAc,IAAI,CAAC,iBAAiB;AACrD,SAAO,mBAAmB,aAAa,WAAW,SAAS,GAAG,GAAG,IAAI;CACtE,EAAC,CAAC,KAAK,IAAI,GAAG,aAAa,QAC5B;CAEF,IAAI,EACF,aACD,GAAG,MAAM,gBAAgB;CAE1B,MAAM,UAAU,CACd,GAAG,YAAY,SAAS,kBAAkB,AAC3C,EAAC,IAAI,CAAC,UAAU;EACf,MAAM,EACJ,OACD,GAAG;EACJ,MAAM,CACJ,EACE,QACD,CACF,GAAG;AACJ,SAAO;GACL;GACA;EACD;CACF,EAAC,CAAC,SAAS;AAEZ,MAAK,MAAM,EACT,OACA,QACD,IAAI,SACH,cAAc,YAAY,MAAM,GAAG,MAAM,GACvC,YAAY;;EACV,QACE;EAAO;AAGf,KAAI,oBAAoB,aAAa,QAAQ,WAAW,oBAAoB,YAAY,EACtF,MAAM,MAAM,OAAO,GAAG,SAAS,EAChC,GAAE,uCAAuC,CACxC;CAGF,MAAM,oBAAoB,eAAe,CAAC,qBAAqB;EAC7D,MAAM,OAAO,GAAG,iBAAiB,KAAK,CAAC,EAAE,MAAM,kBAAkB,iBAAiB,EAAE,CAAC,MAAM;EAC3F,oBAAoB,MAAM,QAAQ,WAAW,oBAAoB,YAAY,kBAAkB,uCAAuC;CACvI,GAAE,KAAK;CAER,MAAM,EACJ,eACD,GAAG,MAAM,cAAc,MAAM,KAAK;CACnC,MAAM,mBAAmB,MAAM,WAAW,CAAC,EACzC,KAAK,SACN,KAAK;AACJ,SAAO,qBAAqB,IAAI,QAAQ,IACtC,MAAM,aAAa,QAAQ,IAAI,CAAC,cAAc,KAAK,CAAC,EAClD,KACD,KAAK;AAGJ,UAAO,QAAQ;EAChB,EAAC;CACL,EAAC;CAEF,cAAc,KAAK,CAAC,QAAQ;EAC1B,MAAM,OACJ,MAAM,kBAAkB,IAAI,CAC5B,QAAQ,QAAQ,GAAG,CAAC,SAAS;AAE/B,SAAO,oBAAoB,MAAM,QAAQ,WAAW,oBAAoB,YAAY,KAAK,uCAAuC;CACjI,EAAC;CAEF,iBAAiB,KAAK,CAAC,QAAQ;EAC7B,MAAM,OAAO,GAAG,IAAI,KAAK,CAAC,EAAE,MAAM,kBAAkB,IAAI,EAAE,CAAC,MAAM;AAEjE,SAAO,oBAAoB,MAAM,QAAQ,WAAW,oBAAoB,YAAY,KAAK,uCAAuC;CACjI,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,eAAe;KACb,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,wCAAwC,EACtC,MAAM,UACP;IACD,MAAM;KACJ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireExample.js

@@ -1,77 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireExample.js
-var requireExample_default = iterateJsdoc(({ context, jsdoc, report, utils }) => {
-	if (utils.avoidDocs()) return;
-	const { enableFixer = true, exemptNoArguments = false } = context.options[0] || {};
-	const targetTagName = "example";
-	const functionExamples = jsdoc.tags.filter(({ tag }) => {
-		return tag === targetTagName;
-	});
-	if (!functionExamples.length) {
-		if (exemptNoArguments && utils.isIteratingFunctionOrVariable() && !utils.hasParams()) return;
-		utils.reportJSDoc(`Missing JSDoc @${targetTagName} declaration.`, null, () => {
-			if (enableFixer) utils.addTag(targetTagName);
-		});
-		return;
-	}
-	for (const example of functionExamples) {
-		const exampleContent = `${example.name} ${utils.getTagDescription(example)}`.trim().split("\n").filter(Boolean);
-		if (!exampleContent.length) report(`Missing JSDoc @${targetTagName} description.`, null, example);
-	}
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that all functions have examples.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-example.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				checkConstructors: {
-					default: true,
-					type: "boolean"
-				},
-				checkGetters: {
-					default: false,
-					type: "boolean"
-				},
-				checkSetters: {
-					default: false,
-					type: "boolean"
-				},
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				enableFixer: {
-					default: true,
-					type: "boolean"
-				},
-				exemptedBy: {
-					items: { type: "string" },
-					type: "array"
-				},
-				exemptNoArguments: {
-					default: false,
-					type: "boolean"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireExample_default as default };
-//# sourceMappingURL=requireExample.js.map

package/dist/rules/requireExample.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireExample.js","names":[],"sources":["../../src/rules/requireExample.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  const {\n    enableFixer = true,\n    exemptNoArguments = false,\n  } = context.options[0] || {};\n\n  const targetTagName = 'example';\n\n  const functionExamples = jsdoc.tags.filter(({\n    tag,\n  }) => {\n    return tag === targetTagName;\n  });\n\n  if (!functionExamples.length) {\n    if (exemptNoArguments && utils.isIteratingFunctionOrVariable() &&\n      !utils.hasParams()\n    ) {\n      return;\n    }\n\n    utils.reportJSDoc(`Missing JSDoc @${targetTagName} declaration.`, null, () => {\n      if (enableFixer) {\n        utils.addTag(targetTagName);\n      }\n    });\n\n    return;\n  }\n\n  for (const example of functionExamples) {\n    const exampleContent = `${example.name} ${utils.getTagDescription(example)}`\n      .trim()\n      .split('\\n')\n      .filter(Boolean);\n\n    if (!exampleContent.length) {\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 examples.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-example.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: false,\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          enableFixer: {\n            default: true,\n            type: 'boolean',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          exemptNoArguments: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,6BAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;AACJ,KAAI,MAAM,WAAW,CACnB;CAGF,MAAM,EACJ,cAAc,MACd,oBAAoB,OACrB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,gBAAgB;CAEtB,MAAM,mBAAmB,MAAM,KAAK,OAAO,CAAC,EAC1C,KACD,KAAK;AACJ,SAAO,QAAQ;CAChB,EAAC;AAEF,KAAI,CAAC,iBAAiB,QAAQ;AAC5B,MAAI,qBAAqB,MAAM,+BAA+B,IAC5D,CAAC,MAAM,WAAW,CAElB;EAGF,MAAM,YAAY,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,MAAM;AAC5E,OAAI,aACF,MAAM,OAAO,cAAc;EAE9B,EAAC;AAEF;CACD;AAED,MAAK,MAAM,WAAW,kBAAkB;EACtC,MAAM,iBAAiB,GAAG,QAAQ,KAAK,CAAC,EAAE,MAAM,kBAAkB,QAAQ,EAAE,CACzE,MAAM,CACN,MAAM,KAAK,CACX,OAAO,QAAQ;AAElB,MAAI,CAAC,eAAe,QAClB,OAAO,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,QAAQ;CAExE;AACF,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,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,aAAa;KACX,SAAS;KACT,MAAM;IACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireFileOverview.js

@@ -1,81 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireFileOverview.js
-const defaultTags = { file: {
-	initialCommentsOnly: true,
-	mustExist: true,
-	preventDuplicates: true
-} };
-/**
-* @param {import('../iterateJsdoc.js').StateObject} state
-* @returns {void}
-*/
-const setDefaults = (state) => {
-	if (!state.globalTags) {
-		state.globalTags = {};
-		state.hasDuplicates = {};
-		state.hasTag = {};
-		state.hasNonCommentBeforeTag = {};
-	}
-};
-var requireFileOverview_default = iterateJsdoc(({ context, jsdocNode, state, utils }) => {
-	const { tags = defaultTags } = context.options[0] || {};
-	setDefaults(state);
-	for (const tagName of Object.keys(tags)) {
-		const targetTagName = utils.getPreferredTagName({ tagName });
-		const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));
-		state.hasTag[tagName] = hasTag || state.hasTag[tagName];
-		const hasDuplicate = state.hasDuplicates[tagName];
-		if (hasDuplicate === false) state.hasDuplicates[tagName] = hasTag;
-		else if (!hasDuplicate && hasTag) {
-			state.hasDuplicates[tagName] = false;
-			state.hasNonCommentBeforeTag[tagName] = state.hasNonComment && state.hasNonComment < jsdocNode.range[0];
-		}
-	}
-}, {
-	exit({ context, state, utils }) {
-		setDefaults(state);
-		const { tags = defaultTags } = context.options[0] || {};
-		for (const [tagName, { initialCommentsOnly = false, mustExist = false, preventDuplicates = false }] of Object.entries(tags)) {
-			const obj = utils.getPreferredTagNameObject({ tagName });
-			if (obj && typeof obj === "object" && "blocked" in obj) utils.reportSettings(`\`settings.jsdoc.tagNamePreference\` cannot block @${obj.tagName} for the \`require-file-overview\` rule`);
-			else {
-				const targetTagName = obj && typeof obj === "object" && obj.replacement || obj;
-				if (mustExist && !state.hasTag[tagName]) utils.reportSettings(`Missing @${targetTagName}`);
-				if (preventDuplicates && state.hasDuplicates[tagName]) utils.reportSettings(`Duplicate @${targetTagName}`);
-				if (initialCommentsOnly && state.hasNonCommentBeforeTag[tagName]) utils.reportSettings(`@${targetTagName} should be at the beginning of the file`);
-			}
-		}
-	},
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { tags: {
-				patternProperties: { ".*": {
-					additionalProperties: false,
-					properties: {
-						initialCommentsOnly: { type: "boolean" },
-						mustExist: { type: "boolean" },
-						preventDuplicates: { type: "boolean" }
-					},
-					type: "object"
-				} },
-				type: "object"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	},
-	nonComment({ node, state }) {
-		if (!state.hasNonComment) state.hasNonComment = node.range[0];
-	}
-});
-
-//#endregion
-export { requireFileOverview_default as default };
-//# sourceMappingURL=requireFileOverview.js.map

package/dist/rules/requireFileOverview.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireFileOverview.js","names":[],"sources":["../../src/rules/requireFileOverview.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultTags = {\n  file: {\n    initialCommentsOnly: true,\n    mustExist: true,\n    preventDuplicates: true,\n  },\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n  // First iteration\n  if (!state.globalTags) {\n    state.globalTags = {};\n    state.hasDuplicates = {};\n    state.hasTag = {};\n    state.hasNonCommentBeforeTag = {};\n  }\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  state,\n  utils,\n}) => {\n  const {\n    tags = defaultTags,\n  } = context.options[0] || {};\n\n  setDefaults(state);\n\n  for (const tagName of Object.keys(tags)) {\n    const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName,\n    }));\n\n    const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));\n\n    state.hasTag[tagName] = hasTag || state.hasTag[tagName];\n\n    const hasDuplicate = state.hasDuplicates[tagName];\n\n    if (hasDuplicate === false) {\n      // Was marked before, so if a tag now, is a dupe\n      state.hasDuplicates[tagName] = hasTag;\n    } else if (!hasDuplicate && hasTag) {\n      // No dupes set before, but has first tag, so change state\n      //   from `undefined` to `false` so can detect next time\n      state.hasDuplicates[tagName] = false;\n      state.hasNonCommentBeforeTag[tagName] = state.hasNonComment &&\n        state.hasNonComment < jsdocNode.range[0];\n    }\n  }\n}, {\n  exit ({\n    context,\n    state,\n    utils,\n  }) {\n    setDefaults(state);\n    const {\n      tags = defaultTags,\n    } = context.options[0] || {};\n\n    for (const [\n      tagName,\n      {\n        initialCommentsOnly = false,\n        mustExist = false,\n        preventDuplicates = false,\n      },\n    ] of Object.entries(tags)) {\n      const obj = utils.getPreferredTagNameObject({\n        tagName,\n      });\n      if (obj && typeof obj === 'object' && 'blocked' in obj) {\n        utils.reportSettings(\n          `\\`settings.jsdoc.tagNamePreference\\` cannot block @${obj.tagName} ` +\n          'for the `require-file-overview` rule',\n        );\n      } else {\n        const targetTagName = (\n          obj && typeof obj === 'object' && obj.replacement\n        ) || obj;\n        if (mustExist && !state.hasTag[tagName]) {\n          utils.reportSettings(`Missing @${targetTagName}`);\n        }\n\n        if (preventDuplicates && state.hasDuplicates[tagName]) {\n          utils.reportSettings(\n            `Duplicate @${targetTagName}`,\n          );\n        }\n\n        if (initialCommentsOnly &&\n            state.hasNonCommentBeforeTag[tagName]\n        ) {\n          utils.reportSettings(\n            `@${targetTagName} should be at the beginning of the file`,\n          );\n        }\n      }\n    }\n  },\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            patternProperties: {\n              '.*': {\n                additionalProperties: false,\n                properties: {\n                  initialCommentsOnly: {\n                    type: 'boolean',\n                  },\n                  mustExist: {\n                    type: 'boolean',\n                  },\n                  preventDuplicates: {\n                    type: 'boolean',\n                  },\n                },\n                type: 'object',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n  nonComment ({\n    node,\n    state,\n  }) {\n    if (!state.hasNonComment) {\n      state.hasNonComment = node.range[0];\n    }\n  },\n});\n"],"mappings":";;;AAEA,MAAM,cAAc,EAClB,MAAM;CACJ,qBAAqB;CACrB,WAAW;CACX,mBAAmB;AACpB,EACF;;;;;AAMD,MAAM,cAAc,CAAC,UAAU;AAE7B,KAAI,CAAC,MAAM,YAAY;EACrB,MAAM,aAAa,CAAE;EACrB,MAAM,gBAAgB,CAAE;EACxB,MAAM,SAAS,CAAE;EACjB,MAAM,yBAAyB,CAAE;CAClC;AACF;AAED,kCAAe,aAAa,CAAC,EAC3B,SACA,WACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,OAAO,aACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,YAAY,MAAM;AAElB,MAAK,MAAM,WAAW,OAAO,KAAK,KAAK,EAAE;EACvC,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,QACD,EAAC;EAEF,MAAM,SAAS,QAAQ,iBAAiB,MAAM,OAAO,cAAc,CAAC;EAEpE,MAAM,OAAO,WAAW,UAAU,MAAM,OAAO;EAE/C,MAAM,eAAe,MAAM,cAAc;AAEzC,MAAI,iBAAiB,OAEnB,MAAM,cAAc,WAAW;WACtB,CAAC,gBAAgB,QAAQ;GAGlC,MAAM,cAAc,WAAW;GAC/B,MAAM,uBAAuB,WAAW,MAAM,iBAC5C,MAAM,gBAAgB,UAAU,MAAM;EACzC;CACF;AACF,GAAE;CACD,KAAM,EACJ,SACA,OACA,OACD,EAAE;EACD,YAAY,MAAM;EAClB,MAAM,EACJ,OAAO,aACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,OAAK,MAAM,CACT,SACA,EACE,sBAAsB,OACtB,YAAY,OACZ,oBAAoB,OACrB,CACF,IAAI,OAAO,QAAQ,KAAK,EAAE;GACzB,MAAM,MAAM,MAAM,0BAA0B,EAC1C,QACD,EAAC;AACF,OAAI,OAAO,OAAO,QAAQ,YAAY,aAAa,KACjD,MAAM,eACJ,CAAC,mDAAmD,EAAE,IAAI,QAAQ,uCAAC,CAC7B,CACvC;QACI;IACL,MAAM,gBACJ,OAAO,OAAO,QAAQ,YAAY,IAAI,eACnC;AACL,QAAI,aAAa,CAAC,MAAM,OAAO,UAC7B,MAAM,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC;AAGnD,QAAI,qBAAqB,MAAM,cAAc,UAC3C,MAAM,eACJ,CAAC,WAAW,EAAE,eAAe,CAC9B;AAGH,QAAI,uBACA,MAAM,uBAAuB,UAE/B,MAAM,eACJ,CAAC,CAAC,EAAE,cAAc,uCAAuC,CAAC,CAC3D;GAEJ;EACF;CACF;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,mBAAmB,EACjB,MAAM;KACJ,sBAAsB;KACtB,YAAY;MACV,qBAAqB,EACnB,MAAM,UACP;MACD,WAAW,EACT,MAAM,UACP;MACD,mBAAmB,EACjB,MAAM,UACP;KACF;KACD,MAAM;IACP,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;CACD,WAAY,EACV,MACA,OACD,EAAE;AACD,MAAI,CAAC,MAAM,eACT,MAAM,gBAAgB,KAAK,MAAM;CAEpC;AACF,EAAC"}

package/dist/rules/requireHyphenBeforeParamDescription.js

@@ -1,89 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireHyphenBeforeParamDescription.js
-var requireHyphenBeforeParamDescription_default = iterateJsdoc(({ context, jsdoc, utils }) => {
-	const [mainCircumstance, { tags = null } = {}] = context.options;
-	const tgs = tags;
-	/**
-	* @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} jsdocTag
-	* @param {string} targetTagName
-	* @param {"always"|"never"} [circumstance]
-	* @returns {void}
-	*/
-	const checkHyphens = (jsdocTag, targetTagName, circumstance = mainCircumstance) => {
-		const always = !circumstance || circumstance === "always";
-		const desc = utils.getTagDescription(jsdocTag);
-		if (!desc.trim()) return;
-		const startsWithHyphen = /^\s*-/v.test(desc);
-		let lines = 0;
-		for (const { tokens } of jsdocTag.source) {
-			if (tokens.description) break;
-			lines++;
-		}
-		if (always) {
-			if (!startsWithHyphen) utils.reportJSDoc(`There must be a hyphen before @${targetTagName} description.`, { line: jsdocTag.source[0].number + lines }, () => {
-				for (const { tokens } of jsdocTag.source) if (tokens.description) {
-					tokens.description = tokens.description.replace(/^(\s*)/v, "$1- ");
-					break;
-				}
-			});
-		} else if (startsWithHyphen) utils.reportJSDoc(`There must be no hyphen before @${targetTagName} description.`, { line: jsdocTag.source[0].number + lines }, () => {
-			for (const { tokens } of jsdocTag.source) if (tokens.description) {
-				tokens.description = tokens.description.replace(/^\s*-\s*/v, "");
-				break;
-			}
-		}, true);
-	};
-	utils.forEachPreferredTag("param", checkHyphens);
-	if (tgs) {
-		const tagEntries = Object.entries(tgs);
-		for (const [tagName, circumstance] of tagEntries) {
-			if (tagName === "*") {
-				const preferredParamTag = utils.getPreferredTagName({ tagName: "param" });
-				for (const { tag } of jsdoc.tags) {
-					if (tag === preferredParamTag || tagEntries.some(([tagNme]) => {
-						return tagNme !== "*" && tagNme === tag;
-					})) continue;
-					utils.forEachPreferredTag(tag, (jsdocTag, targetTagName) => {
-						checkHyphens(jsdocTag, targetTagName, circumstance);
-					});
-				}
-				continue;
-			}
-			utils.forEachPreferredTag(tagName, (jsdocTag, targetTagName) => {
-				checkHyphens(jsdocTag, targetTagName, circumstance);
-			});
-		}
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires a hyphen before the `@param` description.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			enum: ["always", "never"],
-			type: "string"
-		}, {
-			additionalProperties: false,
-			properties: { tags: { anyOf: [{
-				patternProperties: { ".*": {
-					enum: ["always", "never"],
-					type: "string"
-				} },
-				type: "object"
-			}, {
-				enum: ["any"],
-				type: "string"
-			}] } },
-			type: "object"
-		}],
-		type: "layout"
-	}
-});
-
-//#endregion
-export { requireHyphenBeforeParamDescription_default as default };
-//# sourceMappingURL=requireHyphenBeforeParamDescription.js.map

package/dist/rules/requireHyphenBeforeParamDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireHyphenBeforeParamDescription.js","names":[],"sources":["../../src/rules/requireHyphenBeforeParamDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    mainCircumstance,\n    {\n      tags = null,\n    } = {},\n  ] = context.options;\n\n  const tgs = /**\n               * @type {null|\"any\"|{[key: string]: \"always\"|\"never\"}}\n               */ (tags);\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} jsdocTag\n   * @param {string} targetTagName\n   * @param {\"always\"|\"never\"} [circumstance]\n   * @returns {void}\n   */\n  const checkHyphens = (jsdocTag, targetTagName, circumstance = mainCircumstance) => {\n    const always = !circumstance || circumstance === 'always';\n    const desc = /** @type {string} */ (utils.getTagDescription(jsdocTag));\n    if (!desc.trim()) {\n      return;\n    }\n\n    const startsWithHyphen = (/^\\s*-/v).test(desc);\n    let lines = 0;\n    for (const {\n      tokens,\n    } of jsdocTag.source) {\n      if (tokens.description) {\n        break;\n      }\n\n      lines++;\n    }\n\n    if (always) {\n      if (!startsWithHyphen) {\n        utils.reportJSDoc(\n          `There must be a hyphen before @${targetTagName} description.`,\n          {\n            line: jsdocTag.source[0].number + lines,\n          },\n          () => {\n            for (const {\n              tokens,\n            } of jsdocTag.source) {\n              if (tokens.description) {\n                tokens.description = tokens.description.replace(\n                  /^(\\s*)/v, '$1- ',\n                );\n                break;\n              }\n            }\n          },\n        );\n      }\n    } else if (startsWithHyphen) {\n      utils.reportJSDoc(\n        `There must be no hyphen before @${targetTagName} description.`,\n        {\n          line: jsdocTag.source[0].number + lines,\n        },\n        () => {\n          for (const {\n            tokens,\n          } of jsdocTag.source) {\n            if (tokens.description) {\n              tokens.description = tokens.description.replace(\n                /^\\s*-\\s*/v, '',\n              );\n              break;\n            }\n          }\n        },\n        true,\n      );\n    }\n  };\n\n  utils.forEachPreferredTag('param', checkHyphens);\n  if (tgs) {\n    const tagEntries = Object.entries(tgs);\n    for (const [\n      tagName,\n      circumstance,\n    ] of tagEntries) {\n      if (tagName === '*') {\n        const preferredParamTag = utils.getPreferredTagName({\n          tagName: 'param',\n        });\n        for (const {\n          tag,\n        } of jsdoc.tags) {\n          if (tag === preferredParamTag || tagEntries.some(([\n            tagNme,\n          ]) => {\n            return tagNme !== '*' && tagNme === tag;\n          })) {\n            continue;\n          }\n\n          utils.forEachPreferredTag(tag, (jsdocTag, targetTagName) => {\n            checkHyphens(\n              jsdocTag,\n              targetTagName,\n              /** @type {\"always\"|\"never\"} */ (circumstance),\n            );\n          });\n        }\n\n        continue;\n      }\n\n      utils.forEachPreferredTag(tagName, (jsdocTag, targetTagName) => {\n        checkHyphens(\n          jsdocTag,\n          targetTagName,\n          /** @type {\"always\"|\"never\"} */ (circumstance),\n        );\n      });\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires a hyphen before the `@param` description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            anyOf: [\n              {\n                patternProperties: {\n                  '.*': {\n                    enum: [\n                      'always', 'never',\n                    ],\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n              {\n                enum: [\n                  'any',\n                ],\n                type: 'string',\n              },\n            ],\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;AAEA,kDAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,CACJ,kBACA,EACE,OAAO,MACR,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,MAAM,MAEW;;;;;;;CAQjB,MAAM,eAAe,CAAC,UAAU,eAAe,eAAe,qBAAqB;EACjF,MAAM,SAAS,CAAC,gBAAgB,iBAAiB;EACjD,MAAM,OAA8B,MAAM,kBAAkB,SAAS;AACrE,MAAI,CAAC,KAAK,MAAM,CACd;EAGF,MAAM,mBAAoB,SAAU,KAAK,KAAK;EAC9C,IAAI,QAAQ;AACZ,OAAK,MAAM,EACT,QACD,IAAI,SAAS,QAAQ;AACpB,OAAI,OAAO,YACT;GAGF;EACD;AAED,MAAI,QACF;OAAI,CAAC,kBACH,MAAM,YACJ,CAAC,+BAA+B,EAAE,cAAc,aAAa,CAAC,EAC9D,EACE,MAAM,SAAS,OAAO,GAAG,SAAS,MACnC,GACD,MAAM;AACJ,SAAK,MAAM,EACT,QACD,IAAI,SAAS,OACZ,KAAI,OAAO,aAAa;KACtB,OAAO,cAAc,OAAO,YAAY,QACtC,WAAW,OACZ;AACD;IACD;GAEJ,EACF;EACF,WACQ,kBACT,MAAM,YACJ,CAAC,gCAAgC,EAAE,cAAc,aAAa,CAAC,EAC/D,EACE,MAAM,SAAS,OAAO,GAAG,SAAS,MACnC,GACD,MAAM;AACJ,QAAK,MAAM,EACT,QACD,IAAI,SAAS,OACZ,KAAI,OAAO,aAAa;IACtB,OAAO,cAAc,OAAO,YAAY,QACtC,aAAa,GACd;AACD;GACD;EAEJ,GACD,KACD;CAEJ;CAED,MAAM,oBAAoB,SAAS,aAAa;AAChD,KAAI,KAAK;EACP,MAAM,aAAa,OAAO,QAAQ,IAAI;AACtC,OAAK,MAAM,CACT,SACA,aACD,IAAI,YAAY;AACf,OAAI,YAAY,KAAK;IACnB,MAAM,oBAAoB,MAAM,oBAAoB,EAClD,SAAS,QACV,EAAC;AACF,SAAK,MAAM,EACT,KACD,IAAI,MAAM,MAAM;AACf,SAAI,QAAQ,qBAAqB,WAAW,KAAK,CAAC,CAChD,OACD,KAAK;AACJ,aAAO,WAAW,OAAO,WAAW;KACrC,EAAC,CACA;KAGF,MAAM,oBAAoB,KAAK,CAAC,UAAU,kBAAkB;MAC1D,aACE,UACA,eACiC,aAClC;KACF,EAAC;IACH;AAED;GACD;GAED,MAAM,oBAAoB,SAAS,CAAC,UAAU,kBAAkB;IAC9D,aACE,UACA,eACiC,aAClC;GACF,EAAC;EACH;CACF;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM,CACJ,UAAU,OACX;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM,EACJ,OAAO,CACL;IACE,mBAAmB,EACjB,MAAM;KACJ,MAAM,CACJ,UAAU,OACX;KACD,MAAM;IACP,EACF;IACD,MAAM;GACP,GACD;IACE,MAAM,CACJ,KACD;IACD,MAAM;GACP,CACF,EACF,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}