eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/requireAsteriskPrefix.cjs

@@ -1,163 +1,112 @@
-"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,
-  indent,
-  jsdoc,
-  utils
-}) => {
-  const [defaultRequireValue = 'always', {
-    tags: tagMap = {}
-  } = {}] = context.options;
-  const {
-    source
-  } = jsdoc;
-  const always = defaultRequireValue === 'always';
-  const never = defaultRequireValue === 'never';
-
-  /** @type {string} */
-  let currentTag;
-  source.some(({
-    number,
-    tokens
-  }) => {
-    const {
-      delimiter,
-      description,
-      end,
-      tag
-    } = tokens;
-
-    /**
-     * @returns {void}
-     */
-    const neverFix = () => {
-      tokens.delimiter = '';
-      tokens.postDelimiter = '';
-    };
-
-    /**
-     * @param {string} checkValue
-     * @returns {boolean}
-     */
-    const checkNever = checkValue => {
-      if (delimiter && delimiter !== '/**' && (never && !tagMap.always?.includes(checkValue) || tagMap.never?.includes(checkValue))) {
-        utils.reportJSDoc('Expected JSDoc line to have no prefix.', {
-          column: 0,
-          line: number
-        }, neverFix);
-        return true;
-      }
-      return false;
-    };
-
-    /**
-     * @returns {void}
-     */
-    const alwaysFix = () => {
-      if (!tokens.start) {
-        tokens.start = indent + ' ';
-      }
-      tokens.delimiter = '*';
-      tokens.postDelimiter = tag || description ? ' ' : '';
-    };
-
-    /**
-     * @param {string} checkValue
-     * @returns {boolean}
-     */
-    const checkAlways = checkValue => {
-      if (!delimiter && (always && !tagMap.never?.includes(checkValue) || tagMap.always?.includes(checkValue))) {
-        utils.reportJSDoc('Expected JSDoc line to have the prefix.', {
-          column: 0,
-          line: number
-        }, alwaysFix);
-        return true;
-      }
-      return false;
-    };
-    if (tag) {
-      // Remove at sign
-      currentTag = tag.slice(1);
-    }
-    if (
-    // If this is the end but has a tag, the delimiter will also be
-    //  populated and will be safely ignored later
-    end && !tag) {
-      return false;
-    }
-    if (!currentTag) {
-      if (tagMap.any?.includes('*description')) {
-        return false;
-      }
-      if (checkNever('*description')) {
-        return true;
-      }
-      if (checkAlways('*description')) {
-        return true;
-      }
-      return false;
-    }
-    if (tagMap.any?.includes(currentTag)) {
-      return false;
-    }
-    if (checkNever(currentTag)) {
-      return true;
-    }
-    if (checkAlways(currentTag)) {
-      return true;
-    }
-    return false;
-  });
+//#region src/rules/requireAsteriskPrefix.js
+var requireAsteriskPrefix_default = require_iterateJsdoc.default(({ context, indent, jsdoc, utils }) => {
+	const [defaultRequireValue = "always", { tags: tagMap = {} } = {}] = context.options;
+	const { source } = jsdoc;
+	const always = defaultRequireValue === "always";
+	const never = defaultRequireValue === "never";
+	/** @type {string} */
+	let currentTag;
+	source.some(({ number, tokens }) => {
+		const { delimiter, description, end, tag } = tokens;
+		/**
+		* @returns {void}
+		*/
+		const neverFix = () => {
+			tokens.delimiter = "";
+			tokens.postDelimiter = "";
+		};
+		/**
+		* @param {string} checkValue
+		* @returns {boolean}
+		*/
+		const checkNever = (checkValue) => {
+			if (delimiter && delimiter !== "/**" && (never && !tagMap.always?.includes(checkValue) || tagMap.never?.includes(checkValue))) {
+				utils.reportJSDoc("Expected JSDoc line to have no prefix.", {
+					column: 0,
+					line: number
+				}, neverFix);
+				return true;
+			}
+			return false;
+		};
+		/**
+		* @returns {void}
+		*/
+		const alwaysFix = () => {
+			if (!tokens.start) tokens.start = indent + " ";
+			tokens.delimiter = "*";
+			tokens.postDelimiter = tag || description ? " " : "";
+		};
+		/**
+		* @param {string} checkValue
+		* @returns {boolean}
+		*/
+		const checkAlways = (checkValue) => {
+			if (!delimiter && (always && !tagMap.never?.includes(checkValue) || tagMap.always?.includes(checkValue))) {
+				utils.reportJSDoc("Expected JSDoc line to have the prefix.", {
+					column: 0,
+					line: number
+				}, alwaysFix);
+				return true;
+			}
+			return false;
+		};
+		if (tag) currentTag = tag.slice(1);
+		if (end && !tag) return false;
+		if (!currentTag) {
+			if (tagMap.any?.includes("*description")) return false;
+			if (checkNever("*description")) return true;
+			if (checkAlways("*description")) return true;
+			return false;
+		}
+		if (tagMap.any?.includes(currentTag)) return false;
+		if (checkNever(currentTag)) return true;
+		if (checkAlways(currentTag)) return true;
+		return false;
+	});
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Requires that each JSDoc line starts with an `*`.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      enum: ['always', 'never', 'any'],
-      type: 'string'
-    }, {
-      additionalProperties: false,
-      properties: {
-        tags: {
-          additionalProperties: false,
-          properties: {
-            always: {
-              items: {
-                type: 'string'
-              },
-              type: 'array'
-            },
-            any: {
-              items: {
-                type: 'string'
-              },
-              type: 'array'
-            },
-            never: {
-              items: {
-                type: 'string'
-              },
-              type: 'array'
-            }
-          },
-          type: 'object'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'layout'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Requires that each JSDoc line starts with an `*`.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			enum: [
+				"always",
+				"never",
+				"any"
+			],
+			type: "string"
+		}, {
+			additionalProperties: false,
+			properties: { tags: {
+				additionalProperties: false,
+				properties: {
+					always: {
+						items: { type: "string" },
+						type: "array"
+					},
+					any: {
+						items: { type: "string" },
+						type: "array"
+					},
+					never: {
+						items: { type: "string" },
+						type: "array"
+					}
+				},
+				type: "object"
+			} },
+			type: "object"
+		}],
+		type: "layout"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireAsteriskPrefix_default;
 //# sourceMappingURL=requireAsteriskPrefix.cjs.map

package/dist/rules/requireAsteriskPrefix.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireAsteriskPrefix.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","indent","jsdoc","utils","defaultRequireValue","tags","tagMap","options","source","always","never","currentTag","some","number","tokens","delimiter","description","end","tag","neverFix","postDelimiter","checkNever","checkValue","includes","reportJSDoc","column","line","alwaysFix","start","checkAlways","slice","any","iterateAllJsdocs","meta","docs","url","fixable","schema","enum","type","additionalProperties","properties","items","module"],"sources":["../../src/rules/requireAsteriskPrefix.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    defaultRequireValue = 'always',\n    {\n      tags: tagMap = {},\n    } = {},\n  ] = context.options;\n\n  const {\n    source,\n  } = jsdoc;\n\n  const always = defaultRequireValue === 'always';\n  const never = defaultRequireValue === 'never';\n\n  /** @type {string} */\n  let currentTag;\n  source.some(({\n    number,\n    tokens,\n  }) => {\n    const {\n      delimiter,\n      description,\n      end,\n      tag,\n    } = tokens;\n\n    /**\n     * @returns {void}\n     */\n    const neverFix = () => {\n      tokens.delimiter = '';\n      tokens.postDelimiter = '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkNever = (checkValue) => {\n      if (delimiter && delimiter !== '/**' && (\n        never && !tagMap.always?.includes(checkValue) ||\n        tagMap.never?.includes(checkValue)\n      )) {\n        utils.reportJSDoc('Expected JSDoc line to have no prefix.', {\n          column: 0,\n          line: number,\n        }, neverFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    /**\n     * @returns {void}\n     */\n    const alwaysFix = () => {\n      if (!tokens.start) {\n        tokens.start = indent + ' ';\n      }\n\n      tokens.delimiter = '*';\n      tokens.postDelimiter = tag || description ? ' ' : '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkAlways = (checkValue) => {\n      if (\n        !delimiter && (\n          always && !tagMap.never?.includes(checkValue) ||\n          tagMap.always?.includes(checkValue)\n        )\n      ) {\n        utils.reportJSDoc('Expected JSDoc line to have the prefix.', {\n          column: 0,\n          line: number,\n        }, alwaysFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    if (tag) {\n      // Remove at sign\n      currentTag = tag.slice(1);\n    }\n\n    if (\n      // If this is the end but has a tag, the delimiter will also be\n      //  populated and will be safely ignored later\n      end && !tag\n    ) {\n      return false;\n    }\n\n    if (!currentTag) {\n      if (tagMap.any?.includes('*description')) {\n        return false;\n      }\n\n      if (checkNever('*description')) {\n        return true;\n      }\n\n      if (checkAlways('*description')) {\n        return true;\n      }\n\n      return false;\n    }\n\n    if (tagMap.any?.includes(currentTag)) {\n      return false;\n    }\n\n    if (checkNever(currentTag)) {\n      return true;\n    }\n\n    if (checkAlways(currentTag)) {\n      return true;\n    }\n\n    return false;\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'Requires that each JSDoc line starts with an `*`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never', 'any',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            additionalProperties: false,\n            properties: {\n              always: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              any: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              never: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n            type: 'object',\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,MAAM;EACNC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ,MAAM,CACJC,mBAAmB,GAAG,QAAQ,EAC9B;IACEC,IAAI,EAAEC,MAAM,GAAG,CAAC;EAClB,CAAC,GAAG,CAAC,CAAC,CACP,GAAGN,OAAO,CAACO,OAAO;EAEnB,MAAM;IACJC;EACF,CAAC,GAAGN,KAAK;EAET,MAAMO,MAAM,GAAGL,mBAAmB,KAAK,QAAQ;EAC/C,MAAMM,KAAK,GAAGN,mBAAmB,KAAK,OAAO;;EAE7C;EACA,IAAIO,UAAU;EACdH,MAAM,CAACI,IAAI,CAAC,CAAC;IACXC,MAAM;IACNC;EACF,CAAC,KAAK;IACJ,MAAM;MACJC,SAAS;MACTC,WAAW;MACXC,GAAG;MACHC;IACF,CAAC,GAAGJ,MAAM;;IAEV;AACJ;AACA;IACI,MAAMK,QAAQ,GAAGA,CAAA,KAAM;MACrBL,MAAM,CAACC,SAAS,GAAG,EAAE;MACrBD,MAAM,CAACM,aAAa,GAAG,EAAE;IAC3B,CAAC;;IAED;AACJ;AACA;AACA;IACI,MAAMC,UAAU,GAAIC,UAAU,IAAK;MACjC,IAAIP,SAAS,IAAIA,SAAS,KAAK,KAAK,KAClCL,KAAK,IAAI,CAACJ,MAAM,CAACG,MAAM,EAAEc,QAAQ,CAACD,UAAU,CAAC,IAC7ChB,MAAM,CAACI,KAAK,EAAEa,QAAQ,CAACD,UAAU,CAAC,CACnC,EAAE;QACDnB,KAAK,CAACqB,WAAW,CAAC,wCAAwC,EAAE;UAC1DC,MAAM,EAAE,CAAC;UACTC,IAAI,EAAEb;QACR,CAAC,EAAEM,QAAQ,CAAC;QAEZ,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd,CAAC;;IAED;AACJ;AACA;IACI,MAAMQ,SAAS,GAAGA,CAAA,KAAM;MACtB,IAAI,CAACb,MAAM,CAACc,KAAK,EAAE;QACjBd,MAAM,CAACc,KAAK,GAAG3B,MAAM,GAAG,GAAG;MAC7B;MAEAa,MAAM,CAACC,SAAS,GAAG,GAAG;MACtBD,MAAM,CAACM,aAAa,GAAGF,GAAG,IAAIF,WAAW,GAAG,GAAG,GAAG,EAAE;IACtD,CAAC;;IAED;AACJ;AACA;AACA;IACI,MAAMa,WAAW,GAAIP,UAAU,IAAK;MAClC,IACE,CAACP,SAAS,KACRN,MAAM,IAAI,CAACH,MAAM,CAACI,KAAK,EAAEa,QAAQ,CAACD,UAAU,CAAC,IAC7ChB,MAAM,CAACG,MAAM,EAAEc,QAAQ,CAACD,UAAU,CAAC,CACpC,EACD;QACAnB,KAAK,CAACqB,WAAW,CAAC,yCAAyC,EAAE;UAC3DC,MAAM,EAAE,CAAC;UACTC,IAAI,EAAEb;QACR,CAAC,EAAEc,SAAS,CAAC;QAEb,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd,CAAC;IAED,IAAIT,GAAG,EAAE;MACP;MACAP,UAAU,GAAGO,GAAG,CAACY,KAAK,CAAC,CAAC,CAAC;IAC3B;IAEA;IACE;IACA;IACAb,GAAG,IAAI,CAACC,GAAG,EACX;MACA,OAAO,KAAK;IACd;IAEA,IAAI,CAACP,UAAU,EAAE;MACf,IAAIL,MAAM,CAACyB,GAAG,EAAER,QAAQ,CAAC,cAAc,CAAC,EAAE;QACxC,OAAO,KAAK;MACd;MAEA,IAAIF,UAAU,CAAC,cAAc,CAAC,EAAE;QAC9B,OAAO,IAAI;MACb;MAEA,IAAIQ,WAAW,CAAC,cAAc,CAAC,EAAE;QAC/B,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd;IAEA,IAAIvB,MAAM,CAACyB,GAAG,EAAER,QAAQ,CAACZ,UAAU,CAAC,EAAE;MACpC,OAAO,KAAK;IACd;IAEA,IAAIU,UAAU,CAACV,UAAU,CAAC,EAAE;MAC1B,OAAO,IAAI;IACb;IAEA,IAAIkB,WAAW,CAAClB,UAAU,CAAC,EAAE;MAC3B,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC,EAAE;EACDqB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJlB,WAAW,EACT,mDAAmD;MACrDmB,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,IAAI,EAAE,CACJ,QAAQ,EAAE,OAAO,EAAE,KAAK,CACzB;MACDC,IAAI,EAAE;IACR,CAAC,EACD;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVpC,IAAI,EAAE;UACJmC,oBAAoB,EAAE,KAAK;UAC3BC,UAAU,EAAE;YACVhC,MAAM,EAAE;cACNiC,KAAK,EAAE;gBACLH,IAAI,EAAE;cACR,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE;cACHW,KAAK,EAAE;gBACLH,IAAI,EAAE;cACR,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;YACD7B,KAAK,EAAE;cACLgC,KAAK,EAAE;gBACLH,IAAI,EAAE;cACR,CAAC;cACDA,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAI,MAAA,CAAA7C,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"requireAsteriskPrefix.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireAsteriskPrefix.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    defaultRequireValue = 'always',\n    {\n      tags: tagMap = {},\n    } = {},\n  ] = context.options;\n\n  const {\n    source,\n  } = jsdoc;\n\n  const always = defaultRequireValue === 'always';\n  const never = defaultRequireValue === 'never';\n\n  /** @type {string} */\n  let currentTag;\n  source.some(({\n    number,\n    tokens,\n  }) => {\n    const {\n      delimiter,\n      description,\n      end,\n      tag,\n    } = tokens;\n\n    /**\n     * @returns {void}\n     */\n    const neverFix = () => {\n      tokens.delimiter = '';\n      tokens.postDelimiter = '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkNever = (checkValue) => {\n      if (delimiter && delimiter !== '/**' && (\n        never && !tagMap.always?.includes(checkValue) ||\n        tagMap.never?.includes(checkValue)\n      )) {\n        utils.reportJSDoc('Expected JSDoc line to have no prefix.', {\n          column: 0,\n          line: number,\n        }, neverFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    /**\n     * @returns {void}\n     */\n    const alwaysFix = () => {\n      if (!tokens.start) {\n        tokens.start = indent + ' ';\n      }\n\n      tokens.delimiter = '*';\n      tokens.postDelimiter = tag || description ? ' ' : '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkAlways = (checkValue) => {\n      if (\n        !delimiter && (\n          always && !tagMap.never?.includes(checkValue) ||\n          tagMap.always?.includes(checkValue)\n        )\n      ) {\n        utils.reportJSDoc('Expected JSDoc line to have the prefix.', {\n          column: 0,\n          line: number,\n        }, alwaysFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    if (tag) {\n      // Remove at sign\n      currentTag = tag.slice(1);\n    }\n\n    if (\n      // If this is the end but has a tag, the delimiter will also be\n      //  populated and will be safely ignored later\n      end && !tag\n    ) {\n      return false;\n    }\n\n    if (!currentTag) {\n      if (tagMap.any?.includes('*description')) {\n        return false;\n      }\n\n      if (checkNever('*description')) {\n        return true;\n      }\n\n      if (checkAlways('*description')) {\n        return true;\n      }\n\n      return false;\n    }\n\n    if (tagMap.any?.includes(currentTag)) {\n      return false;\n    }\n\n    if (checkNever(currentTag)) {\n      return true;\n    }\n\n    if (checkAlways(currentTag)) {\n      return true;\n    }\n\n    return false;\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'Requires that each JSDoc line starts with an `*`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never', 'any',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            additionalProperties: false,\n            properties: {\n              always: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              any: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              never: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;AAEA,oCAAeA,6BAAa,CAAC,EAC3B,SACA,QACA,OACA,OACD,KAAK;CACJ,MAAM,CACJ,sBAAsB,UACtB,EACE,MAAM,SAAS,CAAE,GAClB,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,MAAM,EACJ,QACD,GAAG;CAEJ,MAAM,SAAS,wBAAwB;CACvC,MAAM,QAAQ,wBAAwB;;CAGtC,IAAI;CACJ,OAAO,KAAK,CAAC,EACX,QACA,QACD,KAAK;EACJ,MAAM,EACJ,WACA,aACA,KACA,KACD,GAAG;;;;EAKJ,MAAM,WAAW,MAAM;GACrB,OAAO,YAAY;GACnB,OAAO,gBAAgB;EACxB;;;;;EAMD,MAAM,aAAa,CAAC,eAAe;AACjC,OAAI,aAAa,cAAc,UAC7B,SAAS,CAAC,OAAO,QAAQ,SAAS,WAAW,IAC7C,OAAO,OAAO,SAAS,WAAW,GACjC;IACD,MAAM,YAAY,0CAA0C;KAC1D,QAAQ;KACR,MAAM;IACP,GAAE,SAAS;AAEZ,WAAO;GACR;AAED,UAAO;EACR;;;;EAKD,MAAM,YAAY,MAAM;AACtB,OAAI,CAAC,OAAO,OACV,OAAO,QAAQ,SAAS;GAG1B,OAAO,YAAY;GACnB,OAAO,gBAAgB,OAAO,cAAc,MAAM;EACnD;;;;;EAMD,MAAM,cAAc,CAAC,eAAe;AAClC,OACE,CAAC,cACC,UAAU,CAAC,OAAO,OAAO,SAAS,WAAW,IAC7C,OAAO,QAAQ,SAAS,WAAW,GAErC;IACA,MAAM,YAAY,2CAA2C;KAC3D,QAAQ;KACR,MAAM;IACP,GAAE,UAAU;AAEb,WAAO;GACR;AAED,UAAO;EACR;AAED,MAAI,KAEF,aAAa,IAAI,MAAM,EAAE;AAG3B,MAGE,OAAO,CAAC,IAER,QAAO;AAGT,MAAI,CAAC,YAAY;AACf,OAAI,OAAO,KAAK,SAAS,eAAe,CACtC,QAAO;AAGT,OAAI,WAAW,eAAe,CAC5B,QAAO;AAGT,OAAI,YAAY,eAAe,CAC7B,QAAO;AAGT,UAAO;EACR;AAED,MAAI,OAAO,KAAK,SAAS,WAAW,CAClC,QAAO;AAGT,MAAI,WAAW,WAAW,CACxB,QAAO;AAGT,MAAI,YAAY,WAAW,CACzB,QAAO;AAGT,SAAO;CACR,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aACE;GACF,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM;IACJ;IAAU;IAAS;GACpB;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,sBAAsB;IACtB,YAAY;KACV,QAAQ;MACN,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;KACD,KAAK;MACH,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;KACD,OAAO;MACL,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;IACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireAsteriskPrefix.js

@@ -0,0 +1,112 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/requireAsteriskPrefix.js
+var requireAsteriskPrefix_default = iterateJsdoc(({ context, indent, jsdoc, utils }) => {
+	const [defaultRequireValue = "always", { tags: tagMap = {} } = {}] = context.options;
+	const { source } = jsdoc;
+	const always = defaultRequireValue === "always";
+	const never = defaultRequireValue === "never";
+	/** @type {string} */
+	let currentTag;
+	source.some(({ number, tokens }) => {
+		const { delimiter, description, end, tag } = tokens;
+		/**
+		* @returns {void}
+		*/
+		const neverFix = () => {
+			tokens.delimiter = "";
+			tokens.postDelimiter = "";
+		};
+		/**
+		* @param {string} checkValue
+		* @returns {boolean}
+		*/
+		const checkNever = (checkValue) => {
+			if (delimiter && delimiter !== "/**" && (never && !tagMap.always?.includes(checkValue) || tagMap.never?.includes(checkValue))) {
+				utils.reportJSDoc("Expected JSDoc line to have no prefix.", {
+					column: 0,
+					line: number
+				}, neverFix);
+				return true;
+			}
+			return false;
+		};
+		/**
+		* @returns {void}
+		*/
+		const alwaysFix = () => {
+			if (!tokens.start) tokens.start = indent + " ";
+			tokens.delimiter = "*";
+			tokens.postDelimiter = tag || description ? " " : "";
+		};
+		/**
+		* @param {string} checkValue
+		* @returns {boolean}
+		*/
+		const checkAlways = (checkValue) => {
+			if (!delimiter && (always && !tagMap.never?.includes(checkValue) || tagMap.always?.includes(checkValue))) {
+				utils.reportJSDoc("Expected JSDoc line to have the prefix.", {
+					column: 0,
+					line: number
+				}, alwaysFix);
+				return true;
+			}
+			return false;
+		};
+		if (tag) currentTag = tag.slice(1);
+		if (end && !tag) return false;
+		if (!currentTag) {
+			if (tagMap.any?.includes("*description")) return false;
+			if (checkNever("*description")) return true;
+			if (checkAlways("*description")) return true;
+			return false;
+		}
+		if (tagMap.any?.includes(currentTag)) return false;
+		if (checkNever(currentTag)) return true;
+		if (checkAlways(currentTag)) return true;
+		return false;
+	});
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Requires that each JSDoc line starts with an `*`.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			enum: [
+				"always",
+				"never",
+				"any"
+			],
+			type: "string"
+		}, {
+			additionalProperties: false,
+			properties: { tags: {
+				additionalProperties: false,
+				properties: {
+					always: {
+						items: { type: "string" },
+						type: "array"
+					},
+					any: {
+						items: { type: "string" },
+						type: "array"
+					},
+					never: {
+						items: { type: "string" },
+						type: "array"
+					}
+				},
+				type: "object"
+			} },
+			type: "object"
+		}],
+		type: "layout"
+	}
+});
+
+//#endregion
+export { requireAsteriskPrefix_default as default };
+//# sourceMappingURL=requireAsteriskPrefix.js.map

package/dist/rules/requireAsteriskPrefix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requireAsteriskPrefix.js","names":[],"sources":["../../src/rules/requireAsteriskPrefix.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    defaultRequireValue = 'always',\n    {\n      tags: tagMap = {},\n    } = {},\n  ] = context.options;\n\n  const {\n    source,\n  } = jsdoc;\n\n  const always = defaultRequireValue === 'always';\n  const never = defaultRequireValue === 'never';\n\n  /** @type {string} */\n  let currentTag;\n  source.some(({\n    number,\n    tokens,\n  }) => {\n    const {\n      delimiter,\n      description,\n      end,\n      tag,\n    } = tokens;\n\n    /**\n     * @returns {void}\n     */\n    const neverFix = () => {\n      tokens.delimiter = '';\n      tokens.postDelimiter = '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkNever = (checkValue) => {\n      if (delimiter && delimiter !== '/**' && (\n        never && !tagMap.always?.includes(checkValue) ||\n        tagMap.never?.includes(checkValue)\n      )) {\n        utils.reportJSDoc('Expected JSDoc line to have no prefix.', {\n          column: 0,\n          line: number,\n        }, neverFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    /**\n     * @returns {void}\n     */\n    const alwaysFix = () => {\n      if (!tokens.start) {\n        tokens.start = indent + ' ';\n      }\n\n      tokens.delimiter = '*';\n      tokens.postDelimiter = tag || description ? ' ' : '';\n    };\n\n    /**\n     * @param {string} checkValue\n     * @returns {boolean}\n     */\n    const checkAlways = (checkValue) => {\n      if (\n        !delimiter && (\n          always && !tagMap.never?.includes(checkValue) ||\n          tagMap.always?.includes(checkValue)\n        )\n      ) {\n        utils.reportJSDoc('Expected JSDoc line to have the prefix.', {\n          column: 0,\n          line: number,\n        }, alwaysFix);\n\n        return true;\n      }\n\n      return false;\n    };\n\n    if (tag) {\n      // Remove at sign\n      currentTag = tag.slice(1);\n    }\n\n    if (\n      // If this is the end but has a tag, the delimiter will also be\n      //  populated and will be safely ignored later\n      end && !tag\n    ) {\n      return false;\n    }\n\n    if (!currentTag) {\n      if (tagMap.any?.includes('*description')) {\n        return false;\n      }\n\n      if (checkNever('*description')) {\n        return true;\n      }\n\n      if (checkAlways('*description')) {\n        return true;\n      }\n\n      return false;\n    }\n\n    if (tagMap.any?.includes(currentTag)) {\n      return false;\n    }\n\n    if (checkNever(currentTag)) {\n      return true;\n    }\n\n    if (checkAlways(currentTag)) {\n      return true;\n    }\n\n    return false;\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'Requires that each JSDoc line starts with an `*`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'always', 'never', 'any',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            additionalProperties: false,\n            properties: {\n              always: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              any: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n              never: {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;AAEA,oCAAe,aAAa,CAAC,EAC3B,SACA,QACA,OACA,OACD,KAAK;CACJ,MAAM,CACJ,sBAAsB,UACtB,EACE,MAAM,SAAS,CAAE,GAClB,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,MAAM,EACJ,QACD,GAAG;CAEJ,MAAM,SAAS,wBAAwB;CACvC,MAAM,QAAQ,wBAAwB;;CAGtC,IAAI;CACJ,OAAO,KAAK,CAAC,EACX,QACA,QACD,KAAK;EACJ,MAAM,EACJ,WACA,aACA,KACA,KACD,GAAG;;;;EAKJ,MAAM,WAAW,MAAM;GACrB,OAAO,YAAY;GACnB,OAAO,gBAAgB;EACxB;;;;;EAMD,MAAM,aAAa,CAAC,eAAe;AACjC,OAAI,aAAa,cAAc,UAC7B,SAAS,CAAC,OAAO,QAAQ,SAAS,WAAW,IAC7C,OAAO,OAAO,SAAS,WAAW,GACjC;IACD,MAAM,YAAY,0CAA0C;KAC1D,QAAQ;KACR,MAAM;IACP,GAAE,SAAS;AAEZ,WAAO;GACR;AAED,UAAO;EACR;;;;EAKD,MAAM,YAAY,MAAM;AACtB,OAAI,CAAC,OAAO,OACV,OAAO,QAAQ,SAAS;GAG1B,OAAO,YAAY;GACnB,OAAO,gBAAgB,OAAO,cAAc,MAAM;EACnD;;;;;EAMD,MAAM,cAAc,CAAC,eAAe;AAClC,OACE,CAAC,cACC,UAAU,CAAC,OAAO,OAAO,SAAS,WAAW,IAC7C,OAAO,QAAQ,SAAS,WAAW,GAErC;IACA,MAAM,YAAY,2CAA2C;KAC3D,QAAQ;KACR,MAAM;IACP,GAAE,UAAU;AAEb,WAAO;GACR;AAED,UAAO;EACR;AAED,MAAI,KAEF,aAAa,IAAI,MAAM,EAAE;AAG3B,MAGE,OAAO,CAAC,IAER,QAAO;AAGT,MAAI,CAAC,YAAY;AACf,OAAI,OAAO,KAAK,SAAS,eAAe,CACtC,QAAO;AAGT,OAAI,WAAW,eAAe,CAC5B,QAAO;AAGT,OAAI,YAAY,eAAe,CAC7B,QAAO;AAGT,UAAO;EACR;AAED,MAAI,OAAO,KAAK,SAAS,WAAW,CAClC,QAAO;AAGT,MAAI,WAAW,WAAW,CACxB,QAAO;AAGT,MAAI,YAAY,WAAW,CACzB,QAAO;AAGT,SAAO;CACR,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aACE;GACF,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM;IACJ;IAAU;IAAS;GACpB;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,sBAAsB;IACtB,YAAY;KACV,QAAQ;MACN,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;KACD,KAAK;MACH,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;KACD,OAAO;MACL,OAAO,EACL,MAAM,SACP;MACD,MAAM;KACP;IACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}