eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/requireYields.js

@@ -1,115 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireYields.js
-/**
-* We can skip checking for a yield value, in case the documentation is inherited
-* or the method has a constructor or abstract tag.
-*
-* In either of these cases the yield value is optional or not defined.
-* @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.
-* @returns {boolean} true in case deep checking can be skipped; otherwise false.
-*/
-const canSkip = (utils) => {
-	return utils.hasATag([
-		"abstract",
-		"virtual",
-		"class",
-		"constructor",
-		"type",
-		"interface"
-	]) || utils.avoidDocs();
-};
-/**
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {import('../iterateJsdoc.js').Report} report
-* @param {string} tagName
-* @returns {[preferredTagName?: string, missingTag?: boolean]}
-*/
-const checkTagName = (utils, report, tagName) => {
-	const preferredTagName = utils.getPreferredTagName({ tagName });
-	if (!preferredTagName) return [];
-	const tags = utils.getTags(preferredTagName);
-	if (tags.length > 1) report(`Found more than one @${preferredTagName} declaration.`);
-	const [tag] = tags;
-	const missingTag = typeof tag === "undefined" || tag === null;
-	return [preferredTagName, missingTag];
-};
-var requireYields_default = iterateJsdoc(({ context, report, utils }) => {
-	const { forceRequireNext = false, forceRequireYields = false, next = false, nextWithGeneratorTag = false, withGeneratorTag = true } = context.options[0] || {};
-	if (canSkip(utils)) return;
-	const iteratingFunction = utils.isIteratingFunction();
-	const [preferredYieldTagName, missingYieldTag] = checkTagName(utils, report, "yields");
-	if (preferredYieldTagName) {
-		const shouldReportYields = () => {
-			if (!missingYieldTag) return false;
-			if (withGeneratorTag && utils.hasTag("generator") || forceRequireYields && iteratingFunction && utils.isGenerator()) return true;
-			return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();
-		};
-		if (shouldReportYields()) report(`Missing JSDoc @${preferredYieldTagName} declaration.`);
-	}
-	if (next || nextWithGeneratorTag || forceRequireNext) {
-		const [preferredNextTagName, missingNextTag] = checkTagName(utils, report, "next");
-		if (!preferredNextTagName) return;
-		const shouldReportNext = () => {
-			if (!missingNextTag) return false;
-			if (nextWithGeneratorTag && utils.hasTag("generator")) return true;
-			if (!next && !forceRequireNext || !iteratingFunction || !utils.isGenerator()) return false;
-			return forceRequireNext || utils.hasYieldReturnValue();
-		};
-		if (shouldReportNext()) report(`Missing JSDoc @${preferredNextTagName} declaration.`);
-	}
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires yields are documented.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.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"
-				},
-				exemptedBy: {
-					items: { type: "string" },
-					type: "array"
-				},
-				forceRequireNext: {
-					default: false,
-					type: "boolean"
-				},
-				forceRequireYields: {
-					default: false,
-					type: "boolean"
-				},
-				next: {
-					default: false,
-					type: "boolean"
-				},
-				nextWithGeneratorTag: {
-					default: false,
-					type: "boolean"
-				},
-				withGeneratorTag: {
-					default: true,
-					type: "boolean"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireYields_default as default };
-//# sourceMappingURL=requireYields.js.map

package/dist/rules/requireYields.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireYields.js","names":[],"sources":["../../src/rules/requireYields.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * We can skip checking for a yield value, in case the documentation is inherited\n * or the method has a constructor or abstract tag.\n *\n * In either of these cases the yield value is optional or not defined.\n * @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean} true in case deep checking can be skipped; otherwise false.\n */\nconst canSkip = (utils) => {\n  return utils.hasATag([\n    // inheritdoc implies that all documentation is inherited\n    // see https://jsdoc.app/tags-inheritdoc.html\n    //\n    // Abstract methods are by definition incomplete,\n    // so it is not an error if it declares a yield value but does not implement it.\n    'abstract',\n    'virtual',\n\n    // Constructors do not have a yield value\n    // so we can bail out here, too.\n    'class',\n    'constructor',\n\n    // Yield (and any `next`) type is specified accompanying the targeted\n    //   @type\n    'type',\n\n    // This seems to imply a class as well\n    'interface',\n  ]) ||\n    utils.avoidDocs();\n};\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @param {string} tagName\n * @returns {[preferredTagName?: string, missingTag?: boolean]}\n */\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName,\n  }));\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n  }\n\n  // In case the code yields something, we expect a yields value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingTag = typeof tag === 'undefined' || tag === null;\n\n  return [\n    preferredTagName, missingTag,\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  utils,\n}) => {\n  const {\n    forceRequireNext = false,\n    forceRequireYields = false,\n    next = false,\n    nextWithGeneratorTag = false,\n    withGeneratorTag = true,\n  } = context.options[0] || {};\n\n  // A preflight check. We do not need to run a deep check\n  // in case the @yield comment is optional or undefined.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const iteratingFunction = utils.isIteratingFunction();\n\n  const [\n    preferredYieldTagName,\n    missingYieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (!missingYieldTag) {\n        return false;\n      }\n\n      if (\n        withGeneratorTag && utils.hasTag('generator') ||\n        forceRequireYields && iteratingFunction && utils.isGenerator()\n      ) {\n        return true;\n      }\n\n      return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();\n    };\n\n    if (shouldReportYields()) {\n      report(`Missing JSDoc @${preferredYieldTagName} declaration.`);\n    }\n  }\n\n  if (next || nextWithGeneratorTag || forceRequireNext) {\n    const [\n      preferredNextTagName,\n      missingNextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (!preferredNextTagName) {\n      return;\n    }\n\n    const shouldReportNext = () => {\n      if (!missingNextTag) {\n        return false;\n      }\n\n      if (\n        nextWithGeneratorTag && utils.hasTag('generator')) {\n        return true;\n      }\n\n      if (\n        !next && !forceRequireNext ||\n        !iteratingFunction ||\n        !utils.isGenerator()\n      ) {\n        return false;\n      }\n\n      return forceRequireNext || utils.hasYieldReturnValue();\n    };\n\n    if (shouldReportNext()) {\n      report(`Missing JSDoc @${preferredNextTagName} declaration.`);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires yields are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.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          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          forceRequireNext: {\n            default: false,\n            type: 'boolean',\n          },\n          forceRequireYields: {\n            default: false,\n            type: 'boolean',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n          nextWithGeneratorTag: {\n            default: false,\n            type: 'boolean',\n          },\n          withGeneratorTag: {\n            default: true,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;AAUA,MAAM,UAAU,CAAC,UAAU;AACzB,QAAO,MAAM,QAAQ;EAMnB;EACA;EAIA;EACA;EAIA;EAGA;CACD,EAAC,IACA,MAAM,WAAW;AACpB;;;;;;;AAQD,MAAM,eAAe,CAAC,OAAO,QAAQ,YAAY;CAC/C,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,QACD,EAAC;AACF,KAAI,CAAC,iBACH,QAAO,CAAE;CAGX,MAAM,OAAO,MAAM,QAAQ,iBAAiB;AAE5C,KAAI,KAAK,SAAS,GAChB,OAAO,CAAC,qBAAqB,EAAE,iBAAiB,aAAa,CAAC,CAAC;CAIjE,MAAM,CACJ,IACD,GAAG;CACJ,MAAM,aAAa,OAAO,QAAQ,eAAe,QAAQ;AAEzD,QAAO,CACL,kBAAkB,UACnB;AACF;AAED,4BAAe,aAAa,CAAC,EAC3B,SACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,mBAAmB,OACnB,qBAAqB,OACrB,OAAO,OACP,uBAAuB,OACvB,mBAAmB,MACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAI5B,KAAI,QAAQ,MAAM,CAChB;CAGF,MAAM,oBAAoB,MAAM,qBAAqB;CAErD,MAAM,CACJ,uBACA,gBACD,GAAG,aACF,OAAO,QAAQ,SAChB;AACD,KAAI,uBAAuB;EACzB,MAAM,qBAAqB,MAAM;AAC/B,OAAI,CAAC,gBACH,QAAO;AAGT,OACE,oBAAoB,MAAM,OAAO,YAAY,IAC7C,sBAAsB,qBAAqB,MAAM,aAAa,CAE9D,QAAO;AAGT,UAAO,qBAAqB,MAAM,aAAa,IAAI,MAAM,eAAe;EACzE;AAED,MAAI,oBAAoB,EACtB,OAAO,CAAC,eAAe,EAAE,sBAAsB,aAAa,CAAC,CAAC;CAEjE;AAED,KAAI,QAAQ,wBAAwB,kBAAkB;EACpD,MAAM,CACJ,sBACA,eACD,GAAG,aACF,OAAO,QAAQ,OAChB;AACD,MAAI,CAAC,qBACH;EAGF,MAAM,mBAAmB,MAAM;AAC7B,OAAI,CAAC,eACH,QAAO;AAGT,OACE,wBAAwB,MAAM,OAAO,YAAY,CACjD,QAAO;AAGT,OACE,CAAC,QAAQ,CAAC,oBACV,CAAC,qBACD,CAAC,MAAM,aAAa,CAEpB,QAAO;AAGT,UAAO,oBAAoB,MAAM,qBAAqB;EACvD;AAED,MAAI,kBAAkB,EACpB,OAAO,CAAC,eAAe,EAAE,qBAAqB,aAAa,CAAC,CAAC;CAEhE;AACF,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,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,kBAAkB;KAChB,SAAS;KACT,MAAM;IACP;IACD,oBAAoB;KAClB,SAAS;KACT,MAAM;IACP;IACD,MAAM;KACJ,SAAS;KACT,MAAM;IACP;IACD,sBAAsB;KACpB,SAAS;KACT,MAAM;IACP;IACD,kBAAkB;KAChB,SAAS;KACT,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireYieldsCheck.js

@@ -1,105 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireYieldsCheck.js
-/**
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {import('../iterateJsdoc.js').Settings} settings
-* @returns {boolean}
-*/
-const canSkip = (utils, settings) => {
-	const voidingTags = [
-		"abstract",
-		"virtual",
-		"class",
-		"constructor",
-		"interface"
-	];
-	if (settings.mode === "closure") voidingTags.push("record");
-	return utils.hasATag(voidingTags) || utils.isConstructor() || utils.classHasTag("interface") || settings.mode === "closure" && utils.classHasTag("record");
-};
-/**
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {import('../iterateJsdoc.js').Report} report
-* @param {string} tagName
-* @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}
-*/
-const checkTagName = (utils, report, tagName) => {
-	const preferredTagName = utils.getPreferredTagName({ tagName });
-	if (!preferredTagName) return [];
-	const tags = utils.getTags(preferredTagName);
-	if (tags.length === 0) return [];
-	if (tags.length > 1) {
-		report(`Found more than one @${preferredTagName} declaration.`);
-		return [];
-	}
-	return [preferredTagName, tags[0]];
-};
-var requireYieldsCheck_default = iterateJsdoc(({ context, report, settings, utils }) => {
-	if (canSkip(utils, settings)) return;
-	const { checkGeneratorsOnly = false, next = false } = context.options[0] || {};
-	const [preferredYieldTagName, yieldTag] = checkTagName(utils, report, "yields");
-	if (preferredYieldTagName) {
-		const shouldReportYields = () => {
-			if (yieldTag.type.trim() === "never") {
-				if (utils.hasYieldValue()) report(`JSDoc @${preferredYieldTagName} declaration set with "never" but yield expression is present in function.`);
-				return false;
-			}
-			if (checkGeneratorsOnly && !utils.isGenerator()) return true;
-			return !utils.mayBeUndefinedTypeTag(yieldTag) && !utils.hasYieldValue();
-		};
-		if (shouldReportYields()) report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);
-	}
-	if (next) {
-		const [preferredNextTagName, nextTag] = checkTagName(utils, report, "next");
-		if (preferredNextTagName) {
-			const shouldReportNext = () => {
-				if (nextTag.type.trim() === "never") {
-					if (utils.hasYieldReturnValue()) report(`JSDoc @${preferredNextTagName} declaration set with "never" but yield expression with return value is present in function.`);
-					return false;
-				}
-				if (checkGeneratorsOnly && !utils.isGenerator()) return true;
-				return !utils.mayBeUndefinedTypeTag(nextTag) && !utils.hasYieldReturnValue();
-			};
-			if (shouldReportNext()) report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);
-		}
-	}
-}, { meta: {
-	docs: {
-		description: "Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.",
-		url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header"
-	},
-	schema: [{
-		additionalProperties: false,
-		properties: {
-			checkGeneratorsOnly: {
-				default: false,
-				type: "boolean"
-			},
-			contexts: {
-				items: { anyOf: [{ type: "string" }, {
-					additionalProperties: false,
-					properties: {
-						comment: { type: "string" },
-						context: { type: "string" }
-					},
-					type: "object"
-				}] },
-				type: "array"
-			},
-			exemptedBy: {
-				items: { type: "string" },
-				type: "array"
-			},
-			next: {
-				default: false,
-				type: "boolean"
-			}
-		},
-		type: "object"
-	}],
-	type: "suggestion"
-} });
-
-//#endregion
-export { requireYieldsCheck_default as default };
-//# sourceMappingURL=requireYieldsCheck.js.map

package/dist/rules/requireYieldsCheck.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireYieldsCheck.js","names":[],"sources":["../../src/rules/requireYieldsCheck.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Settings} settings\n * @returns {boolean}\n */\nconst canSkip = (utils, settings) => {\n  const voidingTags = [\n    // An abstract function is by definition incomplete\n    // so it is perfectly fine if a yield is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing yield.\n    'abstract',\n    'virtual',\n\n    // Constructor functions do not have a yield value\n    //  so we can bail here, too.\n    'class',\n    'constructor',\n\n    // This seems to imply a class as well\n    'interface',\n  ];\n\n  if (settings.mode === 'closure') {\n    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned\n    voidingTags.push('record');\n  }\n\n  return utils.hasATag(voidingTags) ||\n    utils.isConstructor() ||\n    utils.classHasTag('interface') ||\n    settings.mode === 'closure' && utils.classHasTag('record');\n};\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @param {string} tagName\n * @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}\n */\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName,\n  }));\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length === 0) {\n    return [];\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n\n    return [];\n  }\n\n  return [\n    preferredTagName, tags[0],\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  const {\n    checkGeneratorsOnly = false,\n    next = false,\n  } = context.options[0] || {};\n\n  const [\n    preferredYieldTagName,\n    yieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (\n        /** @type {import('comment-parser').Spec} */ (\n          yieldTag\n        ).type.trim() === 'never'\n      ) {\n        if (utils.hasYieldValue()) {\n          report(`JSDoc @${preferredYieldTagName} declaration set with \"never\" but yield expression is present in function.`);\n        }\n\n        return false;\n      }\n\n      if (checkGeneratorsOnly && !utils.isGenerator()) {\n        return true;\n      }\n\n      return !utils.mayBeUndefinedTypeTag(\n        /** @type {import('comment-parser').Spec} */\n        (yieldTag),\n      ) && !utils.hasYieldValue();\n    };\n\n    // In case a yield value is declared in JSDoc, we also expect one in the code.\n    if (shouldReportYields()) {\n      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);\n    }\n  }\n\n  if (next) {\n    const [\n      preferredNextTagName,\n      nextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (preferredNextTagName) {\n      const shouldReportNext = () => {\n        if (\n          /** @type {import('comment-parser').Spec} */ (\n            nextTag\n          ).type.trim() === 'never'\n        ) {\n          if (utils.hasYieldReturnValue()) {\n            report(`JSDoc @${preferredNextTagName} declaration set with \"never\" but yield expression with return value is present in function.`);\n          }\n\n          return false;\n        }\n\n        if (checkGeneratorsOnly && !utils.isGenerator()) {\n          return true;\n        }\n\n        return !utils.mayBeUndefinedTypeTag(\n          /** @type {import('comment-parser').Spec} */\n          (nextTag),\n        ) && !utils.hasYieldReturnValue();\n      };\n\n      if (shouldReportNext()) {\n        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);\n      }\n    }\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkGeneratorsOnly: {\n            default: false,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,UAAU,CAAC,OAAO,aAAa;CACnC,MAAM,cAAc;EAMlB;EACA;EAIA;EACA;EAGA;CACD;AAED,KAAI,SAAS,SAAS,WAEpB,YAAY,KAAK,SAAS;AAG5B,QAAO,MAAM,QAAQ,YAAY,IAC/B,MAAM,eAAe,IACrB,MAAM,YAAY,YAAY,IAC9B,SAAS,SAAS,aAAa,MAAM,YAAY,SAAS;AAC7D;;;;;;;AAQD,MAAM,eAAe,CAAC,OAAO,QAAQ,YAAY;CAC/C,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,QACD,EAAC;AACF,KAAI,CAAC,iBACH,QAAO,CAAE;CAGX,MAAM,OAAO,MAAM,QAAQ,iBAAiB;AAE5C,KAAI,KAAK,WAAW,EAClB,QAAO,CAAE;AAGX,KAAI,KAAK,SAAS,GAAG;EACnB,OAAO,CAAC,qBAAqB,EAAE,iBAAiB,aAAa,CAAC,CAAC;AAE/D,SAAO,CAAE;CACV;AAED,QAAO,CACL,kBAAkB,KAAK,EACxB;AACF;AAED,iCAAe,aAAa,CAAC,EAC3B,SACA,QACA,UACA,OACD,KAAK;AACJ,KAAI,QAAQ,OAAO,SAAS,CAC1B;CAGF,MAAM,EACJ,sBAAsB,OACtB,OAAO,OACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,CACJ,uBACA,SACD,GAAG,aACF,OAAO,QAAQ,SAChB;AACD,KAAI,uBAAuB;EACzB,MAAM,qBAAqB,MAAM;AAC/B,OAEI,SACA,KAAK,MAAM,KAAK,SAClB;AACA,QAAI,MAAM,eAAe,EACvB,OAAO,CAAC,OAAO,EAAE,sBAAsB,0EAA0E,CAAC,CAAC;AAGrH,WAAO;GACR;AAED,OAAI,uBAAuB,CAAC,MAAM,aAAa,CAC7C,QAAO;AAGT,UAAO,CAAC,MAAM,sBAEX,SACF,IAAI,CAAC,MAAM,eAAe;EAC5B;AAGD,MAAI,oBAAoB,EACtB,OAAO,CAAC,OAAO,EAAE,sBAAsB,oEAAoE,CAAC,CAAC;CAEhH;AAED,KAAI,MAAM;EACR,MAAM,CACJ,sBACA,QACD,GAAG,aACF,OAAO,QAAQ,OAChB;AACD,MAAI,sBAAsB;GACxB,MAAM,mBAAmB,MAAM;AAC7B,QAEI,QACA,KAAK,MAAM,KAAK,SAClB;AACA,SAAI,MAAM,qBAAqB,EAC7B,OAAO,CAAC,OAAO,EAAE,qBAAqB,4FAA4F,CAAC,CAAC;AAGtI,YAAO;IACR;AAED,QAAI,uBAAuB,CAAC,MAAM,aAAa,CAC7C,QAAO;AAGT,WAAO,CAAC,MAAM,sBAEX,QACF,IAAI,CAAC,MAAM,qBAAqB;GAClC;AAED,OAAI,kBAAkB,EACpB,OAAO,CAAC,OAAO,EAAE,qBAAqB,sFAAsF,CAAC,CAAC;EAEjI;CACF;AACF,GAAE,EACD,MAAM;CACJ,MAAM;EACJ,aAAa;EACb,KAAK;CACN;CACD,QAAQ,CACN;EACE,sBAAsB;EACtB,YAAY;GACV,qBAAqB;IACnB,SAAS;IACT,MAAM;GACP;GACD,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP;GACD,YAAY;IACV,OAAO,EACL,MAAM,SACP;IACD,MAAM;GACP;GACD,MAAM;IACJ,SAAS;IACT,MAAM;GACP;EACF;EACD,MAAM;CACP,CACF;CACD,MAAM;AACP,EACF,EAAC"}

package/dist/rules/sortTags.js

@@ -1,262 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import defaultTagOrder_default from "../defaultTagOrder.js";
-
-//#region src/rules/sortTags.js
-var sortTags_default = iterateJsdoc(({ context, jsdoc, utils }) => {
-	const { alphabetizeExtras = false, linesBetween = 1, reportIntraTagGroupSpacing = true, reportTagGroupSpacing = true, tagSequence = defaultTagOrder_default } = context.options[0] || {};
-	const tagList = tagSequence.flatMap((obj) => {
-		return obj.tags;
-	});
-	const otherPos = tagList.indexOf("-other");
-	const endPos = otherPos > -1 ? otherPos : tagList.length;
-	let ongoingCount = 0;
-	for (const [idx, tag] of jsdoc.tags.entries()) {
-		tag.originalIndex = idx;
-		ongoingCount += tag.source.length;
-		tag.originalLine = ongoingCount;
-	}
-	/** @type {import('../iterateJsdoc.js').Integer|undefined} */
-	let firstChangedTagLine;
-	/** @type {import('../iterateJsdoc.js').Integer|undefined} */
-	let firstChangedTagIndex;
-	/**
-	* @type {(import('comment-parser').Spec & {
-	*   originalIndex: import('../iterateJsdoc.js').Integer,
-	*   originalLine: import('../iterateJsdoc.js').Integer,
-	* })[]}
-	*/
-	const sortedTags = JSON.parse(JSON.stringify(jsdoc.tags));
-	sortedTags.sort(({ tag: tagNew }, { originalIndex, originalLine, tag: tagOld }) => {
-		if (tagNew === tagOld) return 0;
-		const checkOrSetFirstChanged = () => {
-			if (!firstChangedTagLine || originalLine < firstChangedTagLine) {
-				firstChangedTagLine = originalLine;
-				firstChangedTagIndex = originalIndex;
-			}
-		};
-		const newPos = tagList.indexOf(tagNew);
-		const oldPos = tagList.indexOf(tagOld);
-		const preferredNewPos = newPos === -1 ? endPos : newPos;
-		const preferredOldPos = oldPos === -1 ? endPos : oldPos;
-		if (preferredNewPos < preferredOldPos) {
-			checkOrSetFirstChanged();
-			return -1;
-		}
-		if (preferredNewPos > preferredOldPos) return 1;
-		if (!alphabetizeExtras || newPos >= 0) return 0;
-		if (tagNew < tagOld) {
-			checkOrSetFirstChanged();
-			return -1;
-		}
-		return 1;
-	});
-	if (firstChangedTagLine === void 0) {
-		/**
-		* @type {import('comment-parser').Spec[]}
-		*/
-		const lastTagsOfGroup = [];
-		/**
-		* @type {[
-		*   import('comment-parser').Spec,
-		*   import('../iterateJsdoc.js').Integer
-		* ][]}
-		*/
-		const badLastTagsOfGroup = [];
-		/**
-		* @param {import('comment-parser').Spec} tag
-		*/
-		const countTagEmptyLines = (tag) => {
-			return tag.source.reduce((acc, { tokens: { description, end, name, tag: tg, type } }) => {
-				const empty = !tg && !type && !name && !description;
-				return empty ? acc + Number(empty && !end) : 0;
-			}, 0);
-		};
-		let idx = 0;
-		for (const { tags } of tagSequence) {
-			let innerIdx;
-			/** @type {import('comment-parser').Spec} */
-			let currentTag;
-			/** @type {import('comment-parser').Spec|undefined} */
-			let lastTag;
-			do {
-				currentTag = jsdoc.tags[idx];
-				if (!currentTag) {
-					idx++;
-					break;
-				}
-				innerIdx = tags.indexOf(currentTag.tag);
-				if (innerIdx === -1 && (!tags.includes("-other") || tagSequence.some(({ tags: tgs }) => {
-					return tgs.includes(currentTag.tag);
-				}))) {
-					idx++;
-					break;
-				}
-				lastTag = currentTag;
-				idx++;
-			} while (true);
-			idx--;
-			if (lastTag) {
-				lastTagsOfGroup.push(lastTag);
-				const ct = countTagEmptyLines(lastTag);
-				if (ct !== linesBetween && jsdoc.tags[idx]) badLastTagsOfGroup.push([lastTag, ct]);
-			}
-		}
-		if (reportTagGroupSpacing && badLastTagsOfGroup.length) {
-			/**
-			* @param {import('comment-parser').Spec} tg
-			* @returns {() => void}
-			*/
-			const fixer = (tg) => {
-				return () => {
-					for (const [currIdx, { tokens }] of jsdoc.source.entries()) {
-						if (tokens.tag !== "@" + tg.tag) continue;
-						let newIdx = currIdx;
-						const emptyLine = () => {
-							return {
-								number: 0,
-								source: "",
-								tokens: utils.seedTokens({
-									delimiter: "*",
-									start: jsdoc.source[newIdx - 1].tokens.start
-								})
-							};
-						};
-						let existingEmptyLines = 0;
-						while (true) {
-							const nextTokens = jsdoc.source[++newIdx]?.tokens;
-							/* c8 ignore next 3 -- Guard */
-							if (!nextTokens) return;
-							if (nextTokens.tag) {
-								if (nextTokens.tag === tokens.tag) {
-									existingEmptyLines = 0;
-									continue;
-								}
-								const lineDiff = linesBetween - existingEmptyLines;
-								if (lineDiff > 0) {
-									const lines = Array.from({ length: lineDiff }, () => {
-										return emptyLine();
-									});
-									jsdoc.source.splice(newIdx, 0, ...lines);
-								} else jsdoc.source.splice(newIdx + lineDiff, -lineDiff);
-								break;
-							}
-							const empty = !nextTokens.type && !nextTokens.name && !nextTokens.description;
-							if (empty) existingEmptyLines++;
-							else existingEmptyLines = 0;
-						}
-						break;
-					}
-					for (const [srcIdx, src] of jsdoc.source.entries()) src.number = srcIdx;
-				};
-			};
-			for (const [tg] of badLastTagsOfGroup) utils.reportJSDoc("Tag groups do not have the expected whitespace", tg, fixer(tg));
-			return;
-		}
-		if (!reportIntraTagGroupSpacing) return;
-		for (const [tagIdx, tag] of jsdoc.tags.entries()) {
-			if (!jsdoc.tags[tagIdx + 1] || lastTagsOfGroup.includes(tag)) continue;
-			const ct = countTagEmptyLines(tag);
-			if (ct) {
-				const fixer = () => {
-					let foundFirstTag = false;
-					/** @type {string|undefined} */
-					let currentTag;
-					for (const [currIdx, { tokens: { description, end, name, tag: tg, type } }] of jsdoc.source.entries()) {
-						if (tg) {
-							foundFirstTag = true;
-							currentTag = tg;
-						}
-						if (!foundFirstTag) continue;
-						if (currentTag && !tg && !type && !name && !description && !end) {
-							let nextIdx = currIdx;
-							let ignore = true;
-							if (lastTagsOfGroup.some((lastTagOfGroup) => {
-								return currentTag === "@" + lastTagOfGroup.tag;
-							})) while (true) {
-								const nextTokens = jsdoc.source[++nextIdx]?.tokens;
-								if (!nextTokens) break;
-								if (!nextTokens.tag) continue;
-								if (nextTokens.tag === currentTag) ignore = false;
-							}
-							else while (true) {
-								const nextTokens = jsdoc.source[++nextIdx]?.tokens;
-								if (!nextTokens || nextTokens.end) break;
-								if (nextTokens.tag) {
-									ignore = false;
-									break;
-								}
-							}
-							if (!ignore) {
-								jsdoc.source.splice(currIdx, 1);
-								for (const [srcIdx, src] of jsdoc.source.entries()) src.number = srcIdx;
-							}
-						}
-					}
-				};
-				utils.reportJSDoc("Intra-group tags have unexpected whitespace", tag, fixer);
-			}
-		}
-		return;
-	}
-	const firstLine = utils.getFirstLine();
-	const fix = () => {
-		const itemsToMoveRange = [...Array.from({ length: jsdoc.tags.length - firstChangedTagIndex }).keys()];
-		const unchangedPriorTagDescriptions = jsdoc.tags.slice(0, firstChangedTagIndex).reduce((ct, { source }) => {
-			return ct + source.length - 1;
-		}, 0);
-		const initialOffset = firstLine + firstChangedTagIndex + unchangedPriorTagDescriptions;
-		for (const idx of itemsToMoveRange) utils.removeTag(idx + firstChangedTagIndex);
-		const changedTags = sortedTags.slice(firstChangedTagIndex);
-		let extraTagCount = 0;
-		for (const idx of itemsToMoveRange) {
-			const changedTag = changedTags[idx];
-			utils.addTag(changedTag.tag, extraTagCount + initialOffset + idx, {
-				...changedTag.source[0].tokens,
-				end: ""
-			});
-			for (const { tokens } of changedTag.source.slice(1)) if (!tokens.end) {
-				utils.addLine(extraTagCount + initialOffset + idx + 1, {
-					...tokens,
-					end: ""
-				});
-				extraTagCount++;
-			}
-		}
-	};
-	utils.reportJSDoc(`Tags are not in the prescribed order: ${tagList.join(", ") || "(alphabetical)"}`, jsdoc.tags[firstChangedTagIndex], fix, true);
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Sorts tags by a specified sequence according to tag name.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				alphabetizeExtras: { type: "boolean" },
-				linesBetween: { type: "integer" },
-				reportIntraTagGroupSpacing: { type: "boolean" },
-				reportTagGroupSpacing: { type: "boolean" },
-				tagSequence: {
-					items: {
-						additionalProperties: false,
-						properties: { tags: {
-							items: { type: "string" },
-							type: "array"
-						} },
-						type: "object"
-					},
-					type: "array"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { sortTags_default as default };
-//# sourceMappingURL=sortTags.js.map

package/dist/rules/sortTags.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sortTags.js","names":["defaultTagOrder"],"sources":["../../src/rules/sortTags.js"],"sourcesContent":["import defaultTagOrder from '../defaultTagOrder.js';\nimport iterateJsdoc from '../iterateJsdoc.js';\n\n// eslint-disable-next-line complexity -- Temporary\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const\n    /**\n     * @type {{\n     *   linesBetween: import('../iterateJsdoc.js').Integer,\n     *   tagSequence: {\n     *     tags: string[]\n     *   }[],\n     *   alphabetizeExtras: boolean,\n     *   reportTagGroupSpacing: boolean,\n     *   reportIntraTagGroupSpacing: boolean,\n     * }}\n     */ {\n      alphabetizeExtras = false,\n      linesBetween = 1,\n      reportIntraTagGroupSpacing = true,\n      reportTagGroupSpacing = true,\n      tagSequence = defaultTagOrder,\n    } = context.options[0] || {};\n\n  const tagList = tagSequence.flatMap((obj) => {\n    /* typeof obj === 'string' ? obj : */\n    return obj.tags;\n  });\n\n  const otherPos = tagList.indexOf('-other');\n  const endPos = otherPos > -1 ? otherPos : tagList.length;\n\n  let ongoingCount = 0;\n  for (const [\n    idx,\n    tag,\n  ] of\n    /**\n     * @type {(\n     *   import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n     *     originalIndex: import('../iterateJsdoc.js').Integer,\n     *     originalLine: import('../iterateJsdoc.js').Integer,\n     *   }\n     * )[]}\n     */ (jsdoc.tags).entries()) {\n    tag.originalIndex = idx;\n    ongoingCount += tag.source.length;\n    tag.originalLine = ongoingCount;\n  }\n\n  /** @type {import('../iterateJsdoc.js').Integer|undefined} */\n  let firstChangedTagLine;\n  /** @type {import('../iterateJsdoc.js').Integer|undefined} */\n  let firstChangedTagIndex;\n\n  /**\n   * @type {(import('comment-parser').Spec & {\n   *   originalIndex: import('../iterateJsdoc.js').Integer,\n   *   originalLine: import('../iterateJsdoc.js').Integer,\n   * })[]}\n   */\n  const sortedTags = JSON.parse(JSON.stringify(jsdoc.tags));\n  sortedTags.sort(({\n    tag: tagNew,\n  }, {\n    originalIndex,\n    originalLine,\n    tag: tagOld,\n  }) => {\n    // Optimize: Just keep relative positions if the same tag name\n    if (tagNew === tagOld) {\n      return 0;\n    }\n\n    const checkOrSetFirstChanged = () => {\n      if (!firstChangedTagLine || originalLine < firstChangedTagLine) {\n        firstChangedTagLine = originalLine;\n        firstChangedTagIndex = originalIndex;\n      }\n    };\n\n    const newPos = tagList.indexOf(tagNew);\n    const oldPos = tagList.indexOf(tagOld);\n\n    const preferredNewPos = newPos === -1 ? endPos : newPos;\n    const preferredOldPos = oldPos === -1 ? endPos : oldPos;\n\n    if (preferredNewPos < preferredOldPos) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    if (preferredNewPos > preferredOldPos) {\n      return 1;\n    }\n\n    // preferredNewPos === preferredOldPos\n    if (\n      !alphabetizeExtras ||\n\n      // Optimize: If tagNew (or tagOld which is the same) was found in the\n      //   priority array, it can maintain its relative position—without need\n      //   of alphabetizing (secondary sorting)\n      newPos >= 0\n    ) {\n      return 0;\n    }\n\n    if (tagNew < tagOld) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    // tagNew > tagOld\n    return 1;\n  });\n\n  if (firstChangedTagLine === undefined) {\n    // Should be ordered by now\n\n    /**\n     * @type {import('comment-parser').Spec[]}\n     */\n    const lastTagsOfGroup = [];\n\n    /**\n     * @type {[\n     *   import('comment-parser').Spec,\n     *   import('../iterateJsdoc.js').Integer\n     * ][]}\n     */\n    const badLastTagsOfGroup = [];\n\n    /**\n     * @param {import('comment-parser').Spec} tag\n     */\n    const countTagEmptyLines = (tag) => {\n      return tag.source.reduce((acc, {\n        tokens: {\n          description,\n          end,\n          name,\n          tag: tg,\n          type,\n        },\n      }) => {\n        const empty = !tg && !type && !name && !description;\n        // Reset the count so long as there is content\n        return empty ? acc + Number(empty && !end) : 0;\n      }, 0);\n    };\n\n    let idx = 0;\n    for (const {\n      tags,\n    } of tagSequence) {\n      let innerIdx;\n      /** @type {import('comment-parser').Spec} */\n      let currentTag;\n      /** @type {import('comment-parser').Spec|undefined} */\n      let lastTag;\n      do {\n        currentTag = jsdoc.tags[idx];\n        if (!currentTag) {\n          idx++;\n          break;\n        }\n\n        innerIdx = tags.indexOf(currentTag.tag);\n\n        if (\n          innerIdx === -1 &&\n          // eslint-disable-next-line no-loop-func -- Safe\n          (!tags.includes('-other') || tagSequence.some(({\n            tags: tgs,\n          }) => {\n            return tgs.includes(currentTag.tag);\n          }))\n        ) {\n          idx++;\n          break;\n        }\n\n        lastTag = currentTag;\n\n        idx++;\n      } while (true);\n\n      idx--;\n\n      if (lastTag) {\n        lastTagsOfGroup.push(lastTag);\n        const ct = countTagEmptyLines(lastTag);\n        if (\n          ct !== linesBetween &&\n          // Use another rule for adding to end (should be of interest outside this rule)\n          jsdoc.tags[idx]\n        ) {\n          badLastTagsOfGroup.push([\n            lastTag, ct,\n          ]);\n        }\n      }\n    }\n\n    if (reportTagGroupSpacing && badLastTagsOfGroup.length) {\n      /**\n       * @param {import('comment-parser').Spec} tg\n       * @returns {() => void}\n       */\n      const fixer = (tg) => {\n        return () => {\n          // Due to https://github.com/syavorsky/comment-parser/issues/110 ,\n          //  we have to modify `jsdoc.source` rather than just modify tags\n          //  directly\n          for (const [\n            currIdx,\n            {\n              tokens,\n            },\n          ] of jsdoc.source.entries()) {\n            if (tokens.tag !== '@' + tg.tag) {\n              continue;\n            }\n\n            // Cannot be `tokens.end`, as dropped off last tag, so safe to\n            //  go on\n            let newIdx = currIdx;\n\n            const emptyLine = () => {\n              return {\n                number: 0,\n                source: '',\n                tokens: utils.seedTokens({\n                  delimiter: '*',\n                  start: jsdoc.source[newIdx - 1].tokens.start,\n                }),\n              };\n            };\n\n            let existingEmptyLines = 0;\n            while (true) {\n              const nextTokens = jsdoc.source[++newIdx]?.tokens;\n\n              /* c8 ignore next 3 -- Guard */\n              if (!nextTokens) {\n                return;\n              }\n\n              // Should be no `nextTokens.end` to worry about since ignored\n              //  if not followed by tag\n\n              if (nextTokens.tag) {\n                // Haven't made it to last tag instance yet, so keep looking\n                if (nextTokens.tag === tokens.tag) {\n                  existingEmptyLines = 0;\n                  continue;\n                }\n\n                const lineDiff = linesBetween - existingEmptyLines;\n                if (lineDiff > 0) {\n                  const lines = Array.from({\n                    length: lineDiff,\n                  }, () => {\n                    return emptyLine();\n                  });\n                  jsdoc.source.splice(newIdx, 0, ...lines);\n                } else {\n                  // lineDiff < 0\n                  jsdoc.source.splice(\n                    newIdx + lineDiff,\n                    -lineDiff,\n                  );\n                }\n\n                break;\n              }\n\n              const empty = !nextTokens.type && !nextTokens.name &&\n                !nextTokens.description;\n\n              if (empty) {\n                existingEmptyLines++;\n              } else {\n                // Has content again, so reset empty line count\n                existingEmptyLines = 0;\n              }\n            }\n\n            break;\n          }\n\n          for (const [\n            srcIdx,\n            src,\n          ] of jsdoc.source.entries()) {\n            src.number = srcIdx;\n          }\n        };\n      };\n\n      for (const [\n        tg,\n      ] of badLastTagsOfGroup) {\n        utils.reportJSDoc(\n          'Tag groups do not have the expected whitespace',\n          tg,\n          fixer(tg),\n        );\n      }\n\n      return;\n    }\n\n    if (!reportIntraTagGroupSpacing) {\n      return;\n    }\n\n    for (const [\n      tagIdx,\n      tag,\n    ] of jsdoc.tags.entries()) {\n      if (!jsdoc.tags[tagIdx + 1] || lastTagsOfGroup.includes(tag)) {\n        continue;\n      }\n\n      const ct = countTagEmptyLines(tag);\n      if (ct) {\n        // eslint-disable-next-line complexity -- Temporary\n        const fixer = () => {\n          let foundFirstTag = false;\n\n          /** @type {string|undefined} */\n          let currentTag;\n\n          for (const [\n            currIdx,\n            {\n              tokens: {\n                description,\n                end,\n                name,\n                tag: tg,\n                type,\n              },\n            },\n          ] of jsdoc.source.entries()) {\n            if (tg) {\n              foundFirstTag = true;\n              currentTag = tg;\n            }\n\n            if (!foundFirstTag) {\n              continue;\n            }\n\n            if (currentTag && !tg && !type && !name && !description && !end) {\n              let nextIdx = currIdx;\n\n              let ignore = true;\n              // Even if a tag of the same name as the last tags in a group,\n              //  could still be an earlier tag in that group\n\n              // eslint-disable-next-line no-loop-func -- Safe\n              if (lastTagsOfGroup.some((lastTagOfGroup) => {\n                return currentTag === '@' + lastTagOfGroup.tag;\n              })) {\n                while (true) {\n                  const nextTokens = jsdoc.source[++nextIdx]?.tokens;\n                  if (!nextTokens) {\n                    break;\n                  }\n\n                  if (!nextTokens.tag) {\n                    continue;\n                  }\n\n                  // Followed by the same tag name, so not actually last in group,\n                  //   and of interest\n                  if (nextTokens.tag === currentTag) {\n                    ignore = false;\n                  }\n                }\n              } else {\n                while (true) {\n                  const nextTokens = jsdoc.source[++nextIdx]?.tokens;\n                  if (!nextTokens || nextTokens.end) {\n                    break;\n                  }\n\n                  // Not the very last tag, so don't ignore\n                  if (nextTokens.tag) {\n                    ignore = false;\n                    break;\n                  }\n                }\n              }\n\n              if (!ignore) {\n                jsdoc.source.splice(currIdx, 1);\n                for (const [\n                  srcIdx,\n                  src,\n                ] of jsdoc.source.entries()) {\n                  src.number = srcIdx;\n                }\n              }\n            }\n          }\n        };\n\n        utils.reportJSDoc(\n          'Intra-group tags have unexpected whitespace',\n          tag,\n          fixer,\n        );\n      }\n    }\n\n    return;\n  }\n\n  const firstLine = utils.getFirstLine();\n\n  const fix = () => {\n    const itemsToMoveRange = [\n      ...Array.from({\n        length: jsdoc.tags.length -\n        /** @type {import('../iterateJsdoc.js').Integer} */ (\n          firstChangedTagIndex\n        ),\n      }).keys(),\n    ];\n\n    const unchangedPriorTagDescriptions = jsdoc.tags.slice(\n      0,\n      firstChangedTagIndex,\n    ).reduce((ct, {\n      source,\n    }) => {\n      return ct + source.length - 1;\n    }, 0);\n\n    // This offset includes not only the offset from where the first tag\n    //   must begin, and the additional offset of where the first changed\n    //   tag begins, but it must also account for prior descriptions\n    const initialOffset = /** @type {import('../iterateJsdoc.js').Integer} */ (\n      firstLine\n    ) + /** @type {import('../iterateJsdoc.js').Integer} */ (firstChangedTagIndex) +\n\n      // May be the first tag, so don't try finding a prior one if so\n      unchangedPriorTagDescriptions;\n\n    // Use `firstChangedTagLine` for line number to begin reporting/splicing\n    for (const idx of itemsToMoveRange) {\n      utils.removeTag(\n        idx +\n        /** @type {import('../iterateJsdoc.js').Integer} */ (\n          firstChangedTagIndex\n        ),\n      );\n    }\n\n    const changedTags = sortedTags.slice(firstChangedTagIndex);\n    let extraTagCount = 0;\n\n    for (const idx of itemsToMoveRange) {\n      const changedTag = changedTags[idx];\n\n      utils.addTag(\n        changedTag.tag,\n        extraTagCount + initialOffset + idx,\n        {\n          ...changedTag.source[0].tokens,\n\n          // `comment-parser` puts the `end` within the `tags` section, so\n          //   avoid adding another to jsdoc.source\n          end: '',\n        },\n      );\n\n      for (const {\n        tokens,\n      } of changedTag.source.slice(1)) {\n        if (!tokens.end) {\n          utils.addLine(\n            extraTagCount + initialOffset + idx + 1,\n            {\n              ...tokens,\n              end: '',\n            },\n          );\n          extraTagCount++;\n        }\n      }\n    }\n  };\n\n  utils.reportJSDoc(\n    `Tags are not in the prescribed order: ${\n      tagList.join(', ') || '(alphabetical)'\n    }`,\n    jsdoc.tags[/** @type {import('../iterateJsdoc.js').Integer} */ (\n      firstChangedTagIndex\n    )],\n    fix,\n    true,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Sorts tags by a specified sequence according to tag name.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          alphabetizeExtras: {\n            type: 'boolean',\n          },\n          linesBetween: {\n            type: 'integer',\n          },\n          reportIntraTagGroupSpacing: {\n            type: 'boolean',\n          },\n          reportTagGroupSpacing: {\n            type: 'boolean',\n          },\n          tagSequence: {\n            items: {\n              additionalProperties: false,\n              properties: {\n                tags: {\n                  items: {\n                    type: 'string',\n                  },\n                  type: 'array',\n                },\n              },\n              type: 'object',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAIA,uBAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAWM,EACF,oBAAoB,OACpB,eAAe,GACf,6BAA6B,MAC7B,wBAAwB,MACxB,cAAcA,yBACf,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE9B,MAAM,UAAU,YAAY,QAAQ,CAAC,QAAQ;AAE3C,SAAO,IAAI;CACZ,EAAC;CAEF,MAAM,WAAW,QAAQ,QAAQ,SAAS;CAC1C,MAAM,SAAS,WAAW,KAAK,WAAW,QAAQ;CAElD,IAAI,eAAe;AACnB,MAAK,MAAM,CACT,KACA,IACD,IAQM,MAAM,KAAM,SAAS,EAAE;EAC5B,IAAI,gBAAgB;EACpB,gBAAgB,IAAI,OAAO;EAC3B,IAAI,eAAe;CACpB;;CAGD,IAAI;;CAEJ,IAAI;;;;;;;CAQJ,MAAM,aAAa,KAAK,MAAM,KAAK,UAAU,MAAM,KAAK,CAAC;CACzD,WAAW,KAAK,CAAC,EACf,KAAK,QACN,EAAE,EACD,eACA,cACA,KAAK,QACN,KAAK;AAEJ,MAAI,WAAW,OACb,QAAO;EAGT,MAAM,yBAAyB,MAAM;AACnC,OAAI,CAAC,uBAAuB,eAAe,qBAAqB;IAC9D,sBAAsB;IACtB,uBAAuB;GACxB;EACF;EAED,MAAM,SAAS,QAAQ,QAAQ,OAAO;EACtC,MAAM,SAAS,QAAQ,QAAQ,OAAO;EAEtC,MAAM,kBAAkB,WAAW,KAAK,SAAS;EACjD,MAAM,kBAAkB,WAAW,KAAK,SAAS;AAEjD,MAAI,kBAAkB,iBAAiB;GACrC,wBAAwB;AACxB,UAAO;EACR;AAED,MAAI,kBAAkB,gBACpB,QAAO;AAIT,MACE,CAAC,qBAKD,UAAU,EAEV,QAAO;AAGT,MAAI,SAAS,QAAQ;GACnB,wBAAwB;AACxB,UAAO;EACR;AAGD,SAAO;CACR,EAAC;AAEF,KAAI,wBAAwB,QAAW;;;;EAMrC,MAAM,kBAAkB,CAAE;;;;;;;EAQ1B,MAAM,qBAAqB,CAAE;;;;EAK7B,MAAM,qBAAqB,CAAC,QAAQ;AAClC,UAAO,IAAI,OAAO,OAAO,CAAC,KAAK,EAC7B,QAAQ,EACN,aACA,KACA,MACA,KAAK,IACL,MACD,EACF,KAAK;IACJ,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;AAExC,WAAO,QAAQ,MAAM,OAAO,SAAS,CAAC,IAAI,GAAG;GAC9C,GAAE,EAAE;EACN;EAED,IAAI,MAAM;AACV,OAAK,MAAM,EACT,MACD,IAAI,aAAa;GAChB,IAAI;;GAEJ,IAAI;;GAEJ,IAAI;AACJ,MAAG;IACD,aAAa,MAAM,KAAK;AACxB,QAAI,CAAC,YAAY;KACf;AACA;IACD;IAED,WAAW,KAAK,QAAQ,WAAW,IAAI;AAEvC,QACE,aAAa,OAEZ,CAAC,KAAK,SAAS,SAAS,IAAI,YAAY,KAAK,CAAC,EAC7C,MAAM,KACP,KAAK;AACJ,YAAO,IAAI,SAAS,WAAW,IAAI;IACpC,EAAC,GACF;KACA;AACA;IACD;IAED,UAAU;IAEV;GACD,SAAQ;GAET;AAEA,OAAI,SAAS;IACX,gBAAgB,KAAK,QAAQ;IAC7B,MAAM,KAAK,mBAAmB,QAAQ;AACtC,QACE,OAAO,gBAEP,MAAM,KAAK,MAEX,mBAAmB,KAAK,CACtB,SAAS,EACV,EAAC;GAEL;EACF;AAED,MAAI,yBAAyB,mBAAmB,QAAQ;;;;;GAKtD,MAAM,QAAQ,CAAC,OAAO;AACpB,WAAO,MAAM;AAIX,UAAK,MAAM,CACT,SACA,EACE,QACD,CACF,IAAI,MAAM,OAAO,SAAS,EAAE;AAC3B,UAAI,OAAO,QAAQ,MAAM,GAAG,IAC1B;MAKF,IAAI,SAAS;MAEb,MAAM,YAAY,MAAM;AACtB,cAAO;QACL,QAAQ;QACR,QAAQ;QACR,QAAQ,MAAM,WAAW;SACvB,WAAW;SACX,OAAO,MAAM,OAAO,SAAS,GAAG,OAAO;QACxC,EAAC;OACH;MACF;MAED,IAAI,qBAAqB;AACzB,aAAO,MAAM;OACX,MAAM,aAAa,MAAM,OAAO,EAAE,SAAS;;AAG3C,WAAI,CAAC,WACH;AAMF,WAAI,WAAW,KAAK;AAElB,YAAI,WAAW,QAAQ,OAAO,KAAK;SACjC,qBAAqB;AACrB;QACD;QAED,MAAM,WAAW,eAAe;AAChC,YAAI,WAAW,GAAG;SAChB,MAAM,QAAQ,MAAM,KAAK,EACvB,QAAQ,SACT,GAAE,MAAM;AACP,iBAAO,WAAW;SACnB,EAAC;SACF,MAAM,OAAO,OAAO,QAAQ,GAAG,GAAG,MAAM;QACzC,OAEC,MAAM,OAAO,OACX,SAAS,UACT,CAAC,SACF;AAGH;OACD;OAED,MAAM,QAAQ,CAAC,WAAW,QAAQ,CAAC,WAAW,QAC5C,CAAC,WAAW;AAEd,WAAI,OACF;YAGA,qBAAqB;MAExB;AAED;KACD;AAED,UAAK,MAAM,CACT,QACA,IACD,IAAI,MAAM,OAAO,SAAS,EACzB,IAAI,SAAS;IAEhB;GACF;AAED,QAAK,MAAM,CACT,GACD,IAAI,oBACH,MAAM,YACJ,kDACA,IACA,MAAM,GAAG,CACV;AAGH;EACD;AAED,MAAI,CAAC,2BACH;AAGF,OAAK,MAAM,CACT,QACA,IACD,IAAI,MAAM,KAAK,SAAS,EAAE;AACzB,OAAI,CAAC,MAAM,KAAK,SAAS,MAAM,gBAAgB,SAAS,IAAI,CAC1D;GAGF,MAAM,KAAK,mBAAmB,IAAI;AAClC,OAAI,IAAI;IAEN,MAAM,QAAQ,MAAM;KAClB,IAAI,gBAAgB;;KAGpB,IAAI;AAEJ,UAAK,MAAM,CACT,SACA,EACE,QAAQ,EACN,aACA,KACA,MACA,KAAK,IACL,MACD,EACF,CACF,IAAI,MAAM,OAAO,SAAS,EAAE;AAC3B,UAAI,IAAI;OACN,gBAAgB;OAChB,aAAa;MACd;AAED,UAAI,CAAC,cACH;AAGF,UAAI,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,KAAK;OAC/D,IAAI,UAAU;OAEd,IAAI,SAAS;AAKb,WAAI,gBAAgB,KAAK,CAAC,mBAAmB;AAC3C,eAAO,eAAe,MAAM,eAAe;OAC5C,EAAC,CACA,QAAO,MAAM;QACX,MAAM,aAAa,MAAM,OAAO,EAAE,UAAU;AAC5C,YAAI,CAAC,WACH;AAGF,YAAI,CAAC,WAAW,IACd;AAKF,YAAI,WAAW,QAAQ,YACrB,SAAS;OAEZ;WAED,QAAO,MAAM;QACX,MAAM,aAAa,MAAM,OAAO,EAAE,UAAU;AAC5C,YAAI,CAAC,cAAc,WAAW,IAC5B;AAIF,YAAI,WAAW,KAAK;SAClB,SAAS;AACT;QACD;OACF;AAGH,WAAI,CAAC,QAAQ;QACX,MAAM,OAAO,OAAO,SAAS,EAAE;AAC/B,aAAK,MAAM,CACT,QACA,IACD,IAAI,MAAM,OAAO,SAAS,EACzB,IAAI,SAAS;OAEhB;MACF;KACF;IACF;IAED,MAAM,YACJ,+CACA,KACA,MACD;GACF;EACF;AAED;CACD;CAED,MAAM,YAAY,MAAM,cAAc;CAEtC,MAAM,MAAM,MAAM;EAChB,MAAM,mBAAmB,CACvB,GAAG,MAAM,KAAK,EACZ,QAAQ,MAAM,KAAK,SAEjB,qBAEH,EAAC,CAAC,MAAM,AACV;EAED,MAAM,gCAAgC,MAAM,KAAK,MAC/C,GACA,qBACD,CAAC,OAAO,CAAC,IAAI,EACZ,QACD,KAAK;AACJ,UAAO,KAAK,OAAO,SAAS;EAC7B,GAAE,EAAE;EAKL,MAAM,gBACJ,YACuD,uBAGvD;AAGF,OAAK,MAAM,OAAO,kBAChB,MAAM,UACJ,MAEE,qBAEH;EAGH,MAAM,cAAc,WAAW,MAAM,qBAAqB;EAC1D,IAAI,gBAAgB;AAEpB,OAAK,MAAM,OAAO,kBAAkB;GAClC,MAAM,aAAa,YAAY;GAE/B,MAAM,OACJ,WAAW,KACX,gBAAgB,gBAAgB,KAChC;IACE,GAAG,WAAW,OAAO,GAAG;IAIxB,KAAK;GACN,EACF;AAED,QAAK,MAAM,EACT,QACD,IAAI,WAAW,OAAO,MAAM,EAAE,CAC7B,KAAI,CAAC,OAAO,KAAK;IACf,MAAM,QACJ,gBAAgB,gBAAgB,MAAM,GACtC;KACE,GAAG;KACH,KAAK;IACN,EACF;IACD;GACD;EAEJ;CACF;CAED,MAAM,YACJ,CAAC,sCAAsC,EACrC,QAAQ,KAAK,KAAK,IAAI,kBACtB,EACF,MAAM,KACJ,uBAEF,KACA,KACD;AACF,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,cAAc,EACZ,MAAM,UACP;IACD,4BAA4B,EAC1B,MAAM,UACP;IACD,uBAAuB,EACrB,MAAM,UACP;IACD,aAAa;KACX,OAAO;MACL,sBAAsB;MACtB,YAAY,EACV,MAAM;OACJ,OAAO,EACL,MAAM,SACP;OACD,MAAM;MACP,EACF;MACD,MAAM;KACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}