eslint-plugin-jsdoc 52.0.4 → 53.0.1

package/dist/rules/requireDescriptionCompleteSentence.cjs

@@ -1,282 +1,221 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _escapeStringRegexp = _interopRequireDefault(require("escape-string-regexp"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const otherDescriptiveTags = new Set(['classdesc', 'deprecated', 'exception', 'file', 'fileoverview', 'overview',
-// 'copyright' and 'see' might be good addition, but as the former may be
-//   sensitive text, and the latter may have just a link, they are not
-//   included by default
-'summary', 'throws', 'todo', 'yield', 'yields']);
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+const escape_string_regexp = require_rolldown_runtime.__toESM(require("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
+* @returns {string[]}
+*/
+const extractParagraphs = (text) => {
+	return text.split(/(?<![;:])\n\n+/v);
 };
-
 /**
- * @param {string} text
- * @param {string|RegExp} abbreviationsRegex
- * @returns {string[]}
- */
+* @param {string} text
+* @param {string|RegExp} abbreviationsRegex
+* @returns {string[]}
+*/
 const extractSentences = (text, abbreviationsRegex) => {
-  const txt = text
-  // Remove all {} tags.
-  .replaceAll(/(?<!^)\{[\s\S]*?\}\s*/gv, '')
-
-  // Remove custom abbreviations
-  .replace(abbreviationsRegex, '');
-  const sentenceEndGrouping = /([.?!])(?:\s+|$)/gv;
-  const puncts = [...txt.matchAll(sentenceEndGrouping)].map(sentEnd => {
-    return sentEnd[0];
-  });
-  return txt.split(/[.?!](?:\s+|$)/v)
-
-  // Re-add the dot.
-  .map((sentence, idx) => {
-    return !puncts[idx] && /^\s*$/v.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;
-  });
+	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} 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 isCapitalized = (str) => {
+	return str[0] === str[0].toUpperCase();
 };
-
 /**
- * @param {string} str
- * @returns {boolean}
- */
-const isTable = str => {
-  return str.charAt(0) === '|';
+* @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} 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}
- */
+* @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 = /** @type {import('eslint').Rule.ReportFixer} */fixer => {
-      let text = sourceCode.getText(jsdocNode);
-      if (!/[.:?!]$/v.test(paragraph)) {
-        const line = paragraph.split('\n').findLast(Boolean);
-        text = text.replace(new RegExp(`${(0, _escapeStringRegexp.default)(/** @type {string} */
-        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(`(@${(0, _escapeStringRegexp.default)(tag.tag)}.*)${(0, _escapeStringRegexp.default)(beginning)}`, 'v');
-          text = text.replace(reg, (_$0, $1) => {
-            return $1 + capitalize(beginning);
-          });
-        } else {
-          text = text.replace(new RegExp('((?:[.?!]|\\*|\\})\\s*)' + (0, _escapeStringRegexp.default)(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;
-      }
-
-      // Avoid errors if old column doesn't exist here
-      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;
-  });
+	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(`${(0, escape_string_regexp.default)(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(`(@${(0, escape_string_regexp.default)(tag.tag)}.*)${(0, escape_string_regexp.default)(beginning)}`, "v");
+					text = text.replace(reg, (_$0, $1) => {
+						return $1 + capitalize(beginning);
+					});
+				} else text = text.replace(new RegExp("((?:[.?!]|\\*|\\})\\s*)" + (0, escape_string_regexp.default)(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 _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  jsdocNode,
-  report,
-  sourceCode,
-  utils
-}) => {
-  const /** @type {{abbreviations: string[], newlineBeforeCapsAssumesBadSentenceEnd: boolean}} */{
-    abbreviations = [],
-    newlineBeforeCapsAssumesBadSentenceEnd = false
-  } = context.options[0] || {};
-  const abbreviationsRegex = abbreviations.length ? new RegExp('\\b' + abbreviations.map(abbreviation => {
-    return (0, _escapeStringRegexp.default)(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
-    }) => {
-      // If user accidentally adds tags with names (or like `returns`
-      //  get parsed as having names), do not add to this list
-      return tag === tagName;
-    });
-  });
-  tagsWithNames.some(tag => {
-    const desc = /** @type {string} */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);
-  });
+var requireDescriptionCompleteSentence_default = require_iterateJsdoc.default(({ context, jsdoc, jsdocNode, report, sourceCode, utils }) => {
+	const { abbreviations = [], newlineBeforeCapsAssumesBadSentenceEnd = false } = context.options[0] || {};
+	const abbreviationsRegex = abbreviations.length ? new RegExp("\\b" + abbreviations.map((abbreviation) => {
+		return (0, escape_string_regexp.default)(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'
-  }
+	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"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireDescriptionCompleteSentence_default;
 //# sourceMappingURL=requireDescriptionCompleteSentence.cjs.map

package/dist/rules/requireDescriptionCompleteSentence.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireDescriptionCompleteSentence.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_escapeStringRegexp","e","__esModule","default","otherDescriptiveTags","Set","extractParagraphs","text","split","extractSentences","abbreviationsRegex","txt","replaceAll","replace","sentenceEndGrouping","puncts","matchAll","map","sentEnd","sentence","idx","test","isNewLinePrecededByAPeriod","lastLineEndsSentence","lines","some","line","isCapitalized","str","toUpperCase","isTable","charAt","capitalize","slice","validateDescription","description","reportOrig","jsdocNode","sourceCode","tag","newlineBeforeCapsAssumesBadSentenceEnd","descriptionNoHeadings","paragraphs","filter","Boolean","paragraph","parIdx","sentences","fix","fixer","getText","findLast","RegExp","escapeStringRegexp","sentence_","beginning","reg","_$0","$1","replaceText","report","msg","tagObj","source","number","column","paragraphNoAbbreviations","_default","exports","iterateJsdoc","context","jsdoc","utils","abbreviations","options","length","abbreviation","join","getDescription","indices","match","index","reverse","forEachPreferredTag","matchingJsdocTag","desc","name","getTagDescription","trim","tagsWithNames","getTagsByType","tags","tagsWithoutNames","filterTags","tagName","has","hasOptionTag","trimEnd","iterateAllJsdocs","meta","docs","url","fixable","schema","additionalProperties","properties","items","type","module"],"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":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,mBAAA,GAAAF,sBAAA,CAAAC,OAAA;AAAsD,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEtD,MAAMG,oBAAoB,GAAG,IAAIC,GAAG,CAAC,CACnC,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU;AAC1E;AACA;AACA;AACA,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAC/C,CAAC;;AAEF;AACA;AACA;AACA;AACA,MAAMC,iBAAiB,GAAIC,IAAI,IAAK;EAClC,OAAOA,IAAI,CAACC,KAAK,CAAC,iBAAiB,CAAC;AACtC,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMC,gBAAgB,GAAGA,CAACF,IAAI,EAAEG,kBAAkB,KAAK;EACrD,MAAMC,GAAG,GAAGJ;EACV;EAAA,CACCK,UAAU,CAAC,yBAAyB,EAAE,EAAE;;EAEzC;EAAA,CACCC,OAAO,CAACH,kBAAkB,EAAE,EAAE,CAAC;EAElC,MAAMI,mBAAmB,GAAG,oBAAoB;EAEhD,MAAMC,MAAM,GAAG,CACb,GAAGJ,GAAG,CAACK,QAAQ,CAACF,mBAAmB,CAAC,CACrC,CAACG,GAAG,CAAEC,OAAO,IAAK;IACjB,OAAOA,OAAO,CAAC,CAAC,CAAC;EACnB,CAAC,CAAC;EAEF,OAAOP,GAAG,CACPH,KAAK,CAAC,iBAAiB;;EAExB;EAAA,CACCS,GAAG,CAAC,CAACE,QAAQ,EAAEC,GAAG,KAAK;IACtB,OAAO,CAACL,MAAM,CAACK,GAAG,CAAC,IAAI,QAAQ,CAACC,IAAI,CAACF,QAAQ,CAAC,GAAGA,QAAQ,GAAG,GAAGA,QAAQ,GAAGJ,MAAM,CAACK,GAAG,CAAC,IAAI,EAAE,EAAE;EAC/F,CAAC,CAAC;AACN,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAME,0BAA0B,GAAIf,IAAI,IAAK;EAC3C;EACA,IAAIgB,oBAAoB;EAExB,MAAMC,KAAK,GAAGjB,IAAI,CAACC,KAAK,CAAC,IAAI,CAAC;EAE9B,OAAO,CAACgB,KAAK,CAACC,IAAI,CAAEC,IAAI,IAAK;IAC3B,IAAIH,oBAAoB,KAAK,KAAK,IAAI,cAAc,CAACF,IAAI,CAACK,IAAI,CAAC,EAAE;MAC/D,OAAO,IAAI;IACb;IAEAH,oBAAoB,GAAG,YAAY,CAACF,IAAI,CAACK,IAAI,CAAC;IAE9C,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,aAAa,GAAIC,GAAG,IAAK;EAC7B,OAAOA,GAAG,CAAC,CAAC,CAAC,KAAKA,GAAG,CAAC,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC;AACxC,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,OAAO,GAAIF,GAAG,IAAK;EACvB,OAAOA,GAAG,CAACG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;AAC9B,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,UAAU,GAAIJ,GAAG,IAAK;EAC1B,OAAOA,GAAG,CAACG,MAAM,CAAC,CAAC,CAAC,CAACF,WAAW,CAAC,CAAC,GAAGD,GAAG,CAACK,KAAK,CAAC,CAAC,CAAC;AACnD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,mBAAmB,GAAGA,CAC1BC,WAAW,EAAEC,UAAU,EAAEC,SAAS,EAAE3B,kBAAkB,EACtD4B,UAAU,EAAEC,GAAG,EAAEC,sCAAsC,KACpD;EACH,IAAI,CAACL,WAAW,IAAK,QAAQ,CAAEd,IAAI,CAACc,WAAW,CAAC,EAAE;IAChD,OAAO,KAAK;EACd;EAEA,MAAMM,qBAAqB,GAAGN,WAAW,CAACvB,UAAU,CAAC,sBAAsB,EAAE,EAAE,CAAC;EAEhF,MAAM8B,UAAU,GAAGpC,iBAAiB,CAACmC,qBAAqB,CAAC,CAACE,MAAM,CAACC,OAAO,CAAC;EAE3E,OAAOF,UAAU,CAACjB,IAAI,CAAC,CAACoB,SAAS,EAAEC,MAAM,KAAK;IAC5C,MAAMC,SAAS,GAAGtC,gBAAgB,CAACoC,SAAS,EAAEnC,kBAAkB,CAAC;IAEjE,MAAMsC,GAAG,GAAG,gDAAkDC,KAAK,IAAK;MACtE,IAAI1C,IAAI,GAAG+B,UAAU,CAACY,OAAO,CAACb,SAAS,CAAC;MAExC,IAAI,CAAC,UAAU,CAAChB,IAAI,CAACwB,SAAS,CAAC,EAAE;QAC/B,MAAMnB,IAAI,GAAGmB,SAAS,CAACrC,KAAK,CAAC,IAAI,CAAC,CAAC2C,QAAQ,CAACP,OAAO,CAAC;QACpDrC,IAAI,GAAGA,IAAI,CAACM,OAAO,CAAC,IAAIuC,MAAM,CAAC,GAAG,IAAAC,2BAAkB,EAClD;QACC3B,IACH,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAGA,IAAI,GAAG,CAAC;MAC1B;MAEA,KAAK,MAAMP,QAAQ,IAAI4B,SAAS,CAACJ,MAAM,CAAEW,SAAS,IAAK;QACrD,OAAO,CAAE,QAAQ,CAAEjC,IAAI,CAACiC,SAAS,CAAC,IAAI,CAAC3B,aAAa,CAAC2B,SAAS,CAAC,IAC7D,CAACxB,OAAO,CAACwB,SAAS,CAAC;MACvB,CAAC,CAAC,EAAE;QACF,MAAMC,SAAS,GAAGpC,QAAQ,CAACX,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEzC,IAAI,KAAK,IAAI+B,GAAG,IAAIA,GAAG,CAACA,GAAG,EAAE;UAC3B,MAAMiB,GAAG,GAAG,IAAIJ,MAAM,CAAC,KAAK,IAAAC,2BAAkB,EAACd,GAAG,CAACA,GAAG,CAAC,MAAM,IAAAc,2BAAkB,EAACE,SAAS,CAAC,EAAE,EAAE,GAAG,CAAC;UAElGhD,IAAI,GAAGA,IAAI,CAACM,OAAO,CAAC2C,GAAG,EAAE,CAACC,GAAG,EAAEC,EAAE,KAAK;YACpC,OAAOA,EAAE,GAAG1B,UAAU,CAACuB,SAAS,CAAC;UACnC,CAAC,CAAC;QACJ,CAAC,MAAM;UACLhD,IAAI,GAAGA,IAAI,CAACM,OAAO,CAAC,IAAIuC,MAAM,CAAC,yBAAyB,GAAG,IAAAC,2BAAkB,EAACE,SAAS,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,GAAGvB,UAAU,CAACuB,SAAS,CAAC,CAAC;QAC/H;MACF;MAEA,OAAON,KAAK,CAACU,WAAW,CAACtB,SAAS,EAAE9B,IAAI,CAAC;IAC3C,CAAC;;IAED;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,MAAMqD,MAAM,GAAGA,CAACC,GAAG,EAAEZ,KAAK,EAAEa,MAAM,KAAK;MACrC,IAAI,MAAM,IAAIA,MAAM,EAAE;QACpB;AACR;AACA;AACA;AACA;QAAaA,MAAM,CAAEpC,IAAI,IAAIoB,MAAM,GAAG,CAAC;MACjC,CAAC,MAAM;QACL,4CACEgB,MAAM,CACNC,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM,IAAIlB,MAAM,GAAG,CAAC;MAClC;;MAEA;MACAgB,MAAM,CAACG,MAAM,GAAG,CAAC;MACjB7B,UAAU,CAACyB,GAAG,EAAEZ,KAAK,EAAEa,MAAM,CAAC;IAChC,CAAC;IAED,IAAIf,SAAS,CAACtB,IAAI,CAAEN,QAAQ,IAAK;MAC/B,OAAQ,UAAU,CAAEE,IAAI,CAACF,QAAQ,CAAC;IACpC,CAAC,CAAC,EAAE;MACFyC,MAAM,CAAC,0CAA0C,EAAE,IAAI,EAAErB,GAAG,CAAC;IAC/D;IAEA,IAAIQ,SAAS,CAACtB,IAAI,CAAEN,QAAQ,IAAK;MAC/B,OAAO,CAAE,QAAQ,CAAEE,IAAI,CAACF,QAAQ,CAAC,IAAI,CAACQ,aAAa,CAACR,QAAQ,CAAC,IAAI,CAACW,OAAO,CAACX,QAAQ,CAAC;IACrF,CAAC,CAAC,EAAE;MACFyC,MAAM,CAAC,qDAAqD,EAAEZ,GAAG,EAAET,GAAG,CAAC;IACzE;IAEA,MAAM2B,wBAAwB,GAAGrB,SAAS,CAAChC,OAAO,CAACH,kBAAkB,EAAE,EAAE,CAAC;IAE1E,IAAI,CAAC,sBAAsB,CAACW,IAAI,CAAC6C,wBAAwB,CAAC,EAAE;MAC1DN,MAAM,CAAC,mCAAmC,EAAEZ,GAAG,EAAET,GAAG,CAAC;MACrD,OAAO,IAAI;IACb;IAEA,IAAIC,sCAAsC,IAAI,CAAClB,0BAA0B,CAAC4C,wBAAwB,CAAC,EAAE;MACnGN,MAAM,CAAC,0GAA0G,EAAE,IAAI,EAAErB,GAAG,CAAC;MAE7H,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;AAAC,IAAA4B,QAAA,GAAAC,OAAA,CAAAjE,OAAA,GAEa,IAAAkE,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLlC,SAAS;EACTuB,MAAM;EACNtB,UAAU;EACVkC;AACF,CAAC,KAAK;EACJ,MAAM,yFAA0F;IAC9FC,aAAa,GAAG,EAAE;IAClBjC,sCAAsC,GAAG;EAC3C,CAAC,GAAG8B,OAAO,CAACI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAMhE,kBAAkB,GAAG+D,aAAa,CAACE,MAAM,GAC7C,IAAIvB,MAAM,CAAC,KAAK,GAAGqB,aAAa,CAACxD,GAAG,CAAE2D,YAAY,IAAK;IACrD,OAAO,IAAAvB,2BAAkB,EAACuB,YAAY,CAAChE,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC;EACvE,CAAC,CAAC,CAACiE,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,EAAE,IAAI,CAAC,GACjC,EAAE;EAEJ,IAAI;IACF1C;EACF,CAAC,GAAGqC,KAAK,CAACM,cAAc,CAAC,CAAC;EAE1B,MAAMC,OAAO,GAAG,CACd,GAAG5C,WAAW,CAACnB,QAAQ,CAAC,iBAAiB,CAAC,CAC3C,CAACC,GAAG,CAAE+D,KAAK,IAAK;IACf,MAAM;MACJC;IACF,CAAC,GAAGD,KAAK;IACT,MAAM,CACJ;MACEL;IACF,CAAC,CACF,GAAGK,KAAK;IACT,OAAO;MACLC,KAAK;MACLN;IACF,CAAC;EACH,CAAC,CAAC,CAACO,OAAO,CAAC,CAAC;EAEZ,KAAK,MAAM;IACTD,KAAK;IACLN;EACF,CAAC,IAAII,OAAO,EAAE;IACZ5C,WAAW,GAAGA,WAAW,CAACF,KAAK,CAAC,CAAC,EAAEgD,KAAK,CAAC,GACvC9C,WAAW,CAACF,KAAK,CAAC,mDAChBgD,KAAK,GACHN,MAAM,CAAC;EACf;EAEA,IAAIzC,mBAAmB,CAACC,WAAW,EAAEyB,MAAM,EAAEvB,SAAS,EAAE3B,kBAAkB,EAAE4B,UAAU,EAAE;IACtFZ,IAAI,EAAE6C,KAAK,CAACR,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM,GAAG;EACjC,CAAC,EAAExB,sCAAsC,CAAC,EAAE;IAC1C;EACF;EAEAgC,KAAK,CAACW,mBAAmB,CAAC,aAAa,EAAGC,gBAAgB,IAAK;IAC7D,MAAMC,IAAI,GAAG,GAAGD,gBAAgB,CAACE,IAAI,IAAId,KAAK,CAACe,iBAAiB,CAACH,gBAAgB,CAAC,EAAE,CAACI,IAAI,CAAC,CAAC;IAC3FtD,mBAAmB,CAACmD,IAAI,EAAEzB,MAAM,EAAEvB,SAAS,EAAE3B,kBAAkB,EAAE4B,UAAU,EAAE8C,gBAAgB,EAAE5C,sCAAsC,CAAC;EACxI,CAAC,EAAE,IAAI,CAAC;EAER,MAAM;IACJiD;EACF,CAAC,GAAGjB,KAAK,CAACkB,aAAa,CAACnB,KAAK,CAACoB,IAAI,CAAC;EACnC,MAAMC,gBAAgB,GAAGpB,KAAK,CAACqB,UAAU,CAAC,CAAC;IACzCtD,GAAG,EAAEuD;EACP,CAAC,KAAK;IACJ,OAAO1F,oBAAoB,CAAC2F,GAAG,CAACD,OAAO,CAAC,IACtCtB,KAAK,CAACwB,YAAY,CAACF,OAAO,CAAC,IAAI,CAACL,aAAa,CAAChE,IAAI,CAAC,CAAC;MAClDc;IACF,CAAC,KAAK;MACJ;MACA;MACA,OAAOA,GAAG,KAAKuD,OAAO;IACxB,CAAC,CAAC;EACN,CAAC,CAAC;EAEFL,aAAa,CAAChE,IAAI,CAAEc,GAAG,IAAK;IAC1B,MAAM8C,IAAI,GAAG,qBACXb,KAAK,CAACe,iBAAiB,CAAChD,GAAG,CAAC,CAC5B1B,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAACoF,OAAO,CAAC,CAAC;IAE/B,OAAO/D,mBAAmB,CAACmD,IAAI,EAAEzB,MAAM,EAAEvB,SAAS,EAAE3B,kBAAkB,EAAE4B,UAAU,EAAEC,GAAG,EAAEC,sCAAsC,CAAC;EAClI,CAAC,CAAC;EAEFoD,gBAAgB,CAACnE,IAAI,CAAEc,GAAG,IAAK;IAC7B,MAAM8C,IAAI,GAAG,GAAG9C,GAAG,CAAC+C,IAAI,IAAId,KAAK,CAACe,iBAAiB,CAAChD,GAAG,CAAC,EAAE,CAACiD,IAAI,CAAC,CAAC;IAEjE,OAAOtD,mBAAmB,CAACmD,IAAI,EAAEzB,MAAM,EAAEvB,SAAS,EAAE3B,kBAAkB,EAAE4B,UAAU,EAAEC,GAAG,EAAEC,sCAAsC,CAAC;EAClI,CAAC,CAAC;AACJ,CAAC,EAAE;EACD0D,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJjE,WAAW,EAAE,uIAAuI;MACpJkE,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVhC,aAAa,EAAE;UACbiC,KAAK,EAAE;YACLC,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDnE,sCAAsC,EAAE;UACtCmE,IAAI,EAAE;QACR,CAAC;QACDhB,IAAI,EAAE;UACJe,KAAK,EAAE;YACLC,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAAxC,OAAA,GAAAA,OAAA,CAAAjE,OAAA","ignoreList":[]}
+{"version":3,"file":"requireDescriptionCompleteSentence.cjs","names":["iterateJsdoc"],"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,qCAE5B,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,oCAAqB,IAAI,IAAI,CAAC,GAAG,oCAAqB,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,8DAA+C,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,iDAAeA,6BAAa,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,2CAA0B,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"}