eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/matchDescription.cjs

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

package/dist/rules/matchDescription.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"matchDescription.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","matchDescriptionDefault","stringOrDefault","value","userDefault","_default","exports","iterateJsdoc","context","jsdoc","report","utils","mainDescription","matchDescription","message","nonemptyTags","tags","options","validateDescription","desc","tag","mainDescriptionMatch","errorMessage","match","Object","hasOwn","tagValue","tagName","regex","getRegexFromString","test","line","source","number","description","getDescription","hasNoTag","forEachPreferredTag","matchingJsdocTag","targetTagName","name","getTagDescription","trim","keys","length","hasOptionTag","Boolean","whitelistedTags","filterTags","tagsWithNames","tagsWithoutNames","getTagsByType","some","replace","contextDefaults","meta","docs","url","schema","additionalProperties","properties","contexts","items","anyOf","type","comment","oneOf","format","patternProperties","enum","module"],"sources":["../../src/rules/matchDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// If supporting Node >= 10, we could loosen the default to this for the\n//   initial letter: \\\\p{Upper}\nconst matchDescriptionDefault = '^\\n?([A-Z`\\\\d_][\\\\s\\\\S]*[.?!`\\\\p{RGI_Emoji}]\\\\s*)?$';\n\n/**\n * @param {string} value\n * @param {string} userDefault\n * @returns {string}\n */\nconst stringOrDefault = (value, userDefault) => {\n  return typeof value === 'string' ?\n    value :\n    userDefault || matchDescriptionDefault;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    mainDescription,\n    matchDescription,\n    message,\n    nonemptyTags = true,\n    tags = {},\n  } = context.options[0] || {};\n\n  /**\n   * @param {string} desc\n   * @param {import('comment-parser').Spec} [tag]\n   * @returns {void}\n   */\n  const validateDescription = (desc, tag) => {\n    let mainDescriptionMatch = mainDescription;\n    let errorMessage = message;\n    if (typeof mainDescription === 'object') {\n      mainDescriptionMatch = mainDescription.match;\n      errorMessage = mainDescription.message;\n    }\n\n    if (mainDescriptionMatch === false && (\n      !tag || !Object.hasOwn(tags, tag.tag))\n    ) {\n      return;\n    }\n\n    let tagValue = mainDescriptionMatch;\n    if (tag) {\n      const tagName = tag.tag;\n      if (typeof tags[tagName] === 'object') {\n        tagValue = tags[tagName].match;\n        errorMessage = tags[tagName].message;\n      } else {\n        tagValue = tags[tagName];\n      }\n    }\n\n    const regex = utils.getRegexFromString(\n      stringOrDefault(tagValue, matchDescription),\n    );\n\n    if (!regex.test(desc)) {\n      report(\n        errorMessage || 'JSDoc description does not satisfy the regex pattern.',\n        null,\n        tag || {\n          // Add one as description would typically be into block\n          line: jsdoc.source[0].number + 1,\n        },\n      );\n    }\n  };\n\n  const {\n    description,\n  } = utils.getDescription();\n  if (description) {\n    validateDescription(description);\n  }\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const hasNoTag = (tagName) => {\n    return !tags[tagName];\n  };\n\n  for (const tag of [\n    'description',\n    'summary',\n    'file',\n    'classdesc',\n  ]) {\n    utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {\n      const desc = (matchingJsdocTag.name + ' ' + utils.getTagDescription(matchingJsdocTag)).trim();\n      if (hasNoTag(targetTagName)) {\n        validateDescription(desc, matchingJsdocTag);\n      }\n    }, true);\n  }\n\n  if (nonemptyTags) {\n    for (const tag of [\n      'copyright',\n      'example',\n      'see',\n      'todo',\n    ]) {\n      utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {\n        const desc = (matchingJsdocTag.name + ' ' + utils.getTagDescription(matchingJsdocTag)).trim();\n\n        if (hasNoTag(targetTagName) && !(/.+/v).test(desc)) {\n          report(\n            'JSDoc description must not be empty.',\n            null,\n            matchingJsdocTag,\n          );\n        }\n      });\n    }\n  }\n\n  if (!Object.keys(tags).length) {\n    return;\n  }\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const hasOptionTag = (tagName) => {\n    return Boolean(tags[tagName]);\n  };\n\n  const whitelistedTags = utils.filterTags(({\n    tag: tagName,\n  }) => {\n    return hasOptionTag(tagName);\n  });\n  const {\n    tagsWithNames,\n    tagsWithoutNames,\n  } = utils.getTagsByType(whitelistedTags);\n\n  tagsWithNames.some((tag) => {\n    const desc = /** @type {string} */ (\n      utils.getTagDescription(tag)\n    ).replace(/^[\\- ]*/v, '')\n      .trim();\n\n    return validateDescription(desc, tag);\n  });\n\n  tagsWithoutNames.some((tag) => {\n    const desc = (tag.name + ' ' + utils.getTagDescription(tag)).trim();\n\n    return validateDescription(desc, tag);\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Enforces a regular expression pattern on descriptions.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          mainDescription: {\n            oneOf: [\n              {\n                format: 'regex',\n                type: 'string',\n              },\n              {\n                type: 'boolean',\n              },\n              {\n                additionalProperties: false,\n                properties: {\n                  match: {\n                    oneOf: [\n                      {\n                        format: 'regex',\n                        type: 'string',\n                      },\n                      {\n                        type: 'boolean',\n                      },\n                    ],\n                  },\n                  message: {\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n            ],\n          },\n          matchDescription: {\n            format: 'regex',\n            type: 'string',\n          },\n          message: {\n            type: 'string',\n          },\n          nonemptyTags: {\n            type: 'boolean',\n          },\n          tags: {\n            patternProperties: {\n              '.*': {\n                oneOf: [\n                  {\n                    format: 'regex',\n                    type: 'string',\n                  },\n                  {\n                    enum: [\n                      true,\n                    ],\n                    type: 'boolean',\n                  },\n                  {\n                    additionalProperties: false,\n                    properties: {\n                      match: {\n                        oneOf: [\n                          {\n                            format: 'regex',\n                            type: 'string',\n                          },\n                          {\n                            enum: [\n                              true,\n                            ],\n                            type: 'boolean',\n                          },\n                        ],\n                      },\n                      message: {\n                        type: 'string',\n                      },\n                    },\n                    type: 'object',\n                  },\n                ],\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA,MAAMG,uBAAuB,GAAG,qDAAqD;;AAErF;AACA;AACA;AACA;AACA;AACA,MAAMC,eAAe,GAAGA,CAACC,KAAK,EAAEC,WAAW,KAAK;EAC9C,OAAO,OAAOD,KAAK,KAAK,QAAQ,GAC9BA,KAAK,GACLC,WAAW,IAAIH,uBAAuB;AAC1C,CAAC;AAAC,IAAAI,QAAA,GAAAC,OAAA,CAAAN,OAAA,GAEa,IAAAO,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,eAAe;IACfC,gBAAgB;IAChBC,OAAO;IACPC,YAAY,GAAG,IAAI;IACnBC,IAAI,GAAG,CAAC;EACV,CAAC,GAAGR,OAAO,CAACS,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;AACA;AACA;EACE,MAAMC,mBAAmB,GAAGA,CAACC,IAAI,EAAEC,GAAG,KAAK;IACzC,IAAIC,oBAAoB,GAAGT,eAAe;IAC1C,IAAIU,YAAY,GAAGR,OAAO;IAC1B,IAAI,OAAOF,eAAe,KAAK,QAAQ,EAAE;MACvCS,oBAAoB,GAAGT,eAAe,CAACW,KAAK;MAC5CD,YAAY,GAAGV,eAAe,CAACE,OAAO;IACxC;IAEA,IAAIO,oBAAoB,KAAK,KAAK,KAChC,CAACD,GAAG,IAAI,CAACI,MAAM,CAACC,MAAM,CAACT,IAAI,EAAEI,GAAG,CAACA,GAAG,CAAC,CAAC,EACtC;MACA;IACF;IAEA,IAAIM,QAAQ,GAAGL,oBAAoB;IACnC,IAAID,GAAG,EAAE;MACP,MAAMO,OAAO,GAAGP,GAAG,CAACA,GAAG;MACvB,IAAI,OAAOJ,IAAI,CAACW,OAAO,CAAC,KAAK,QAAQ,EAAE;QACrCD,QAAQ,GAAGV,IAAI,CAACW,OAAO,CAAC,CAACJ,KAAK;QAC9BD,YAAY,GAAGN,IAAI,CAACW,OAAO,CAAC,CAACb,OAAO;MACtC,CAAC,MAAM;QACLY,QAAQ,GAAGV,IAAI,CAACW,OAAO,CAAC;MAC1B;IACF;IAEA,MAAMC,KAAK,GAAGjB,KAAK,CAACkB,kBAAkB,CACpC3B,eAAe,CAACwB,QAAQ,EAAEb,gBAAgB,CAC5C,CAAC;IAED,IAAI,CAACe,KAAK,CAACE,IAAI,CAACX,IAAI,CAAC,EAAE;MACrBT,MAAM,CACJY,YAAY,IAAI,uDAAuD,EACvE,IAAI,EACJF,GAAG,IAAI;QACL;QACAW,IAAI,EAAEtB,KAAK,CAACuB,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM,GAAG;MACjC,CACF,CAAC;IACH;EACF,CAAC;EAED,MAAM;IACJC;EACF,CAAC,GAAGvB,KAAK,CAACwB,cAAc,CAAC,CAAC;EAC1B,IAAID,WAAW,EAAE;IACfhB,mBAAmB,CAACgB,WAAW,CAAC;EAClC;;EAEA;AACF;AACA;AACA;EACE,MAAME,QAAQ,GAAIT,OAAO,IAAK;IAC5B,OAAO,CAACX,IAAI,CAACW,OAAO,CAAC;EACvB,CAAC;EAED,KAAK,MAAMP,GAAG,IAAI,CAChB,aAAa,EACb,SAAS,EACT,MAAM,EACN,WAAW,CACZ,EAAE;IACDT,KAAK,CAAC0B,mBAAmB,CAACjB,GAAG,EAAE,CAACkB,gBAAgB,EAAEC,aAAa,KAAK;MAClE,MAAMpB,IAAI,GAAG,CAACmB,gBAAgB,CAACE,IAAI,GAAG,GAAG,GAAG7B,KAAK,CAAC8B,iBAAiB,CAACH,gBAAgB,CAAC,EAAEI,IAAI,CAAC,CAAC;MAC7F,IAAIN,QAAQ,CAACG,aAAa,CAAC,EAAE;QAC3BrB,mBAAmB,CAACC,IAAI,EAAEmB,gBAAgB,CAAC;MAC7C;IACF,CAAC,EAAE,IAAI,CAAC;EACV;EAEA,IAAIvB,YAAY,EAAE;IAChB,KAAK,MAAMK,GAAG,IAAI,CAChB,WAAW,EACX,SAAS,EACT,KAAK,EACL,MAAM,CACP,EAAE;MACDT,KAAK,CAAC0B,mBAAmB,CAACjB,GAAG,EAAE,CAACkB,gBAAgB,EAAEC,aAAa,KAAK;QAClE,MAAMpB,IAAI,GAAG,CAACmB,gBAAgB,CAACE,IAAI,GAAG,GAAG,GAAG7B,KAAK,CAAC8B,iBAAiB,CAACH,gBAAgB,CAAC,EAAEI,IAAI,CAAC,CAAC;QAE7F,IAAIN,QAAQ,CAACG,aAAa,CAAC,IAAI,CAAE,KAAK,CAAET,IAAI,CAACX,IAAI,CAAC,EAAE;UAClDT,MAAM,CACJ,sCAAsC,EACtC,IAAI,EACJ4B,gBACF,CAAC;QACH;MACF,CAAC,CAAC;IACJ;EACF;EAEA,IAAI,CAACd,MAAM,CAACmB,IAAI,CAAC3B,IAAI,CAAC,CAAC4B,MAAM,EAAE;IAC7B;EACF;;EAEA;AACF;AACA;AACA;EACE,MAAMC,YAAY,GAAIlB,OAAO,IAAK;IAChC,OAAOmB,OAAO,CAAC9B,IAAI,CAACW,OAAO,CAAC,CAAC;EAC/B,CAAC;EAED,MAAMoB,eAAe,GAAGpC,KAAK,CAACqC,UAAU,CAAC,CAAC;IACxC5B,GAAG,EAAEO;EACP,CAAC,KAAK;IACJ,OAAOkB,YAAY,CAAClB,OAAO,CAAC;EAC9B,CAAC,CAAC;EACF,MAAM;IACJsB,aAAa;IACbC;EACF,CAAC,GAAGvC,KAAK,CAACwC,aAAa,CAACJ,eAAe,CAAC;EAExCE,aAAa,CAACG,IAAI,CAAEhC,GAAG,IAAK;IAC1B,MAAMD,IAAI,GAAG,qBACXR,KAAK,CAAC8B,iBAAiB,CAACrB,GAAG,CAAC,CAC5BiC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CACtBX,IAAI,CAAC,CAAC;IAET,OAAOxB,mBAAmB,CAACC,IAAI,EAAEC,GAAG,CAAC;EACvC,CAAC,CAAC;EAEF8B,gBAAgB,CAACE,IAAI,CAAEhC,GAAG,IAAK;IAC7B,MAAMD,IAAI,GAAG,CAACC,GAAG,CAACoB,IAAI,GAAG,GAAG,GAAG7B,KAAK,CAAC8B,iBAAiB,CAACrB,GAAG,CAAC,EAAEsB,IAAI,CAAC,CAAC;IAEnE,OAAOxB,mBAAmB,CAACC,IAAI,EAAEC,GAAG,CAAC;EACvC,CAAC,CAAC;AACJ,CAAC,EAAE;EACDkC,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJtB,WAAW,EAAE,wDAAwD;MACrEuB,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEC,IAAI,EAAE;YACR,CAAC,EACD;cACEL,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVK,OAAO,EAAE;kBACPD,IAAI,EAAE;gBACR,CAAC;gBACDxD,OAAO,EAAE;kBACPwD,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDpD,eAAe,EAAE;UACfsD,KAAK,EAAE,CACL;YACEC,MAAM,EAAE,OAAO;YACfH,IAAI,EAAE;UACR,CAAC,EACD;YACEA,IAAI,EAAE;UACR,CAAC,EACD;YACEL,oBAAoB,EAAE,KAAK;YAC3BC,UAAU,EAAE;cACVrC,KAAK,EAAE;gBACL2C,KAAK,EAAE,CACL;kBACEC,MAAM,EAAE,OAAO;kBACfH,IAAI,EAAE;gBACR,CAAC,EACD;kBACEA,IAAI,EAAE;gBACR,CAAC;cAEL,CAAC;cACDlD,OAAO,EAAE;gBACPkD,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;QAEL,CAAC;QACDnD,gBAAgB,EAAE;UAChBsD,MAAM,EAAE,OAAO;UACfH,IAAI,EAAE;QACR,CAAC;QACDlD,OAAO,EAAE;UACPkD,IAAI,EAAE;QACR,CAAC;QACDjD,YAAY,EAAE;UACZiD,IAAI,EAAE;QACR,CAAC;QACDhD,IAAI,EAAE;UACJoD,iBAAiB,EAAE;YACjB,IAAI,EAAE;cACJF,KAAK,EAAE,CACL;gBACEC,MAAM,EAAE,OAAO;gBACfH,IAAI,EAAE;cACR,CAAC,EACD;gBACEK,IAAI,EAAE,CACJ,IAAI,CACL;gBACDL,IAAI,EAAE;cACR,CAAC,EACD;gBACEL,oBAAoB,EAAE,KAAK;gBAC3BC,UAAU,EAAE;kBACVrC,KAAK,EAAE;oBACL2C,KAAK,EAAE,CACL;sBACEC,MAAM,EAAE,OAAO;sBACfH,IAAI,EAAE;oBACR,CAAC,EACD;sBACEK,IAAI,EAAE,CACJ,IAAI,CACL;sBACDL,IAAI,EAAE;oBACR,CAAC;kBAEL,CAAC;kBACDlD,OAAO,EAAE;oBACPkD,IAAI,EAAE;kBACR;gBACF,CAAC;gBACDA,IAAI,EAAE;cACR,CAAC;YAEL;UACF,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAM,MAAA,CAAAhE,OAAA,GAAAA,OAAA,CAAAN,OAAA","ignoreList":[]}
+{"version":3,"file":"matchDescription.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/matchDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// If supporting Node >= 10, we could loosen the default to this for the\n//   initial letter: \\\\p{Upper}\nconst matchDescriptionDefault = '^\\n?([A-Z`\\\\d_][\\\\s\\\\S]*[.?!`\\\\p{RGI_Emoji}]\\\\s*)?$';\n\n/**\n * @param {string} value\n * @param {string} userDefault\n * @returns {string}\n */\nconst stringOrDefault = (value, userDefault) => {\n  return typeof value === 'string' ?\n    value :\n    userDefault || matchDescriptionDefault;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    mainDescription,\n    matchDescription,\n    message,\n    nonemptyTags = true,\n    tags = {},\n  } = context.options[0] || {};\n\n  /**\n   * @param {string} desc\n   * @param {import('comment-parser').Spec} [tag]\n   * @returns {void}\n   */\n  const validateDescription = (desc, tag) => {\n    let mainDescriptionMatch = mainDescription;\n    let errorMessage = message;\n    if (typeof mainDescription === 'object') {\n      mainDescriptionMatch = mainDescription.match;\n      errorMessage = mainDescription.message;\n    }\n\n    if (mainDescriptionMatch === false && (\n      !tag || !Object.hasOwn(tags, tag.tag))\n    ) {\n      return;\n    }\n\n    let tagValue = mainDescriptionMatch;\n    if (tag) {\n      const tagName = tag.tag;\n      if (typeof tags[tagName] === 'object') {\n        tagValue = tags[tagName].match;\n        errorMessage = tags[tagName].message;\n      } else {\n        tagValue = tags[tagName];\n      }\n    }\n\n    const regex = utils.getRegexFromString(\n      stringOrDefault(tagValue, matchDescription),\n    );\n\n    if (!regex.test(desc)) {\n      report(\n        errorMessage || 'JSDoc description does not satisfy the regex pattern.',\n        null,\n        tag || {\n          // Add one as description would typically be into block\n          line: jsdoc.source[0].number + 1,\n        },\n      );\n    }\n  };\n\n  const {\n    description,\n  } = utils.getDescription();\n  if (description) {\n    validateDescription(description);\n  }\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const hasNoTag = (tagName) => {\n    return !tags[tagName];\n  };\n\n  for (const tag of [\n    'description',\n    'summary',\n    'file',\n    'classdesc',\n  ]) {\n    utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {\n      const desc = (matchingJsdocTag.name + ' ' + utils.getTagDescription(matchingJsdocTag)).trim();\n      if (hasNoTag(targetTagName)) {\n        validateDescription(desc, matchingJsdocTag);\n      }\n    }, true);\n  }\n\n  if (nonemptyTags) {\n    for (const tag of [\n      'copyright',\n      'example',\n      'see',\n      'todo',\n    ]) {\n      utils.forEachPreferredTag(tag, (matchingJsdocTag, targetTagName) => {\n        const desc = (matchingJsdocTag.name + ' ' + utils.getTagDescription(matchingJsdocTag)).trim();\n\n        if (hasNoTag(targetTagName) && !(/.+/v).test(desc)) {\n          report(\n            'JSDoc description must not be empty.',\n            null,\n            matchingJsdocTag,\n          );\n        }\n      });\n    }\n  }\n\n  if (!Object.keys(tags).length) {\n    return;\n  }\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const hasOptionTag = (tagName) => {\n    return Boolean(tags[tagName]);\n  };\n\n  const whitelistedTags = utils.filterTags(({\n    tag: tagName,\n  }) => {\n    return hasOptionTag(tagName);\n  });\n  const {\n    tagsWithNames,\n    tagsWithoutNames,\n  } = utils.getTagsByType(whitelistedTags);\n\n  tagsWithNames.some((tag) => {\n    const desc = /** @type {string} */ (\n      utils.getTagDescription(tag)\n    ).replace(/^[\\- ]*/v, '')\n      .trim();\n\n    return validateDescription(desc, tag);\n  });\n\n  tagsWithoutNames.some((tag) => {\n    const desc = (tag.name + ' ' + utils.getTagDescription(tag)).trim();\n\n    return validateDescription(desc, tag);\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Enforces a regular expression pattern on descriptions.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          mainDescription: {\n            oneOf: [\n              {\n                format: 'regex',\n                type: 'string',\n              },\n              {\n                type: 'boolean',\n              },\n              {\n                additionalProperties: false,\n                properties: {\n                  match: {\n                    oneOf: [\n                      {\n                        format: 'regex',\n                        type: 'string',\n                      },\n                      {\n                        type: 'boolean',\n                      },\n                    ],\n                  },\n                  message: {\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n            ],\n          },\n          matchDescription: {\n            format: 'regex',\n            type: 'string',\n          },\n          message: {\n            type: 'string',\n          },\n          nonemptyTags: {\n            type: 'boolean',\n          },\n          tags: {\n            patternProperties: {\n              '.*': {\n                oneOf: [\n                  {\n                    format: 'regex',\n                    type: 'string',\n                  },\n                  {\n                    enum: [\n                      true,\n                    ],\n                    type: 'boolean',\n                  },\n                  {\n                    additionalProperties: false,\n                    properties: {\n                      match: {\n                        oneOf: [\n                          {\n                            format: 'regex',\n                            type: 'string',\n                          },\n                          {\n                            enum: [\n                              true,\n                            ],\n                            type: 'boolean',\n                          },\n                        ],\n                      },\n                      message: {\n                        type: 'string',\n                      },\n                    },\n                    type: 'object',\n                  },\n                ],\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAIA,MAAM,0BAA0B;;;;;;AAOhC,MAAM,kBAAkB,CAAC,OAAO,gBAAgB;AAC9C,QAAO,OAAO,UAAU,WACtB,QACA,eAAe;AAClB;AAED,+BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,iBACA,kBACA,SACA,eAAe,MACf,OAAO,CAAE,GACV,GAAG,QAAQ,QAAQ,MAAM,CAAE;;;;;;CAO5B,MAAM,sBAAsB,CAAC,MAAM,QAAQ;EACzC,IAAI,uBAAuB;EAC3B,IAAI,eAAe;AACnB,MAAI,OAAO,oBAAoB,UAAU;GACvC,uBAAuB,gBAAgB;GACvC,eAAe,gBAAgB;EAChC;AAED,MAAI,yBAAyB,UAC3B,CAAC,OAAO,CAAC,OAAO,OAAO,MAAM,IAAI,IAAI,EAErC;EAGF,IAAI,WAAW;AACf,MAAI,KAAK;GACP,MAAM,UAAU,IAAI;AACpB,OAAI,OAAO,KAAK,aAAa,UAAU;IACrC,WAAW,KAAK,SAAS;IACzB,eAAe,KAAK,SAAS;GAC9B,OACC,WAAW,KAAK;EAEnB;EAED,MAAM,QAAQ,MAAM,mBAClB,gBAAgB,UAAU,iBAAiB,CAC5C;AAED,MAAI,CAAC,MAAM,KAAK,KAAK,EACnB,OACE,gBAAgB,yDAChB,MACA,OAAO,EAEL,MAAM,MAAM,OAAO,GAAG,SAAS,EAChC,EACF;CAEJ;CAED,MAAM,EACJ,aACD,GAAG,MAAM,gBAAgB;AAC1B,KAAI,aACF,oBAAoB,YAAY;;;;;CAOlC,MAAM,WAAW,CAAC,YAAY;AAC5B,SAAO,CAAC,KAAK;CACd;AAED,MAAK,MAAM,OAAO;EAChB;EACA;EACA;EACA;CACD,GACC,MAAM,oBAAoB,KAAK,CAAC,kBAAkB,kBAAkB;EAClE,MAAM,QAAQ,iBAAiB,OAAO,MAAM,MAAM,kBAAkB,iBAAiB,EAAE,MAAM;AAC7F,MAAI,SAAS,cAAc,EACzB,oBAAoB,MAAM,iBAAiB;CAE9C,GAAE,KAAK;AAGV,KAAI,aACF,MAAK,MAAM,OAAO;EAChB;EACA;EACA;EACA;CACD,GACC,MAAM,oBAAoB,KAAK,CAAC,kBAAkB,kBAAkB;EAClE,MAAM,QAAQ,iBAAiB,OAAO,MAAM,MAAM,kBAAkB,iBAAiB,EAAE,MAAM;AAE7F,MAAI,SAAS,cAAc,IAAI,CAAE,MAAO,KAAK,KAAK,EAChD,OACE,wCACA,MACA,iBACD;CAEJ,EAAC;AAIN,KAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OACrB;;;;;CAOF,MAAM,eAAe,CAAC,YAAY;AAChC,SAAO,QAAQ,KAAK,SAAS;CAC9B;CAED,MAAM,kBAAkB,MAAM,WAAW,CAAC,EACxC,KAAK,SACN,KAAK;AACJ,SAAO,aAAa,QAAQ;CAC7B,EAAC;CACF,MAAM,EACJ,eACA,kBACD,GAAG,MAAM,cAAc,gBAAgB;CAExC,cAAc,KAAK,CAAC,QAAQ;EAC1B,MAAM,OACJ,MAAM,kBAAkB,IAAI,CAC5B,QAAQ,YAAY,GAAG,CACtB,MAAM;AAET,SAAO,oBAAoB,MAAM,IAAI;CACtC,EAAC;CAEF,iBAAiB,KAAK,CAAC,QAAQ;EAC7B,MAAM,QAAQ,IAAI,OAAO,MAAM,MAAM,kBAAkB,IAAI,EAAE,MAAM;AAEnE,SAAO,oBAAoB,MAAM,IAAI;CACtC,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,iBAAiB,EACf,OAAO;KACL;MACE,QAAQ;MACR,MAAM;KACP;KACD,EACE,MAAM,UACP;KACD;MACE,sBAAsB;MACtB,YAAY;OACV,OAAO,EACL,OAAO,CACL;QACE,QAAQ;QACR,MAAM;OACP,GACD,EACE,MAAM,UACP,CACF,EACF;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP;IACF,EACF;IACD,kBAAkB;KAChB,QAAQ;KACR,MAAM;IACP;IACD,SAAS,EACP,MAAM,SACP;IACD,cAAc,EACZ,MAAM,UACP;IACD,MAAM;KACJ,mBAAmB,EACjB,MAAM,EACJ,OAAO;MACL;OACE,QAAQ;OACR,MAAM;MACP;MACD;OACE,MAAM,CACJ,IACD;OACD,MAAM;MACP;MACD;OACE,sBAAsB;OACtB,YAAY;QACV,OAAO,EACL,OAAO,CACL;SACE,QAAQ;SACR,MAAM;QACP,GACD;SACE,MAAM,CACJ,IACD;SACD,MAAM;QACP,CACF,EACF;QACD,SAAS,EACP,MAAM,SACP;OACF;OACD,MAAM;MACP;KACF,EACF,EACF;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/matchDescription.js

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

package/dist/rules/matchDescription.js.map

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