eslint-plugin-jsdoc 52.0.1 → 52.0.3

package/dist/rules/matchName.cjs

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

package/dist/rules/matchName.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"matchName.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","info","lastIndex","jsdoc","report","utils","match","options","allowName","disallowName","replacement","tags","allowNameRegex","getRegexFromString","disallowNameRegex","applicableTags","includes","getPresentTags","reported","tag","tagName","name","replace","allowed","test","disallowed","hasRegex","fixer","src","source","tokens","message","reportJSDoc","undefined","matchContext","meta","docs","description","url","fixable","schema","additionalProperties","properties","items","type","comment","required","module"],"sources":["../../src/rules/matchName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// eslint-disable-next-line complexity\nexport default iterateJsdoc(({\n  context,\n  info: {\n    lastIndex,\n  },\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    match,\n  } = context.options[0] || {};\n  if (!match) {\n    report('Rule `no-restricted-syntax` is missing a `match` option.');\n\n    return;\n  }\n\n  const {\n    allowName,\n    disallowName,\n    replacement,\n    tags = [\n      '*',\n    ],\n  } = match[/** @type {import('../iterateJsdoc.js').Integer} */ (lastIndex)];\n\n  const allowNameRegex = allowName && utils.getRegexFromString(allowName);\n  const disallowNameRegex = disallowName && utils.getRegexFromString(disallowName);\n\n  let applicableTags = jsdoc.tags;\n  if (!tags.includes('*')) {\n    applicableTags = utils.getPresentTags(tags);\n  }\n\n  let reported = false;\n  for (const tag of applicableTags) {\n    const tagName = tag.name.replace(/^\\[/v, '').replace(/(=.*)?\\]$/v, '');\n    const allowed = !allowNameRegex || allowNameRegex.test(tagName);\n    const disallowed = disallowNameRegex && disallowNameRegex.test(tagName);\n    const hasRegex = allowNameRegex || disallowNameRegex;\n    if (hasRegex && allowed && !disallowed) {\n      continue;\n    }\n\n    if (!hasRegex && reported) {\n      continue;\n    }\n\n    const fixer = () => {\n      for (const src of tag.source) {\n        if (src.tokens.name) {\n          src.tokens.name = src.tokens.name.replace(\n            disallowNameRegex, replacement,\n          );\n          break;\n        }\n      }\n    };\n\n    let {\n      message,\n    } = match[/** @type {import('../iterateJsdoc.js').Integer} */ (lastIndex)];\n    if (!message) {\n      if (hasRegex) {\n        message = disallowed ?\n          `Only allowing names not matching \\`${disallowNameRegex}\\` but found \"${tagName}\".` :\n          `Only allowing names matching \\`${allowNameRegex}\\` but found \"${tagName}\".`;\n      } else {\n        message = `Prohibited context for \"${tagName}\".`;\n      }\n    }\n\n    utils.reportJSDoc(\n      message,\n      hasRegex ? tag : null,\n\n      // We could match up\n      disallowNameRegex && replacement !== undefined ?\n        fixer :\n        null,\n      false,\n      {\n        // Could also supply `context`, `comment`, `tags`\n        allowName,\n        disallowName,\n        name: tagName,\n      },\n    );\n    if (!hasRegex) {\n      reported = true;\n    }\n  }\n}, {\n  matchContext: true,\n  meta: {\n    docs: {\n      description: 'Reports the name portion of a JSDoc tag if matching or not matching a given regular expression.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          match: {\n            items: {\n              additionalProperties: false,\n              properties: {\n                allowName: {\n                  type: 'string',\n                },\n                comment: {\n                  type: 'string',\n                },\n                context: {\n                  type: 'string',\n                },\n                disallowName: {\n                  type: 'string',\n                },\n                message: {\n                  type: 'string',\n                },\n                replacement: {\n                  type: 'string',\n                },\n                tags: {\n                  items: {\n                    type: 'string',\n                  },\n                  type: 'array',\n                },\n              },\n              type: 'object',\n            },\n            type: 'array',\n          },\n        },\n        required: [\n          'match',\n        ],\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GACe,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI,EAAE;IACJC;EACF,CAAC;EACDC,KAAK;EACLC,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC;EACF,CAAC,GAAGN,OAAO,CAACO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAC5B,IAAI,CAACD,KAAK,EAAE;IACVF,MAAM,CAAC,0DAA0D,CAAC;IAElE;EACF;EAEA,MAAM;IACJI,SAAS;IACTC,YAAY;IACZC,WAAW;IACXC,IAAI,GAAG,CACL,GAAG;EAEP,CAAC,GAAGL,KAAK,EAAC,mDAAqDJ,SAAS,EAAE;EAE1E,MAAMU,cAAc,GAAGJ,SAAS,IAAIH,KAAK,CAACQ,kBAAkB,CAACL,SAAS,CAAC;EACvE,MAAMM,iBAAiB,GAAGL,YAAY,IAAIJ,KAAK,CAACQ,kBAAkB,CAACJ,YAAY,CAAC;EAEhF,IAAIM,cAAc,GAAGZ,KAAK,CAACQ,IAAI;EAC/B,IAAI,CAACA,IAAI,CAACK,QAAQ,CAAC,GAAG,CAAC,EAAE;IACvBD,cAAc,GAAGV,KAAK,CAACY,cAAc,CAACN,IAAI,CAAC;EAC7C;EAEA,IAAIO,QAAQ,GAAG,KAAK;EACpB,KAAK,MAAMC,GAAG,IAAIJ,cAAc,EAAE;IAChC,MAAMK,OAAO,GAAGD,GAAG,CAACE,IAAI,CAACC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAACA,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;IACtE,MAAMC,OAAO,GAAG,CAACX,cAAc,IAAIA,cAAc,CAACY,IAAI,CAACJ,OAAO,CAAC;IAC/D,MAAMK,UAAU,GAAGX,iBAAiB,IAAIA,iBAAiB,CAACU,IAAI,CAACJ,OAAO,CAAC;IACvE,MAAMM,QAAQ,GAAGd,cAAc,IAAIE,iBAAiB;IACpD,IAAIY,QAAQ,IAAIH,OAAO,IAAI,CAACE,UAAU,EAAE;MACtC;IACF;IAEA,IAAI,CAACC,QAAQ,IAAIR,QAAQ,EAAE;MACzB;IACF;IAEA,MAAMS,KAAK,GAAGA,CAAA,KAAM;MAClB,KAAK,MAAMC,GAAG,IAAIT,GAAG,CAACU,MAAM,EAAE;QAC5B,IAAID,GAAG,CAACE,MAAM,CAACT,IAAI,EAAE;UACnBO,GAAG,CAACE,MAAM,CAACT,IAAI,GAAGO,GAAG,CAACE,MAAM,CAACT,IAAI,CAACC,OAAO,CACvCR,iBAAiB,EAAEJ,WACrB,CAAC;UACD;QACF;MACF;IACF,CAAC;IAED,IAAI;MACFqB;IACF,CAAC,GAAGzB,KAAK,EAAC,mDAAqDJ,SAAS,EAAE;IAC1E,IAAI,CAAC6B,OAAO,EAAE;MACZ,IAAIL,QAAQ,EAAE;QACZK,OAAO,GAAGN,UAAU,GAClB,sCAAsCX,iBAAiB,iBAAiBM,OAAO,IAAI,GACnF,kCAAkCR,cAAc,iBAAiBQ,OAAO,IAAI;MAChF,CAAC,MAAM;QACLW,OAAO,GAAG,2BAA2BX,OAAO,IAAI;MAClD;IACF;IAEAf,KAAK,CAAC2B,WAAW,CACfD,OAAO,EACPL,QAAQ,GAAGP,GAAG,GAAG,IAAI;IAErB;IACAL,iBAAiB,IAAIJ,WAAW,KAAKuB,SAAS,GAC5CN,KAAK,GACL,IAAI,EACN,KAAK,EACL;MACE;MACAnB,SAAS;MACTC,YAAY;MACZY,IAAI,EAAED;IACR,CACF,CAAC;IACD,IAAI,CAACM,QAAQ,EAAE;MACbR,QAAQ,GAAG,IAAI;IACjB;EACF;AACF,CAAC,EAAE;EACDgB,YAAY,EAAE,IAAI;EAClBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,iGAAiG;MAC9GC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVpC,KAAK,EAAE;UACLqC,KAAK,EAAE;YACLF,oBAAoB,EAAE,KAAK;YAC3BC,UAAU,EAAE;cACVlC,SAAS,EAAE;gBACToC,IAAI,EAAE;cACR,CAAC;cACDC,OAAO,EAAE;gBACPD,IAAI,EAAE;cACR,CAAC;cACD5C,OAAO,EAAE;gBACP4C,IAAI,EAAE;cACR,CAAC;cACDnC,YAAY,EAAE;gBACZmC,IAAI,EAAE;cACR,CAAC;cACDb,OAAO,EAAE;gBACPa,IAAI,EAAE;cACR,CAAC;cACDlC,WAAW,EAAE;gBACXkC,IAAI,EAAE;cACR,CAAC;cACDjC,IAAI,EAAE;gBACJgC,KAAK,EAAE;kBACLC,IAAI,EAAE;gBACR,CAAC;gBACDA,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDE,QAAQ,EAAE,CACR,OAAO,CACR;MACDF,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAG,MAAA,CAAAjD,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"matchName.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/matchName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// eslint-disable-next-line complexity\nexport default iterateJsdoc(({\n  context,\n  info: {\n    lastIndex,\n  },\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    match,\n  } = context.options[0] || {};\n  if (!match) {\n    report('Rule `no-restricted-syntax` is missing a `match` option.');\n\n    return;\n  }\n\n  const {\n    allowName,\n    disallowName,\n    replacement,\n    tags = [\n      '*',\n    ],\n  } = match[/** @type {import('../iterateJsdoc.js').Integer} */ (lastIndex)];\n\n  const allowNameRegex = allowName && utils.getRegexFromString(allowName);\n  const disallowNameRegex = disallowName && utils.getRegexFromString(disallowName);\n\n  let applicableTags = jsdoc.tags;\n  if (!tags.includes('*')) {\n    applicableTags = utils.getPresentTags(tags);\n  }\n\n  let reported = false;\n  for (const tag of applicableTags) {\n    const tagName = tag.name.replace(/^\\[/v, '').replace(/(=.*)?\\]$/v, '');\n    const allowed = !allowNameRegex || allowNameRegex.test(tagName);\n    const disallowed = disallowNameRegex && disallowNameRegex.test(tagName);\n    const hasRegex = allowNameRegex || disallowNameRegex;\n    if (hasRegex && allowed && !disallowed) {\n      continue;\n    }\n\n    if (!hasRegex && reported) {\n      continue;\n    }\n\n    const fixer = () => {\n      for (const src of tag.source) {\n        if (src.tokens.name) {\n          src.tokens.name = src.tokens.name.replace(\n            disallowNameRegex, replacement,\n          );\n          break;\n        }\n      }\n    };\n\n    let {\n      message,\n    } = match[/** @type {import('../iterateJsdoc.js').Integer} */ (lastIndex)];\n    if (!message) {\n      if (hasRegex) {\n        message = disallowed ?\n          `Only allowing names not matching \\`${disallowNameRegex}\\` but found \"${tagName}\".` :\n          `Only allowing names matching \\`${allowNameRegex}\\` but found \"${tagName}\".`;\n      } else {\n        message = `Prohibited context for \"${tagName}\".`;\n      }\n    }\n\n    utils.reportJSDoc(\n      message,\n      hasRegex ? tag : null,\n\n      // We could match up\n      disallowNameRegex && replacement !== undefined ?\n        fixer :\n        null,\n      false,\n      {\n        // Could also supply `context`, `comment`, `tags`\n        allowName,\n        disallowName,\n        name: tagName,\n      },\n    );\n    if (!hasRegex) {\n      reported = true;\n    }\n  }\n}, {\n  matchContext: true,\n  meta: {\n    docs: {\n      description: 'Reports the name portion of a JSDoc tag if matching or not matching a given regular expression.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          match: {\n            items: {\n              additionalProperties: false,\n              properties: {\n                allowName: {\n                  type: 'string',\n                },\n                comment: {\n                  type: 'string',\n                },\n                context: {\n                  type: 'string',\n                },\n                disallowName: {\n                  type: 'string',\n                },\n                message: {\n                  type: 'string',\n                },\n                replacement: {\n                  type: 'string',\n                },\n                tags: {\n                  items: {\n                    type: 'string',\n                  },\n                  type: 'array',\n                },\n              },\n              type: 'object',\n            },\n            type: 'array',\n          },\n        },\n        required: [\n          'match',\n        ],\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAGA,wBAAeA,6BAAa,CAAC,EAC3B,SACA,MAAM,EACJ,WACD,EACD,OACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,OACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAC5B,KAAI,CAAC,OAAO;EACV,OAAO,2DAA2D;AAElE;CACD;CAED,MAAM,EACJ,WACA,cACA,aACA,OAAO,CACL,GACD,GACF,GAAG,MAA2D;CAE/D,MAAM,iBAAiB,aAAa,MAAM,mBAAmB,UAAU;CACvE,MAAM,oBAAoB,gBAAgB,MAAM,mBAAmB,aAAa;CAEhF,IAAI,iBAAiB,MAAM;AAC3B,KAAI,CAAC,KAAK,SAAS,IAAI,EACrB,iBAAiB,MAAM,eAAe,KAAK;CAG7C,IAAI,WAAW;AACf,MAAK,MAAM,OAAO,gBAAgB;EAChC,MAAM,UAAU,IAAI,KAAK,QAAQ,QAAQ,GAAG,CAAC,QAAQ,cAAc,GAAG;EACtE,MAAM,UAAU,CAAC,kBAAkB,eAAe,KAAK,QAAQ;EAC/D,MAAM,aAAa,qBAAqB,kBAAkB,KAAK,QAAQ;EACvE,MAAM,WAAW,kBAAkB;AACnC,MAAI,YAAY,WAAW,CAAC,WAC1B;AAGF,MAAI,CAAC,YAAY,SACf;EAGF,MAAM,QAAQ,MAAM;AAClB,QAAK,MAAM,OAAO,IAAI,OACpB,KAAI,IAAI,OAAO,MAAM;IACnB,IAAI,OAAO,OAAO,IAAI,OAAO,KAAK,QAChC,mBAAmB,YACpB;AACD;GACD;EAEJ;EAED,IAAI,EACF,SACD,GAAG,MAA2D;AAC/D,MAAI,CAAC,QACH,KAAI,UACF,UAAU,aACR,CAAC,mCAAmC,EAAE,kBAAkB,cAAc,EAAE,QAAQ,EAAE,CAAC,GACnF,CAAC,+BAA+B,EAAE,eAAe,cAAc,EAAE,QAAQ,EAAE,CAAC;OAE9E,UAAU,CAAC,wBAAwB,EAAE,QAAQ,EAAE,CAAC;EAIpD,MAAM,YACJ,SACA,WAAW,MAAM,MAGjB,qBAAqB,gBAAgB,SACnC,QACA,MACF,OACA;GAEE;GACA;GACA,MAAM;EACP,EACF;AACD,MAAI,CAAC,UACH,WAAW;CAEd;AACF,GAAE;CACD,cAAc;CACd,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,OAAO;IACL,OAAO;KACL,sBAAsB;KACtB,YAAY;MACV,WAAW,EACT,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,cAAc,EACZ,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,aAAa,EACX,MAAM,SACP;MACD,MAAM;OACJ,OAAO,EACL,MAAM,SACP;OACD,MAAM;MACP;KACF;KACD,MAAM;IACP;IACD,MAAM;GACP,EACF;GACD,UAAU,CACR,OACD;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/matchName.js

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

package/dist/rules/matchName.js.map

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