eslint-plugin-jsdoc 52.0.4 → 53.0.1

package/dist/rules/requireDescriptionCompleteSentence.js

@@ -0,0 +1,220 @@
+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

@@ -0,0 +1 @@
+{"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.cjs

@@ -1,108 +1,77 @@
-"use strict";
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  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.isIteratingFunction() && !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);
-    }
-  }
+//#region src/rules/requireExample.js
+var requireExample_default = require_iterateJsdoc.default(({ 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'
-  }
+	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"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireExample_default;
 //# sourceMappingURL=requireExample.cjs.map

package/dist/rules/requireExample.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireExample.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","jsdoc","report","utils","avoidDocs","enableFixer","exemptNoArguments","options","targetTagName","functionExamples","tags","filter","tag","length","isIteratingFunction","hasParams","reportJSDoc","addTag","example","exampleContent","name","getTagDescription","trim","split","Boolean","contextDefaults","meta","docs","description","url","fixable","schema","additionalProperties","properties","checkConstructors","type","checkGetters","checkSetters","contexts","items","anyOf","comment","exemptedBy","module"],"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.isIteratingFunction() &&\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":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,IAAIA,KAAK,CAACC,SAAS,CAAC,CAAC,EAAE;IACrB;EACF;EAEA,MAAM;IACJC,WAAW,GAAG,IAAI;IAClBC,iBAAiB,GAAG;EACtB,CAAC,GAAGN,OAAO,CAACO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAMC,aAAa,GAAG,SAAS;EAE/B,MAAMC,gBAAgB,GAAGR,KAAK,CAACS,IAAI,CAACC,MAAM,CAAC,CAAC;IAC1CC;EACF,CAAC,KAAK;IACJ,OAAOA,GAAG,KAAKJ,aAAa;EAC9B,CAAC,CAAC;EAEF,IAAI,CAACC,gBAAgB,CAACI,MAAM,EAAE;IAC5B,IAAIP,iBAAiB,IAAIH,KAAK,CAACW,mBAAmB,CAAC,CAAC,IAClD,CAACX,KAAK,CAACY,SAAS,CAAC,CAAC,EAClB;MACA;IACF;IAEAZ,KAAK,CAACa,WAAW,CAAC,kBAAkBR,aAAa,eAAe,EAAE,IAAI,EAAE,MAAM;MAC5E,IAAIH,WAAW,EAAE;QACfF,KAAK,CAACc,MAAM,CAACT,aAAa,CAAC;MAC7B;IACF,CAAC,CAAC;IAEF;EACF;EAEA,KAAK,MAAMU,OAAO,IAAIT,gBAAgB,EAAE;IACtC,MAAMU,cAAc,GAAG,GAAGD,OAAO,CAACE,IAAI,IAAIjB,KAAK,CAACkB,iBAAiB,CAACH,OAAO,CAAC,EAAE,CACzEI,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAAC,CACXZ,MAAM,CAACa,OAAO,CAAC;IAElB,IAAI,CAACL,cAAc,CAACN,MAAM,EAAE;MAC1BX,MAAM,CAAC,kBAAkBM,aAAa,eAAe,EAAE,IAAI,EAAEU,OAAO,CAAC;IACvE;EACF;AACF,CAAC,EAAE;EACDO,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,4CAA4C;MACzDC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,iBAAiB,EAAE;UACjBtC,OAAO,EAAE,IAAI;UACbuC,IAAI,EAAE;QACR,CAAC;QACDC,YAAY,EAAE;UACZxC,OAAO,EAAE,KAAK;UACduC,IAAI,EAAE;QACR,CAAC;QACDE,YAAY,EAAE;UACZzC,OAAO,EAAE,KAAK;UACduC,IAAI,EAAE;QACR,CAAC;QACDG,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEL,IAAI,EAAE;YACR,CAAC,EACD;cACEH,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVQ,OAAO,EAAE;kBACPN,IAAI,EAAE;gBACR,CAAC;gBACDnC,OAAO,EAAE;kBACPmC,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD9B,WAAW,EAAE;UACXT,OAAO,EAAE,IAAI;UACbuC,IAAI,EAAE;QACR,CAAC;QACDO,UAAU,EAAE;UACVH,KAAK,EAAE;YACLJ,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD7B,iBAAiB,EAAE;UACjBV,OAAO,EAAE,KAAK;UACduC,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAQ,MAAA,CAAA7C,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"requireExample.cjs","names":["iterateJsdoc"],"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,6BAAeA,6BAAa,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/requireExample.js

@@ -0,0 +1,77 @@
+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

@@ -0,0 +1 @@
+{"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"}