eslint-plugin-jsdoc 52.0.1 → 52.0.3

package/dist/rules/tagLines.js

@@ -0,0 +1,183 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/tagLines.js
+var tagLines_default = iterateJsdoc(({ context, jsdoc, utils }) => {
+	const [alwaysNever = "never", { applyToEndTag = true, count = 1, endLines = 0, startLines = 0, tags = {} } = {}] = context.options;
+	jsdoc.tags.some((tg, tagIdx) => {
+		let lastTag;
+		/**
+		* @type {null|import('../iterateJsdoc.js').Integer}
+		*/
+		let lastEmpty = null;
+		/**
+		* @type {null|import('../iterateJsdoc.js').Integer}
+		*/
+		let reportIndex = null;
+		let emptyLinesCount = 0;
+		for (const [idx, { tokens: { description, end, name, tag, type } }] of tg.source.entries()) {
+			if (description) reportIndex = null;
+			if (lastTag && ["always", "any"].includes(tags[lastTag.slice(1)]?.lines)) continue;
+			const empty = !tag && !name && !type && !description;
+			if (empty && !end && (alwaysNever === "never" || lastTag && tags[lastTag.slice(1)]?.lines === "never")) {
+				reportIndex = idx;
+				continue;
+			}
+			if (!end) {
+				if (empty) emptyLinesCount++;
+				else emptyLinesCount = 0;
+				lastEmpty = empty ? idx : null;
+			}
+			lastTag = tag;
+		}
+		if (typeof endLines === "number" && lastEmpty !== null && tagIdx === jsdoc.tags.length - 1) {
+			const lineDiff = endLines - emptyLinesCount;
+			if (lineDiff < 0) {
+				const fixer = () => {
+					utils.removeTag(tagIdx, { tagSourceOffset: lastEmpty + lineDiff + 1 });
+				};
+				utils.reportJSDoc(`Expected ${endLines} trailing lines`, { line: tg.source[lastEmpty].number + lineDiff + 1 }, fixer);
+			} else if (lineDiff > 0) {
+				const fixer = () => {
+					utils.addLines(tagIdx, lastEmpty, endLines - emptyLinesCount);
+				};
+				utils.reportJSDoc(`Expected ${endLines} trailing lines`, { line: tg.source[lastEmpty].number }, fixer);
+			}
+			return true;
+		}
+		if (reportIndex !== null) {
+			const fixer = () => {
+				utils.removeTag(tagIdx, { tagSourceOffset: reportIndex });
+			};
+			utils.reportJSDoc("Expected no lines between tags", { line: tg.source[0].number + 1 }, fixer);
+			return true;
+		}
+		return false;
+	});
+	(applyToEndTag ? jsdoc.tags : jsdoc.tags.slice(0, -1)).some((tg, tagIdx) => {
+		/**
+		* @type {{
+		*   idx: import('../iterateJsdoc.js').Integer,
+		*   number: import('../iterateJsdoc.js').Integer
+		* }[]}
+		*/
+		const lines = [];
+		let currentTag;
+		let tagSourceIdx = 0;
+		for (const [idx, { number, tokens: { description, end, name, tag, type } }] of tg.source.entries()) {
+			if (description) {
+				lines.splice(0, lines.length);
+				tagSourceIdx = idx;
+			}
+			if (tag) currentTag = tag;
+			if (!tag && !name && !type && !description && !end) lines.push({
+				idx,
+				number
+			});
+		}
+		const currentTg = currentTag && tags[currentTag.slice(1)];
+		const tagCount = currentTg?.count;
+		const defaultAlways = alwaysNever === "always" && currentTg?.lines !== "never" && currentTg?.lines !== "any" && lines.length < count;
+		let overrideAlways;
+		let fixCount = count;
+		if (!defaultAlways) {
+			fixCount = typeof tagCount === "number" ? tagCount : count;
+			overrideAlways = currentTg?.lines === "always" && lines.length < fixCount;
+		}
+		if (defaultAlways || overrideAlways) {
+			const fixer = () => {
+				utils.addLines(tagIdx, lines[lines.length - 1]?.idx || tagSourceIdx + 1, fixCount - lines.length);
+			};
+			const line = lines[lines.length - 1]?.number || tg.source[tagSourceIdx].number;
+			utils.reportJSDoc(`Expected ${fixCount} line${fixCount === 1 ? "" : "s"} between tags but found ${lines.length}`, { line }, fixer);
+			return true;
+		}
+		return false;
+	});
+	if (typeof startLines === "number") {
+		if (!jsdoc.tags.length) return;
+		const { description, lastDescriptionLine } = utils.getDescription();
+		if (!/\S/v.test(description)) return;
+		const trailingLines = description.match(/\n+$/v)?.[0]?.length;
+		const trailingDiff = (trailingLines ?? 0) - startLines;
+		if (trailingDiff > 0) utils.reportJSDoc(`Expected only ${startLines} line after block description`, { line: lastDescriptionLine - trailingDiff }, () => {
+			utils.setBlockDescription((info, seedTokens, descLines) => {
+				return descLines.slice(0, -trailingDiff).map((desc) => {
+					return {
+						number: 0,
+						source: "",
+						tokens: seedTokens({
+							...info,
+							description: desc,
+							postDelimiter: desc.trim() ? info.postDelimiter : ""
+						})
+					};
+				});
+			});
+		});
+		else if (trailingDiff < 0) utils.reportJSDoc(`Expected ${startLines} lines after block description`, { line: lastDescriptionLine }, () => {
+			utils.setBlockDescription((info, seedTokens, descLines) => {
+				return [...descLines, ...Array.from({ length: -trailingDiff }, () => {
+					return "";
+				})].map((desc) => {
+					return {
+						number: 0,
+						source: "",
+						tokens: seedTokens({
+							...info,
+							description: desc,
+							postDelimiter: desc.trim() ? info.postDelimiter : ""
+						})
+					};
+				});
+			});
+		});
+	}
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Enforces lines (or no lines) between tags.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			enum: [
+				"always",
+				"any",
+				"never"
+			],
+			type: "string"
+		}, {
+			additionalProperties: false,
+			properties: {
+				applyToEndTag: { type: "boolean" },
+				count: { type: "integer" },
+				endLines: { anyOf: [{ type: "integer" }, { type: "null" }] },
+				startLines: { anyOf: [{ type: "integer" }, { type: "null" }] },
+				tags: {
+					patternProperties: { ".*": {
+						additionalProperties: false,
+						properties: {
+							count: { type: "integer" },
+							lines: {
+								enum: [
+									"always",
+									"never",
+									"any"
+								],
+								type: "string"
+							}
+						}
+					} },
+					type: "object"
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { tagLines_default as default };
+//# sourceMappingURL=tagLines.js.map

package/dist/rules/tagLines.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagLines.js","names":[],"sources":["../../src/rules/tagLines.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    alwaysNever = 'never',\n    {\n      applyToEndTag = true,\n      count = 1,\n      endLines = 0,\n      startLines = 0,\n      tags = {},\n    } = {},\n  ] = context.options;\n\n  // eslint-disable-next-line complexity -- Temporary\n  jsdoc.tags.some((tg, tagIdx) => {\n    let lastTag;\n\n    /**\n     * @type {null|import('../iterateJsdoc.js').Integer}\n     */\n    let lastEmpty = null;\n\n    /**\n     * @type {null|import('../iterateJsdoc.js').Integer}\n     */\n    let reportIndex = null;\n    let emptyLinesCount = 0;\n    for (const [\n      idx,\n      {\n        tokens: {\n          description,\n          end,\n          name,\n          tag,\n          type,\n        },\n      },\n    ] of tg.source.entries()) {\n      // May be text after a line break within a tag description\n      if (description) {\n        reportIndex = null;\n      }\n\n      if (lastTag && [\n        'always', 'any',\n      ].includes(tags[lastTag.slice(1)]?.lines)) {\n        continue;\n      }\n\n      const empty = !tag && !name && !type && !description;\n      if (\n        empty && !end &&\n        (alwaysNever === 'never' ||\n          lastTag && tags[lastTag.slice(1)]?.lines === 'never'\n        )\n      ) {\n        reportIndex = idx;\n\n        continue;\n      }\n\n      if (!end) {\n        if (empty) {\n          emptyLinesCount++;\n        } else {\n          emptyLinesCount = 0;\n        }\n\n        lastEmpty = empty ? idx : null;\n      }\n\n      lastTag = tag;\n    }\n\n    if (\n      typeof endLines === 'number' &&\n      lastEmpty !== null && tagIdx === jsdoc.tags.length - 1\n    ) {\n      const lineDiff = endLines - emptyLinesCount;\n\n      if (lineDiff < 0) {\n        const fixer = () => {\n          utils.removeTag(tagIdx, {\n            tagSourceOffset: /** @type {import('../iterateJsdoc.js').Integer} */ (\n              lastEmpty\n            ) + lineDiff + 1,\n          });\n        };\n\n        utils.reportJSDoc(\n          `Expected ${endLines} trailing lines`,\n          {\n            line: tg.source[lastEmpty].number + lineDiff + 1,\n          },\n          fixer,\n        );\n      } else if (lineDiff > 0) {\n        const fixer = () => {\n          utils.addLines(\n            tagIdx,\n            /** @type {import('../iterateJsdoc.js').Integer} */ (lastEmpty),\n            endLines - emptyLinesCount,\n          );\n        };\n\n        utils.reportJSDoc(\n          `Expected ${endLines} trailing lines`,\n          {\n            line: tg.source[lastEmpty].number,\n          },\n          fixer,\n        );\n      }\n\n      return true;\n    }\n\n    if (reportIndex !== null) {\n      const fixer = () => {\n        utils.removeTag(tagIdx, {\n          tagSourceOffset: /** @type {import('../iterateJsdoc.js').Integer} */ (\n            reportIndex\n          ),\n        });\n      };\n\n      utils.reportJSDoc(\n        'Expected no lines between tags',\n        {\n          line: tg.source[0].number + 1,\n        },\n        fixer,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n\n  (applyToEndTag ? jsdoc.tags : jsdoc.tags.slice(0, -1)).some((tg, tagIdx) => {\n    /**\n     * @type {{\n     *   idx: import('../iterateJsdoc.js').Integer,\n     *   number: import('../iterateJsdoc.js').Integer\n     * }[]}\n     */\n    const lines = [];\n\n    let currentTag;\n    let tagSourceIdx = 0;\n    for (const [\n      idx,\n      {\n        number,\n        tokens: {\n          description,\n          end,\n          name,\n          tag,\n          type,\n        },\n      },\n    ] of tg.source.entries()) {\n      if (description) {\n        lines.splice(0, lines.length);\n        tagSourceIdx = idx;\n      }\n\n      if (tag) {\n        currentTag = tag;\n      }\n\n      if (!tag && !name && !type && !description && !end) {\n        lines.push({\n          idx,\n          number,\n        });\n      }\n    }\n\n    const currentTg = currentTag && tags[currentTag.slice(1)];\n    const tagCount = currentTg?.count;\n\n    const defaultAlways = alwaysNever === 'always' && currentTg?.lines !== 'never' &&\n      currentTg?.lines !== 'any' && lines.length < count;\n\n    let overrideAlways;\n    let fixCount = count;\n    if (!defaultAlways) {\n      fixCount = typeof tagCount === 'number' ? tagCount : count;\n      overrideAlways = currentTg?.lines === 'always' &&\n        lines.length < fixCount;\n    }\n\n    if (defaultAlways || overrideAlways) {\n      const fixer = () => {\n        utils.addLines(tagIdx, lines[lines.length - 1]?.idx || tagSourceIdx + 1, fixCount - lines.length);\n      };\n\n      const line = lines[lines.length - 1]?.number || tg.source[tagSourceIdx].number;\n      utils.reportJSDoc(\n        `Expected ${fixCount} line${fixCount === 1 ? '' : 's'} between tags but found ${lines.length}`,\n        {\n          line,\n        },\n        fixer,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n\n  if (typeof startLines === 'number') {\n    if (!jsdoc.tags.length) {\n      return;\n    }\n\n    const {\n      description,\n      lastDescriptionLine,\n    } = utils.getDescription();\n    if (!(/\\S/v).test(description)) {\n      return;\n    }\n\n    const trailingLines = description.match(/\\n+$/v)?.[0]?.length;\n    const trailingDiff = (trailingLines ?? 0) - startLines;\n    if (trailingDiff > 0) {\n      utils.reportJSDoc(\n        `Expected only ${startLines} line after block description`,\n        {\n          line: lastDescriptionLine - trailingDiff,\n        },\n        () => {\n          utils.setBlockDescription((info, seedTokens, descLines) => {\n            return descLines.slice(0, -trailingDiff).map((desc) => {\n              return {\n                number: 0,\n                source: '',\n                tokens: seedTokens({\n                  ...info,\n                  description: desc,\n                  postDelimiter: desc.trim() ? info.postDelimiter : '',\n                }),\n              };\n            });\n          });\n        },\n      );\n    } else if (trailingDiff < 0) {\n      utils.reportJSDoc(\n        `Expected ${startLines} lines after block description`,\n        {\n          line: lastDescriptionLine,\n        },\n        () => {\n          utils.setBlockDescription((info, seedTokens, descLines) => {\n            return [\n              ...descLines,\n              ...Array.from({\n                length: -trailingDiff,\n              }, () => {\n                return '';\n              }),\n            ].map((desc) => {\n              return {\n                number: 0,\n                source: '',\n                tokens: seedTokens({\n                  ...info,\n                  description: desc,\n                  postDelimiter: desc.trim() ? info.postDelimiter : '',\n                }),\n              };\n            });\n          });\n        },\n      );\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Enforces lines (or no lines) between tags.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'any', 'never',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          applyToEndTag: {\n            type: 'boolean',\n          },\n          count: {\n            type: 'integer',\n          },\n          endLines: {\n            anyOf: [\n              {\n                type: 'integer',\n              },\n              {\n                type: 'null',\n              },\n            ],\n          },\n          startLines: {\n            anyOf: [\n              {\n                type: 'integer',\n              },\n              {\n                type: 'null',\n              },\n            ],\n          },\n          tags: {\n            patternProperties: {\n              '.*': {\n                additionalProperties: false,\n                properties: {\n                  count: {\n                    type: 'integer',\n                  },\n                  lines: {\n                    enum: [\n                      'always', 'never', 'any',\n                    ],\n                    type: 'string',\n                  },\n                },\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,uBAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,CACJ,cAAc,SACd,EACE,gBAAgB,MAChB,QAAQ,GACR,WAAW,GACX,aAAa,GACb,OAAO,CAAE,GACV,GAAG,CAAE,EACP,GAAG,QAAQ;CAGZ,MAAM,KAAK,KAAK,CAAC,IAAI,WAAW;EAC9B,IAAI;;;;EAKJ,IAAI,YAAY;;;;EAKhB,IAAI,cAAc;EAClB,IAAI,kBAAkB;AACtB,OAAK,MAAM,CACT,KACA,EACE,QAAQ,EACN,aACA,KACA,MACA,KACA,MACD,EACF,CACF,IAAI,GAAG,OAAO,SAAS,EAAE;AAExB,OAAI,aACF,cAAc;AAGhB,OAAI,WAAW,CACb,UAAU,KACX,EAAC,SAAS,KAAK,QAAQ,MAAM,EAAE,GAAG,MAAM,CACvC;GAGF,MAAM,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACzC,OACE,SAAS,CAAC,QACT,gBAAgB,WACf,WAAW,KAAK,QAAQ,MAAM,EAAE,GAAG,UAAU,UAE/C;IACA,cAAc;AAEd;GACD;AAED,OAAI,CAAC,KAAK;AACR,QAAI,OACF;SAEA,kBAAkB;IAGpB,YAAY,QAAQ,MAAM;GAC3B;GAED,UAAU;EACX;AAED,MACE,OAAO,aAAa,YACpB,cAAc,QAAQ,WAAW,MAAM,KAAK,SAAS,GACrD;GACA,MAAM,WAAW,WAAW;AAE5B,OAAI,WAAW,GAAG;IAChB,MAAM,QAAQ,MAAM;KAClB,MAAM,UAAU,QAAQ,EACtB,iBACE,YACE,WAAW,EAChB,EAAC;IACH;IAED,MAAM,YACJ,CAAC,SAAS,EAAE,SAAS,eAAe,CAAC,EACrC,EACE,MAAM,GAAG,OAAO,WAAW,SAAS,WAAW,EAChD,GACD,MACD;GACF,WAAU,WAAW,GAAG;IACvB,MAAM,QAAQ,MAAM;KAClB,MAAM,SACJ,QACqD,WACrD,WAAW,gBACZ;IACF;IAED,MAAM,YACJ,CAAC,SAAS,EAAE,SAAS,eAAe,CAAC,EACrC,EACE,MAAM,GAAG,OAAO,WAAW,OAC5B,GACD,MACD;GACF;AAED,UAAO;EACR;AAED,MAAI,gBAAgB,MAAM;GACxB,MAAM,QAAQ,MAAM;IAClB,MAAM,UAAU,QAAQ,EACtB,iBACE,YAEH,EAAC;GACH;GAED,MAAM,YACJ,kCACA,EACE,MAAM,GAAG,OAAO,GAAG,SAAS,EAC7B,GACD,MACD;AAED,UAAO;EACR;AAED,SAAO;CACR,EAAC;EAED,gBAAgB,MAAM,OAAO,MAAM,KAAK,MAAM,GAAG,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW;;;;;;;EAO1E,MAAM,QAAQ,CAAE;EAEhB,IAAI;EACJ,IAAI,eAAe;AACnB,OAAK,MAAM,CACT,KACA,EACE,QACA,QAAQ,EACN,aACA,KACA,MACA,KACA,MACD,EACF,CACF,IAAI,GAAG,OAAO,SAAS,EAAE;AACxB,OAAI,aAAa;IACf,MAAM,OAAO,GAAG,MAAM,OAAO;IAC7B,eAAe;GAChB;AAED,OAAI,KACF,aAAa;AAGf,OAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,KAC7C,MAAM,KAAK;IACT;IACA;GACD,EAAC;EAEL;EAED,MAAM,YAAY,cAAc,KAAK,WAAW,MAAM,EAAE;EACxD,MAAM,WAAW,WAAW;EAE5B,MAAM,gBAAgB,gBAAgB,YAAY,WAAW,UAAU,WACrE,WAAW,UAAU,SAAS,MAAM,SAAS;EAE/C,IAAI;EACJ,IAAI,WAAW;AACf,MAAI,CAAC,eAAe;GAClB,WAAW,OAAO,aAAa,WAAW,WAAW;GACrD,iBAAiB,WAAW,UAAU,YACpC,MAAM,SAAS;EAClB;AAED,MAAI,iBAAiB,gBAAgB;GACnC,MAAM,QAAQ,MAAM;IAClB,MAAM,SAAS,QAAQ,MAAM,MAAM,SAAS,IAAI,OAAO,eAAe,GAAG,WAAW,MAAM,OAAO;GAClG;GAED,MAAM,OAAO,MAAM,MAAM,SAAS,IAAI,UAAU,GAAG,OAAO,cAAc;GACxE,MAAM,YACJ,CAAC,SAAS,EAAE,SAAS,KAAK,EAAE,aAAa,IAAI,KAAK,IAAI,wBAAwB,EAAE,MAAM,QAAQ,EAC9F,EACE,KACD,GACD,MACD;AAED,UAAO;EACR;AAED,SAAO;CACR,EAAC;AAEF,KAAI,OAAO,eAAe,UAAU;AAClC,MAAI,CAAC,MAAM,KAAK,OACd;EAGF,MAAM,EACJ,aACA,qBACD,GAAG,MAAM,gBAAgB;AAC1B,MAAI,CAAE,MAAO,KAAK,YAAY,CAC5B;EAGF,MAAM,gBAAgB,YAAY,MAAM,QAAQ,GAAG,IAAI;EACvD,MAAM,gBAAgB,iBAAiB,KAAK;AAC5C,MAAI,eAAe,GACjB,MAAM,YACJ,CAAC,cAAc,EAAE,WAAW,6BAA6B,CAAC,EAC1D,EACE,MAAM,sBAAsB,aAC7B,GACD,MAAM;GACJ,MAAM,oBAAoB,CAAC,MAAM,YAAY,cAAc;AACzD,WAAO,UAAU,MAAM,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS;AACrD,YAAO;MACL,QAAQ;MACR,QAAQ;MACR,QAAQ,WAAW;OACjB,GAAG;OACH,aAAa;OACb,eAAe,KAAK,MAAM,GAAG,KAAK,gBAAgB;MACnD,EAAC;KACH;IACF,EAAC;GACH,EAAC;EACH,EACF;WACQ,eAAe,GACxB,MAAM,YACJ,CAAC,SAAS,EAAE,WAAW,8BAA8B,CAAC,EACtD,EACE,MAAM,oBACP,GACD,MAAM;GACJ,MAAM,oBAAoB,CAAC,MAAM,YAAY,cAAc;AACzD,WAAO,CACL,GAAG,WACH,GAAG,MAAM,KAAK,EACZ,QAAQ,CAAC,aACV,GAAE,MAAM;AACP,YAAO;IACR,EAAC,AACH,EAAC,IAAI,CAAC,SAAS;AACd,YAAO;MACL,QAAQ;MACR,QAAQ;MACR,QAAQ,WAAW;OACjB,GAAG;OACH,aAAa;OACb,eAAe,KAAK,MAAM,GAAG,KAAK,gBAAgB;MACnD,EAAC;KACH;IACF,EAAC;GACH,EAAC;EACH,EACF;CAEJ;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM;IACJ;IAAU;IAAO;GAClB;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY;IACV,eAAe,EACb,MAAM,UACP;IACD,OAAO,EACL,MAAM,UACP;IACD,UAAU,EACR,OAAO,CACL,EACE,MAAM,UACP,GACD,EACE,MAAM,OACP,CACF,EACF;IACD,YAAY,EACV,OAAO,CACL,EACE,MAAM,UACP,GACD,EACE,MAAM,OACP,CACF,EACF;IACD,MAAM;KACJ,mBAAmB,EACjB,MAAM;MACJ,sBAAsB;MACtB,YAAY;OACV,OAAO,EACL,MAAM,UACP;OACD,OAAO;QACL,MAAM;SACJ;SAAU;SAAS;QACpB;QACD,MAAM;OACP;MACF;KACF,EACF;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/textEscaping.cjs

@@ -1,137 +1,102 @@
-"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 }; }
-// We could disallow raw gt, quot, and apos, but allow for parity; but we do
-//  not allow hex or decimal character references
+//#region src/rules/textEscaping.js
 const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/v;
 const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/v;
-
 /**
- * @param {string} desc
- * @returns {string}
- */
-const htmlReplacer = desc => {
-  return desc.replaceAll(new RegExp(htmlRegex, 'gv'), _ => {
-    if (_ === '<') {
-      return '&lt;';
-    }
-    return '&amp;';
-  });
+* @param {string} desc
+* @returns {string}
+*/
+const htmlReplacer = (desc) => {
+	return desc.replaceAll(new RegExp(htmlRegex, "gv"), (_) => {
+		if (_ === "<") return "&lt;";
+		return "&amp;";
+	});
 };
-
 /**
- * @param {string} desc
- * @returns {string}
- */
-const markdownReplacer = desc => {
-  return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {
-    const bookend = '`'.repeat(backticks.length);
-    return `\\${bookend}${encapsed}${bookend}`;
-  });
+* @param {string} desc
+* @returns {string}
+*/
+const markdownReplacer = (desc) => {
+	return desc.replaceAll(new RegExp(markdownRegex, "gv"), (_, backticks, encapsed) => {
+		const bookend = "`".repeat(backticks.length);
+		return `\\${bookend}${encapsed}${bookend}`;
+	});
 };
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  utils
-}) => {
-  const {
-    escapeHTML,
-    escapeMarkdown
-  } = context.options[0] || {};
-  if (!escapeHTML && !escapeMarkdown) {
-    context.report({
-      loc: {
-        end: {
-          column: 1,
-          line: 1
-        },
-        start: {
-          column: 1,
-          line: 1
-        }
-      },
-      message: 'You must include either `escapeHTML` or `escapeMarkdown`'
-    });
-    return;
-  }
-  const {
-    descriptions
-  } = utils.getDescription();
-  if (escapeHTML) {
-    if (descriptions.some(desc => {
-      return htmlRegex.test(desc);
-    })) {
-      const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);
-      utils.reportJSDoc('You have unescaped HTML characters < or &', {
-        line
-      }, () => {}, true);
-      return;
-    }
-    for (const tag of jsdoc.tags) {
-      if (tag.tag === 'example') {
-        continue;
-      }
-      if (/** @type {string[]} */utils.getTagDescription(tag, true).some(desc => {
-        return htmlRegex.test(desc);
-      })) {
-        const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) + tag.source[0].number;
-        utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {
-          line
-        }, () => {}, true);
-      }
-    }
-    return;
-  }
-  if (descriptions.some(desc => {
-    return markdownRegex.test(desc);
-  })) {
-    const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);
-    utils.reportJSDoc('You have unescaped Markdown backtick sequences', {
-      line
-    }, () => {}, true);
-    return;
-  }
-  for (const tag of jsdoc.tags) {
-    if (tag.tag === 'example') {
-      continue;
-    }
-    if (/** @type {string[]} */utils.getTagDescription(tag, true).some(desc => {
-      return markdownRegex.test(desc);
-    })) {
-      const line = utils.setTagDescription(tag, markdownRegex, markdownReplacer) + tag.source[0].number;
-      utils.reportJSDoc('You have unescaped Markdown backtick sequences in a tag', {
-        line
-      }, () => {}, true);
-    }
-  }
+var textEscaping_default = require_iterateJsdoc.default(({ context, jsdoc, utils }) => {
+	const { escapeHTML, escapeMarkdown } = context.options[0] || {};
+	if (!escapeHTML && !escapeMarkdown) {
+		context.report({
+			loc: {
+				end: {
+					column: 1,
+					line: 1
+				},
+				start: {
+					column: 1,
+					line: 1
+				}
+			},
+			message: "You must include either `escapeHTML` or `escapeMarkdown`"
+		});
+		return;
+	}
+	const { descriptions } = utils.getDescription();
+	if (escapeHTML) {
+		if (descriptions.some((desc) => {
+			return htmlRegex.test(desc);
+		})) {
+			const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);
+			utils.reportJSDoc("You have unescaped HTML characters < or &", { line }, () => {}, true);
+			return;
+		}
+		for (const tag of jsdoc.tags) {
+			if (tag.tag === "example") continue;
+			if (utils.getTagDescription(tag, true).some((desc) => {
+				return htmlRegex.test(desc);
+			})) {
+				const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) + tag.source[0].number;
+				utils.reportJSDoc("You have unescaped HTML characters < or & in a tag", { line }, () => {}, true);
+			}
+		}
+		return;
+	}
+	if (descriptions.some((desc) => {
+		return markdownRegex.test(desc);
+	})) {
+		const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);
+		utils.reportJSDoc("You have unescaped Markdown backtick sequences", { line }, () => {}, true);
+		return;
+	}
+	for (const tag of jsdoc.tags) {
+		if (tag.tag === "example") continue;
+		if (utils.getTagDescription(tag, true).some((desc) => {
+			return markdownRegex.test(desc);
+		})) {
+			const line = utils.setTagDescription(tag, markdownRegex, markdownReplacer) + tag.source[0].number;
+			utils.reportJSDoc("You have unescaped Markdown backtick sequences in a tag", { line }, () => {}, true);
+		}
+	}
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Auto-escape certain characters that are input within block and tag descriptions.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        // Option properties here (or remove the object)
-        escapeHTML: {
-          type: 'boolean'
-        },
-        escapeMarkdown: {
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Auto-escape certain characters that are input within block and tag descriptions.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				escapeHTML: { type: "boolean" },
+				escapeMarkdown: { type: "boolean" }
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = textEscaping_default;
 //# sourceMappingURL=textEscaping.cjs.map

package/dist/rules/textEscaping.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"textEscaping.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","htmlRegex","markdownRegex","htmlReplacer","desc","replaceAll","RegExp","_","markdownReplacer","backticks","encapsed","bookend","repeat","length","_default","exports","iterateJsdoc","context","jsdoc","utils","escapeHTML","escapeMarkdown","options","report","loc","end","column","line","start","message","descriptions","getDescription","some","test","setDescriptionLines","reportJSDoc","tag","tags","getTagDescription","setTagDescription","source","number","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperties","properties","type","module"],"sources":["../../src/rules/textEscaping.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// We could disallow raw gt, quot, and apos, but allow for parity; but we do\n//  not allow hex or decimal character references\nconst htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\\S)/v;\nconst markdownRegex = /(?<!\\\\)(`+)([^`]+)\\1(?!`)/v;\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst htmlReplacer = (desc) => {\n  return desc.replaceAll(new RegExp(htmlRegex, 'gv'), (_) => {\n    if (_ === '<') {\n      return '&lt;';\n    }\n\n    return '&amp;';\n  });\n};\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst markdownReplacer = (desc) => {\n  return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {\n    const bookend = '`'.repeat(backticks.length);\n    return `\\\\${bookend}${encapsed}${bookend}`;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    escapeHTML,\n    escapeMarkdown,\n  } = context.options[0] || {};\n\n  if (!escapeHTML && !escapeMarkdown) {\n    context.report({\n      loc: {\n        end: {\n          column: 1,\n          line: 1,\n        },\n        start: {\n          column: 1,\n          line: 1,\n        },\n      },\n      message: 'You must include either `escapeHTML` or `escapeMarkdown`',\n    });\n    return;\n  }\n\n  const {\n    descriptions,\n  } = utils.getDescription();\n\n  if (escapeHTML) {\n    if (descriptions.some((desc) => {\n      return htmlRegex.test(desc);\n    })) {\n      const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);\n      utils.reportJSDoc('You have unescaped HTML characters < or &', {\n        line,\n      }, () => {}, true);\n      return;\n    }\n\n    for (const tag of jsdoc.tags) {\n      if (tag.tag === 'example') {\n        continue;\n      }\n\n      if (/** @type {string[]} */ (\n        utils.getTagDescription(tag, true)\n      ).some((desc) => {\n        return htmlRegex.test(desc);\n      })) {\n        const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) +\n          tag.source[0].number;\n        utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {\n          line,\n        }, () => {}, true);\n      }\n    }\n\n    return;\n  }\n\n  if (descriptions.some((desc) => {\n    return markdownRegex.test(desc);\n  })) {\n    const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);\n    utils.reportJSDoc('You have unescaped Markdown backtick sequences', {\n      line,\n    }, () => {}, true);\n    return;\n  }\n\n  for (const tag of jsdoc.tags) {\n    if (tag.tag === 'example') {\n      continue;\n    }\n\n    if (/** @type {string[]} */ (\n      utils.getTagDescription(tag, true)\n    ).some((desc) => {\n      return markdownRegex.test(desc);\n    })) {\n      const line = utils.setTagDescription(\n        tag, markdownRegex, markdownReplacer,\n      ) + tag.source[0].number;\n      utils.reportJSDoc(\n        'You have unescaped Markdown backtick sequences in a tag',\n        {\n          line,\n        },\n        () => {},\n        true,\n      );\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Auto-escape certain characters that are input within block and tag descriptions.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          // Option properties here (or remove the object)\n          escapeHTML: {\n            type: 'boolean',\n          },\n          escapeMarkdown: {\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;AAE9C;AACA;AACA,MAAMG,SAAS,GAAG,0CAA0C;AAC5D,MAAMC,aAAa,GAAG,4BAA4B;;AAElD;AACA;AACA;AACA;AACA,MAAMC,YAAY,GAAIC,IAAI,IAAK;EAC7B,OAAOA,IAAI,CAACC,UAAU,CAAC,IAAIC,MAAM,CAACL,SAAS,EAAE,IAAI,CAAC,EAAGM,CAAC,IAAK;IACzD,IAAIA,CAAC,KAAK,GAAG,EAAE;MACb,OAAO,MAAM;IACf;IAEA,OAAO,OAAO;EAChB,CAAC,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,gBAAgB,GAAIJ,IAAI,IAAK;EACjC,OAAOA,IAAI,CAACC,UAAU,CAAC,IAAIC,MAAM,CAACJ,aAAa,EAAE,IAAI,CAAC,EAAE,CAACK,CAAC,EAAEE,SAAS,EAAEC,QAAQ,KAAK;IAClF,MAAMC,OAAO,GAAG,GAAG,CAACC,MAAM,CAACH,SAAS,CAACI,MAAM,CAAC;IAC5C,OAAO,KAAKF,OAAO,GAAGD,QAAQ,GAAGC,OAAO,EAAE;EAC5C,CAAC,CAAC;AACJ,CAAC;AAAC,IAAAG,QAAA,GAAAC,OAAA,CAAAf,OAAA,GAEa,IAAAgB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,UAAU;IACVC;EACF,CAAC,GAAGJ,OAAO,CAACK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAI,CAACF,UAAU,IAAI,CAACC,cAAc,EAAE;IAClCJ,OAAO,CAACM,MAAM,CAAC;MACbC,GAAG,EAAE;QACHC,GAAG,EAAE;UACHC,MAAM,EAAE,CAAC;UACTC,IAAI,EAAE;QACR,CAAC;QACDC,KAAK,EAAE;UACLF,MAAM,EAAE,CAAC;UACTC,IAAI,EAAE;QACR;MACF,CAAC;MACDE,OAAO,EAAE;IACX,CAAC,CAAC;IACF;EACF;EAEA,MAAM;IACJC;EACF,CAAC,GAAGX,KAAK,CAACY,cAAc,CAAC,CAAC;EAE1B,IAAIX,UAAU,EAAE;IACd,IAAIU,YAAY,CAACE,IAAI,CAAE5B,IAAI,IAAK;MAC9B,OAAOH,SAAS,CAACgC,IAAI,CAAC7B,IAAI,CAAC;IAC7B,CAAC,CAAC,EAAE;MACF,MAAMuB,IAAI,GAAGR,KAAK,CAACe,mBAAmB,CAACjC,SAAS,EAAEE,YAAY,CAAC;MAC/DgB,KAAK,CAACgB,WAAW,CAAC,2CAA2C,EAAE;QAC7DR;MACF,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;MAClB;IACF;IAEA,KAAK,MAAMS,GAAG,IAAIlB,KAAK,CAACmB,IAAI,EAAE;MAC5B,IAAID,GAAG,CAACA,GAAG,KAAK,SAAS,EAAE;QACzB;MACF;MAEA,IAAI,uBACFjB,KAAK,CAACmB,iBAAiB,CAACF,GAAG,EAAE,IAAI,CAAC,CAClCJ,IAAI,CAAE5B,IAAI,IAAK;QACf,OAAOH,SAAS,CAACgC,IAAI,CAAC7B,IAAI,CAAC;MAC7B,CAAC,CAAC,EAAE;QACF,MAAMuB,IAAI,GAAGR,KAAK,CAACoB,iBAAiB,CAACH,GAAG,EAAEnC,SAAS,EAAEE,YAAY,CAAC,GAChEiC,GAAG,CAACI,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM;QACtBtB,KAAK,CAACgB,WAAW,CAAC,oDAAoD,EAAE;UACtER;QACF,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;MACpB;IACF;IAEA;EACF;EAEA,IAAIG,YAAY,CAACE,IAAI,CAAE5B,IAAI,IAAK;IAC9B,OAAOF,aAAa,CAAC+B,IAAI,CAAC7B,IAAI,CAAC;EACjC,CAAC,CAAC,EAAE;IACF,MAAMuB,IAAI,GAAGR,KAAK,CAACe,mBAAmB,CAAChC,aAAa,EAAEM,gBAAgB,CAAC;IACvEW,KAAK,CAACgB,WAAW,CAAC,gDAAgD,EAAE;MAClER;IACF,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;IAClB;EACF;EAEA,KAAK,MAAMS,GAAG,IAAIlB,KAAK,CAACmB,IAAI,EAAE;IAC5B,IAAID,GAAG,CAACA,GAAG,KAAK,SAAS,EAAE;MACzB;IACF;IAEA,IAAI,uBACFjB,KAAK,CAACmB,iBAAiB,CAACF,GAAG,EAAE,IAAI,CAAC,CAClCJ,IAAI,CAAE5B,IAAI,IAAK;MACf,OAAOF,aAAa,CAAC+B,IAAI,CAAC7B,IAAI,CAAC;IACjC,CAAC,CAAC,EAAE;MACF,MAAMuB,IAAI,GAAGR,KAAK,CAACoB,iBAAiB,CAClCH,GAAG,EAAElC,aAAa,EAAEM,gBACtB,CAAC,GAAG4B,GAAG,CAACI,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM;MACxBtB,KAAK,CAACgB,WAAW,CACf,yDAAyD,EACzD;QACER;MACF,CAAC,EACD,MAAM,CAAC,CAAC,EACR,IACF,CAAC;IACH;EACF;AACF,CAAC,EAAE;EACDe,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,kFAAkF;MAC/FC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACV;QACA9B,UAAU,EAAE;UACV+B,IAAI,EAAE;QACR,CAAC;QACD9B,cAAc,EAAE;UACd8B,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAArC,OAAA,GAAAA,OAAA,CAAAf,OAAA","ignoreList":[]}
+{"version":3,"file":"textEscaping.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/textEscaping.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// We could disallow raw gt, quot, and apos, but allow for parity; but we do\n//  not allow hex or decimal character references\nconst htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\\S)/v;\nconst markdownRegex = /(?<!\\\\)(`+)([^`]+)\\1(?!`)/v;\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst htmlReplacer = (desc) => {\n  return desc.replaceAll(new RegExp(htmlRegex, 'gv'), (_) => {\n    if (_ === '<') {\n      return '&lt;';\n    }\n\n    return '&amp;';\n  });\n};\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst markdownReplacer = (desc) => {\n  return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {\n    const bookend = '`'.repeat(backticks.length);\n    return `\\\\${bookend}${encapsed}${bookend}`;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    escapeHTML,\n    escapeMarkdown,\n  } = context.options[0] || {};\n\n  if (!escapeHTML && !escapeMarkdown) {\n    context.report({\n      loc: {\n        end: {\n          column: 1,\n          line: 1,\n        },\n        start: {\n          column: 1,\n          line: 1,\n        },\n      },\n      message: 'You must include either `escapeHTML` or `escapeMarkdown`',\n    });\n    return;\n  }\n\n  const {\n    descriptions,\n  } = utils.getDescription();\n\n  if (escapeHTML) {\n    if (descriptions.some((desc) => {\n      return htmlRegex.test(desc);\n    })) {\n      const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);\n      utils.reportJSDoc('You have unescaped HTML characters < or &', {\n        line,\n      }, () => {}, true);\n      return;\n    }\n\n    for (const tag of jsdoc.tags) {\n      if (tag.tag === 'example') {\n        continue;\n      }\n\n      if (/** @type {string[]} */ (\n        utils.getTagDescription(tag, true)\n      ).some((desc) => {\n        return htmlRegex.test(desc);\n      })) {\n        const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) +\n          tag.source[0].number;\n        utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {\n          line,\n        }, () => {}, true);\n      }\n    }\n\n    return;\n  }\n\n  if (descriptions.some((desc) => {\n    return markdownRegex.test(desc);\n  })) {\n    const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);\n    utils.reportJSDoc('You have unescaped Markdown backtick sequences', {\n      line,\n    }, () => {}, true);\n    return;\n  }\n\n  for (const tag of jsdoc.tags) {\n    if (tag.tag === 'example') {\n      continue;\n    }\n\n    if (/** @type {string[]} */ (\n      utils.getTagDescription(tag, true)\n    ).some((desc) => {\n      return markdownRegex.test(desc);\n    })) {\n      const line = utils.setTagDescription(\n        tag, markdownRegex, markdownReplacer,\n      ) + tag.source[0].number;\n      utils.reportJSDoc(\n        'You have unescaped Markdown backtick sequences in a tag',\n        {\n          line,\n        },\n        () => {},\n        true,\n      );\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Auto-escape certain characters that are input within block and tag descriptions.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          // Option properties here (or remove the object)\n          escapeHTML: {\n            type: 'boolean',\n          },\n          escapeMarkdown: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAIA,MAAM,YAAY;AAClB,MAAM,gBAAgB;;;;;AAMtB,MAAM,eAAe,CAAC,SAAS;AAC7B,QAAO,KAAK,WAAW,IAAI,OAAO,WAAW,OAAO,CAAC,MAAM;AACzD,MAAI,MAAM,IACR,QAAO;AAGT,SAAO;CACR,EAAC;AACH;;;;;AAMD,MAAM,mBAAmB,CAAC,SAAS;AACjC,QAAO,KAAK,WAAW,IAAI,OAAO,eAAe,OAAO,CAAC,GAAG,WAAW,aAAa;EAClF,MAAM,UAAU,IAAI,OAAO,UAAU,OAAO;AAC5C,SAAO,CAAC,EAAE,EAAE,UAAU,WAAW,SAAS;CAC3C,EAAC;AACH;AAED,2BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,YACA,gBACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,CAAC,cAAc,CAAC,gBAAgB;EAClC,QAAQ,OAAO;GACb,KAAK;IACH,KAAK;KACH,QAAQ;KACR,MAAM;IACP;IACD,OAAO;KACL,QAAQ;KACR,MAAM;IACP;GACF;GACD,SAAS;EACV,EAAC;AACF;CACD;CAED,MAAM,EACJ,cACD,GAAG,MAAM,gBAAgB;AAE1B,KAAI,YAAY;AACd,MAAI,aAAa,KAAK,CAAC,SAAS;AAC9B,UAAO,UAAU,KAAK,KAAK;EAC5B,EAAC,EAAE;GACF,MAAM,OAAO,MAAM,oBAAoB,WAAW,aAAa;GAC/D,MAAM,YAAY,6CAA6C,EAC7D,KACD,GAAE,MAAM,CAAE,GAAE,KAAK;AAClB;EACD;AAED,OAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,OAAI,IAAI,QAAQ,UACd;AAGF,OACE,MAAM,kBAAkB,KAAK,KAAK,CAClC,KAAK,CAAC,SAAS;AACf,WAAO,UAAU,KAAK,KAAK;GAC5B,EAAC,EAAE;IACF,MAAM,OAAO,MAAM,kBAAkB,KAAK,WAAW,aAAa,GAChE,IAAI,OAAO,GAAG;IAChB,MAAM,YAAY,sDAAsD,EACtE,KACD,GAAE,MAAM,CAAE,GAAE,KAAK;GACnB;EACF;AAED;CACD;AAED,KAAI,aAAa,KAAK,CAAC,SAAS;AAC9B,SAAO,cAAc,KAAK,KAAK;CAChC,EAAC,EAAE;EACF,MAAM,OAAO,MAAM,oBAAoB,eAAe,iBAAiB;EACvE,MAAM,YAAY,kDAAkD,EAClE,KACD,GAAE,MAAM,CAAE,GAAE,KAAK;AAClB;CACD;AAED,MAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,MAAI,IAAI,QAAQ,UACd;AAGF,MACE,MAAM,kBAAkB,KAAK,KAAK,CAClC,KAAK,CAAC,SAAS;AACf,UAAO,cAAc,KAAK,KAAK;EAChC,EAAC,EAAE;GACF,MAAM,OAAO,MAAM,kBACjB,KAAK,eAAe,iBACrB,GAAG,IAAI,OAAO,GAAG;GAClB,MAAM,YACJ,2DACA,EACE,KACD,GACD,MAAM,CAAE,GACR,KACD;EACF;CACF;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IAEV,YAAY,EACV,MAAM,UACP;IACD,gBAAgB,EACd,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/textEscaping.js

@@ -0,0 +1,102 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/textEscaping.js
+const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/v;
+const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/v;
+/**
+* @param {string} desc
+* @returns {string}
+*/
+const htmlReplacer = (desc) => {
+	return desc.replaceAll(new RegExp(htmlRegex, "gv"), (_) => {
+		if (_ === "<") return "&lt;";
+		return "&amp;";
+	});
+};
+/**
+* @param {string} desc
+* @returns {string}
+*/
+const markdownReplacer = (desc) => {
+	return desc.replaceAll(new RegExp(markdownRegex, "gv"), (_, backticks, encapsed) => {
+		const bookend = "`".repeat(backticks.length);
+		return `\\${bookend}${encapsed}${bookend}`;
+	});
+};
+var textEscaping_default = iterateJsdoc(({ context, jsdoc, utils }) => {
+	const { escapeHTML, escapeMarkdown } = context.options[0] || {};
+	if (!escapeHTML && !escapeMarkdown) {
+		context.report({
+			loc: {
+				end: {
+					column: 1,
+					line: 1
+				},
+				start: {
+					column: 1,
+					line: 1
+				}
+			},
+			message: "You must include either `escapeHTML` or `escapeMarkdown`"
+		});
+		return;
+	}
+	const { descriptions } = utils.getDescription();
+	if (escapeHTML) {
+		if (descriptions.some((desc) => {
+			return htmlRegex.test(desc);
+		})) {
+			const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);
+			utils.reportJSDoc("You have unescaped HTML characters < or &", { line }, () => {}, true);
+			return;
+		}
+		for (const tag of jsdoc.tags) {
+			if (tag.tag === "example") continue;
+			if (utils.getTagDescription(tag, true).some((desc) => {
+				return htmlRegex.test(desc);
+			})) {
+				const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) + tag.source[0].number;
+				utils.reportJSDoc("You have unescaped HTML characters < or & in a tag", { line }, () => {}, true);
+			}
+		}
+		return;
+	}
+	if (descriptions.some((desc) => {
+		return markdownRegex.test(desc);
+	})) {
+		const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);
+		utils.reportJSDoc("You have unescaped Markdown backtick sequences", { line }, () => {}, true);
+		return;
+	}
+	for (const tag of jsdoc.tags) {
+		if (tag.tag === "example") continue;
+		if (utils.getTagDescription(tag, true).some((desc) => {
+			return markdownRegex.test(desc);
+		})) {
+			const line = utils.setTagDescription(tag, markdownRegex, markdownReplacer) + tag.source[0].number;
+			utils.reportJSDoc("You have unescaped Markdown backtick sequences in a tag", { line }, () => {}, true);
+		}
+	}
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Auto-escape certain characters that are input within block and tag descriptions.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				escapeHTML: { type: "boolean" },
+				escapeMarkdown: { type: "boolean" }
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { textEscaping_default as default };
+//# sourceMappingURL=textEscaping.js.map

package/dist/rules/textEscaping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"textEscaping.js","names":[],"sources":["../../src/rules/textEscaping.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// We could disallow raw gt, quot, and apos, but allow for parity; but we do\n//  not allow hex or decimal character references\nconst htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\\S)/v;\nconst markdownRegex = /(?<!\\\\)(`+)([^`]+)\\1(?!`)/v;\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst htmlReplacer = (desc) => {\n  return desc.replaceAll(new RegExp(htmlRegex, 'gv'), (_) => {\n    if (_ === '<') {\n      return '&lt;';\n    }\n\n    return '&amp;';\n  });\n};\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst markdownReplacer = (desc) => {\n  return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {\n    const bookend = '`'.repeat(backticks.length);\n    return `\\\\${bookend}${encapsed}${bookend}`;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    escapeHTML,\n    escapeMarkdown,\n  } = context.options[0] || {};\n\n  if (!escapeHTML && !escapeMarkdown) {\n    context.report({\n      loc: {\n        end: {\n          column: 1,\n          line: 1,\n        },\n        start: {\n          column: 1,\n          line: 1,\n        },\n      },\n      message: 'You must include either `escapeHTML` or `escapeMarkdown`',\n    });\n    return;\n  }\n\n  const {\n    descriptions,\n  } = utils.getDescription();\n\n  if (escapeHTML) {\n    if (descriptions.some((desc) => {\n      return htmlRegex.test(desc);\n    })) {\n      const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);\n      utils.reportJSDoc('You have unescaped HTML characters < or &', {\n        line,\n      }, () => {}, true);\n      return;\n    }\n\n    for (const tag of jsdoc.tags) {\n      if (tag.tag === 'example') {\n        continue;\n      }\n\n      if (/** @type {string[]} */ (\n        utils.getTagDescription(tag, true)\n      ).some((desc) => {\n        return htmlRegex.test(desc);\n      })) {\n        const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) +\n          tag.source[0].number;\n        utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {\n          line,\n        }, () => {}, true);\n      }\n    }\n\n    return;\n  }\n\n  if (descriptions.some((desc) => {\n    return markdownRegex.test(desc);\n  })) {\n    const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);\n    utils.reportJSDoc('You have unescaped Markdown backtick sequences', {\n      line,\n    }, () => {}, true);\n    return;\n  }\n\n  for (const tag of jsdoc.tags) {\n    if (tag.tag === 'example') {\n      continue;\n    }\n\n    if (/** @type {string[]} */ (\n      utils.getTagDescription(tag, true)\n    ).some((desc) => {\n      return markdownRegex.test(desc);\n    })) {\n      const line = utils.setTagDescription(\n        tag, markdownRegex, markdownReplacer,\n      ) + tag.source[0].number;\n      utils.reportJSDoc(\n        'You have unescaped Markdown backtick sequences in a tag',\n        {\n          line,\n        },\n        () => {},\n        true,\n      );\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Auto-escape certain characters that are input within block and tag descriptions.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          // Option properties here (or remove the object)\n          escapeHTML: {\n            type: 'boolean',\n          },\n          escapeMarkdown: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAIA,MAAM,YAAY;AAClB,MAAM,gBAAgB;;;;;AAMtB,MAAM,eAAe,CAAC,SAAS;AAC7B,QAAO,KAAK,WAAW,IAAI,OAAO,WAAW,OAAO,CAAC,MAAM;AACzD,MAAI,MAAM,IACR,QAAO;AAGT,SAAO;CACR,EAAC;AACH;;;;;AAMD,MAAM,mBAAmB,CAAC,SAAS;AACjC,QAAO,KAAK,WAAW,IAAI,OAAO,eAAe,OAAO,CAAC,GAAG,WAAW,aAAa;EAClF,MAAM,UAAU,IAAI,OAAO,UAAU,OAAO;AAC5C,SAAO,CAAC,EAAE,EAAE,UAAU,WAAW,SAAS;CAC3C,EAAC;AACH;AAED,2BAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,YACA,gBACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,CAAC,cAAc,CAAC,gBAAgB;EAClC,QAAQ,OAAO;GACb,KAAK;IACH,KAAK;KACH,QAAQ;KACR,MAAM;IACP;IACD,OAAO;KACL,QAAQ;KACR,MAAM;IACP;GACF;GACD,SAAS;EACV,EAAC;AACF;CACD;CAED,MAAM,EACJ,cACD,GAAG,MAAM,gBAAgB;AAE1B,KAAI,YAAY;AACd,MAAI,aAAa,KAAK,CAAC,SAAS;AAC9B,UAAO,UAAU,KAAK,KAAK;EAC5B,EAAC,EAAE;GACF,MAAM,OAAO,MAAM,oBAAoB,WAAW,aAAa;GAC/D,MAAM,YAAY,6CAA6C,EAC7D,KACD,GAAE,MAAM,CAAE,GAAE,KAAK;AAClB;EACD;AAED,OAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,OAAI,IAAI,QAAQ,UACd;AAGF,OACE,MAAM,kBAAkB,KAAK,KAAK,CAClC,KAAK,CAAC,SAAS;AACf,WAAO,UAAU,KAAK,KAAK;GAC5B,EAAC,EAAE;IACF,MAAM,OAAO,MAAM,kBAAkB,KAAK,WAAW,aAAa,GAChE,IAAI,OAAO,GAAG;IAChB,MAAM,YAAY,sDAAsD,EACtE,KACD,GAAE,MAAM,CAAE,GAAE,KAAK;GACnB;EACF;AAED;CACD;AAED,KAAI,aAAa,KAAK,CAAC,SAAS;AAC9B,SAAO,cAAc,KAAK,KAAK;CAChC,EAAC,EAAE;EACF,MAAM,OAAO,MAAM,oBAAoB,eAAe,iBAAiB;EACvE,MAAM,YAAY,kDAAkD,EAClE,KACD,GAAE,MAAM,CAAE,GAAE,KAAK;AAClB;CACD;AAED,MAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,MAAI,IAAI,QAAQ,UACd;AAGF,MACE,MAAM,kBAAkB,KAAK,KAAK,CAClC,KAAK,CAAC,SAAS;AACf,UAAO,cAAc,KAAK,KAAK;EAChC,EAAC,EAAE;GACF,MAAM,OAAO,MAAM,kBACjB,KAAK,eAAe,iBACrB,GAAG,IAAI,OAAO,GAAG;GAClB,MAAM,YACJ,2DACA,EACE,KACD,GACD,MAAM,CAAE,GACR,KACD;EACF;CACF;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IAEV,YAAY,EACV,MAAM,UACP;IACD,gBAAgB,EACd,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}