eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/rules/linesBeforeBlock.js

@@ -1,75 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/linesBeforeBlock.js
-/**
-* Punctuators that begin a logical group should not require a line before it skipped. Specifically
-* `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a
-* declaration (like a variable or a type alias).
-*/
-const startPunctuators = new Set([
-	"(",
-	"=",
-	"[",
-	"{"
-]);
-var linesBeforeBlock_default = iterateJsdoc(({ context, jsdocNode, report, sourceCode, utils }) => {
-	const { checkBlockStarts, excludedTags = ["type"], ignoreSameLine = true, ignoreSingleLines = true, lines = 1 } = context.options[0] || {};
-	if (utils.hasATag(excludedTags)) return;
-	const tokensBefore = sourceCode.getTokensBefore(jsdocNode, { includeComments: true });
-	const tokenBefore = tokensBefore.at(-1);
-	if (!tokenBefore || tokenBefore.type === "Punctuator" && !checkBlockStarts && startPunctuators.has(tokenBefore.value)) return;
-	if (tokenBefore.loc?.end?.line + lines >= jsdocNode.loc?.start?.line) {
-		const startLine = jsdocNode.loc?.start?.line;
-		const sameLine = tokenBefore.loc?.end?.line === startLine;
-		if (sameLine && ignoreSameLine) return;
-		if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) return;
-		/** @type {import('eslint').Rule.ReportFixer} */
-		const fix = (fixer) => {
-			let indent = "";
-			if (sameLine) {
-				const spaceDiff = jsdocNode.loc?.start?.column - tokenBefore.loc?.end?.column;
-				indent = jsdocNode.value.match(/^\*\n([\t ]*) \*/v)?.[1]?.slice(spaceDiff);
-				if (!indent) {
-					/** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */
-					let tokenPrior = tokenBefore;
-					let startColumn;
-					while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {
-						startColumn = tokenPrior.loc?.start?.column;
-						tokenPrior = tokensBefore.pop();
-					}
-					indent = " ".repeat(startColumn ? startColumn - 1 : 0);
-				}
-			}
-			return fixer.insertTextAfter(tokenBefore, "\n".repeat(lines) + (sameLine ? "\n" + indent : ""));
-		};
-		report(`Required ${lines} line(s) before JSDoc block`, fix);
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Enforces minimum number of newlines before JSDoc comment blocks",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				checkBlockStarts: { type: "boolean" },
-				excludedTags: {
-					items: { type: "string" },
-					type: "array"
-				},
-				ignoreSameLine: { type: "boolean" },
-				ignoreSingleLines: { type: "boolean" },
-				lines: { type: "integer" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { linesBeforeBlock_default as default };
-//# sourceMappingURL=linesBeforeBlock.js.map

package/dist/rules/linesBeforeBlock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"linesBeforeBlock.js","names":[],"sources":["../../src/rules/linesBeforeBlock.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * Punctuators that begin a logical group should not require a line before it skipped. Specifically\n * `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a\n * declaration (like a variable or a type alias).\n */\nconst startPunctuators = new Set([\n  '(', '=', '[', '{',\n]);\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  sourceCode,\n  utils,\n}) => {\n  const {\n    checkBlockStarts,\n    excludedTags = [\n      'type',\n    ],\n    ignoreSameLine = true,\n    ignoreSingleLines = true,\n    lines = 1,\n  } = context.options[0] || {};\n\n  if (utils.hasATag(excludedTags)) {\n    return;\n  }\n\n  const tokensBefore = sourceCode.getTokensBefore(jsdocNode, {\n    includeComments: true,\n  });\n  const tokenBefore = tokensBefore.at(-1);\n  if (\n    !tokenBefore || (\n      tokenBefore.type === 'Punctuator' &&\n      !checkBlockStarts &&\n      startPunctuators.has(tokenBefore.value)\n    )\n  ) {\n    return;\n  }\n\n  if (tokenBefore.loc?.end?.line + lines >=\n  /** @type {number} */\n      (jsdocNode.loc?.start?.line)\n  ) {\n    const startLine = jsdocNode.loc?.start?.line;\n    const sameLine = tokenBefore.loc?.end?.line === startLine;\n\n    if (sameLine && ignoreSameLine) {\n      return;\n    }\n\n    if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) {\n      return;\n    }\n\n    /** @type {import('eslint').Rule.ReportFixer} */\n    const fix = (fixer) => {\n      let indent = '';\n      if (sameLine) {\n        const spaceDiff = /** @type {number} */ (jsdocNode.loc?.start?.column) -\n        /** @type {number} */ (tokenBefore.loc?.end?.column);\n        // @ts-expect-error Should be a comment\n        indent = /** @type {import('estree').Comment} */ (\n          jsdocNode\n        ).value.match(/^\\*\\n([\\t ]*) \\*/v)?.[1]?.slice(spaceDiff);\n        if (!indent) {\n          /** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */\n          let tokenPrior = tokenBefore;\n          let startColumn;\n          while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {\n            startColumn = tokenPrior.loc?.start?.column;\n            tokenPrior = tokensBefore.pop();\n          }\n\n          indent = ' '.repeat(\n            /* c8 ignore next */\n            /** @type {number} */ (startColumn ? startColumn - 1 : 0),\n          );\n        }\n      }\n\n      return fixer.insertTextAfter(\n        /** @type {import('eslint').AST.Token} */\n        (tokenBefore),\n        '\\n'.repeat(lines) +\n        (sameLine ? '\\n' + indent : ''),\n      );\n    };\n\n    report(`Required ${lines} line(s) before JSDoc block`, fix);\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Enforces minimum number of newlines before JSDoc comment blocks',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkBlockStarts: {\n            type: 'boolean',\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreSameLine: {\n            type: 'boolean',\n          },\n          ignoreSingleLines: {\n            type: 'boolean',\n          },\n          lines: {\n            type: 'integer',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,mBAAmB,IAAI,IAAI;CAC/B;CAAK;CAAK;CAAK;AAChB;AAED,+BAAe,aAAa,CAAC,EAC3B,SACA,WACA,QACA,YACA,OACD,KAAK;CACJ,MAAM,EACJ,kBACA,eAAe,CACb,MACD,GACD,iBAAiB,MACjB,oBAAoB,MACpB,QAAQ,GACT,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,MAAM,QAAQ,aAAa,CAC7B;CAGF,MAAM,eAAe,WAAW,gBAAgB,WAAW,EACzD,iBAAiB,KAClB,EAAC;CACF,MAAM,cAAc,aAAa,GAAG,GAAG;AACvC,KACE,CAAC,eACC,YAAY,SAAS,gBACrB,CAAC,oBACD,iBAAiB,IAAI,YAAY,MAAM,CAGzC;AAGF,KAAI,YAAY,KAAK,KAAK,OAAO,SAE5B,UAAU,KAAK,OAAO,MACzB;EACA,MAAM,YAAY,UAAU,KAAK,OAAO;EACxC,MAAM,WAAW,YAAY,KAAK,KAAK,SAAS;AAEhD,MAAI,YAAY,eACd;AAGF,MAAI,qBAAqB,UAAU,KAAK,MAAM,SAAS,UAAU,KAAK,IAAI,KACxE;;EAIF,MAAM,MAAM,CAAC,UAAU;GACrB,IAAI,SAAS;AACb,OAAI,UAAU;IACZ,MAAM,YAAmC,UAAU,KAAK,OAAO,SACxC,YAAY,KAAK,KAAK;IAE7C,SACE,UACA,MAAM,MAAM,oBAAoB,GAAG,IAAI,MAAM,UAAU;AACzD,QAAI,CAAC,QAAQ;;KAEX,IAAI,aAAa;KACjB,IAAI;AACJ,YAAO,cAAc,YAAY,KAAK,OAAO,SAAS,WAAW;MAC/D,cAAc,WAAW,KAAK,OAAO;MACrC,aAAa,aAAa,KAAK;KAChC;KAED,SAAS,IAAI,OAEY,cAAc,cAAc,IAAI,EACxD;IACF;GACF;AAED,UAAO,MAAM,gBAEV,aACD,KAAK,OAAO,MAAM,IACjB,WAAW,OAAO,SAAS,IAC7B;EACF;EAED,OAAO,CAAC,SAAS,EAAE,MAAM,2BAA2B,CAAC,EAAE,IAAI;CAC5D;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,kBAAkB,EAChB,MAAM,UACP;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,gBAAgB,EACd,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,OAAO,EACL,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/matchDescription.js

@@ -1,167 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/matchDescription.js
-const matchDescriptionDefault = "^\n?([A-Z`\\d_][\\s\\S]*[.?!`\\p{RGI_Emoji}]\\s*)?$";
-/**
-* @param {string} value
-* @param {string} userDefault
-* @returns {string}
-*/
-const stringOrDefault = (value, userDefault) => {
-	return typeof value === "string" ? value : userDefault || matchDescriptionDefault;
-};
-var matchDescription_default = iterateJsdoc(({ context, jsdoc, report, utils }) => {
-	const { mainDescription, matchDescription, message, nonemptyTags = true, tags = {} } = context.options[0] || {};
-	/**
-	* @param {string} desc
-	* @param {import('comment-parser').Spec} [tag]
-	* @returns {void}
-	*/
-	const validateDescription = (desc, tag) => {
-		let mainDescriptionMatch = mainDescription;
-		let errorMessage = message;
-		if (typeof mainDescription === "object") {
-			mainDescriptionMatch = mainDescription.match;
-			errorMessage = mainDescription.message;
-		}
-		if (mainDescriptionMatch === false && (!tag || !Object.hasOwn(tags, tag.tag))) return;
-		let tagValue = mainDescriptionMatch;
-		if (tag) {
-			const tagName = tag.tag;
-			if (typeof tags[tagName] === "object") {
-				tagValue = tags[tagName].match;
-				errorMessage = tags[tagName].message;
-			} else tagValue = tags[tagName];
-		}
-		const regex = utils.getRegexFromString(stringOrDefault(tagValue, matchDescription));
-		if (!regex.test(desc)) report(errorMessage || "JSDoc description does not satisfy the regex pattern.", null, tag || { line: jsdoc.source[0].number + 1 });
-	};
-	const { description } = utils.getDescription();
-	if (description) validateDescription(description);
-	/**
-	* @param {string} tagName
-	* @returns {boolean}
-	*/
-	const hasNoTag = (tagName) => {
-		return !tags[tagName];
-	};
-	for (const tag of [
-		"description",
-		"summary",
-		"file",
-		"classdesc"
-	]) utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {
-		const desc = (matchingJsdocTag.name + " " + utils.getTagDescription(matchingJsdocTag)).trim();
-		if (hasNoTag(targetTagName)) validateDescription(desc, matchingJsdocTag);
-	}, true);
-	if (nonemptyTags) for (const tag of [
-		"copyright",
-		"example",
-		"see",
-		"todo"
-	]) utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {
-		const desc = (matchingJsdocTag.name + " " + utils.getTagDescription(matchingJsdocTag)).trim();
-		if (hasNoTag(targetTagName) && !/.+/v.test(desc)) report("JSDoc description must not be empty.", null, matchingJsdocTag);
-	});
-	if (!Object.keys(tags).length) return;
-	/**
-	* @param {string} tagName
-	* @returns {boolean}
-	*/
-	const hasOptionTag = (tagName) => {
-		return Boolean(tags[tagName]);
-	};
-	const whitelistedTags = utils.filterTags(({ tag: tagName }) => {
-		return hasOptionTag(tagName);
-	});
-	const { tagsWithNames, tagsWithoutNames } = utils.getTagsByType(whitelistedTags);
-	tagsWithNames.some((tag) => {
-		const desc = utils.getTagDescription(tag).replace(/^[\- ]*/v, "").trim();
-		return validateDescription(desc, tag);
-	});
-	tagsWithoutNames.some((tag) => {
-		const desc = (tag.name + " " + utils.getTagDescription(tag)).trim();
-		return validateDescription(desc, tag);
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Enforces a regular expression pattern on descriptions.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				mainDescription: { oneOf: [
-					{
-						format: "regex",
-						type: "string"
-					},
-					{ type: "boolean" },
-					{
-						additionalProperties: false,
-						properties: {
-							match: { oneOf: [{
-								format: "regex",
-								type: "string"
-							}, { type: "boolean" }] },
-							message: { type: "string" }
-						},
-						type: "object"
-					}
-				] },
-				matchDescription: {
-					format: "regex",
-					type: "string"
-				},
-				message: { type: "string" },
-				nonemptyTags: { type: "boolean" },
-				tags: {
-					patternProperties: { ".*": { oneOf: [
-						{
-							format: "regex",
-							type: "string"
-						},
-						{
-							enum: [true],
-							type: "boolean"
-						},
-						{
-							additionalProperties: false,
-							properties: {
-								match: { oneOf: [{
-									format: "regex",
-									type: "string"
-								}, {
-									enum: [true],
-									type: "boolean"
-								}] },
-								message: { type: "string" }
-							},
-							type: "object"
-						}
-					] } },
-					type: "object"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { matchDescription_default as default };
-//# sourceMappingURL=matchDescription.js.map

package/dist/rules/matchDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"matchDescription.js","names":[],"sources":["../../src/rules/matchDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// If supporting Node >= 10, we could loosen the default to this for the\n//   initial letter: \\\\p{Upper}\nconst matchDescriptionDefault = '^\\n?([A-Z`\\\\d_][\\\\s\\\\S]*[.?!`\\\\p{RGI_Emoji}]\\\\s*)?$';\n\n/**\n * @param {string} value\n * @param {string} userDefault\n * @returns {string}\n */\nconst stringOrDefault = (value, userDefault) => {\n  return typeof value === 'string' ?\n    value :\n    userDefault || matchDescriptionDefault;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    mainDescription,\n    matchDescription,\n    message,\n    nonemptyTags = true,\n    tags = {},\n  } = context.options[0] || {};\n\n  /**\n   * @param {string} desc\n   * @param {import('comment-parser').Spec} [tag]\n   * @returns {void}\n   */\n  const validateDescription = (desc, tag) => {\n    let mainDescriptionMatch = mainDescription;\n    let errorMessage = message;\n    if (typeof mainDescription === 'object') {\n      mainDescriptionMatch = mainDescription.match;\n      errorMessage = mainDescription.message;\n    }\n\n    if (mainDescriptionMatch === false && (\n      !tag || !Object.hasOwn(tags, tag.tag))\n    ) {\n      return;\n    }\n\n    let tagValue = mainDescriptionMatch;\n    if (tag) {\n      const tagName = tag.tag;\n      if (typeof tags[tagName] === 'object') {\n        tagValue = tags[tagName].match;\n        errorMessage = tags[tagName].message;\n      } else {\n        tagValue = tags[tagName];\n      }\n    }\n\n    const regex = utils.getRegexFromString(\n      stringOrDefault(tagValue, matchDescription),\n    );\n\n    if (!regex.test(desc)) {\n      report(\n        errorMessage || 'JSDoc description does not satisfy the regex pattern.',\n        null,\n        tag || {\n          // Add one as description would typically be into block\n          line: jsdoc.source[0].number + 1,\n        },\n      );\n    }\n  };\n\n  const {\n    description,\n  } = utils.getDescription();\n  if (description) {\n    validateDescription(description);\n  }\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const hasNoTag = (tagName) => {\n    return !tags[tagName];\n  };\n\n  for (const tag of [\n    'description',\n    'summary',\n    'file',\n    'classdesc',\n  ]) {\n    utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {\n      const desc = (matchingJsdocTag.name + ' ' + utils.getTagDescription(matchingJsdocTag)).trim();\n      if (hasNoTag(targetTagName)) {\n        validateDescription(desc, matchingJsdocTag);\n      }\n    }, true);\n  }\n\n  if (nonemptyTags) {\n    for (const tag of [\n      'copyright',\n      'example',\n      'see',\n      'todo',\n    ]) {\n      utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {\n        const desc = (matchingJsdocTag.name + ' ' + utils.getTagDescription(matchingJsdocTag)).trim();\n\n        if (hasNoTag(targetTagName) && !(/.+/v).test(desc)) {\n          report(\n            'JSDoc description must not be empty.',\n            null,\n            matchingJsdocTag,\n          );\n        }\n      });\n    }\n  }\n\n  if (!Object.keys(tags).length) {\n    return;\n  }\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const hasOptionTag = (tagName) => {\n    return Boolean(tags[tagName]);\n  };\n\n  const whitelistedTags = utils.filterTags(({\n    tag: tagName,\n  }) => {\n    return hasOptionTag(tagName);\n  });\n  const {\n    tagsWithNames,\n    tagsWithoutNames,\n  } = utils.getTagsByType(whitelistedTags);\n\n  tagsWithNames.some((tag) => {\n    const desc = /** @type {string} */ (\n      utils.getTagDescription(tag)\n    ).replace(/^[\\- ]*/v, '')\n      .trim();\n\n    return validateDescription(desc, tag);\n  });\n\n  tagsWithoutNames.some((tag) => {\n    const desc = (tag.name + ' ' + utils.getTagDescription(tag)).trim();\n\n    return validateDescription(desc, tag);\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Enforces a regular expression pattern on descriptions.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          mainDescription: {\n            oneOf: [\n              {\n                format: 'regex',\n                type: 'string',\n              },\n              {\n                type: 'boolean',\n              },\n              {\n                additionalProperties: false,\n                properties: {\n                  match: {\n                    oneOf: [\n                      {\n                        format: 'regex',\n                        type: 'string',\n                      },\n                      {\n                        type: 'boolean',\n                      },\n                    ],\n                  },\n                  message: {\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n            ],\n          },\n          matchDescription: {\n            format: 'regex',\n            type: 'string',\n          },\n          message: {\n            type: 'string',\n          },\n          nonemptyTags: {\n            type: 'boolean',\n          },\n          tags: {\n            patternProperties: {\n              '.*': {\n                oneOf: [\n                  {\n                    format: 'regex',\n                    type: 'string',\n                  },\n                  {\n                    enum: [\n                      true,\n                    ],\n                    type: 'boolean',\n                  },\n                  {\n                    additionalProperties: false,\n                    properties: {\n                      match: {\n                        oneOf: [\n                          {\n                            format: 'regex',\n                            type: 'string',\n                          },\n                          {\n                            enum: [\n                              true,\n                            ],\n                            type: 'boolean',\n                          },\n                        ],\n                      },\n                      message: {\n                        type: 'string',\n                      },\n                    },\n                    type: 'object',\n                  },\n                ],\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAIA,MAAM,0BAA0B;;;;;;AAOhC,MAAM,kBAAkB,CAAC,OAAO,gBAAgB;AAC9C,QAAO,OAAO,UAAU,WACtB,QACA,eAAe;AAClB;AAED,+BAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,iBACA,kBACA,SACA,eAAe,MACf,OAAO,CAAE,GACV,GAAG,QAAQ,QAAQ,MAAM,CAAE;;;;;;CAO5B,MAAM,sBAAsB,CAAC,MAAM,QAAQ;EACzC,IAAI,uBAAuB;EAC3B,IAAI,eAAe;AACnB,MAAI,OAAO,oBAAoB,UAAU;GACvC,uBAAuB,gBAAgB;GACvC,eAAe,gBAAgB;EAChC;AAED,MAAI,yBAAyB,UAC3B,CAAC,OAAO,CAAC,OAAO,OAAO,MAAM,IAAI,IAAI,EAErC;EAGF,IAAI,WAAW;AACf,MAAI,KAAK;GACP,MAAM,UAAU,IAAI;AACpB,OAAI,OAAO,KAAK,aAAa,UAAU;IACrC,WAAW,KAAK,SAAS;IACzB,eAAe,KAAK,SAAS;GAC9B,OACC,WAAW,KAAK;EAEnB;EAED,MAAM,QAAQ,MAAM,mBAClB,gBAAgB,UAAU,iBAAiB,CAC5C;AAED,MAAI,CAAC,MAAM,KAAK,KAAK,EACnB,OACE,gBAAgB,yDAChB,MACA,OAAO,EAEL,MAAM,MAAM,OAAO,GAAG,SAAS,EAChC,EACF;CAEJ;CAED,MAAM,EACJ,aACD,GAAG,MAAM,gBAAgB;AAC1B,KAAI,aACF,oBAAoB,YAAY;;;;;CAOlC,MAAM,WAAW,CAAC,YAAY;AAC5B,SAAO,CAAC,KAAK;CACd;AAED,MAAK,MAAM,OAAO;EAChB;EACA;EACA;EACA;CACD,GACC,MAAM,oBAAoB,KAAK,CAAC,kBAAkB,kBAAkB;EAClE,MAAM,QAAQ,iBAAiB,OAAO,MAAM,MAAM,kBAAkB,iBAAiB,EAAE,MAAM;AAC7F,MAAI,SAAS,cAAc,EACzB,oBAAoB,MAAM,iBAAiB;CAE9C,GAAE,KAAK;AAGV,KAAI,aACF,MAAK,MAAM,OAAO;EAChB;EACA;EACA;EACA;CACD,GACC,MAAM,oBAAoB,KAAK,CAAC,kBAAkB,kBAAkB;EAClE,MAAM,QAAQ,iBAAiB,OAAO,MAAM,MAAM,kBAAkB,iBAAiB,EAAE,MAAM;AAE7F,MAAI,SAAS,cAAc,IAAI,CAAE,MAAO,KAAK,KAAK,EAChD,OACE,wCACA,MACA,iBACD;CAEJ,EAAC;AAIN,KAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OACrB;;;;;CAOF,MAAM,eAAe,CAAC,YAAY;AAChC,SAAO,QAAQ,KAAK,SAAS;CAC9B;CAED,MAAM,kBAAkB,MAAM,WAAW,CAAC,EACxC,KAAK,SACN,KAAK;AACJ,SAAO,aAAa,QAAQ;CAC7B,EAAC;CACF,MAAM,EACJ,eACA,kBACD,GAAG,MAAM,cAAc,gBAAgB;CAExC,cAAc,KAAK,CAAC,QAAQ;EAC1B,MAAM,OACJ,MAAM,kBAAkB,IAAI,CAC5B,QAAQ,YAAY,GAAG,CACtB,MAAM;AAET,SAAO,oBAAoB,MAAM,IAAI;CACtC,EAAC;CAEF,iBAAiB,KAAK,CAAC,QAAQ;EAC7B,MAAM,QAAQ,IAAI,OAAO,MAAM,MAAM,kBAAkB,IAAI,EAAE,MAAM;AAEnE,SAAO,oBAAoB,MAAM,IAAI;CACtC,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,iBAAiB,EACf,OAAO;KACL;MACE,QAAQ;MACR,MAAM;KACP;KACD,EACE,MAAM,UACP;KACD;MACE,sBAAsB;MACtB,YAAY;OACV,OAAO,EACL,OAAO,CACL;QACE,QAAQ;QACR,MAAM;OACP,GACD,EACE,MAAM,UACP,CACF,EACF;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP;IACF,EACF;IACD,kBAAkB;KAChB,QAAQ;KACR,MAAM;IACP;IACD,SAAS,EACP,MAAM,SACP;IACD,cAAc,EACZ,MAAM,UACP;IACD,MAAM;KACJ,mBAAmB,EACjB,MAAM,EACJ,OAAO;MACL;OACE,QAAQ;OACR,MAAM;MACP;MACD;OACE,MAAM,CACJ,IACD;OACD,MAAM;MACP;MACD;OACE,sBAAsB;OACtB,YAAY;QACV,OAAO,EACL,OAAO,CACL;SACE,QAAQ;SACR,MAAM;QACP,GACD;SACE,MAAM,CACJ,IACD;SACD,MAAM;QACP,CACF,EACF;QACD,SAAS,EACP,MAAM,SACP;OACF;OACD,MAAM;MACP;KACF,EACF,EACF;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/matchName.js

@@ -1,77 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/matchName.js
-var matchName_default = iterateJsdoc(({ context, info: { lastIndex }, jsdoc, report, utils }) => {
-	const { match } = context.options[0] || {};
-	if (!match) {
-		report("Rule `no-restricted-syntax` is missing a `match` option.");
-		return;
-	}
-	const { allowName, disallowName, replacement, tags = ["*"] } = match[lastIndex];
-	const allowNameRegex = allowName && utils.getRegexFromString(allowName);
-	const disallowNameRegex = disallowName && utils.getRegexFromString(disallowName);
-	let applicableTags = jsdoc.tags;
-	if (!tags.includes("*")) applicableTags = utils.getPresentTags(tags);
-	let reported = false;
-	for (const tag of applicableTags) {
-		const tagName = tag.name.replace(/^\[/v, "").replace(/(=.*)?\]$/v, "");
-		const allowed = !allowNameRegex || allowNameRegex.test(tagName);
-		const disallowed = disallowNameRegex && disallowNameRegex.test(tagName);
-		const hasRegex = allowNameRegex || disallowNameRegex;
-		if (hasRegex && allowed && !disallowed) continue;
-		if (!hasRegex && reported) continue;
-		const fixer = () => {
-			for (const src of tag.source) if (src.tokens.name) {
-				src.tokens.name = src.tokens.name.replace(disallowNameRegex, replacement);
-				break;
-			}
-		};
-		let { message } = match[lastIndex];
-		if (!message) if (hasRegex) message = disallowed ? `Only allowing names not matching \`${disallowNameRegex}\` but found "${tagName}".` : `Only allowing names matching \`${allowNameRegex}\` but found "${tagName}".`;
-		else message = `Prohibited context for "${tagName}".`;
-		utils.reportJSDoc(message, hasRegex ? tag : null, disallowNameRegex && replacement !== void 0 ? fixer : null, false, {
-			allowName,
-			disallowName,
-			name: tagName
-		});
-		if (!hasRegex) reported = true;
-	}
-}, {
-	matchContext: true,
-	meta: {
-		docs: {
-			description: "Reports the name portion of a JSDoc tag if matching or not matching a given regular expression.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: { match: {
-				items: {
-					additionalProperties: false,
-					properties: {
-						allowName: { type: "string" },
-						comment: { type: "string" },
-						context: { type: "string" },
-						disallowName: { type: "string" },
-						message: { type: "string" },
-						replacement: { type: "string" },
-						tags: {
-							items: { type: "string" },
-							type: "array"
-						}
-					},
-					type: "object"
-				},
-				type: "array"
-			} },
-			required: ["match"],
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { matchName_default as default };
-//# sourceMappingURL=matchName.js.map

package/dist/rules/matchName.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"matchName.js","names":[],"sources":["../../src/rules/matchName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// eslint-disable-next-line complexity\nexport default iterateJsdoc(({\n  context,\n  info: {\n    lastIndex,\n  },\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    match,\n  } = context.options[0] || {};\n  if (!match) {\n    report('Rule `no-restricted-syntax` is missing a `match` option.');\n\n    return;\n  }\n\n  const {\n    allowName,\n    disallowName,\n    replacement,\n    tags = [\n      '*',\n    ],\n  } = match[/** @type {import('../iterateJsdoc.js').Integer} */ (lastIndex)];\n\n  const allowNameRegex = allowName && utils.getRegexFromString(allowName);\n  const disallowNameRegex = disallowName && utils.getRegexFromString(disallowName);\n\n  let applicableTags = jsdoc.tags;\n  if (!tags.includes('*')) {\n    applicableTags = utils.getPresentTags(tags);\n  }\n\n  let reported = false;\n  for (const tag of applicableTags) {\n    const tagName = tag.name.replace(/^\\[/v, '').replace(/(=.*)?\\]$/v, '');\n    const allowed = !allowNameRegex || allowNameRegex.test(tagName);\n    const disallowed = disallowNameRegex && disallowNameRegex.test(tagName);\n    const hasRegex = allowNameRegex || disallowNameRegex;\n    if (hasRegex && allowed && !disallowed) {\n      continue;\n    }\n\n    if (!hasRegex && reported) {\n      continue;\n    }\n\n    const fixer = () => {\n      for (const src of tag.source) {\n        if (src.tokens.name) {\n          src.tokens.name = src.tokens.name.replace(\n            disallowNameRegex, replacement,\n          );\n          break;\n        }\n      }\n    };\n\n    let {\n      message,\n    } = match[/** @type {import('../iterateJsdoc.js').Integer} */ (lastIndex)];\n    if (!message) {\n      if (hasRegex) {\n        message = disallowed ?\n          `Only allowing names not matching \\`${disallowNameRegex}\\` but found \"${tagName}\".` :\n          `Only allowing names matching \\`${allowNameRegex}\\` but found \"${tagName}\".`;\n      } else {\n        message = `Prohibited context for \"${tagName}\".`;\n      }\n    }\n\n    utils.reportJSDoc(\n      message,\n      hasRegex ? tag : null,\n\n      // We could match up\n      disallowNameRegex && replacement !== undefined ?\n        fixer :\n        null,\n      false,\n      {\n        // Could also supply `context`, `comment`, `tags`\n        allowName,\n        disallowName,\n        name: tagName,\n      },\n    );\n    if (!hasRegex) {\n      reported = true;\n    }\n  }\n}, {\n  matchContext: true,\n  meta: {\n    docs: {\n      description: 'Reports the name portion of a JSDoc tag if matching or not matching a given regular expression.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          match: {\n            items: {\n              additionalProperties: false,\n              properties: {\n                allowName: {\n                  type: 'string',\n                },\n                comment: {\n                  type: 'string',\n                },\n                context: {\n                  type: 'string',\n                },\n                disallowName: {\n                  type: 'string',\n                },\n                message: {\n                  type: 'string',\n                },\n                replacement: {\n                  type: 'string',\n                },\n                tags: {\n                  items: {\n                    type: 'string',\n                  },\n                  type: 'array',\n                },\n              },\n              type: 'object',\n            },\n            type: 'array',\n          },\n        },\n        required: [\n          'match',\n        ],\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAGA,wBAAe,aAAa,CAAC,EAC3B,SACA,MAAM,EACJ,WACD,EACD,OACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,OACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAC5B,KAAI,CAAC,OAAO;EACV,OAAO,2DAA2D;AAElE;CACD;CAED,MAAM,EACJ,WACA,cACA,aACA,OAAO,CACL,GACD,GACF,GAAG,MAA2D;CAE/D,MAAM,iBAAiB,aAAa,MAAM,mBAAmB,UAAU;CACvE,MAAM,oBAAoB,gBAAgB,MAAM,mBAAmB,aAAa;CAEhF,IAAI,iBAAiB,MAAM;AAC3B,KAAI,CAAC,KAAK,SAAS,IAAI,EACrB,iBAAiB,MAAM,eAAe,KAAK;CAG7C,IAAI,WAAW;AACf,MAAK,MAAM,OAAO,gBAAgB;EAChC,MAAM,UAAU,IAAI,KAAK,QAAQ,QAAQ,GAAG,CAAC,QAAQ,cAAc,GAAG;EACtE,MAAM,UAAU,CAAC,kBAAkB,eAAe,KAAK,QAAQ;EAC/D,MAAM,aAAa,qBAAqB,kBAAkB,KAAK,QAAQ;EACvE,MAAM,WAAW,kBAAkB;AACnC,MAAI,YAAY,WAAW,CAAC,WAC1B;AAGF,MAAI,CAAC,YAAY,SACf;EAGF,MAAM,QAAQ,MAAM;AAClB,QAAK,MAAM,OAAO,IAAI,OACpB,KAAI,IAAI,OAAO,MAAM;IACnB,IAAI,OAAO,OAAO,IAAI,OAAO,KAAK,QAChC,mBAAmB,YACpB;AACD;GACD;EAEJ;EAED,IAAI,EACF,SACD,GAAG,MAA2D;AAC/D,MAAI,CAAC,QACH,KAAI,UACF,UAAU,aACR,CAAC,mCAAmC,EAAE,kBAAkB,cAAc,EAAE,QAAQ,EAAE,CAAC,GACnF,CAAC,+BAA+B,EAAE,eAAe,cAAc,EAAE,QAAQ,EAAE,CAAC;OAE9E,UAAU,CAAC,wBAAwB,EAAE,QAAQ,EAAE,CAAC;EAIpD,MAAM,YACJ,SACA,WAAW,MAAM,MAGjB,qBAAqB,gBAAgB,SACnC,QACA,MACF,OACA;GAEE;GACA;GACA,MAAM;EACP,EACF;AACD,MAAI,CAAC,UACH,WAAW;CAEd;AACF,GAAE;CACD,cAAc;CACd,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,OAAO;IACL,OAAO;KACL,sBAAsB;KACtB,YAAY;MACV,WAAW,EACT,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,cAAc,EACZ,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,aAAa,EACX,MAAM,SACP;MACD,MAAM;OACJ,OAAO,EACL,MAAM,SACP;OACD,MAAM;MACP;KACF;KACD,MAAM;IACP;IACD,MAAM;GACP,EACF;GACD,UAAU,CACR,OACD;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/multilineBlocks.js

@@ -1,245 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/multilineBlocks.js
-/**
-* @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {number} requireSingleLineUnderCount
-*/
-const checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {
-	if (!requireSingleLineUnderCount || !jsdoc.tags.length) return false;
-	let lastLineWithTag = 0;
-	let isUnderCountLimit = false;
-	let hasMultiDescOrType = false;
-	const tagLines = jsdoc.source.reduce((acc, { tokens: { delimiter, description: desc, name, postDelimiter, postName, postTag, postType, start, tag, type } }, idx) => {
-		if (tag.length) {
-			lastLineWithTag = idx;
-			if (start.length + delimiter.length + postDelimiter.length + type.length + postType.length + name.length + postName.length + tag.length + postTag.length + desc.length < requireSingleLineUnderCount) isUnderCountLimit = true;
-			return acc + 1;
-		} else if (desc.length || type.length) {
-			hasMultiDescOrType = true;
-			return acc;
-		}
-		return acc;
-	}, 0);
-	if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {
-		const fixer = () => {
-			const tokens = jsdoc.source[lastLineWithTag].tokens;
-			jsdoc.source = [{
-				number: 0,
-				source: "",
-				tokens: utils.seedTokens({
-					delimiter: "/**",
-					description: tokens.description.trimEnd() + " ",
-					end: "*/",
-					name: tokens.name,
-					postDelimiter: " ",
-					postName: tokens.postName,
-					postTag: tokens.postTag,
-					postType: tokens.postType,
-					start: jsdoc.source[0].tokens.start,
-					tag: tokens.tag,
-					type: tokens.type
-				})
-			}];
-		};
-		utils.reportJSDoc("Description is too short to be multi-line.", null, fixer);
-		return true;
-	}
-	return false;
-};
-/**
-* @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {number} requireSingleLineUnderCount
-*/
-const checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {
-	if (!requireSingleLineUnderCount || jsdoc.tags.length) return false;
-	let lastLineWithDesc = 0;
-	let isUnderCountLimit = false;
-	const descLines = jsdoc.source.reduce((acc, { tokens: { delimiter, description: desc, postDelimiter, start } }, idx) => {
-		if (desc.length) {
-			lastLineWithDesc = idx;
-			if (start.length + delimiter.length + postDelimiter.length + desc.length < requireSingleLineUnderCount) isUnderCountLimit = true;
-			return acc + 1;
-		}
-		return acc;
-	}, 0);
-	if (isUnderCountLimit && descLines === 1) {
-		const fixer = () => {
-			const desc = jsdoc.source[lastLineWithDesc].tokens.description;
-			jsdoc.source = [{
-				number: 0,
-				source: "",
-				tokens: utils.seedTokens({
-					delimiter: "/**",
-					description: desc.trimEnd() + " ",
-					end: "*/",
-					postDelimiter: " ",
-					start: jsdoc.source[0].tokens.start
-				})
-			}];
-		};
-		utils.reportJSDoc("Description is too short to be multi-line.", null, fixer);
-		return true;
-	}
-	return false;
-};
-var multilineBlocks_default = iterateJsdoc(({ context, jsdoc, utils }) => {
-	const { allowMultipleTags = true, minimumLengthForMultiline = Number.POSITIVE_INFINITY, multilineTags = ["*"], noFinalLineText = true, noMultilineBlocks = false, noSingleLineBlocks = false, noZeroLineText = true, requireSingleLineUnderCount = null, singleLineTags = ["lends", "type"] } = context.options[0] || {};
-	const { source: [{ tokens }] } = jsdoc;
-	const { description, tag } = tokens;
-	const sourceLength = jsdoc.source.length;
-	/**
-	* @param {string} tagName
-	* @returns {boolean}
-	*/
-	const isInvalidSingleLine = (tagName) => {
-		return noSingleLineBlocks && (!tagName || !singleLineTags.includes(tagName) && !singleLineTags.includes("*"));
-	};
-	if (sourceLength === 1) {
-		if (!isInvalidSingleLine(tag.slice(1))) return;
-		const fixer = () => {
-			utils.makeMultiline();
-		};
-		utils.reportJSDoc("Single line blocks are not permitted by your configuration.", null, fixer, true);
-		return;
-	}
-	if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)) return;
-	if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)) return;
-	const lineChecks = () => {
-		if (noZeroLineText && (tag || description)) {
-			const fixer = () => {
-				const line = { ...tokens };
-				utils.emptyTokens(tokens);
-				const { tokens: { delimiter, start } } = jsdoc.source[1];
-				utils.addLine(1, {
-					...line,
-					delimiter,
-					start
-				});
-			};
-			utils.reportJSDoc("Should have no text on the \"0th\" line (after the `/**`).", null, fixer);
-			return;
-		}
-		const finalLine = jsdoc.source[jsdoc.source.length - 1];
-		const finalLineTokens = finalLine.tokens;
-		if (noFinalLineText && finalLineTokens.description.trim()) {
-			const fixer = () => {
-				const line = { ...finalLineTokens };
-				line.description = line.description.trimEnd();
-				const { delimiter } = line;
-				for (const prop of [
-					"delimiter",
-					"postDelimiter",
-					"tag",
-					"type",
-					"lineEnd",
-					"postType",
-					"postTag",
-					"name",
-					"postName",
-					"description"
-				]) finalLineTokens[prop] = "";
-				utils.addLine(jsdoc.source.length - 1, {
-					...line,
-					delimiter,
-					end: ""
-				});
-			};
-			utils.reportJSDoc("Should have no text on the final line (before the `*/`).", null, fixer);
-		}
-	};
-	if (noMultilineBlocks) {
-		if (jsdoc.tags.length && (multilineTags.includes("*") || utils.hasATag(multilineTags))) {
-			lineChecks();
-			return;
-		}
-		if (jsdoc.description.length >= minimumLengthForMultiline) {
-			lineChecks();
-			return;
-		}
-		if (noSingleLineBlocks && (!jsdoc.tags.length || !utils.filterTags(({ tag: tg }) => {
-			return !isInvalidSingleLine(tg);
-		}).length)) {
-			utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration but fixing would result in a single line block which you have prohibited with `noSingleLineBlocks`.");
-			return;
-		}
-		if (jsdoc.tags.length > 1) {
-			if (!allowMultipleTags) {
-				utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration but the block has multiple tags.");
-				return;
-			}
-		} else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {
-			if (!allowMultipleTags) {
-				utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration but the block has a description with a tag.");
-				return;
-			}
-		} else {
-			const fixer = () => {
-				jsdoc.source = [{
-					number: 1,
-					source: "",
-					tokens: jsdoc.source.reduce((obj, { tokens: { description: desc, lineEnd, name: nme, postName, postTag, postType, tag: tg, type: typ } }) => {
-						if (typ) obj.type = typ;
-						if (tg && typ && nme) obj.postType = postType;
-						if (nme) obj.name += nme;
-						if (nme && desc) obj.postName = postName;
-						obj.description += desc;
-						const nameOrDescription = obj.description || obj.name;
-						if (nameOrDescription && nameOrDescription.slice(-1) !== " ") obj.description += " ";
-						obj.lineEnd = lineEnd;
-						obj.tag += tg;
-						if (tg) obj.postTag = postTag || " ";
-						return obj;
-					}, utils.seedTokens({
-						delimiter: "/**",
-						end: "*/",
-						postDelimiter: " "
-					}))
-				}];
-			};
-			utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration.", null, fixer);
-			return;
-		}
-	}
-	lineChecks();
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				allowMultipleTags: { type: "boolean" },
-				minimumLengthForMultiline: { type: "integer" },
-				multilineTags: { anyOf: [{
-					enum: ["*"],
-					type: "string"
-				}, {
-					items: { type: "string" },
-					type: "array"
-				}] },
-				noFinalLineText: { type: "boolean" },
-				noMultilineBlocks: { type: "boolean" },
-				noSingleLineBlocks: { type: "boolean" },
-				noZeroLineText: { type: "boolean" },
-				requireSingleLineUnderCount: { type: "number" },
-				singleLineTags: {
-					items: { type: "string" },
-					type: "array"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { multilineBlocks_default as default };
-//# sourceMappingURL=multilineBlocks.js.map

package/dist/rules/multilineBlocks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"multilineBlocks.js","names":[],"sources":["../../src/rules/multilineBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || !jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithTag = 0;\n  let isUnderCountLimit = false;\n  let hasMultiDescOrType = false;\n  const tagLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      name,\n      postDelimiter,\n      postName,\n      postTag,\n      postType,\n      start,\n      tag,\n      type,\n    },\n  }, idx) => {\n    if (tag.length) {\n      lastLineWithTag = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length +\n        type.length + postType.length + name.length + postName.length +\n        tag.length + postTag.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    } else if (desc.length || type.length) {\n      hasMultiDescOrType = true;\n      return acc;\n    }\n\n    return acc;\n  }, 0);\n  // Could be tagLines > 1\n  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {\n    const fixer = () => {\n      const tokens = jsdoc.source[lastLineWithTag].tokens;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: tokens.description.trimEnd() + ' ',\n            end: '*/',\n            name: tokens.name,\n            postDelimiter: ' ',\n            postName: tokens.postName,\n            postTag: tokens.postTag,\n            postType: tokens.postType,\n            start: jsdoc.source[0].tokens.start,\n            tag: tokens.tag,\n            type: tokens.type,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithDesc = 0;\n  let isUnderCountLimit = false;\n  const descLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      postDelimiter,\n      start,\n    },\n  }, idx) => {\n    if (desc.length) {\n      lastLineWithDesc = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    }\n\n    return acc;\n  }, 0);\n  // Could be descLines > 1\n  if (isUnderCountLimit && descLines === 1) {\n    const fixer = () => {\n      const desc = jsdoc.source[lastLineWithDesc].tokens.description;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: desc.trimEnd() + ' ',\n            end: '*/',\n            postDelimiter: ' ',\n            start: jsdoc.source[0].tokens.start,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    allowMultipleTags = true,\n    minimumLengthForMultiline = Number.POSITIVE_INFINITY,\n    multilineTags = [\n      '*',\n    ],\n    noFinalLineText = true,\n    noMultilineBlocks = false,\n    noSingleLineBlocks = false,\n    noZeroLineText = true,\n    requireSingleLineUnderCount = null,\n    singleLineTags = [\n      'lends', 'type',\n    ],\n  } = context.options[0] || {};\n\n  const {\n    source: [\n      {\n        tokens,\n      },\n    ],\n  } = jsdoc;\n  const {\n    description,\n    tag,\n  } = tokens;\n  const sourceLength = jsdoc.source.length;\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const isInvalidSingleLine = (tagName) => {\n    return noSingleLineBlocks &&\n      (!tagName ||\n      !singleLineTags.includes(tagName) && !singleLineTags.includes('*'));\n  };\n\n  if (sourceLength === 1) {\n    if (!isInvalidSingleLine(tag.slice(1))) {\n      return;\n    }\n\n    const fixer = () => {\n      utils.makeMultiline();\n    };\n\n    utils.reportJSDoc(\n      'Single line blocks are not permitted by your configuration.',\n      null,\n      fixer,\n      true,\n    );\n\n    return;\n  }\n\n  if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  const lineChecks = () => {\n    if (\n      noZeroLineText &&\n      (tag || description)\n    ) {\n      const fixer = () => {\n        const line = {\n          ...tokens,\n        };\n        utils.emptyTokens(tokens);\n        const {\n          tokens: {\n            delimiter,\n            start,\n          },\n        } = jsdoc.source[1];\n        utils.addLine(1, {\n          ...line,\n          delimiter,\n          start,\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the \"0th\" line (after the `/**`).',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n\n    const finalLine = jsdoc.source[jsdoc.source.length - 1];\n    const finalLineTokens = finalLine.tokens;\n    if (\n      noFinalLineText &&\n      finalLineTokens.description.trim()\n    ) {\n      const fixer = () => {\n        const line = {\n          ...finalLineTokens,\n        };\n        line.description = line.description.trimEnd();\n\n        const {\n          delimiter,\n        } = line;\n\n        for (const prop of [\n          'delimiter',\n          'postDelimiter',\n          'tag',\n          'type',\n          'lineEnd',\n          'postType',\n          'postTag',\n          'name',\n          'postName',\n          'description',\n        ]) {\n          finalLineTokens[\n            /**\n             * @type {\"delimiter\"|\"postDelimiter\"|\"tag\"|\"type\"|\n             *   \"lineEnd\"|\"postType\"|\"postTag\"|\"name\"|\n             *   \"postName\"|\"description\"}\n             */ (\n              prop\n            )\n          ] = '';\n        }\n\n        utils.addLine(jsdoc.source.length - 1, {\n          ...line,\n          delimiter,\n          end: '',\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the final line (before the `*/`).',\n        null,\n        fixer,\n      );\n    }\n  };\n\n  if (noMultilineBlocks) {\n    if (\n      jsdoc.tags.length &&\n      (multilineTags.includes('*') || utils.hasATag(multilineTags))\n    ) {\n      lineChecks();\n\n      return;\n    }\n\n    if (jsdoc.description.length >= minimumLengthForMultiline) {\n      lineChecks();\n\n      return;\n    }\n\n    if (\n      noSingleLineBlocks &&\n      (!jsdoc.tags.length ||\n      !utils.filterTags(({\n        tag: tg,\n      }) => {\n        return !isInvalidSingleLine(tg);\n      }).length)\n    ) {\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration but fixing would result in a single ' +\n          'line block which you have prohibited with `noSingleLineBlocks`.',\n      );\n\n      return;\n    }\n\n    if (jsdoc.tags.length > 1) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has multiple tags.',\n        );\n\n        return;\n      }\n    } else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has a description with a tag.',\n        );\n\n        return;\n      }\n    } else {\n      const fixer = () => {\n        jsdoc.source = [\n          {\n            number: 1,\n            source: '',\n            tokens: jsdoc.source.reduce((obj, {\n              tokens: {\n                description: desc,\n                lineEnd,\n                name: nme,\n                postName,\n                postTag,\n                postType,\n                tag: tg,\n                type: typ,\n              },\n            }) => {\n              if (typ) {\n                obj.type = typ;\n              }\n\n              if (tg && typ && nme) {\n                obj.postType = postType;\n              }\n\n              if (nme) {\n                obj.name += nme;\n              }\n\n              if (nme && desc) {\n                obj.postName = postName;\n              }\n\n              obj.description += desc;\n\n              const nameOrDescription = obj.description || obj.name;\n              if (\n                nameOrDescription && nameOrDescription.slice(-1) !== ' '\n              ) {\n                obj.description += ' ';\n              }\n\n              obj.lineEnd = lineEnd;\n\n              // Already filtered for multiple tags\n              obj.tag += tg;\n              if (tg) {\n                obj.postTag = postTag || ' ';\n              }\n\n              return obj;\n            }, utils.seedTokens({\n              delimiter: '/**',\n              end: '*/',\n              postDelimiter: ' ',\n            })),\n          },\n        ];\n      };\n\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration.',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n  }\n\n  lineChecks();\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowMultipleTags: {\n            type: 'boolean',\n          },\n          minimumLengthForMultiline: {\n            type: 'integer',\n          },\n          multilineTags: {\n            anyOf: [\n              {\n                enum: [\n                  '*',\n                ],\n                type: 'string',\n              }, {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            ],\n          },\n          noFinalLineText: {\n            type: 'boolean',\n          },\n          noMultilineBlocks: {\n            type: 'boolean',\n          },\n          noSingleLineBlocks: {\n            type: 'boolean',\n          },\n          noZeroLineText: {\n            type: 'boolean',\n          },\n          requireSingleLineUnderCount: {\n            type: 'number',\n          },\n          singleLineTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,oBAAoB,CAAC,OAAO,OAAO,gCAAgC;AACvE,KAAI,CAAC,+BAA+B,CAAC,MAAM,KAAK,OAC9C,QAAO;CAGT,IAAI,kBAAkB;CACtB,IAAI,oBAAoB;CACxB,IAAI,qBAAqB;CACzB,MAAM,WAAW,MAAM,OAAO,OAAO,CAAC,KAAK,EACzC,QAAQ,EACN,WACA,aAAa,MACb,MACA,eACA,UACA,SACA,UACA,OACA,KACA,MACD,EACF,EAAE,QAAQ;AACT,MAAI,IAAI,QAAQ;GACd,kBAAkB;AAClB,OACE,MAAM,SAAS,UAAU,SAAS,cAAc,SAChD,KAAK,SAAS,SAAS,SAAS,KAAK,SAAS,SAAS,SACvD,IAAI,SAAS,QAAQ,SAAS,KAAK,SACjC,6BAEF,oBAAoB;AAGtB,UAAO,MAAM;EACd,WAAU,KAAK,UAAU,KAAK,QAAQ;GACrC,qBAAqB;AACrB,UAAO;EACR;AAED,SAAO;CACR,GAAE,EAAE;AAEL,KAAI,CAAC,sBAAsB,qBAAqB,aAAa,GAAG;EAC9D,MAAM,QAAQ,MAAM;GAClB,MAAM,SAAS,MAAM,OAAO,iBAAiB;GAC7C,MAAM,SAAS,CACb;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM,WAAW;KACvB,WAAW;KACX,aAAa,OAAO,YAAY,SAAS,GAAG;KAC5C,KAAK;KACL,MAAM,OAAO;KACb,eAAe;KACf,UAAU,OAAO;KACjB,SAAS,OAAO;KAChB,UAAU,OAAO;KACjB,OAAO,MAAM,OAAO,GAAG,OAAO;KAC9B,KAAK,OAAO;KACZ,MAAM,OAAO;IACd,EAAC;GACH,CACF;EACF;EAED,MAAM,YACJ,8CACA,MACA,MACD;AACD,SAAO;CACR;AAED,QAAO;AACR;;;;;;AAOD,MAAM,4BAA4B,CAAC,OAAO,OAAO,gCAAgC;AAC/E,KAAI,CAAC,+BAA+B,MAAM,KAAK,OAC7C,QAAO;CAGT,IAAI,mBAAmB;CACvB,IAAI,oBAAoB;CACxB,MAAM,YAAY,MAAM,OAAO,OAAO,CAAC,KAAK,EAC1C,QAAQ,EACN,WACA,aAAa,MACb,eACA,OACD,EACF,EAAE,QAAQ;AACT,MAAI,KAAK,QAAQ;GACf,mBAAmB;AACnB,OACE,MAAM,SAAS,UAAU,SAAS,cAAc,SAAS,KAAK,SAC5D,6BAEF,oBAAoB;AAGtB,UAAO,MAAM;EACd;AAED,SAAO;CACR,GAAE,EAAE;AAEL,KAAI,qBAAqB,cAAc,GAAG;EACxC,MAAM,QAAQ,MAAM;GAClB,MAAM,OAAO,MAAM,OAAO,kBAAkB,OAAO;GACnD,MAAM,SAAS,CACb;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM,WAAW;KACvB,WAAW;KACX,aAAa,KAAK,SAAS,GAAG;KAC9B,KAAK;KACL,eAAe;KACf,OAAO,MAAM,OAAO,GAAG,OAAO;IAC/B,EAAC;GACH,CACF;EACF;EAED,MAAM,YACJ,8CACA,MACA,MACD;AACD,SAAO;CACR;AAED,QAAO;AACR;AAED,8BAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,oBAAoB,MACpB,4BAA4B,OAAO,mBACnC,gBAAgB,CACd,GACD,GACD,kBAAkB,MAClB,oBAAoB,OACpB,qBAAqB,OACrB,iBAAiB,MACjB,8BAA8B,MAC9B,iBAAiB,CACf,SAAS,MACV,GACF,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,EACJ,QAAQ,CACN,EACE,QACD,CACF,EACF,GAAG;CACJ,MAAM,EACJ,aACA,KACD,GAAG;CACJ,MAAM,eAAe,MAAM,OAAO;;;;;CAMlC,MAAM,sBAAsB,CAAC,YAAY;AACvC,SAAO,uBACJ,CAAC,WACF,CAAC,eAAe,SAAS,QAAQ,IAAI,CAAC,eAAe,SAAS,IAAI;CACrE;AAED,KAAI,iBAAiB,GAAG;AACtB,MAAI,CAAC,oBAAoB,IAAI,MAAM,EAAE,CAAC,CACpC;EAGF,MAAM,QAAQ,MAAM;GAClB,MAAM,eAAe;EACtB;EAED,MAAM,YACJ,+DACA,MACA,OACA,KACD;AAED;CACD;AAED,KAAI,0BAA0B,OAAO,OAAO,4BAA4B,CAEtE;AAGF,KAAI,kBAAkB,OAAO,OAAO,4BAA4B,CAE9D;CAGF,MAAM,aAAa,MAAM;AACvB,MACE,mBACC,OAAO,cACR;GACA,MAAM,QAAQ,MAAM;IAClB,MAAM,OAAO,EACX,GAAG,OACJ;IACD,MAAM,YAAY,OAAO;IACzB,MAAM,EACJ,QAAQ,EACN,WACA,OACD,EACF,GAAG,MAAM,OAAO;IACjB,MAAM,QAAQ,GAAG;KACf,GAAG;KACH;KACA;IACD,EAAC;GACH;GAED,MAAM,YACJ,8DACA,MACA,MACD;AAED;EACD;EAED,MAAM,YAAY,MAAM,OAAO,MAAM,OAAO,SAAS;EACrD,MAAM,kBAAkB,UAAU;AAClC,MACE,mBACA,gBAAgB,YAAY,MAAM,EAClC;GACA,MAAM,QAAQ,MAAM;IAClB,MAAM,OAAO,EACX,GAAG,gBACJ;IACD,KAAK,cAAc,KAAK,YAAY,SAAS;IAE7C,MAAM,EACJ,WACD,GAAG;AAEJ,SAAK,MAAM,QAAQ;KACjB;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;IACD,GACC,gBAMI,QAEA;IAGN,MAAM,QAAQ,MAAM,OAAO,SAAS,GAAG;KACrC,GAAG;KACH;KACA,KAAK;IACN,EAAC;GACH;GAED,MAAM,YACJ,4DACA,MACA,MACD;EACF;CACF;AAED,KAAI,mBAAmB;AACrB,MACE,MAAM,KAAK,WACV,cAAc,SAAS,IAAI,IAAI,MAAM,QAAQ,cAAc,GAC5D;GACA,YAAY;AAEZ;EACD;AAED,MAAI,MAAM,YAAY,UAAU,2BAA2B;GACzD,YAAY;AAEZ;EACD;AAED,MACE,uBACC,CAAC,MAAM,KAAK,UACb,CAAC,MAAM,WAAW,CAAC,EACjB,KAAK,IACN,KAAK;AACJ,UAAO,CAAC,oBAAoB,GAAG;EAChC,EAAC,CAAC,SACH;GACA,MAAM,YACJ,kKAGD;AAED;EACD;AAED,MAAI,MAAM,KAAK,SAAS,GACtB;OAAI,CAAC,mBAAmB;IACtB,MAAM,YACJ,+FAED;AAED;GACD;aACQ,MAAM,KAAK,WAAW,KAAK,MAAM,YAAY,MAAM,EAC5D;OAAI,CAAC,mBAAmB;IACtB,MAAM,YACJ,0GAED;AAED;GACD;SACI;GACL,MAAM,QAAQ,MAAM;IAClB,MAAM,SAAS,CACb;KACE,QAAQ;KACR,QAAQ;KACR,QAAQ,MAAM,OAAO,OAAO,CAAC,KAAK,EAChC,QAAQ,EACN,aAAa,MACb,SACA,MAAM,KACN,UACA,SACA,UACA,KAAK,IACL,MAAM,KACP,EACF,KAAK;AACJ,UAAI,KACF,IAAI,OAAO;AAGb,UAAI,MAAM,OAAO,KACf,IAAI,WAAW;AAGjB,UAAI,KACF,IAAI,QAAQ;AAGd,UAAI,OAAO,MACT,IAAI,WAAW;MAGjB,IAAI,eAAe;MAEnB,MAAM,oBAAoB,IAAI,eAAe,IAAI;AACjD,UACE,qBAAqB,kBAAkB,MAAM,GAAG,KAAK,KAErD,IAAI,eAAe;MAGrB,IAAI,UAAU;MAGd,IAAI,OAAO;AACX,UAAI,IACF,IAAI,UAAU,WAAW;AAG3B,aAAO;KACR,GAAE,MAAM,WAAW;MAClB,WAAW;MACX,KAAK;MACL,eAAe;KAChB,EAAC,CAAC;IACJ,CACF;GACF;GAED,MAAM,YACJ,gEAEA,MACA,MACD;AAED;EACD;CACF;CAED,YAAY;AACb,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB,EACjB,MAAM,UACP;IACD,2BAA2B,EACzB,MAAM,UACP;IACD,eAAe,EACb,OAAO,CACL;KACE,MAAM,CACJ,GACD;KACD,MAAM;IACP,GAAE;KACD,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP,CACF,EACF;IACD,iBAAiB,EACf,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,oBAAoB,EAClB,MAAM,UACP;IACD,gBAAgB,EACd,MAAM,UACP;IACD,6BAA6B,EAC3B,MAAM,SACP;IACD,gBAAgB;KACd,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}