eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/tagLines.js

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

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

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

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

package/dist/rules/validTypes.js

@@ -1,259 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import { parse, traverse, tryParse } from "@es-joy/jsdoccomment";
-
-//#region src/rules/validTypes.js
-const inlineTags = new Set([
-	"link",
-	"linkcode",
-	"linkplain",
-	"tutorial"
-]);
-const jsdocTypePrattKeywords = new Set([
-	"import",
-	"is",
-	"readonly",
-	"typeof"
-]);
-const asExpression = /as\s+/v;
-const suppressTypes = new Set([
-	"accessControls",
-	"checkDebuggerStatement",
-	"checkEs5InheritanceCorrectnessConditions",
-	"checkPrototypalTypes",
-	"checkRegExp",
-	"checkTypes",
-	"checkVars",
-	"closureClassChecks",
-	"closureDepMethodUsageChecks",
-	"const",
-	"constantProperty",
-	"dangerousUnrecognizedTypeError",
-	"deprecated",
-	"duplicate",
-	"es5Strict",
-	"externsValidation",
-	"extraProvide",
-	"extraRequire",
-	"globalThis",
-	"invalidCasts",
-	"lateProvide",
-	"legacyGoogScopeRequire",
-	"lintChecks",
-	"lintVarDeclarations",
-	"messageConventions",
-	"misplacedTypeAnnotation",
-	"missingOverride",
-	"missingPolyfill",
-	"missingProperties",
-	"missingProvide",
-	"missingRequire",
-	"missingReturn",
-	"missingSourcesWarnings",
-	"moduleLoad",
-	"msgDescriptions",
-	"nonStandardJsDocs",
-	"partialAlias",
-	"polymer",
-	"reportUnknownTypes",
-	"strictCheckTypes",
-	"strictMissingProperties",
-	"strictModuleDepCheck",
-	"strictPrimitiveOperators",
-	"suspiciousCode",
-	"switch",
-	"transitionalSuspiciousCodeWarnings",
-	"undefinedNames",
-	"undefinedVars",
-	"underscore",
-	"unknownDefines",
-	"untranspilableFeatures",
-	"unusedLocalVariables",
-	"unusedPrivateMembers",
-	"uselessCode",
-	"useOfGoogProvide",
-	"visibility",
-	"with"
-]);
-/**
-* @param {string} path
-* @returns {boolean}
-*/
-const tryParsePathIgnoreError = (path) => {
-	try {
-		tryParse(path);
-		return true;
-	} catch {}
-	return false;
-};
-var validTypes_default = iterateJsdoc(({ context, jsdoc, report, settings, utils }) => {
-	const { allowEmptyNamepaths = false } = context.options[0] || {};
-	const { mode } = settings;
-	for (const tag of jsdoc.tags) {
-		/**
-		* @param {string} namepath
-		* @param {string} [tagName]
-		* @returns {boolean}
-		*/
-		const validNamepathParsing = function(namepath, tagName) {
-			if (tryParsePathIgnoreError(namepath) || jsdocTypePrattKeywords.has(namepath)) return true;
-			let handled = false;
-			if (tagName) switch (tagName) {
-				case "memberof":
-				case "memberof!": {
-					const endChar = namepath.slice(-1);
-					if ([
-						"#",
-						".",
-						"~"
-					].includes(endChar)) handled = tryParsePathIgnoreError(namepath.slice(0, -1));
-					break;
-				}
-				case "module":
-				case "requires":
-					if (!namepath.startsWith("module:")) handled = tryParsePathIgnoreError(`module:${namepath}`);
-					break;
-				case "borrows": {
-					const startChar = namepath.charAt(0);
-					if ([
-						"#",
-						".",
-						"~"
-					].includes(startChar)) handled = tryParsePathIgnoreError(namepath.slice(1));
-				}
-			}
-			if (!handled) {
-				report(`Syntax error in namepath: ${namepath}`, null, tag);
-				return false;
-			}
-			return true;
-		};
-		/**
-		* @param {string} type
-		* @returns {boolean}
-		*/
-		const validTypeParsing = function(type) {
-			let parsedTypes;
-			try {
-				if (mode === "permissive") parsedTypes = tryParse(type);
-				else parsedTypes = parse(type, mode);
-			} catch {
-				report(`Syntax error in type: ${type}`, null, tag);
-				return false;
-			}
-			if (mode === "closure" || mode === "typescript") traverse(parsedTypes, (node) => {
-				const { type: typ } = node;
-				if ((typ === "JsdocTypeObjectField" || typ === "JsdocTypeKeyValue") && node.right?.type === "JsdocTypeNullable" && node.right?.meta?.position === "suffix") report(`Syntax error in type: ${node.right.type}`, null, tag);
-			});
-			return true;
-		};
-		if (tag.problems.length) {
-			const msg = tag.problems.reduce((str, { message }) => {
-				return str + "; " + message;
-			}, "").slice(2);
-			report(`Invalid name: ${msg}`, null, tag);
-			continue;
-		}
-		if (tag.tag === "import") continue;
-		if (tag.tag === "borrows") {
-			const thisNamepath = utils.getTagDescription(tag).replace(asExpression, "").trim();
-			if (!asExpression.test(utils.getTagDescription(tag)) || !thisNamepath) {
-				report(`@borrows must have an "as" expression. Found "${utils.getTagDescription(tag)}"`, null, tag);
-				continue;
-			}
-			if (validNamepathParsing(thisNamepath, "borrows")) {
-				const thatNamepath = tag.name;
-				validNamepathParsing(thatNamepath);
-			}
-			continue;
-		}
-		if (tag.tag === "suppress" && mode === "closure") {
-			let parsedTypes;
-			try {
-				parsedTypes = tryParse(tag.type);
-			} catch {}
-			if (parsedTypes) traverse(parsedTypes, (node) => {
-				let type;
-				if ("value" in node && typeof node.value === "string") type = node.value;
-				if (type !== void 0 && !suppressTypes.has(type)) report(`Syntax error in suppress type: ${type}`, null, tag);
-			});
-		}
-		const otherModeMaps = [
-			"jsdoc",
-			"typescript",
-			"closure",
-			"permissive"
-		].filter((mde) => {
-			return mde !== mode;
-		}).map((mde) => {
-			return utils.getTagStructureForMode(mde);
-		});
-		const tagMightHaveNamePosition = utils.tagMightHaveNamePosition(tag.tag, otherModeMaps);
-		if (tagMightHaveNamePosition !== true && tag.name) {
-			const modeInfo = tagMightHaveNamePosition === false ? "" : ` in "${mode}" mode`;
-			report(`@${tag.tag} should not have a name${modeInfo}.`, null, tag);
-			continue;
-		}
-		if (tag.type.trim().startsWith("@")) {
-			tag.description = `{${tag.type}} ${tag.description}`;
-			tag.type = "";
-		}
-		const mightHaveTypePosition = utils.tagMightHaveTypePosition(tag.tag, otherModeMaps);
-		if (mightHaveTypePosition !== true && tag.type) {
-			const modeInfo = mightHaveTypePosition === false ? "" : ` in "${mode}" mode`;
-			report(`@${tag.tag} should not have a bracketed type${modeInfo}.`, null, tag);
-			continue;
-		}
-		const tagMustHaveNamePosition = utils.tagMustHaveNamePosition(tag.tag, otherModeMaps);
-		if (tagMustHaveNamePosition !== false && !tag.name && !allowEmptyNamepaths && ![
-			"arg",
-			"argument",
-			"param",
-			"prop",
-			"property"
-		].includes(tag.tag) && (tag.tag !== "see" || !utils.getTagDescription(tag).includes("{@link"))) {
-			const modeInfo = tagMustHaveNamePosition === true ? "" : ` in "${mode}" mode`;
-			report(`Tag @${tag.tag} must have a name/namepath${modeInfo}.`, null, tag);
-			continue;
-		}
-		const mustHaveTypePosition = utils.tagMustHaveTypePosition(tag.tag, otherModeMaps);
-		if (mustHaveTypePosition !== false && !tag.type) {
-			const modeInfo = mustHaveTypePosition === true ? "" : ` in "${mode}" mode`;
-			report(`Tag @${tag.tag} must have a type${modeInfo}.`, null, tag);
-			continue;
-		}
-		const tagMissingRequiredTypeOrNamepath = utils.tagMissingRequiredTypeOrNamepath(tag, otherModeMaps);
-		if (tagMissingRequiredTypeOrNamepath !== false && !allowEmptyNamepaths) {
-			const modeInfo = tagMissingRequiredTypeOrNamepath === true ? "" : ` in "${mode}" mode`;
-			report(`Tag @${tag.tag} must have either a type or namepath${modeInfo}.`, null, tag);
-			continue;
-		}
-		const hasTypePosition = mightHaveTypePosition === true && Boolean(tag.type);
-		if (hasTypePosition) validTypeParsing(tag.type);
-		const hasNameOrNamepathPosition = (tagMustHaveNamePosition !== false || utils.tagMightHaveNamepath(tag.tag)) && Boolean(tag.name);
-		if (hasNameOrNamepathPosition) if (mode !== "jsdoc" && tag.tag === "template") for (const namepath of utils.parseClosureTemplateTag(tag)) validNamepathParsing(namepath);
-		else validNamepathParsing(tag.name, tag.tag);
-		for (const inlineTag of tag.inlineTags) if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) report(`Inline tag "${inlineTag.tag}" missing content`, null, tag);
-	}
-	for (const inlineTag of jsdoc.inlineTags) if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) report(`Inline tag "${inlineTag.tag}" missing content`);
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires all types to be valid JSDoc or Closure compiler types without syntax errors.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/valid-types.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { allowEmptyNamepaths: {
-				default: false,
-				type: "boolean"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { validTypes_default as default };
-//# sourceMappingURL=validTypes.js.map

package/dist/rules/validTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validTypes.js","names":[],"sources":["../../src/rules/validTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\n\nconst inlineTags = new Set([\n  'link', 'linkcode', 'linkplain',\n  'tutorial',\n]);\n\nconst jsdocTypePrattKeywords = new Set([\n  'import',\n  'is',\n  'readonly',\n  'typeof',\n]);\n\nconst asExpression = /as\\s+/v;\n\nconst suppressTypes = new Set([\n  // https://github.com/google/closure-compiler/wiki/@suppress-annotations\n  // https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/ParserConfig.properties#L154\n  'accessControls',\n  'checkDebuggerStatement',\n  'checkEs5InheritanceCorrectnessConditions',\n  'checkPrototypalTypes',\n  'checkRegExp',\n  'checkTypes',\n  'checkVars',\n  'closureClassChecks',\n  'closureDepMethodUsageChecks',\n  'const',\n  'constantProperty',\n  'dangerousUnrecognizedTypeError',\n  'deprecated',\n  'duplicate',\n  'es5Strict',\n  'externsValidation',\n  'extraProvide',\n  'extraRequire',\n  'globalThis',\n  'invalidCasts',\n  'lateProvide',\n  'legacyGoogScopeRequire',\n  'lintChecks',\n  'lintVarDeclarations',\n  'messageConventions',\n  'misplacedTypeAnnotation',\n  'missingOverride',\n  'missingPolyfill',\n  'missingProperties',\n  'missingProvide',\n  'missingRequire',\n  'missingReturn',\n  'missingSourcesWarnings',\n  'moduleLoad',\n  'msgDescriptions',\n  'nonStandardJsDocs',\n  'partialAlias',\n  'polymer',\n  'reportUnknownTypes',\n  'strictCheckTypes',\n  'strictMissingProperties',\n  'strictModuleDepCheck',\n  'strictPrimitiveOperators',\n  'suspiciousCode',\n\n  // Not documented in enum\n  'switch',\n  'transitionalSuspiciousCodeWarnings',\n  'undefinedNames',\n  'undefinedVars',\n  'underscore',\n  'unknownDefines',\n  'untranspilableFeatures',\n  'unusedLocalVariables',\n\n  // Not documented?\n  'unusedPrivateMembers',\n  'uselessCode',\n  'useOfGoogProvide',\n  'visibility',\n  'with',\n]);\n\n/**\n * @param {string} path\n * @returns {boolean}\n */\nconst tryParsePathIgnoreError = (path) => {\n  try {\n    tryParse(path);\n\n    return true;\n  } catch {\n    // Keep the original error for including the whole type\n  }\n\n  return false;\n};\n\n// eslint-disable-next-line complexity\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    allowEmptyNamepaths = false,\n  } = context.options[0] || {};\n  const {\n    mode,\n  } = settings;\n\n  for (const tag of jsdoc.tags) {\n    /**\n     * @param {string} namepath\n     * @param {string} [tagName]\n     * @returns {boolean}\n     */\n    const validNamepathParsing = function (namepath, tagName) {\n      if (\n        tryParsePathIgnoreError(namepath) ||\n        jsdocTypePrattKeywords.has(namepath)\n      ) {\n        return true;\n      }\n\n      let handled = false;\n\n      if (tagName) {\n        switch (tagName) {\n          case 'memberof':\n          case 'memberof!': {\n            const endChar = namepath.slice(-1);\n            if ([\n              '#', '.', '~',\n            ].includes(endChar)) {\n              handled = tryParsePathIgnoreError(namepath.slice(0, -1));\n            }\n\n            break;\n          }\n\n          case 'module': case 'requires': {\n            if (!namepath.startsWith('module:')) {\n              handled = tryParsePathIgnoreError(`module:${namepath}`);\n            }\n\n            break;\n          }\n\n          case 'borrows': {\n            const startChar = namepath.charAt(0);\n            if ([\n              '#', '.', '~',\n            ].includes(startChar)) {\n              handled = tryParsePathIgnoreError(namepath.slice(1));\n            }\n          }\n        }\n      }\n\n      if (!handled) {\n        report(`Syntax error in namepath: ${namepath}`, null, tag);\n\n        return false;\n      }\n\n      return true;\n    };\n\n    /**\n     * @param {string} type\n     * @returns {boolean}\n     */\n    const validTypeParsing = function (type) {\n      let parsedTypes;\n      try {\n        if (mode === 'permissive') {\n          parsedTypes = tryParse(type);\n        } else {\n          parsedTypes = parse(type, mode);\n        }\n      } catch {\n        report(`Syntax error in type: ${type}`, null, tag);\n\n        return false;\n      }\n\n      if (mode === 'closure' || mode === 'typescript') {\n        traverse(parsedTypes, (node) => {\n          const {\n            type: typ,\n          } = node;\n\n          if (\n            (typ === 'JsdocTypeObjectField' || typ === 'JsdocTypeKeyValue') &&\n            node.right?.type === 'JsdocTypeNullable' &&\n            node.right?.meta?.position === 'suffix'\n          ) {\n            report(`Syntax error in type: ${node.right.type}`, null, tag);\n          }\n        });\n      }\n\n      return true;\n    };\n\n    if (tag.problems.length) {\n      const msg = tag.problems.reduce((str, {\n        message,\n      }) => {\n        return str + '; ' + message;\n      }, '').slice(2);\n      report(`Invalid name: ${msg}`, null, tag);\n      continue;\n    }\n\n    if (tag.tag === 'import') {\n      // A named import will look like a type, but not be valid; we also don't\n      //  need to check the name/namepath\n      continue;\n    }\n\n    if (tag.tag === 'borrows') {\n      const thisNamepath = /** @type {string} */ (\n        utils.getTagDescription(tag)\n      ).replace(asExpression, '')\n        .trim();\n\n      if (!asExpression.test(/** @type {string} */ (\n        utils.getTagDescription(tag)\n      )) || !thisNamepath) {\n        report(`@borrows must have an \"as\" expression. Found \"${utils.getTagDescription(tag)}\"`, null, tag);\n\n        continue;\n      }\n\n      if (validNamepathParsing(thisNamepath, 'borrows')) {\n        const thatNamepath = tag.name;\n\n        validNamepathParsing(thatNamepath);\n      }\n\n      continue;\n    }\n\n    if (tag.tag === 'suppress' && mode === 'closure') {\n      let parsedTypes;\n\n      try {\n        parsedTypes = tryParse(tag.type);\n      } catch {\n        // Ignore\n      }\n\n      if (parsedTypes) {\n        traverse(parsedTypes, (node) => {\n          let type;\n          if ('value' in node && typeof node.value === 'string') {\n            type = node.value;\n          }\n\n          if (type !== undefined && !suppressTypes.has(type)) {\n            report(`Syntax error in suppress type: ${type}`, null, tag);\n          }\n        });\n      }\n    }\n\n    const otherModeMaps = /** @type {import('../jsdocUtils.js').ParserMode[]} */ ([\n      'jsdoc', 'typescript', 'closure', 'permissive',\n    ]).filter(\n      (mde) => {\n        return mde !== mode;\n      },\n    ).map((mde) => {\n      return utils.getTagStructureForMode(mde);\n    });\n\n    const tagMightHaveNamePosition = utils.tagMightHaveNamePosition(tag.tag, otherModeMaps);\n    if (tagMightHaveNamePosition !== true && tag.name) {\n      const modeInfo = tagMightHaveNamePosition === false ? '' : ` in \"${mode}\" mode`;\n      report(`@${tag.tag} should not have a name${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // Documentation like `@returns {@link SomeType}` is technically ambiguous. Specifically it\n    // could either be intepreted as a type `\"@link SomeType\"` or a description `\"{@link SomeType}\"`.\n    // However this is a good heuristic.\n    if (tag.type.trim().startsWith('@')) {\n      tag.description = `{${tag.type}} ${tag.description}`;\n      tag.type = '';\n    }\n\n    const mightHaveTypePosition = utils.tagMightHaveTypePosition(tag.tag, otherModeMaps);\n    if (mightHaveTypePosition !== true && tag.type) {\n      const modeInfo = mightHaveTypePosition === false ? '' : ` in \"${mode}\" mode`;\n      report(`@${tag.tag} should not have a bracketed type${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // REQUIRED NAME\n    const tagMustHaveNamePosition = utils.tagMustHaveNamePosition(tag.tag, otherModeMaps);\n\n    // Don't handle `@param` here though it does require name as handled by\n    //  `require-param-name` (`@property` would similarly seem to require one,\n    //  but is handled by `require-property-name`)\n    if (tagMustHaveNamePosition !== false && !tag.name && !allowEmptyNamepaths && ![\n      'arg', 'argument', 'param',\n      'prop', 'property',\n    ].includes(tag.tag) &&\n      (tag.tag !== 'see' || !utils.getTagDescription(tag).includes('{@link'))\n    ) {\n      const modeInfo = tagMustHaveNamePosition === true ? '' : ` in \"${mode}\" mode`;\n      report(`Tag @${tag.tag} must have a name/namepath${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // REQUIRED TYPE\n    const mustHaveTypePosition = utils.tagMustHaveTypePosition(tag.tag, otherModeMaps);\n    if (mustHaveTypePosition !== false && !tag.type) {\n      const modeInfo = mustHaveTypePosition === true ? '' : ` in \"${mode}\" mode`;\n      report(`Tag @${tag.tag} must have a type${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // REQUIRED TYPE OR NAME/NAMEPATH\n    const tagMissingRequiredTypeOrNamepath = utils.tagMissingRequiredTypeOrNamepath(tag, otherModeMaps);\n    if (tagMissingRequiredTypeOrNamepath !== false && !allowEmptyNamepaths) {\n      const modeInfo = tagMissingRequiredTypeOrNamepath === true ? '' : ` in \"${mode}\" mode`;\n      report(`Tag @${tag.tag} must have either a type or namepath${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // VALID TYPE\n    const hasTypePosition = mightHaveTypePosition === true && Boolean(tag.type);\n    if (hasTypePosition) {\n      validTypeParsing(tag.type);\n    }\n\n    // VALID NAME/NAMEPATH\n    const hasNameOrNamepathPosition = (\n      tagMustHaveNamePosition !== false ||\n      utils.tagMightHaveNamepath(tag.tag)\n    ) && Boolean(tag.name);\n\n    if (hasNameOrNamepathPosition) {\n      if (mode !== 'jsdoc' && tag.tag === 'template') {\n        for (const namepath of utils.parseClosureTemplateTag(tag)) {\n          validNamepathParsing(namepath);\n        }\n      } else {\n        validNamepathParsing(tag.name, tag.tag);\n      }\n    }\n\n    for (const inlineTag of tag.inlineTags) {\n      if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) {\n        report(`Inline tag \"${inlineTag.tag}\" missing content`, null, tag);\n      }\n    }\n  }\n\n  for (const inlineTag of jsdoc.inlineTags) {\n    if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) {\n      report(`Inline tag \"${inlineTag.tag}\" missing content`);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires all types to be valid JSDoc or Closure compiler types without syntax errors.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/valid-types.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowEmptyNamepaths: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAOA,MAAM,aAAa,IAAI,IAAI;CACzB;CAAQ;CAAY;CACpB;AACD;AAED,MAAM,yBAAyB,IAAI,IAAI;CACrC;CACA;CACA;CACA;AACD;AAED,MAAM,eAAe;AAErB,MAAM,gBAAgB,IAAI,IAAI;CAG5B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAGA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAGA;CACA;CACA;CACA;CACA;AACD;;;;;AAMD,MAAM,0BAA0B,CAAC,SAAS;AACxC,KAAI;EACF,SAAS,KAAK;AAEd,SAAO;CACR,QAAO,CAEP;AAED,QAAO;AACR;AAGD,yBAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,sBAAsB,OACvB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,EACJ,MACD,GAAG;AAEJ,MAAK,MAAM,OAAO,MAAM,MAAM;;;;;;EAM5B,MAAM,uBAAuB,SAAU,UAAU,SAAS;AACxD,OACE,wBAAwB,SAAS,IACjC,uBAAuB,IAAI,SAAS,CAEpC,QAAO;GAGT,IAAI,UAAU;AAEd,OAAI,QACF,SAAQ,SAAR;IACE,KAAK;IACL,KAAK,aAAa;KAChB,MAAM,UAAU,SAAS,MAAM,GAAG;AAClC,SAAI;MACF;MAAK;MAAK;KACX,EAAC,SAAS,QAAQ,EACjB,UAAU,wBAAwB,SAAS,MAAM,GAAG,GAAG,CAAC;AAG1D;IACD;IAED,KAAK;IAAU,KAAK;AAClB,SAAI,CAAC,SAAS,WAAW,UAAU,EACjC,UAAU,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC;AAGzD;IAGF,KAAK,WAAW;KACd,MAAM,YAAY,SAAS,OAAO,EAAE;AACpC,SAAI;MACF;MAAK;MAAK;KACX,EAAC,SAAS,UAAU,EACnB,UAAU,wBAAwB,SAAS,MAAM,EAAE,CAAC;IAEvD;GACF;AAGH,OAAI,CAAC,SAAS;IACZ,OAAO,CAAC,0BAA0B,EAAE,UAAU,EAAE,MAAM,IAAI;AAE1D,WAAO;GACR;AAED,UAAO;EACR;;;;;EAMD,MAAM,mBAAmB,SAAU,MAAM;GACvC,IAAI;AACJ,OAAI;AACF,QAAI,SAAS,cACX,cAAc,SAAS,KAAK;SAE5B,cAAc,MAAM,MAAM,KAAK;GAElC,QAAO;IACN,OAAO,CAAC,sBAAsB,EAAE,MAAM,EAAE,MAAM,IAAI;AAElD,WAAO;GACR;AAED,OAAI,SAAS,aAAa,SAAS,cACjC,SAAS,aAAa,CAAC,SAAS;IAC9B,MAAM,EACJ,MAAM,KACP,GAAG;AAEJ,SACG,QAAQ,0BAA0B,QAAQ,wBAC3C,KAAK,OAAO,SAAS,uBACrB,KAAK,OAAO,MAAM,aAAa,UAE/B,OAAO,CAAC,sBAAsB,EAAE,KAAK,MAAM,MAAM,EAAE,MAAM,IAAI;GAEhE,EAAC;AAGJ,UAAO;EACR;AAED,MAAI,IAAI,SAAS,QAAQ;GACvB,MAAM,MAAM,IAAI,SAAS,OAAO,CAAC,KAAK,EACpC,SACD,KAAK;AACJ,WAAO,MAAM,OAAO;GACrB,GAAE,GAAG,CAAC,MAAM,EAAE;GACf,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,MAAM,IAAI;AACzC;EACD;AAED,MAAI,IAAI,QAAQ,SAGd;AAGF,MAAI,IAAI,QAAQ,WAAW;GACzB,MAAM,eACJ,MAAM,kBAAkB,IAAI,CAC5B,QAAQ,cAAc,GAAG,CACxB,MAAM;AAET,OAAI,CAAC,aAAa,KAChB,MAAM,kBAAkB,IAAI,CAC5B,IAAI,CAAC,cAAc;IACnB,OAAO,CAAC,8CAA8C,EAAE,MAAM,kBAAkB,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI;AAEnG;GACD;AAED,OAAI,qBAAqB,cAAc,UAAU,EAAE;IACjD,MAAM,eAAe,IAAI;IAEzB,qBAAqB,aAAa;GACnC;AAED;EACD;AAED,MAAI,IAAI,QAAQ,cAAc,SAAS,WAAW;GAChD,IAAI;AAEJ,OAAI;IACF,cAAc,SAAS,IAAI,KAAK;GACjC,QAAO,CAEP;AAED,OAAI,aACF,SAAS,aAAa,CAAC,SAAS;IAC9B,IAAI;AACJ,QAAI,WAAW,QAAQ,OAAO,KAAK,UAAU,UAC3C,OAAO,KAAK;AAGd,QAAI,SAAS,UAAa,CAAC,cAAc,IAAI,KAAK,EAChD,OAAO,CAAC,+BAA+B,EAAE,MAAM,EAAE,MAAM,IAAI;GAE9D,EAAC;EAEL;EAED,MAAM,gBAAwE;GAC5E;GAAS;GAAc;GAAW;EACnC,EAAE,OACD,CAAC,QAAQ;AACP,UAAO,QAAQ;EAChB,EACF,CAAC,IAAI,CAAC,QAAQ;AACb,UAAO,MAAM,uBAAuB,IAAI;EACzC,EAAC;EAEF,MAAM,2BAA2B,MAAM,yBAAyB,IAAI,KAAK,cAAc;AACvF,MAAI,6BAA6B,QAAQ,IAAI,MAAM;GACjD,MAAM,WAAW,6BAA6B,QAAQ,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC/E,OAAO,CAAC,CAAC,EAAE,IAAI,IAAI,uBAAuB,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAEnE;EACD;AAKD,MAAI,IAAI,KAAK,MAAM,CAAC,WAAW,IAAI,EAAE;GACnC,IAAI,cAAc,CAAC,CAAC,EAAE,IAAI,KAAK,EAAE,EAAE,IAAI,aAAa;GACpD,IAAI,OAAO;EACZ;EAED,MAAM,wBAAwB,MAAM,yBAAyB,IAAI,KAAK,cAAc;AACpF,MAAI,0BAA0B,QAAQ,IAAI,MAAM;GAC9C,MAAM,WAAW,0BAA0B,QAAQ,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC5E,OAAO,CAAC,CAAC,EAAE,IAAI,IAAI,iCAAiC,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAE7E;EACD;EAGD,MAAM,0BAA0B,MAAM,wBAAwB,IAAI,KAAK,cAAc;AAKrF,MAAI,4BAA4B,SAAS,CAAC,IAAI,QAAQ,CAAC,uBAAuB,CAAC;GAC7E;GAAO;GAAY;GACnB;GAAQ;EACT,EAAC,SAAS,IAAI,IAAI,KAChB,IAAI,QAAQ,SAAS,CAAC,MAAM,kBAAkB,IAAI,CAAC,SAAS,SAAS,GACtE;GACA,MAAM,WAAW,4BAA4B,OAAO,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC7E,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,0BAA0B,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAE1E;EACD;EAGD,MAAM,uBAAuB,MAAM,wBAAwB,IAAI,KAAK,cAAc;AAClF,MAAI,yBAAyB,SAAS,CAAC,IAAI,MAAM;GAC/C,MAAM,WAAW,yBAAyB,OAAO,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC1E,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,iBAAiB,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAEjE;EACD;EAGD,MAAM,mCAAmC,MAAM,iCAAiC,KAAK,cAAc;AACnG,MAAI,qCAAqC,SAAS,CAAC,qBAAqB;GACtE,MAAM,WAAW,qCAAqC,OAAO,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GACtF,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,oCAAoC,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAEpF;EACD;EAGD,MAAM,kBAAkB,0BAA0B,QAAQ,QAAQ,IAAI,KAAK;AAC3E,MAAI,iBACF,iBAAiB,IAAI,KAAK;EAI5B,MAAM,6BACJ,4BAA4B,SAC5B,MAAM,qBAAqB,IAAI,IAAI,KAChC,QAAQ,IAAI,KAAK;AAEtB,MAAI,0BACF,KAAI,SAAS,WAAW,IAAI,QAAQ,WAClC,MAAK,MAAM,YAAY,MAAM,wBAAwB,IAAI,EACvD,qBAAqB,SAAS;OAGhC,qBAAqB,IAAI,MAAM,IAAI,IAAI;AAI3C,OAAK,MAAM,aAAa,IAAI,WAC1B,KAAI,WAAW,IAAI,UAAU,IAAI,IAAI,CAAC,UAAU,QAAQ,CAAC,UAAU,eACjE,OAAO,CAAC,YAAY,EAAE,UAAU,IAAI,iBAAiB,CAAC,EAAE,MAAM,IAAI;CAGvE;AAED,MAAK,MAAM,aAAa,MAAM,WAC5B,KAAI,WAAW,IAAI,UAAU,IAAI,IAAI,CAAC,UAAU,QAAQ,CAAC,UAAU,eACjE,OAAO,CAAC,YAAY,EAAE,UAAU,IAAI,iBAAiB,CAAC,CAAC;AAG5D,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,qBAAqB;IACnB,SAAS;IACT,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}