eslint-plugin-jsdoc 52.0.4 → 53.0.1

package/dist/rules/requireDescription.cjs

@@ -1,135 +1,95 @@
-"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 }; }
+//#region src/rules/requireDescription.js
 /**
- * @param {string} description
- * @returns {import('../iterateJsdoc.js').Integer}
- */
-const checkDescription = description => {
-  return description.trim().split('\n').filter(Boolean).length;
+* @param {string} description
+* @returns {import('../iterateJsdoc.js').Integer}
+*/
+const checkDescription = (description) => {
+	return description.trim().split("\n").filter(Boolean).length;
 };
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  report,
-  utils
-}) => {
-  if (utils.avoidDocs()) {
-    return;
-  }
-  const {
-    descriptionStyle = 'body'
-  } = context.options[0] || {};
-  let targetTagName = utils.getPreferredTagName({
-    // We skip reporting except when `@description` is essential to the rule,
-    //  so user can block the tag and still meaningfully use this rule
-    //  even if the tag is present (and `check-tag-names` is the one to
-    //  normally report the fact that it is blocked but present)
-    skipReportingBlockedTag: descriptionStyle !== 'tag',
-    tagName: 'description'
-  });
-  if (!targetTagName) {
-    return;
-  }
-  const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;
-  if (isBlocked) {
-    targetTagName = /** @type {{blocked: true; tagName: string;}} */targetTagName.tagName;
-  }
-  if (descriptionStyle !== 'tag') {
-    const {
-      description
-    } = utils.getDescription();
-    if (checkDescription(description || '')) {
-      return;
-    }
-    if (descriptionStyle === 'body') {
-      const descTags = utils.getPresentTags(['desc', 'description']);
-      if (descTags.length) {
-        const [{
-          tag: tagName
-        }] = descTags;
-        report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);
-      } else {
-        report('Missing JSDoc block description.');
-      }
-      return;
-    }
-  }
-  const functionExamples = isBlocked ? [] : jsdoc.tags.filter(({
-    tag
-  }) => {
-    return tag === targetTagName;
-  });
-  if (!functionExamples.length) {
-    report(descriptionStyle === 'any' ? `Missing JSDoc block description or @${targetTagName} declaration.` : `Missing JSDoc @${targetTagName} declaration.`);
-    return;
-  }
-  for (const example of functionExamples) {
-    if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {
-      report(`Missing JSDoc @${targetTagName} description.`, null, example);
-    }
-  }
+var requireDescription_default = require_iterateJsdoc.default(({ context, jsdoc, report, utils }) => {
+	if (utils.avoidDocs()) return;
+	const { descriptionStyle = "body" } = context.options[0] || {};
+	let targetTagName = utils.getPreferredTagName({
+		skipReportingBlockedTag: descriptionStyle !== "tag",
+		tagName: "description"
+	});
+	if (!targetTagName) return;
+	const isBlocked = typeof targetTagName === "object" && "blocked" in targetTagName && targetTagName.blocked;
+	if (isBlocked) targetTagName = targetTagName.tagName;
+	if (descriptionStyle !== "tag") {
+		const { description } = utils.getDescription();
+		if (checkDescription(description || "")) return;
+		if (descriptionStyle === "body") {
+			const descTags = utils.getPresentTags(["desc", "description"]);
+			if (descTags.length) {
+				const [{ tag: tagName }] = descTags;
+				report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);
+			} else report("Missing JSDoc block description.");
+			return;
+		}
+	}
+	const functionExamples = isBlocked ? [] : jsdoc.tags.filter(({ tag }) => {
+		return tag === targetTagName;
+	});
+	if (!functionExamples.length) {
+		report(descriptionStyle === "any" ? `Missing JSDoc block description or @${targetTagName} declaration.` : `Missing JSDoc @${targetTagName} declaration.`);
+		return;
+	}
+	for (const example of functionExamples) if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) report(`Missing JSDoc @${targetTagName} description.`, null, example);
 }, {
-  contextDefaults: true,
-  meta: {
-    docs: {
-      description: 'Requires that all functions have a description.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        checkConstructors: {
-          default: true,
-          type: 'boolean'
-        },
-        checkGetters: {
-          default: true,
-          type: 'boolean'
-        },
-        checkSetters: {
-          default: true,
-          type: 'boolean'
-        },
-        contexts: {
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              additionalProperties: false,
-              properties: {
-                comment: {
-                  type: 'string'
-                },
-                context: {
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            }]
-          },
-          type: 'array'
-        },
-        descriptionStyle: {
-          enum: ['body', 'tag', 'any'],
-          type: 'string'
-        },
-        exemptedBy: {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
+	contextDefaults: true,
+	meta: {
+		docs: {
+			description: "Requires that all functions have a description.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				checkConstructors: {
+					default: true,
+					type: "boolean"
+				},
+				checkGetters: {
+					default: true,
+					type: "boolean"
+				},
+				checkSetters: {
+					default: true,
+					type: "boolean"
+				},
+				contexts: {
+					items: { anyOf: [{ type: "string" }, {
+						additionalProperties: false,
+						properties: {
+							comment: { type: "string" },
+							context: { type: "string" }
+						},
+						type: "object"
+					}] },
+					type: "array"
+				},
+				descriptionStyle: {
+					enum: [
+						"body",
+						"tag",
+						"any"
+					],
+					type: "string"
+				},
+				exemptedBy: {
+					items: { type: "string" },
+					type: "array"
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireDescription_default;
 //# sourceMappingURL=requireDescription.cjs.map

package/dist/rules/requireDescription.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireDescription.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","checkDescription","description","trim","split","filter","Boolean","length","_default","exports","iterateJsdoc","context","jsdoc","report","utils","avoidDocs","descriptionStyle","options","targetTagName","getPreferredTagName","skipReportingBlockedTag","tagName","isBlocked","blocked","getDescription","descTags","getPresentTags","tag","functionExamples","tags","example","name","getTagDescription","contextDefaults","meta","docs","url","schema","additionalProperties","properties","checkConstructors","type","checkGetters","checkSetters","contexts","items","anyOf","comment","enum","exemptedBy","module"],"sources":["../../src/rules/requireDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} description\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst checkDescription = (description) => {\n  return description\n    .trim()\n    .split('\\n')\n    .filter(Boolean)\n    .length;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  const {\n    descriptionStyle = 'body',\n  } = context.options[0] || {};\n\n  let targetTagName = utils.getPreferredTagName({\n    // We skip reporting except when `@description` is essential to the rule,\n    //  so user can block the tag and still meaningfully use this rule\n    //  even if the tag is present (and `check-tag-names` is the one to\n    //  normally report the fact that it is blocked but present)\n    skipReportingBlockedTag: descriptionStyle !== 'tag',\n    tagName: 'description',\n  });\n  if (!targetTagName) {\n    return;\n  }\n\n  const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;\n  if (isBlocked) {\n    targetTagName = /** @type {{blocked: true; tagName: string;}} */ (\n      targetTagName\n    ).tagName;\n  }\n\n  if (descriptionStyle !== 'tag') {\n    const {\n      description,\n    } = utils.getDescription();\n    if (checkDescription(description || '')) {\n      return;\n    }\n\n    if (descriptionStyle === 'body') {\n      const descTags = utils.getPresentTags([\n        'desc', 'description',\n      ]);\n      if (descTags.length) {\n        const [\n          {\n            tag: tagName,\n          },\n        ] = descTags;\n        report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);\n      } else {\n        report('Missing JSDoc block description.');\n      }\n\n      return;\n    }\n  }\n\n  const functionExamples = isBlocked ?\n    [] :\n    jsdoc.tags.filter(({\n      tag,\n    }) => {\n      return tag === targetTagName;\n    });\n\n  if (!functionExamples.length) {\n    report(\n      descriptionStyle === 'any' ?\n        `Missing JSDoc block description or @${targetTagName} declaration.` :\n        `Missing JSDoc @${targetTagName} declaration.`,\n    );\n\n    return;\n  }\n\n  for (const example of functionExamples) {\n    if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, example);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all functions have a description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: true,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: true,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          descriptionStyle: {\n            enum: [\n              'body', 'tag', 'any',\n            ],\n            type: 'string',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\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;AACA;AACA,MAAMG,gBAAgB,GAAIC,WAAW,IAAK;EACxC,OAAOA,WAAW,CACfC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAAC,CACXC,MAAM,CAACC,OAAO,CAAC,CACfC,MAAM;AACX,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAT,OAAA,GAEa,IAAAU,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,IAAIA,KAAK,CAACC,SAAS,CAAC,CAAC,EAAE;IACrB;EACF;EAEA,MAAM;IACJC,gBAAgB,GAAG;EACrB,CAAC,GAAGL,OAAO,CAACM,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAIC,aAAa,GAAGJ,KAAK,CAACK,mBAAmB,CAAC;IAC5C;IACA;IACA;IACA;IACAC,uBAAuB,EAAEJ,gBAAgB,KAAK,KAAK;IACnDK,OAAO,EAAE;EACX,CAAC,CAAC;EACF,IAAI,CAACH,aAAa,EAAE;IAClB;EACF;EAEA,MAAMI,SAAS,GAAG,OAAOJ,aAAa,KAAK,QAAQ,IAAI,SAAS,IAAIA,aAAa,IAAIA,aAAa,CAACK,OAAO;EAC1G,IAAID,SAAS,EAAE;IACbJ,aAAa,GAAG,gDACdA,aAAa,CACbG,OAAO;EACX;EAEA,IAAIL,gBAAgB,KAAK,KAAK,EAAE;IAC9B,MAAM;MACJd;IACF,CAAC,GAAGY,KAAK,CAACU,cAAc,CAAC,CAAC;IAC1B,IAAIvB,gBAAgB,CAACC,WAAW,IAAI,EAAE,CAAC,EAAE;MACvC;IACF;IAEA,IAAIc,gBAAgB,KAAK,MAAM,EAAE;MAC/B,MAAMS,QAAQ,GAAGX,KAAK,CAACY,cAAc,CAAC,CACpC,MAAM,EAAE,aAAa,CACtB,CAAC;MACF,IAAID,QAAQ,CAAClB,MAAM,EAAE;QACnB,MAAM,CACJ;UACEoB,GAAG,EAAEN;QACP,CAAC,CACF,GAAGI,QAAQ;QACZZ,MAAM,CAAC,eAAeQ,OAAO,yFAAyFA,OAAO,QAAQ,CAAC;MACxI,CAAC,MAAM;QACLR,MAAM,CAAC,kCAAkC,CAAC;MAC5C;MAEA;IACF;EACF;EAEA,MAAMe,gBAAgB,GAAGN,SAAS,GAChC,EAAE,GACFV,KAAK,CAACiB,IAAI,CAACxB,MAAM,CAAC,CAAC;IACjBsB;EACF,CAAC,KAAK;IACJ,OAAOA,GAAG,KAAKT,aAAa;EAC9B,CAAC,CAAC;EAEJ,IAAI,CAACU,gBAAgB,CAACrB,MAAM,EAAE;IAC5BM,MAAM,CACJG,gBAAgB,KAAK,KAAK,GACxB,uCAAuCE,aAAa,eAAe,GACnE,kBAAkBA,aAAa,eACnC,CAAC;IAED;EACF;EAEA,KAAK,MAAMY,OAAO,IAAIF,gBAAgB,EAAE;IACtC,IAAI,CAAC3B,gBAAgB,CAAC,GAAG6B,OAAO,CAACC,IAAI,IAAIjB,KAAK,CAACkB,iBAAiB,CAACF,OAAO,CAAC,EAAE,CAAC,EAAE;MAC5EjB,MAAM,CAAC,kBAAkBK,aAAa,eAAe,EAAE,IAAI,EAAEY,OAAO,CAAC;IACvE;EACF;AACF,CAAC,EAAE;EACDG,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJjC,WAAW,EAAE,iDAAiD;MAC9DkC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,iBAAiB,EAAE;UACjBxC,OAAO,EAAE,IAAI;UACbyC,IAAI,EAAE;QACR,CAAC;QACDC,YAAY,EAAE;UACZ1C,OAAO,EAAE,IAAI;UACbyC,IAAI,EAAE;QACR,CAAC;QACDE,YAAY,EAAE;UACZ3C,OAAO,EAAE,IAAI;UACbyC,IAAI,EAAE;QACR,CAAC;QACDG,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEL,IAAI,EAAE;YACR,CAAC,EACD;cACEH,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVQ,OAAO,EAAE;kBACPN,IAAI,EAAE;gBACR,CAAC;gBACD9B,OAAO,EAAE;kBACP8B,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDzB,gBAAgB,EAAE;UAChBgC,IAAI,EAAE,CACJ,MAAM,EAAE,KAAK,EAAE,KAAK,CACrB;UACDP,IAAI,EAAE;QACR,CAAC;QACDQ,UAAU,EAAE;UACVJ,KAAK,EAAE;YACLJ,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAS,MAAA,CAAAzC,OAAA,GAAAA,OAAA,CAAAT,OAAA","ignoreList":[]}
+{"version":3,"file":"requireDescription.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} description\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst checkDescription = (description) => {\n  return description\n    .trim()\n    .split('\\n')\n    .filter(Boolean)\n    .length;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  const {\n    descriptionStyle = 'body',\n  } = context.options[0] || {};\n\n  let targetTagName = utils.getPreferredTagName({\n    // We skip reporting except when `@description` is essential to the rule,\n    //  so user can block the tag and still meaningfully use this rule\n    //  even if the tag is present (and `check-tag-names` is the one to\n    //  normally report the fact that it is blocked but present)\n    skipReportingBlockedTag: descriptionStyle !== 'tag',\n    tagName: 'description',\n  });\n  if (!targetTagName) {\n    return;\n  }\n\n  const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;\n  if (isBlocked) {\n    targetTagName = /** @type {{blocked: true; tagName: string;}} */ (\n      targetTagName\n    ).tagName;\n  }\n\n  if (descriptionStyle !== 'tag') {\n    const {\n      description,\n    } = utils.getDescription();\n    if (checkDescription(description || '')) {\n      return;\n    }\n\n    if (descriptionStyle === 'body') {\n      const descTags = utils.getPresentTags([\n        'desc', 'description',\n      ]);\n      if (descTags.length) {\n        const [\n          {\n            tag: tagName,\n          },\n        ] = descTags;\n        report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);\n      } else {\n        report('Missing JSDoc block description.');\n      }\n\n      return;\n    }\n  }\n\n  const functionExamples = isBlocked ?\n    [] :\n    jsdoc.tags.filter(({\n      tag,\n    }) => {\n      return tag === targetTagName;\n    });\n\n  if (!functionExamples.length) {\n    report(\n      descriptionStyle === 'any' ?\n        `Missing JSDoc block description or @${targetTagName} declaration.` :\n        `Missing JSDoc @${targetTagName} declaration.`,\n    );\n\n    return;\n  }\n\n  for (const example of functionExamples) {\n    if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, example);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all functions have a description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: true,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: true,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          descriptionStyle: {\n            enum: [\n              'body', 'tag', 'any',\n            ],\n            type: 'string',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;AAMA,MAAM,mBAAmB,CAAC,gBAAgB;AACxC,QAAO,YACJ,MAAM,CACN,MAAM,KAAK,CACX,OAAO,QAAQ,CACf;AACJ;AAED,iCAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;AACJ,KAAI,MAAM,WAAW,CACnB;CAGF,MAAM,EACJ,mBAAmB,QACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,IAAI,gBAAgB,MAAM,oBAAoB;EAK5C,yBAAyB,qBAAqB;EAC9C,SAAS;CACV,EAAC;AACF,KAAI,CAAC,cACH;CAGF,MAAM,YAAY,OAAO,kBAAkB,YAAY,aAAa,iBAAiB,cAAc;AACnG,KAAI,WACF,gBACE,cACA;AAGJ,KAAI,qBAAqB,OAAO;EAC9B,MAAM,EACJ,aACD,GAAG,MAAM,gBAAgB;AAC1B,MAAI,iBAAiB,eAAe,GAAG,CACrC;AAGF,MAAI,qBAAqB,QAAQ;GAC/B,MAAM,WAAW,MAAM,eAAe,CACpC,QAAQ,aACT,EAAC;AACF,OAAI,SAAS,QAAQ;IACnB,MAAM,CACJ,EACE,KAAK,SACN,CACF,GAAG;IACJ,OAAO,CAAC,YAAY,EAAE,QAAQ,sFAAsF,EAAE,QAAQ,MAAM,CAAC,CAAC;GACvI,OACC,OAAO,mCAAmC;AAG5C;EACD;CACF;CAED,MAAM,mBAAmB,YACvB,CAAE,IACF,MAAM,KAAK,OAAO,CAAC,EACjB,KACD,KAAK;AACJ,SAAO,QAAQ;CAChB,EAAC;AAEJ,KAAI,CAAC,iBAAiB,QAAQ;EAC5B,OACE,qBAAqB,QACnB,CAAC,oCAAoC,EAAE,cAAc,aAAa,CAAC,GACnE,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,CACjD;AAED;CACD;AAED,MAAK,MAAM,WAAW,iBACpB,KAAI,CAAC,iBAAiB,GAAG,QAAQ,KAAK,CAAC,EAAE,MAAM,kBAAkB,QAAQ,EAAE,CAAC,EAC1E,OAAO,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,QAAQ;AAG1E,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,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,kBAAkB;KAChB,MAAM;MACJ;MAAQ;MAAO;KAChB;KACD,MAAM;IACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireDescription.js

@@ -0,0 +1,95 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/requireDescription.js
+/**
+* @param {string} description
+* @returns {import('../iterateJsdoc.js').Integer}
+*/
+const checkDescription = (description) => {
+	return description.trim().split("\n").filter(Boolean).length;
+};
+var requireDescription_default = iterateJsdoc(({ context, jsdoc, report, utils }) => {
+	if (utils.avoidDocs()) return;
+	const { descriptionStyle = "body" } = context.options[0] || {};
+	let targetTagName = utils.getPreferredTagName({
+		skipReportingBlockedTag: descriptionStyle !== "tag",
+		tagName: "description"
+	});
+	if (!targetTagName) return;
+	const isBlocked = typeof targetTagName === "object" && "blocked" in targetTagName && targetTagName.blocked;
+	if (isBlocked) targetTagName = targetTagName.tagName;
+	if (descriptionStyle !== "tag") {
+		const { description } = utils.getDescription();
+		if (checkDescription(description || "")) return;
+		if (descriptionStyle === "body") {
+			const descTags = utils.getPresentTags(["desc", "description"]);
+			if (descTags.length) {
+				const [{ tag: tagName }] = descTags;
+				report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);
+			} else report("Missing JSDoc block description.");
+			return;
+		}
+	}
+	const functionExamples = isBlocked ? [] : jsdoc.tags.filter(({ tag }) => {
+		return tag === targetTagName;
+	});
+	if (!functionExamples.length) {
+		report(descriptionStyle === "any" ? `Missing JSDoc block description or @${targetTagName} declaration.` : `Missing JSDoc @${targetTagName} declaration.`);
+		return;
+	}
+	for (const example of functionExamples) if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) report(`Missing JSDoc @${targetTagName} description.`, null, example);
+}, {
+	contextDefaults: true,
+	meta: {
+		docs: {
+			description: "Requires that all functions have a description.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				checkConstructors: {
+					default: true,
+					type: "boolean"
+				},
+				checkGetters: {
+					default: true,
+					type: "boolean"
+				},
+				checkSetters: {
+					default: true,
+					type: "boolean"
+				},
+				contexts: {
+					items: { anyOf: [{ type: "string" }, {
+						additionalProperties: false,
+						properties: {
+							comment: { type: "string" },
+							context: { type: "string" }
+						},
+						type: "object"
+					}] },
+					type: "array"
+				},
+				descriptionStyle: {
+					enum: [
+						"body",
+						"tag",
+						"any"
+					],
+					type: "string"
+				},
+				exemptedBy: {
+					items: { type: "string" },
+					type: "array"
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { requireDescription_default as default };
+//# sourceMappingURL=requireDescription.js.map

package/dist/rules/requireDescription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requireDescription.js","names":[],"sources":["../../src/rules/requireDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} description\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst checkDescription = (description) => {\n  return description\n    .trim()\n    .split('\\n')\n    .filter(Boolean)\n    .length;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  const {\n    descriptionStyle = 'body',\n  } = context.options[0] || {};\n\n  let targetTagName = utils.getPreferredTagName({\n    // We skip reporting except when `@description` is essential to the rule,\n    //  so user can block the tag and still meaningfully use this rule\n    //  even if the tag is present (and `check-tag-names` is the one to\n    //  normally report the fact that it is blocked but present)\n    skipReportingBlockedTag: descriptionStyle !== 'tag',\n    tagName: 'description',\n  });\n  if (!targetTagName) {\n    return;\n  }\n\n  const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;\n  if (isBlocked) {\n    targetTagName = /** @type {{blocked: true; tagName: string;}} */ (\n      targetTagName\n    ).tagName;\n  }\n\n  if (descriptionStyle !== 'tag') {\n    const {\n      description,\n    } = utils.getDescription();\n    if (checkDescription(description || '')) {\n      return;\n    }\n\n    if (descriptionStyle === 'body') {\n      const descTags = utils.getPresentTags([\n        'desc', 'description',\n      ]);\n      if (descTags.length) {\n        const [\n          {\n            tag: tagName,\n          },\n        ] = descTags;\n        report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);\n      } else {\n        report('Missing JSDoc block description.');\n      }\n\n      return;\n    }\n  }\n\n  const functionExamples = isBlocked ?\n    [] :\n    jsdoc.tags.filter(({\n      tag,\n    }) => {\n      return tag === targetTagName;\n    });\n\n  if (!functionExamples.length) {\n    report(\n      descriptionStyle === 'any' ?\n        `Missing JSDoc block description or @${targetTagName} declaration.` :\n        `Missing JSDoc @${targetTagName} declaration.`,\n    );\n\n    return;\n  }\n\n  for (const example of functionExamples) {\n    if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, example);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all functions have a description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: true,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: true,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          descriptionStyle: {\n            enum: [\n              'body', 'tag', 'any',\n            ],\n            type: 'string',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;AAMA,MAAM,mBAAmB,CAAC,gBAAgB;AACxC,QAAO,YACJ,MAAM,CACN,MAAM,KAAK,CACX,OAAO,QAAQ,CACf;AACJ;AAED,iCAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;AACJ,KAAI,MAAM,WAAW,CACnB;CAGF,MAAM,EACJ,mBAAmB,QACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,IAAI,gBAAgB,MAAM,oBAAoB;EAK5C,yBAAyB,qBAAqB;EAC9C,SAAS;CACV,EAAC;AACF,KAAI,CAAC,cACH;CAGF,MAAM,YAAY,OAAO,kBAAkB,YAAY,aAAa,iBAAiB,cAAc;AACnG,KAAI,WACF,gBACE,cACA;AAGJ,KAAI,qBAAqB,OAAO;EAC9B,MAAM,EACJ,aACD,GAAG,MAAM,gBAAgB;AAC1B,MAAI,iBAAiB,eAAe,GAAG,CACrC;AAGF,MAAI,qBAAqB,QAAQ;GAC/B,MAAM,WAAW,MAAM,eAAe,CACpC,QAAQ,aACT,EAAC;AACF,OAAI,SAAS,QAAQ;IACnB,MAAM,CACJ,EACE,KAAK,SACN,CACF,GAAG;IACJ,OAAO,CAAC,YAAY,EAAE,QAAQ,sFAAsF,EAAE,QAAQ,MAAM,CAAC,CAAC;GACvI,OACC,OAAO,mCAAmC;AAG5C;EACD;CACF;CAED,MAAM,mBAAmB,YACvB,CAAE,IACF,MAAM,KAAK,OAAO,CAAC,EACjB,KACD,KAAK;AACJ,SAAO,QAAQ;CAChB,EAAC;AAEJ,KAAI,CAAC,iBAAiB,QAAQ;EAC5B,OACE,qBAAqB,QACnB,CAAC,oCAAoC,EAAE,cAAc,aAAa,CAAC,GACnE,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,CACjD;AAED;CACD;AAED,MAAK,MAAM,WAAW,iBACpB,KAAI,CAAC,iBAAiB,GAAG,QAAQ,KAAK,CAAC,EAAE,MAAM,kBAAkB,QAAQ,EAAE,CAAC,EAC1E,OAAO,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,QAAQ;AAG1E,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,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,kBAAkB;KAChB,MAAM;MACJ;MAAQ;MAAO;KAChB;KACD,MAAM;IACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}