eslint-plugin-jsdoc 52.0.4 → 53.0.1

package/dist/rules/requireFileOverview.cjs

@@ -1,135 +1,81 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const defaultTags = {
-  file: {
-    initialCommentsOnly: true,
-    mustExist: true,
-    preventDuplicates: true
-  }
-};
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
+//#region src/rules/requireFileOverview.js
+const defaultTags = { file: {
+	initialCommentsOnly: true,
+	mustExist: true,
+	preventDuplicates: true
+} };
 /**
- * @param {import('../iterateJsdoc.js').StateObject} state
- * @returns {void}
- */
-const setDefaults = state => {
-  // First iteration
-  if (!state.globalTags) {
-    state.globalTags = {};
-    state.hasDuplicates = {};
-    state.hasTag = {};
-    state.hasNonCommentBeforeTag = {};
-  }
+* @param {import('../iterateJsdoc.js').StateObject} state
+* @returns {void}
+*/
+const setDefaults = (state) => {
+	if (!state.globalTags) {
+		state.globalTags = {};
+		state.hasDuplicates = {};
+		state.hasTag = {};
+		state.hasNonCommentBeforeTag = {};
+	}
 };
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdocNode,
-  state,
-  utils
-}) => {
-  const {
-    tags = defaultTags
-  } = context.options[0] || {};
-  setDefaults(state);
-  for (const tagName of Object.keys(tags)) {
-    const targetTagName = /** @type {string} */utils.getPreferredTagName({
-      tagName
-    });
-    const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));
-    state.hasTag[tagName] = hasTag || state.hasTag[tagName];
-    const hasDuplicate = state.hasDuplicates[tagName];
-    if (hasDuplicate === false) {
-      // Was marked before, so if a tag now, is a dupe
-      state.hasDuplicates[tagName] = hasTag;
-    } else if (!hasDuplicate && hasTag) {
-      // No dupes set before, but has first tag, so change state
-      //   from `undefined` to `false` so can detect next time
-      state.hasDuplicates[tagName] = false;
-      state.hasNonCommentBeforeTag[tagName] = state.hasNonComment && state.hasNonComment < jsdocNode.range[0];
-    }
-  }
+var requireFileOverview_default = require_iterateJsdoc.default(({ context, jsdocNode, state, utils }) => {
+	const { tags = defaultTags } = context.options[0] || {};
+	setDefaults(state);
+	for (const tagName of Object.keys(tags)) {
+		const targetTagName = utils.getPreferredTagName({ tagName });
+		const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));
+		state.hasTag[tagName] = hasTag || state.hasTag[tagName];
+		const hasDuplicate = state.hasDuplicates[tagName];
+		if (hasDuplicate === false) state.hasDuplicates[tagName] = hasTag;
+		else if (!hasDuplicate && hasTag) {
+			state.hasDuplicates[tagName] = false;
+			state.hasNonCommentBeforeTag[tagName] = state.hasNonComment && state.hasNonComment < jsdocNode.range[0];
+		}
+	}
 }, {
-  exit({
-    context,
-    state,
-    utils
-  }) {
-    setDefaults(state);
-    const {
-      tags = defaultTags
-    } = context.options[0] || {};
-    for (const [tagName, {
-      initialCommentsOnly = false,
-      mustExist = false,
-      preventDuplicates = false
-    }] of Object.entries(tags)) {
-      const obj = utils.getPreferredTagNameObject({
-        tagName
-      });
-      if (obj && typeof obj === 'object' && 'blocked' in obj) {
-        utils.reportSettings(`\`settings.jsdoc.tagNamePreference\` cannot block @${obj.tagName} ` + 'for the `require-file-overview` rule');
-      } else {
-        const targetTagName = obj && typeof obj === 'object' && obj.replacement || obj;
-        if (mustExist && !state.hasTag[tagName]) {
-          utils.reportSettings(`Missing @${targetTagName}`);
-        }
-        if (preventDuplicates && state.hasDuplicates[tagName]) {
-          utils.reportSettings(`Duplicate @${targetTagName}`);
-        }
-        if (initialCommentsOnly && state.hasNonCommentBeforeTag[tagName]) {
-          utils.reportSettings(`@${targetTagName} should be at the beginning of the file`);
-        }
-      }
-    }
-  },
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        tags: {
-          patternProperties: {
-            '.*': {
-              additionalProperties: false,
-              properties: {
-                initialCommentsOnly: {
-                  type: 'boolean'
-                },
-                mustExist: {
-                  type: 'boolean'
-                },
-                preventDuplicates: {
-                  type: 'boolean'
-                }
-              },
-              type: 'object'
-            }
-          },
-          type: 'object'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  },
-  nonComment({
-    node,
-    state
-  }) {
-    if (!state.hasNonComment) {
-      state.hasNonComment = node.range[0];
-    }
-  }
+	exit({ context, state, utils }) {
+		setDefaults(state);
+		const { tags = defaultTags } = context.options[0] || {};
+		for (const [tagName, { initialCommentsOnly = false, mustExist = false, preventDuplicates = false }] of Object.entries(tags)) {
+			const obj = utils.getPreferredTagNameObject({ tagName });
+			if (obj && typeof obj === "object" && "blocked" in obj) utils.reportSettings(`\`settings.jsdoc.tagNamePreference\` cannot block @${obj.tagName} for the \`require-file-overview\` rule`);
+			else {
+				const targetTagName = obj && typeof obj === "object" && obj.replacement || obj;
+				if (mustExist && !state.hasTag[tagName]) utils.reportSettings(`Missing @${targetTagName}`);
+				if (preventDuplicates && state.hasDuplicates[tagName]) utils.reportSettings(`Duplicate @${targetTagName}`);
+				if (initialCommentsOnly && state.hasNonCommentBeforeTag[tagName]) utils.reportSettings(`@${targetTagName} should be at the beginning of the file`);
+			}
+		}
+	},
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: { tags: {
+				patternProperties: { ".*": {
+					additionalProperties: false,
+					properties: {
+						initialCommentsOnly: { type: "boolean" },
+						mustExist: { type: "boolean" },
+						preventDuplicates: { type: "boolean" }
+					},
+					type: "object"
+				} },
+				type: "object"
+			} },
+			type: "object"
+		}],
+		type: "suggestion"
+	},
+	nonComment({ node, state }) {
+		if (!state.hasNonComment) state.hasNonComment = node.range[0];
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireFileOverview_default;
 //# sourceMappingURL=requireFileOverview.cjs.map

package/dist/rules/requireFileOverview.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireFileOverview.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","defaultTags","file","initialCommentsOnly","mustExist","preventDuplicates","setDefaults","state","globalTags","hasDuplicates","hasTag","hasNonCommentBeforeTag","_default","exports","iterateJsdoc","context","jsdocNode","utils","tags","options","tagName","Object","keys","targetTagName","getPreferredTagName","Boolean","hasDuplicate","hasNonComment","range","exit","entries","obj","getPreferredTagNameObject","reportSettings","replacement","iterateAllJsdocs","meta","docs","description","url","schema","additionalProperties","properties","patternProperties","type","nonComment","node","module"],"sources":["../../src/rules/requireFileOverview.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultTags = {\n  file: {\n    initialCommentsOnly: true,\n    mustExist: true,\n    preventDuplicates: true,\n  },\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n  // First iteration\n  if (!state.globalTags) {\n    state.globalTags = {};\n    state.hasDuplicates = {};\n    state.hasTag = {};\n    state.hasNonCommentBeforeTag = {};\n  }\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  state,\n  utils,\n}) => {\n  const {\n    tags = defaultTags,\n  } = context.options[0] || {};\n\n  setDefaults(state);\n\n  for (const tagName of Object.keys(tags)) {\n    const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName,\n    }));\n\n    const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));\n\n    state.hasTag[tagName] = hasTag || state.hasTag[tagName];\n\n    const hasDuplicate = state.hasDuplicates[tagName];\n\n    if (hasDuplicate === false) {\n      // Was marked before, so if a tag now, is a dupe\n      state.hasDuplicates[tagName] = hasTag;\n    } else if (!hasDuplicate && hasTag) {\n      // No dupes set before, but has first tag, so change state\n      //   from `undefined` to `false` so can detect next time\n      state.hasDuplicates[tagName] = false;\n      state.hasNonCommentBeforeTag[tagName] = state.hasNonComment &&\n        state.hasNonComment < jsdocNode.range[0];\n    }\n  }\n}, {\n  exit ({\n    context,\n    state,\n    utils,\n  }) {\n    setDefaults(state);\n    const {\n      tags = defaultTags,\n    } = context.options[0] || {};\n\n    for (const [\n      tagName,\n      {\n        initialCommentsOnly = false,\n        mustExist = false,\n        preventDuplicates = false,\n      },\n    ] of Object.entries(tags)) {\n      const obj = utils.getPreferredTagNameObject({\n        tagName,\n      });\n      if (obj && typeof obj === 'object' && 'blocked' in obj) {\n        utils.reportSettings(\n          `\\`settings.jsdoc.tagNamePreference\\` cannot block @${obj.tagName} ` +\n          'for the `require-file-overview` rule',\n        );\n      } else {\n        const targetTagName = (\n          obj && typeof obj === 'object' && obj.replacement\n        ) || obj;\n        if (mustExist && !state.hasTag[tagName]) {\n          utils.reportSettings(`Missing @${targetTagName}`);\n        }\n\n        if (preventDuplicates && state.hasDuplicates[tagName]) {\n          utils.reportSettings(\n            `Duplicate @${targetTagName}`,\n          );\n        }\n\n        if (initialCommentsOnly &&\n            state.hasNonCommentBeforeTag[tagName]\n        ) {\n          utils.reportSettings(\n            `@${targetTagName} should be at the beginning of the file`,\n          );\n        }\n      }\n    }\n  },\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            patternProperties: {\n              '.*': {\n                additionalProperties: false,\n                properties: {\n                  initialCommentsOnly: {\n                    type: 'boolean',\n                  },\n                  mustExist: {\n                    type: 'boolean',\n                  },\n                  preventDuplicates: {\n                    type: 'boolean',\n                  },\n                },\n                type: 'object',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n  nonComment ({\n    node,\n    state,\n  }) {\n    if (!state.hasNonComment) {\n      state.hasNonComment = node.range[0];\n    }\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C,MAAMG,WAAW,GAAG;EAClBC,IAAI,EAAE;IACJC,mBAAmB,EAAE,IAAI;IACzBC,SAAS,EAAE,IAAI;IACfC,iBAAiB,EAAE;EACrB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAIC,KAAK,IAAK;EAC7B;EACA,IAAI,CAACA,KAAK,CAACC,UAAU,EAAE;IACrBD,KAAK,CAACC,UAAU,GAAG,CAAC,CAAC;IACrBD,KAAK,CAACE,aAAa,GAAG,CAAC,CAAC;IACxBF,KAAK,CAACG,MAAM,GAAG,CAAC,CAAC;IACjBH,KAAK,CAACI,sBAAsB,GAAG,CAAC,CAAC;EACnC;AACF,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAb,OAAA,GAEa,IAAAc,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,SAAS;EACTT,KAAK;EACLU;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,IAAI,GAAGjB;EACT,CAAC,GAAGc,OAAO,CAACI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5Bb,WAAW,CAACC,KAAK,CAAC;EAElB,KAAK,MAAMa,OAAO,IAAIC,MAAM,CAACC,IAAI,CAACJ,IAAI,CAAC,EAAE;IACvC,MAAMK,aAAa,GAAG,qBAAuBN,KAAK,CAACO,mBAAmB,CAAC;MACrEJ;IACF,CAAC,CAAE;IAEH,MAAMV,MAAM,GAAGe,OAAO,CAACF,aAAa,IAAIN,KAAK,CAACP,MAAM,CAACa,aAAa,CAAC,CAAC;IAEpEhB,KAAK,CAACG,MAAM,CAACU,OAAO,CAAC,GAAGV,MAAM,IAAIH,KAAK,CAACG,MAAM,CAACU,OAAO,CAAC;IAEvD,MAAMM,YAAY,GAAGnB,KAAK,CAACE,aAAa,CAACW,OAAO,CAAC;IAEjD,IAAIM,YAAY,KAAK,KAAK,EAAE;MAC1B;MACAnB,KAAK,CAACE,aAAa,CAACW,OAAO,CAAC,GAAGV,MAAM;IACvC,CAAC,MAAM,IAAI,CAACgB,YAAY,IAAIhB,MAAM,EAAE;MAClC;MACA;MACAH,KAAK,CAACE,aAAa,CAACW,OAAO,CAAC,GAAG,KAAK;MACpCb,KAAK,CAACI,sBAAsB,CAACS,OAAO,CAAC,GAAGb,KAAK,CAACoB,aAAa,IACzDpB,KAAK,CAACoB,aAAa,GAAGX,SAAS,CAACY,KAAK,CAAC,CAAC,CAAC;IAC5C;EACF;AACF,CAAC,EAAE;EACDC,IAAIA,CAAE;IACJd,OAAO;IACPR,KAAK;IACLU;EACF,CAAC,EAAE;IACDX,WAAW,CAACC,KAAK,CAAC;IAClB,MAAM;MACJW,IAAI,GAAGjB;IACT,CAAC,GAAGc,OAAO,CAACI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAE5B,KAAK,MAAM,CACTC,OAAO,EACP;MACEjB,mBAAmB,GAAG,KAAK;MAC3BC,SAAS,GAAG,KAAK;MACjBC,iBAAiB,GAAG;IACtB,CAAC,CACF,IAAIgB,MAAM,CAACS,OAAO,CAACZ,IAAI,CAAC,EAAE;MACzB,MAAMa,GAAG,GAAGd,KAAK,CAACe,yBAAyB,CAAC;QAC1CZ;MACF,CAAC,CAAC;MACF,IAAIW,GAAG,IAAI,OAAOA,GAAG,KAAK,QAAQ,IAAI,SAAS,IAAIA,GAAG,EAAE;QACtDd,KAAK,CAACgB,cAAc,CAClB,sDAAsDF,GAAG,CAACX,OAAO,GAAG,GACpE,sCACF,CAAC;MACH,CAAC,MAAM;QACL,MAAMG,aAAa,GACjBQ,GAAG,IAAI,OAAOA,GAAG,KAAK,QAAQ,IAAIA,GAAG,CAACG,WAAW,IAC9CH,GAAG;QACR,IAAI3B,SAAS,IAAI,CAACG,KAAK,CAACG,MAAM,CAACU,OAAO,CAAC,EAAE;UACvCH,KAAK,CAACgB,cAAc,CAAC,YAAYV,aAAa,EAAE,CAAC;QACnD;QAEA,IAAIlB,iBAAiB,IAAIE,KAAK,CAACE,aAAa,CAACW,OAAO,CAAC,EAAE;UACrDH,KAAK,CAACgB,cAAc,CAClB,cAAcV,aAAa,EAC7B,CAAC;QACH;QAEA,IAAIpB,mBAAmB,IACnBI,KAAK,CAACI,sBAAsB,CAACS,OAAO,CAAC,EACvC;UACAH,KAAK,CAACgB,cAAc,CAClB,IAAIV,aAAa,yCACnB,CAAC;QACH;MACF;IACF;EACF,CAAC;EACDY,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,2GAA2G;MACxHC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVxB,IAAI,EAAE;UACJyB,iBAAiB,EAAE;YACjB,IAAI,EAAE;cACJF,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVvC,mBAAmB,EAAE;kBACnByC,IAAI,EAAE;gBACR,CAAC;gBACDxC,SAAS,EAAE;kBACTwC,IAAI,EAAE;gBACR,CAAC;gBACDvC,iBAAiB,EAAE;kBACjBuC,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR,CAAC;EACDC,UAAUA,CAAE;IACVC,IAAI;IACJvC;EACF,CAAC,EAAE;IACD,IAAI,CAACA,KAAK,CAACoB,aAAa,EAAE;MACxBpB,KAAK,CAACoB,aAAa,GAAGmB,IAAI,CAAClB,KAAK,CAAC,CAAC,CAAC;IACrC;EACF;AACF,CAAC,CAAC;AAAAmB,MAAA,CAAAlC,OAAA,GAAAA,OAAA,CAAAb,OAAA","ignoreList":[]}
+{"version":3,"file":"requireFileOverview.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireFileOverview.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultTags = {\n  file: {\n    initialCommentsOnly: true,\n    mustExist: true,\n    preventDuplicates: true,\n  },\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n  // First iteration\n  if (!state.globalTags) {\n    state.globalTags = {};\n    state.hasDuplicates = {};\n    state.hasTag = {};\n    state.hasNonCommentBeforeTag = {};\n  }\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  state,\n  utils,\n}) => {\n  const {\n    tags = defaultTags,\n  } = context.options[0] || {};\n\n  setDefaults(state);\n\n  for (const tagName of Object.keys(tags)) {\n    const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName,\n    }));\n\n    const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));\n\n    state.hasTag[tagName] = hasTag || state.hasTag[tagName];\n\n    const hasDuplicate = state.hasDuplicates[tagName];\n\n    if (hasDuplicate === false) {\n      // Was marked before, so if a tag now, is a dupe\n      state.hasDuplicates[tagName] = hasTag;\n    } else if (!hasDuplicate && hasTag) {\n      // No dupes set before, but has first tag, so change state\n      //   from `undefined` to `false` so can detect next time\n      state.hasDuplicates[tagName] = false;\n      state.hasNonCommentBeforeTag[tagName] = state.hasNonComment &&\n        state.hasNonComment < jsdocNode.range[0];\n    }\n  }\n}, {\n  exit ({\n    context,\n    state,\n    utils,\n  }) {\n    setDefaults(state);\n    const {\n      tags = defaultTags,\n    } = context.options[0] || {};\n\n    for (const [\n      tagName,\n      {\n        initialCommentsOnly = false,\n        mustExist = false,\n        preventDuplicates = false,\n      },\n    ] of Object.entries(tags)) {\n      const obj = utils.getPreferredTagNameObject({\n        tagName,\n      });\n      if (obj && typeof obj === 'object' && 'blocked' in obj) {\n        utils.reportSettings(\n          `\\`settings.jsdoc.tagNamePreference\\` cannot block @${obj.tagName} ` +\n          'for the `require-file-overview` rule',\n        );\n      } else {\n        const targetTagName = (\n          obj && typeof obj === 'object' && obj.replacement\n        ) || obj;\n        if (mustExist && !state.hasTag[tagName]) {\n          utils.reportSettings(`Missing @${targetTagName}`);\n        }\n\n        if (preventDuplicates && state.hasDuplicates[tagName]) {\n          utils.reportSettings(\n            `Duplicate @${targetTagName}`,\n          );\n        }\n\n        if (initialCommentsOnly &&\n            state.hasNonCommentBeforeTag[tagName]\n        ) {\n          utils.reportSettings(\n            `@${targetTagName} should be at the beginning of the file`,\n          );\n        }\n      }\n    }\n  },\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            patternProperties: {\n              '.*': {\n                additionalProperties: false,\n                properties: {\n                  initialCommentsOnly: {\n                    type: 'boolean',\n                  },\n                  mustExist: {\n                    type: 'boolean',\n                  },\n                  preventDuplicates: {\n                    type: 'boolean',\n                  },\n                },\n                type: 'object',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n  nonComment ({\n    node,\n    state,\n  }) {\n    if (!state.hasNonComment) {\n      state.hasNonComment = node.range[0];\n    }\n  },\n});\n"],"mappings":";;;AAEA,MAAM,cAAc,EAClB,MAAM;CACJ,qBAAqB;CACrB,WAAW;CACX,mBAAmB;AACpB,EACF;;;;;AAMD,MAAM,cAAc,CAAC,UAAU;AAE7B,KAAI,CAAC,MAAM,YAAY;EACrB,MAAM,aAAa,CAAE;EACrB,MAAM,gBAAgB,CAAE;EACxB,MAAM,SAAS,CAAE;EACjB,MAAM,yBAAyB,CAAE;CAClC;AACF;AAED,kCAAeA,6BAAa,CAAC,EAC3B,SACA,WACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,OAAO,aACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,YAAY,MAAM;AAElB,MAAK,MAAM,WAAW,OAAO,KAAK,KAAK,EAAE;EACvC,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,QACD,EAAC;EAEF,MAAM,SAAS,QAAQ,iBAAiB,MAAM,OAAO,cAAc,CAAC;EAEpE,MAAM,OAAO,WAAW,UAAU,MAAM,OAAO;EAE/C,MAAM,eAAe,MAAM,cAAc;AAEzC,MAAI,iBAAiB,OAEnB,MAAM,cAAc,WAAW;WACtB,CAAC,gBAAgB,QAAQ;GAGlC,MAAM,cAAc,WAAW;GAC/B,MAAM,uBAAuB,WAAW,MAAM,iBAC5C,MAAM,gBAAgB,UAAU,MAAM;EACzC;CACF;AACF,GAAE;CACD,KAAM,EACJ,SACA,OACA,OACD,EAAE;EACD,YAAY,MAAM;EAClB,MAAM,EACJ,OAAO,aACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,OAAK,MAAM,CACT,SACA,EACE,sBAAsB,OACtB,YAAY,OACZ,oBAAoB,OACrB,CACF,IAAI,OAAO,QAAQ,KAAK,EAAE;GACzB,MAAM,MAAM,MAAM,0BAA0B,EAC1C,QACD,EAAC;AACF,OAAI,OAAO,OAAO,QAAQ,YAAY,aAAa,KACjD,MAAM,eACJ,CAAC,mDAAmD,EAAE,IAAI,QAAQ,uCAAC,CAC7B,CACvC;QACI;IACL,MAAM,gBACJ,OAAO,OAAO,QAAQ,YAAY,IAAI,eACnC;AACL,QAAI,aAAa,CAAC,MAAM,OAAO,UAC7B,MAAM,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC;AAGnD,QAAI,qBAAqB,MAAM,cAAc,UAC3C,MAAM,eACJ,CAAC,WAAW,EAAE,eAAe,CAC9B;AAGH,QAAI,uBACA,MAAM,uBAAuB,UAE/B,MAAM,eACJ,CAAC,CAAC,EAAE,cAAc,uCAAuC,CAAC,CAC3D;GAEJ;EACF;CACF;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,mBAAmB,EACjB,MAAM;KACJ,sBAAsB;KACtB,YAAY;MACV,qBAAqB,EACnB,MAAM,UACP;MACD,WAAW,EACT,MAAM,UACP;MACD,mBAAmB,EACjB,MAAM,UACP;KACF;KACD,MAAM;IACP,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;CACD,WAAY,EACV,MACA,OACD,EAAE;AACD,MAAI,CAAC,MAAM,eACT,MAAM,gBAAgB,KAAK,MAAM;CAEpC;AACF,EAAC"}

package/dist/rules/requireFileOverview.js

@@ -0,0 +1,81 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/requireFileOverview.js
+const defaultTags = { file: {
+	initialCommentsOnly: true,
+	mustExist: true,
+	preventDuplicates: true
+} };
+/**
+* @param {import('../iterateJsdoc.js').StateObject} state
+* @returns {void}
+*/
+const setDefaults = (state) => {
+	if (!state.globalTags) {
+		state.globalTags = {};
+		state.hasDuplicates = {};
+		state.hasTag = {};
+		state.hasNonCommentBeforeTag = {};
+	}
+};
+var requireFileOverview_default = iterateJsdoc(({ context, jsdocNode, state, utils }) => {
+	const { tags = defaultTags } = context.options[0] || {};
+	setDefaults(state);
+	for (const tagName of Object.keys(tags)) {
+		const targetTagName = utils.getPreferredTagName({ tagName });
+		const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));
+		state.hasTag[tagName] = hasTag || state.hasTag[tagName];
+		const hasDuplicate = state.hasDuplicates[tagName];
+		if (hasDuplicate === false) state.hasDuplicates[tagName] = hasTag;
+		else if (!hasDuplicate && hasTag) {
+			state.hasDuplicates[tagName] = false;
+			state.hasNonCommentBeforeTag[tagName] = state.hasNonComment && state.hasNonComment < jsdocNode.range[0];
+		}
+	}
+}, {
+	exit({ context, state, utils }) {
+		setDefaults(state);
+		const { tags = defaultTags } = context.options[0] || {};
+		for (const [tagName, { initialCommentsOnly = false, mustExist = false, preventDuplicates = false }] of Object.entries(tags)) {
+			const obj = utils.getPreferredTagNameObject({ tagName });
+			if (obj && typeof obj === "object" && "blocked" in obj) utils.reportSettings(`\`settings.jsdoc.tagNamePreference\` cannot block @${obj.tagName} for the \`require-file-overview\` rule`);
+			else {
+				const targetTagName = obj && typeof obj === "object" && obj.replacement || obj;
+				if (mustExist && !state.hasTag[tagName]) utils.reportSettings(`Missing @${targetTagName}`);
+				if (preventDuplicates && state.hasDuplicates[tagName]) utils.reportSettings(`Duplicate @${targetTagName}`);
+				if (initialCommentsOnly && state.hasNonCommentBeforeTag[tagName]) utils.reportSettings(`@${targetTagName} should be at the beginning of the file`);
+			}
+		}
+	},
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: { tags: {
+				patternProperties: { ".*": {
+					additionalProperties: false,
+					properties: {
+						initialCommentsOnly: { type: "boolean" },
+						mustExist: { type: "boolean" },
+						preventDuplicates: { type: "boolean" }
+					},
+					type: "object"
+				} },
+				type: "object"
+			} },
+			type: "object"
+		}],
+		type: "suggestion"
+	},
+	nonComment({ node, state }) {
+		if (!state.hasNonComment) state.hasNonComment = node.range[0];
+	}
+});
+
+//#endregion
+export { requireFileOverview_default as default };
+//# sourceMappingURL=requireFileOverview.js.map

package/dist/rules/requireFileOverview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requireFileOverview.js","names":[],"sources":["../../src/rules/requireFileOverview.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultTags = {\n  file: {\n    initialCommentsOnly: true,\n    mustExist: true,\n    preventDuplicates: true,\n  },\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n  // First iteration\n  if (!state.globalTags) {\n    state.globalTags = {};\n    state.hasDuplicates = {};\n    state.hasTag = {};\n    state.hasNonCommentBeforeTag = {};\n  }\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  state,\n  utils,\n}) => {\n  const {\n    tags = defaultTags,\n  } = context.options[0] || {};\n\n  setDefaults(state);\n\n  for (const tagName of Object.keys(tags)) {\n    const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName,\n    }));\n\n    const hasTag = Boolean(targetTagName && utils.hasTag(targetTagName));\n\n    state.hasTag[tagName] = hasTag || state.hasTag[tagName];\n\n    const hasDuplicate = state.hasDuplicates[tagName];\n\n    if (hasDuplicate === false) {\n      // Was marked before, so if a tag now, is a dupe\n      state.hasDuplicates[tagName] = hasTag;\n    } else if (!hasDuplicate && hasTag) {\n      // No dupes set before, but has first tag, so change state\n      //   from `undefined` to `false` so can detect next time\n      state.hasDuplicates[tagName] = false;\n      state.hasNonCommentBeforeTag[tagName] = state.hasNonComment &&\n        state.hasNonComment < jsdocNode.range[0];\n    }\n  }\n}, {\n  exit ({\n    context,\n    state,\n    utils,\n  }) {\n    setDefaults(state);\n    const {\n      tags = defaultTags,\n    } = context.options[0] || {};\n\n    for (const [\n      tagName,\n      {\n        initialCommentsOnly = false,\n        mustExist = false,\n        preventDuplicates = false,\n      },\n    ] of Object.entries(tags)) {\n      const obj = utils.getPreferredTagNameObject({\n        tagName,\n      });\n      if (obj && typeof obj === 'object' && 'blocked' in obj) {\n        utils.reportSettings(\n          `\\`settings.jsdoc.tagNamePreference\\` cannot block @${obj.tagName} ` +\n          'for the `require-file-overview` rule',\n        );\n      } else {\n        const targetTagName = (\n          obj && typeof obj === 'object' && obj.replacement\n        ) || obj;\n        if (mustExist && !state.hasTag[tagName]) {\n          utils.reportSettings(`Missing @${targetTagName}`);\n        }\n\n        if (preventDuplicates && state.hasDuplicates[tagName]) {\n          utils.reportSettings(\n            `Duplicate @${targetTagName}`,\n          );\n        }\n\n        if (initialCommentsOnly &&\n            state.hasNonCommentBeforeTag[tagName]\n        ) {\n          utils.reportSettings(\n            `@${targetTagName} should be at the beginning of the file`,\n          );\n        }\n      }\n    }\n  },\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            patternProperties: {\n              '.*': {\n                additionalProperties: false,\n                properties: {\n                  initialCommentsOnly: {\n                    type: 'boolean',\n                  },\n                  mustExist: {\n                    type: 'boolean',\n                  },\n                  preventDuplicates: {\n                    type: 'boolean',\n                  },\n                },\n                type: 'object',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n  nonComment ({\n    node,\n    state,\n  }) {\n    if (!state.hasNonComment) {\n      state.hasNonComment = node.range[0];\n    }\n  },\n});\n"],"mappings":";;;AAEA,MAAM,cAAc,EAClB,MAAM;CACJ,qBAAqB;CACrB,WAAW;CACX,mBAAmB;AACpB,EACF;;;;;AAMD,MAAM,cAAc,CAAC,UAAU;AAE7B,KAAI,CAAC,MAAM,YAAY;EACrB,MAAM,aAAa,CAAE;EACrB,MAAM,gBAAgB,CAAE;EACxB,MAAM,SAAS,CAAE;EACjB,MAAM,yBAAyB,CAAE;CAClC;AACF;AAED,kCAAe,aAAa,CAAC,EAC3B,SACA,WACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,OAAO,aACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,YAAY,MAAM;AAElB,MAAK,MAAM,WAAW,OAAO,KAAK,KAAK,EAAE;EACvC,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,QACD,EAAC;EAEF,MAAM,SAAS,QAAQ,iBAAiB,MAAM,OAAO,cAAc,CAAC;EAEpE,MAAM,OAAO,WAAW,UAAU,MAAM,OAAO;EAE/C,MAAM,eAAe,MAAM,cAAc;AAEzC,MAAI,iBAAiB,OAEnB,MAAM,cAAc,WAAW;WACtB,CAAC,gBAAgB,QAAQ;GAGlC,MAAM,cAAc,WAAW;GAC/B,MAAM,uBAAuB,WAAW,MAAM,iBAC5C,MAAM,gBAAgB,UAAU,MAAM;EACzC;CACF;AACF,GAAE;CACD,KAAM,EACJ,SACA,OACA,OACD,EAAE;EACD,YAAY,MAAM;EAClB,MAAM,EACJ,OAAO,aACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,OAAK,MAAM,CACT,SACA,EACE,sBAAsB,OACtB,YAAY,OACZ,oBAAoB,OACrB,CACF,IAAI,OAAO,QAAQ,KAAK,EAAE;GACzB,MAAM,MAAM,MAAM,0BAA0B,EAC1C,QACD,EAAC;AACF,OAAI,OAAO,OAAO,QAAQ,YAAY,aAAa,KACjD,MAAM,eACJ,CAAC,mDAAmD,EAAE,IAAI,QAAQ,uCAAC,CAC7B,CACvC;QACI;IACL,MAAM,gBACJ,OAAO,OAAO,QAAQ,YAAY,IAAI,eACnC;AACL,QAAI,aAAa,CAAC,MAAM,OAAO,UAC7B,MAAM,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC;AAGnD,QAAI,qBAAqB,MAAM,cAAc,UAC3C,MAAM,eACJ,CAAC,WAAW,EAAE,eAAe,CAC9B;AAGH,QAAI,uBACA,MAAM,uBAAuB,UAE/B,MAAM,eACJ,CAAC,CAAC,EAAE,cAAc,uCAAuC,CAAC,CAC3D;GAEJ;EACF;CACF;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,mBAAmB,EACjB,MAAM;KACJ,sBAAsB;KACtB,YAAY;MACV,qBAAqB,EACnB,MAAM,UACP;MACD,WAAW,EACT,MAAM,UACP;MACD,mBAAmB,EACjB,MAAM,UACP;KACF;KACD,MAAM;IACP,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;CACD,WAAY,EACV,MACA,OACD,EAAE;AACD,MAAI,CAAC,MAAM,eACT,MAAM,gBAAgB,KAAK,MAAM;CAEpC;AACF,EAAC"}

package/dist/rules/requireHyphenBeforeParamDescription.cjs

@@ -1,137 +1,89 @@
-"use strict";
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  utils
-}) => {
-  const [mainCircumstance, {
-    tags = null
-  } = {}] = context.options;
-  const tgs =
-  /**
-   * @type {null|"any"|{[key: string]: "always"|"never"}}
-   */
-  tags;
-
-  /**
-   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} jsdocTag
-   * @param {string} targetTagName
-   * @param {"always"|"never"} [circumstance]
-   * @returns {void}
-   */
-  const checkHyphens = (jsdocTag, targetTagName, circumstance = mainCircumstance) => {
-    const always = !circumstance || circumstance === 'always';
-    const desc = /** @type {string} */utils.getTagDescription(jsdocTag);
-    if (!desc.trim()) {
-      return;
-    }
-    const startsWithHyphen = /^\s*-/v.test(desc);
-    let lines = 0;
-    for (const {
-      tokens
-    } of jsdocTag.source) {
-      if (tokens.description) {
-        break;
-      }
-      lines++;
-    }
-    if (always) {
-      if (!startsWithHyphen) {
-        utils.reportJSDoc(`There must be a hyphen before @${targetTagName} description.`, {
-          line: jsdocTag.source[0].number + lines
-        }, () => {
-          for (const {
-            tokens
-          } of jsdocTag.source) {
-            if (tokens.description) {
-              tokens.description = tokens.description.replace(/^(\s*)/v, '$1- ');
-              break;
-            }
-          }
-        });
-      }
-    } else if (startsWithHyphen) {
-      utils.reportJSDoc(`There must be no hyphen before @${targetTagName} description.`, {
-        line: jsdocTag.source[0].number + lines
-      }, () => {
-        for (const {
-          tokens
-        } of jsdocTag.source) {
-          if (tokens.description) {
-            tokens.description = tokens.description.replace(/^\s*-\s*/v, '');
-            break;
-          }
-        }
-      }, true);
-    }
-  };
-  utils.forEachPreferredTag('param', checkHyphens);
-  if (tgs) {
-    const tagEntries = Object.entries(tgs);
-    for (const [tagName, circumstance] of tagEntries) {
-      if (tagName === '*') {
-        const preferredParamTag = utils.getPreferredTagName({
-          tagName: 'param'
-        });
-        for (const {
-          tag
-        } of jsdoc.tags) {
-          if (tag === preferredParamTag || tagEntries.some(([tagNme]) => {
-            return tagNme !== '*' && tagNme === tag;
-          })) {
-            continue;
-          }
-          utils.forEachPreferredTag(tag, (jsdocTag, targetTagName) => {
-            checkHyphens(jsdocTag, targetTagName, /** @type {"always"|"never"} */circumstance);
-          });
-        }
-        continue;
-      }
-      utils.forEachPreferredTag(tagName, (jsdocTag, targetTagName) => {
-        checkHyphens(jsdocTag, targetTagName, /** @type {"always"|"never"} */circumstance);
-      });
-    }
-  }
+//#region src/rules/requireHyphenBeforeParamDescription.js
+var requireHyphenBeforeParamDescription_default = require_iterateJsdoc.default(({ context, jsdoc, utils }) => {
+	const [mainCircumstance, { tags = null } = {}] = context.options;
+	const tgs = tags;
+	/**
+	* @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} jsdocTag
+	* @param {string} targetTagName
+	* @param {"always"|"never"} [circumstance]
+	* @returns {void}
+	*/
+	const checkHyphens = (jsdocTag, targetTagName, circumstance = mainCircumstance) => {
+		const always = !circumstance || circumstance === "always";
+		const desc = utils.getTagDescription(jsdocTag);
+		if (!desc.trim()) return;
+		const startsWithHyphen = /^\s*-/v.test(desc);
+		let lines = 0;
+		for (const { tokens } of jsdocTag.source) {
+			if (tokens.description) break;
+			lines++;
+		}
+		if (always) {
+			if (!startsWithHyphen) utils.reportJSDoc(`There must be a hyphen before @${targetTagName} description.`, { line: jsdocTag.source[0].number + lines }, () => {
+				for (const { tokens } of jsdocTag.source) if (tokens.description) {
+					tokens.description = tokens.description.replace(/^(\s*)/v, "$1- ");
+					break;
+				}
+			});
+		} else if (startsWithHyphen) utils.reportJSDoc(`There must be no hyphen before @${targetTagName} description.`, { line: jsdocTag.source[0].number + lines }, () => {
+			for (const { tokens } of jsdocTag.source) if (tokens.description) {
+				tokens.description = tokens.description.replace(/^\s*-\s*/v, "");
+				break;
+			}
+		}, true);
+	};
+	utils.forEachPreferredTag("param", checkHyphens);
+	if (tgs) {
+		const tagEntries = Object.entries(tgs);
+		for (const [tagName, circumstance] of tagEntries) {
+			if (tagName === "*") {
+				const preferredParamTag = utils.getPreferredTagName({ tagName: "param" });
+				for (const { tag } of jsdoc.tags) {
+					if (tag === preferredParamTag || tagEntries.some(([tagNme]) => {
+						return tagNme !== "*" && tagNme === tag;
+					})) continue;
+					utils.forEachPreferredTag(tag, (jsdocTag, targetTagName) => {
+						checkHyphens(jsdocTag, targetTagName, circumstance);
+					});
+				}
+				continue;
+			}
+			utils.forEachPreferredTag(tagName, (jsdocTag, targetTagName) => {
+				checkHyphens(jsdocTag, targetTagName, circumstance);
+			});
+		}
+	}
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Requires a hyphen before the `@param` description.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      enum: ['always', 'never'],
-      type: 'string'
-    }, {
-      additionalProperties: false,
-      properties: {
-        tags: {
-          anyOf: [{
-            patternProperties: {
-              '.*': {
-                enum: ['always', 'never'],
-                type: 'string'
-              }
-            },
-            type: 'object'
-          }, {
-            enum: ['any'],
-            type: 'string'
-          }]
-        }
-      },
-      type: 'object'
-    }],
-    type: 'layout'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Requires a hyphen before the `@param` description.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			enum: ["always", "never"],
+			type: "string"
+		}, {
+			additionalProperties: false,
+			properties: { tags: { anyOf: [{
+				patternProperties: { ".*": {
+					enum: ["always", "never"],
+					type: "string"
+				} },
+				type: "object"
+			}, {
+				enum: ["any"],
+				type: "string"
+			}] } },
+			type: "object"
+		}],
+		type: "layout"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireHyphenBeforeParamDescription_default;
 //# sourceMappingURL=requireHyphenBeforeParamDescription.cjs.map

package/dist/rules/requireHyphenBeforeParamDescription.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireHyphenBeforeParamDescription.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","jsdoc","utils","mainCircumstance","tags","options","tgs","checkHyphens","jsdocTag","targetTagName","circumstance","always","desc","getTagDescription","trim","startsWithHyphen","test","lines","tokens","source","description","reportJSDoc","line","number","replace","forEachPreferredTag","tagEntries","Object","entries","tagName","preferredParamTag","getPreferredTagName","tag","some","tagNme","iterateAllJsdocs","meta","docs","url","fixable","schema","enum","type","additionalProperties","properties","anyOf","patternProperties","module"],"sources":["../../src/rules/requireHyphenBeforeParamDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    mainCircumstance,\n    {\n      tags = null,\n    } = {},\n  ] = context.options;\n\n  const tgs = /**\n               * @type {null|\"any\"|{[key: string]: \"always\"|\"never\"}}\n               */ (tags);\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} jsdocTag\n   * @param {string} targetTagName\n   * @param {\"always\"|\"never\"} [circumstance]\n   * @returns {void}\n   */\n  const checkHyphens = (jsdocTag, targetTagName, circumstance = mainCircumstance) => {\n    const always = !circumstance || circumstance === 'always';\n    const desc = /** @type {string} */ (utils.getTagDescription(jsdocTag));\n    if (!desc.trim()) {\n      return;\n    }\n\n    const startsWithHyphen = (/^\\s*-/v).test(desc);\n    let lines = 0;\n    for (const {\n      tokens,\n    } of jsdocTag.source) {\n      if (tokens.description) {\n        break;\n      }\n\n      lines++;\n    }\n\n    if (always) {\n      if (!startsWithHyphen) {\n        utils.reportJSDoc(\n          `There must be a hyphen before @${targetTagName} description.`,\n          {\n            line: jsdocTag.source[0].number + lines,\n          },\n          () => {\n            for (const {\n              tokens,\n            } of jsdocTag.source) {\n              if (tokens.description) {\n                tokens.description = tokens.description.replace(\n                  /^(\\s*)/v, '$1- ',\n                );\n                break;\n              }\n            }\n          },\n        );\n      }\n    } else if (startsWithHyphen) {\n      utils.reportJSDoc(\n        `There must be no hyphen before @${targetTagName} description.`,\n        {\n          line: jsdocTag.source[0].number + lines,\n        },\n        () => {\n          for (const {\n            tokens,\n          } of jsdocTag.source) {\n            if (tokens.description) {\n              tokens.description = tokens.description.replace(\n                /^\\s*-\\s*/v, '',\n              );\n              break;\n            }\n          }\n        },\n        true,\n      );\n    }\n  };\n\n  utils.forEachPreferredTag('param', checkHyphens);\n  if (tgs) {\n    const tagEntries = Object.entries(tgs);\n    for (const [\n      tagName,\n      circumstance,\n    ] of tagEntries) {\n      if (tagName === '*') {\n        const preferredParamTag = utils.getPreferredTagName({\n          tagName: 'param',\n        });\n        for (const {\n          tag,\n        } of jsdoc.tags) {\n          if (tag === preferredParamTag || tagEntries.some(([\n            tagNme,\n          ]) => {\n            return tagNme !== '*' && tagNme === tag;\n          })) {\n            continue;\n          }\n\n          utils.forEachPreferredTag(tag, (jsdocTag, targetTagName) => {\n            checkHyphens(\n              jsdocTag,\n              targetTagName,\n              /** @type {\"always\"|\"never\"} */ (circumstance),\n            );\n          });\n        }\n\n        continue;\n      }\n\n      utils.forEachPreferredTag(tagName, (jsdocTag, targetTagName) => {\n        checkHyphens(\n          jsdocTag,\n          targetTagName,\n          /** @type {\"always\"|\"never\"} */ (circumstance),\n        );\n      });\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires a hyphen before the `@param` description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            anyOf: [\n              {\n                patternProperties: {\n                  '.*': {\n                    enum: [\n                      'always', 'never',\n                    ],\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n              {\n                enum: [\n                  'any',\n                ],\n                type: 'string',\n              },\n            ],\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ,MAAM,CACJC,gBAAgB,EAChB;IACEC,IAAI,GAAG;EACT,CAAC,GAAG,CAAC,CAAC,CACP,GAAGJ,OAAO,CAACK,OAAO;EAEnB,MAAMC,GAAG;EAAG;AACd;AACA;EAAmBF,IAAK;;EAEtB;AACF;AACA;AACA;AACA;AACA;EACE,MAAMG,YAAY,GAAGA,CAACC,QAAQ,EAAEC,aAAa,EAAEC,YAAY,GAAGP,gBAAgB,KAAK;IACjF,MAAMQ,MAAM,GAAG,CAACD,YAAY,IAAIA,YAAY,KAAK,QAAQ;IACzD,MAAME,IAAI,GAAG,qBAAuBV,KAAK,CAACW,iBAAiB,CAACL,QAAQ,CAAE;IACtE,IAAI,CAACI,IAAI,CAACE,IAAI,CAAC,CAAC,EAAE;MAChB;IACF;IAEA,MAAMC,gBAAgB,GAAI,QAAQ,CAAEC,IAAI,CAACJ,IAAI,CAAC;IAC9C,IAAIK,KAAK,GAAG,CAAC;IACb,KAAK,MAAM;MACTC;IACF,CAAC,IAAIV,QAAQ,CAACW,MAAM,EAAE;MACpB,IAAID,MAAM,CAACE,WAAW,EAAE;QACtB;MACF;MAEAH,KAAK,EAAE;IACT;IAEA,IAAIN,MAAM,EAAE;MACV,IAAI,CAACI,gBAAgB,EAAE;QACrBb,KAAK,CAACmB,WAAW,CACf,kCAAkCZ,aAAa,eAAe,EAC9D;UACEa,IAAI,EAAEd,QAAQ,CAACW,MAAM,CAAC,CAAC,CAAC,CAACI,MAAM,GAAGN;QACpC,CAAC,EACD,MAAM;UACJ,KAAK,MAAM;YACTC;UACF,CAAC,IAAIV,QAAQ,CAACW,MAAM,EAAE;YACpB,IAAID,MAAM,CAACE,WAAW,EAAE;cACtBF,MAAM,CAACE,WAAW,GAAGF,MAAM,CAACE,WAAW,CAACI,OAAO,CAC7C,SAAS,EAAE,MACb,CAAC;cACD;YACF;UACF;QACF,CACF,CAAC;MACH;IACF,CAAC,MAAM,IAAIT,gBAAgB,EAAE;MAC3Bb,KAAK,CAACmB,WAAW,CACf,mCAAmCZ,aAAa,eAAe,EAC/D;QACEa,IAAI,EAAEd,QAAQ,CAACW,MAAM,CAAC,CAAC,CAAC,CAACI,MAAM,GAAGN;MACpC,CAAC,EACD,MAAM;QACJ,KAAK,MAAM;UACTC;QACF,CAAC,IAAIV,QAAQ,CAACW,MAAM,EAAE;UACpB,IAAID,MAAM,CAACE,WAAW,EAAE;YACtBF,MAAM,CAACE,WAAW,GAAGF,MAAM,CAACE,WAAW,CAACI,OAAO,CAC7C,WAAW,EAAE,EACf,CAAC;YACD;UACF;QACF;MACF,CAAC,EACD,IACF,CAAC;IACH;EACF,CAAC;EAEDtB,KAAK,CAACuB,mBAAmB,CAAC,OAAO,EAAElB,YAAY,CAAC;EAChD,IAAID,GAAG,EAAE;IACP,MAAMoB,UAAU,GAAGC,MAAM,CAACC,OAAO,CAACtB,GAAG,CAAC;IACtC,KAAK,MAAM,CACTuB,OAAO,EACPnB,YAAY,CACb,IAAIgB,UAAU,EAAE;MACf,IAAIG,OAAO,KAAK,GAAG,EAAE;QACnB,MAAMC,iBAAiB,GAAG5B,KAAK,CAAC6B,mBAAmB,CAAC;UAClDF,OAAO,EAAE;QACX,CAAC,CAAC;QACF,KAAK,MAAM;UACTG;QACF,CAAC,IAAI/B,KAAK,CAACG,IAAI,EAAE;UACf,IAAI4B,GAAG,KAAKF,iBAAiB,IAAIJ,UAAU,CAACO,IAAI,CAAC,CAAC,CAChDC,MAAM,CACP,KAAK;YACJ,OAAOA,MAAM,KAAK,GAAG,IAAIA,MAAM,KAAKF,GAAG;UACzC,CAAC,CAAC,EAAE;YACF;UACF;UAEA9B,KAAK,CAACuB,mBAAmB,CAACO,GAAG,EAAE,CAACxB,QAAQ,EAAEC,aAAa,KAAK;YAC1DF,YAAY,CACVC,QAAQ,EACRC,aAAa,EACb,+BAAiCC,YACnC,CAAC;UACH,CAAC,CAAC;QACJ;QAEA;MACF;MAEAR,KAAK,CAACuB,mBAAmB,CAACI,OAAO,EAAE,CAACrB,QAAQ,EAAEC,aAAa,KAAK;QAC9DF,YAAY,CACVC,QAAQ,EACRC,aAAa,EACb,+BAAiCC,YACnC,CAAC;MACH,CAAC,CAAC;IACJ;EACF;AACF,CAAC,EAAE;EACDyB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJjB,WAAW,EAAE,oDAAoD;MACjEkB,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,IAAI,EAAE,CACJ,QAAQ,EAAE,OAAO,CAClB;MACDC,IAAI,EAAE;IACR,CAAC,EACD;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVxC,IAAI,EAAE;UACJyC,KAAK,EAAE,CACL;YACEC,iBAAiB,EAAE;cACjB,IAAI,EAAE;gBACJL,IAAI,EAAE,CACJ,QAAQ,EAAE,OAAO,CAClB;gBACDC,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC,EACD;YACED,IAAI,EAAE,CACJ,KAAK,CACN;YACDC,IAAI,EAAE;UACR,CAAC;QAEL;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAK,MAAA,CAAAjD,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"requireHyphenBeforeParamDescription.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireHyphenBeforeParamDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    mainCircumstance,\n    {\n      tags = null,\n    } = {},\n  ] = context.options;\n\n  const tgs = /**\n               * @type {null|\"any\"|{[key: string]: \"always\"|\"never\"}}\n               */ (tags);\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} jsdocTag\n   * @param {string} targetTagName\n   * @param {\"always\"|\"never\"} [circumstance]\n   * @returns {void}\n   */\n  const checkHyphens = (jsdocTag, targetTagName, circumstance = mainCircumstance) => {\n    const always = !circumstance || circumstance === 'always';\n    const desc = /** @type {string} */ (utils.getTagDescription(jsdocTag));\n    if (!desc.trim()) {\n      return;\n    }\n\n    const startsWithHyphen = (/^\\s*-/v).test(desc);\n    let lines = 0;\n    for (const {\n      tokens,\n    } of jsdocTag.source) {\n      if (tokens.description) {\n        break;\n      }\n\n      lines++;\n    }\n\n    if (always) {\n      if (!startsWithHyphen) {\n        utils.reportJSDoc(\n          `There must be a hyphen before @${targetTagName} description.`,\n          {\n            line: jsdocTag.source[0].number + lines,\n          },\n          () => {\n            for (const {\n              tokens,\n            } of jsdocTag.source) {\n              if (tokens.description) {\n                tokens.description = tokens.description.replace(\n                  /^(\\s*)/v, '$1- ',\n                );\n                break;\n              }\n            }\n          },\n        );\n      }\n    } else if (startsWithHyphen) {\n      utils.reportJSDoc(\n        `There must be no hyphen before @${targetTagName} description.`,\n        {\n          line: jsdocTag.source[0].number + lines,\n        },\n        () => {\n          for (const {\n            tokens,\n          } of jsdocTag.source) {\n            if (tokens.description) {\n              tokens.description = tokens.description.replace(\n                /^\\s*-\\s*/v, '',\n              );\n              break;\n            }\n          }\n        },\n        true,\n      );\n    }\n  };\n\n  utils.forEachPreferredTag('param', checkHyphens);\n  if (tgs) {\n    const tagEntries = Object.entries(tgs);\n    for (const [\n      tagName,\n      circumstance,\n    ] of tagEntries) {\n      if (tagName === '*') {\n        const preferredParamTag = utils.getPreferredTagName({\n          tagName: 'param',\n        });\n        for (const {\n          tag,\n        } of jsdoc.tags) {\n          if (tag === preferredParamTag || tagEntries.some(([\n            tagNme,\n          ]) => {\n            return tagNme !== '*' && tagNme === tag;\n          })) {\n            continue;\n          }\n\n          utils.forEachPreferredTag(tag, (jsdocTag, targetTagName) => {\n            checkHyphens(\n              jsdocTag,\n              targetTagName,\n              /** @type {\"always\"|\"never\"} */ (circumstance),\n            );\n          });\n        }\n\n        continue;\n      }\n\n      utils.forEachPreferredTag(tagName, (jsdocTag, targetTagName) => {\n        checkHyphens(\n          jsdocTag,\n          targetTagName,\n          /** @type {\"always\"|\"never\"} */ (circumstance),\n        );\n      });\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires a hyphen before the `@param` description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            anyOf: [\n              {\n                patternProperties: {\n                  '.*': {\n                    enum: [\n                      'always', 'never',\n                    ],\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n              {\n                enum: [\n                  'any',\n                ],\n                type: 'string',\n              },\n            ],\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;AAEA,kDAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,CACJ,kBACA,EACE,OAAO,MACR,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,MAAM,MAEW;;;;;;;CAQjB,MAAM,eAAe,CAAC,UAAU,eAAe,eAAe,qBAAqB;EACjF,MAAM,SAAS,CAAC,gBAAgB,iBAAiB;EACjD,MAAM,OAA8B,MAAM,kBAAkB,SAAS;AACrE,MAAI,CAAC,KAAK,MAAM,CACd;EAGF,MAAM,mBAAoB,SAAU,KAAK,KAAK;EAC9C,IAAI,QAAQ;AACZ,OAAK,MAAM,EACT,QACD,IAAI,SAAS,QAAQ;AACpB,OAAI,OAAO,YACT;GAGF;EACD;AAED,MAAI,QACF;OAAI,CAAC,kBACH,MAAM,YACJ,CAAC,+BAA+B,EAAE,cAAc,aAAa,CAAC,EAC9D,EACE,MAAM,SAAS,OAAO,GAAG,SAAS,MACnC,GACD,MAAM;AACJ,SAAK,MAAM,EACT,QACD,IAAI,SAAS,OACZ,KAAI,OAAO,aAAa;KACtB,OAAO,cAAc,OAAO,YAAY,QACtC,WAAW,OACZ;AACD;IACD;GAEJ,EACF;EACF,WACQ,kBACT,MAAM,YACJ,CAAC,gCAAgC,EAAE,cAAc,aAAa,CAAC,EAC/D,EACE,MAAM,SAAS,OAAO,GAAG,SAAS,MACnC,GACD,MAAM;AACJ,QAAK,MAAM,EACT,QACD,IAAI,SAAS,OACZ,KAAI,OAAO,aAAa;IACtB,OAAO,cAAc,OAAO,YAAY,QACtC,aAAa,GACd;AACD;GACD;EAEJ,GACD,KACD;CAEJ;CAED,MAAM,oBAAoB,SAAS,aAAa;AAChD,KAAI,KAAK;EACP,MAAM,aAAa,OAAO,QAAQ,IAAI;AACtC,OAAK,MAAM,CACT,SACA,aACD,IAAI,YAAY;AACf,OAAI,YAAY,KAAK;IACnB,MAAM,oBAAoB,MAAM,oBAAoB,EAClD,SAAS,QACV,EAAC;AACF,SAAK,MAAM,EACT,KACD,IAAI,MAAM,MAAM;AACf,SAAI,QAAQ,qBAAqB,WAAW,KAAK,CAAC,CAChD,OACD,KAAK;AACJ,aAAO,WAAW,OAAO,WAAW;KACrC,EAAC,CACA;KAGF,MAAM,oBAAoB,KAAK,CAAC,UAAU,kBAAkB;MAC1D,aACE,UACA,eACiC,aAClC;KACF,EAAC;IACH;AAED;GACD;GAED,MAAM,oBAAoB,SAAS,CAAC,UAAU,kBAAkB;IAC9D,aACE,UACA,eACiC,aAClC;GACF,EAAC;EACH;CACF;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM,CACJ,UAAU,OACX;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM,EACJ,OAAO,CACL;IACE,mBAAmB,EACjB,MAAM;KACJ,MAAM,CACJ,UAAU,OACX;KACD,MAAM;IACP,EACF;IACD,MAAM;GACP,GACD;IACE,MAAM,CACJ,KACD;IACD,MAAM;GACP,CACF,EACF,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}