eslint-plugin-jsdoc 59.0.2 → 59.1.0

package/dist/rules/noRestrictedSyntax.cjs

@@ -4,52 +4,23 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  info: {
-    comment
+var _buildForbidRuleDefinition = require("../buildForbidRuleDefinition.cjs");
+var _default = exports.default = (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
+  getContexts(context, report) {
+    if (!context.options.length) {
+      report('Rule `no-restricted-syntax` is missing a `contexts` option.');
+      return false;
+    }
+    const {
+      contexts
+    } = context.options[0];
+    return contexts;
   },
-  report,
-  utils
-}) => {
-  if (!context.options.length) {
-    report('Rule `no-restricted-syntax` is missing a `contexts` option.');
-    return;
-  }
-  const {
-    contexts
-  } = context.options[0];
-  const {
-    contextStr,
-    foundContext
-  } = utils.findContext(contexts, comment);
-
-  // We are not on the *particular* matching context/comment, so don't assume
-  //   we need reporting
-  if (!foundContext) {
-    return;
-  }
-  const message = /** @type {import('../iterateJsdoc.js').ContextObject} */foundContext?.message ?? 'Syntax is restricted: {{context}}' + (comment ? ' with {{comment}}' : '');
-  report(message, null, null, comment ? {
-    comment,
-    context: contextStr
-  } : {
-    context: contextStr
-  });
-}, {
-  contextSelected: true,
-  meta: {
-    docs: {
-      description: 'Reports when certain comment structures are present.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        contexts: {
-          description: `Set this to an array of strings representing the AST context (or an object with
+  schema: [{
+    additionalProperties: false,
+    properties: {
+      contexts: {
+        description: `Set this to an array of strings representing the AST context (or an object with
 \`context\` and \`comment\` properties) where you wish the rule to be applied.
 
 \`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
@@ -66,34 +37,32 @@ aliases \`@func\` or \`@method\`) (including those associated with an \`@interfa
 
 See the ["AST and Selectors"](../#advanced-ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              additionalProperties: false,
-              properties: {
-                comment: {
-                  type: 'string'
-                },
-                context: {
-                  type: 'string'
-                },
-                message: {
-                  type: 'string'
-                }
+        items: {
+          anyOf: [{
+            type: 'string'
+          }, {
+            additionalProperties: false,
+            properties: {
+              comment: {
+                type: 'string'
               },
-              type: 'object'
-            }]
-          },
-          type: 'array'
-        }
-      },
-      required: ['contexts'],
-      type: 'object'
-    }],
-    type: 'suggestion'
-  },
-  nonGlobalSettings: true
+              context: {
+                type: 'string'
+              },
+              message: {
+                type: 'string'
+              }
+            },
+            type: 'object'
+          }]
+        },
+        type: 'array'
+      }
+    },
+    required: ['contexts'],
+    type: 'object'
+  }],
+  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header'
 });
 module.exports = exports.default;
 //# sourceMappingURL=noRestrictedSyntax.cjs.map

package/dist/rules/noRestrictedSyntax.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"noRestrictedSyntax.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","info","comment","report","utils","options","length","contexts","contextStr","foundContext","findContext","message","contextSelected","meta","docs","description","url","schema","additionalProperties","properties","items","anyOf","type","required","nonGlobalSettings","module"],"sources":["../../src/rules/noRestrictedSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  info: {\n    comment,\n  },\n  report,\n  utils,\n}) => {\n  if (!context.options.length) {\n    report('Rule `no-restricted-syntax` is missing a `contexts` option.');\n\n    return;\n  }\n\n  const {\n    contexts,\n  } = context.options[0];\n\n  const {\n    contextStr,\n    foundContext,\n  } = utils.findContext(contexts, comment);\n\n  // We are not on the *particular* matching context/comment, so don't assume\n  //   we need reporting\n  if (!foundContext) {\n    return;\n  }\n\n  const message = /** @type {import('../iterateJsdoc.js').ContextObject} */ (\n    foundContext\n  )?.message ??\n    'Syntax is restricted: {{context}}' +\n      (comment ? ' with {{comment}}' : '');\n\n  report(message, null, null, comment ? {\n    comment,\n    context: contextStr,\n  } : {\n    context: contextStr,\n  });\n}, {\n  contextSelected: true,\n  meta: {\n    docs: {\n      description: 'Reports when certain comment structures are present.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            description: `Set this to an array of strings representing the AST context (or an object with\n\\`context\\` and \\`comment\\` properties) where you wish the rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nUse the \\`message\\` property to indicate the specific error to be shown when an\nerror is reported for that context being found. Defaults to\n\\`\"Syntax is restricted: {{context}}\"\\`, or with a comment, to\n\\`\"Syntax is restricted: {{context}} with {{comment}}\"\\`.\n\nSet to \\`\"any\"\\` if you want the rule to apply to any JSDoc block throughout\nyour files (as is necessary for finding function blocks not attached to a\nfunction declaration or expression, i.e., \\`@callback\\` or \\`@function\\` (or its\naliases \\`@func\\` or \\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../#advanced-ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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                    message: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        required: [\n          'contexts',\n        ],\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n  nonGlobalSettings: true,\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI,EAAE;IACJC;EACF,CAAC;EACDC,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,IAAI,CAACJ,OAAO,CAACK,OAAO,CAACC,MAAM,EAAE;IAC3BH,MAAM,CAAC,6DAA6D,CAAC;IAErE;EACF;EAEA,MAAM;IACJI;EACF,CAAC,GAAGP,OAAO,CAACK,OAAO,CAAC,CAAC,CAAC;EAEtB,MAAM;IACJG,UAAU;IACVC;EACF,CAAC,GAAGL,KAAK,CAACM,WAAW,CAACH,QAAQ,EAAEL,OAAO,CAAC;;EAExC;EACA;EACA,IAAI,CAACO,YAAY,EAAE;IACjB;EACF;EAEA,MAAME,OAAO,GAAG,yDACdF,YAAY,EACXE,OAAO,IACR,mCAAmC,IAChCT,OAAO,GAAG,mBAAmB,GAAG,EAAE,CAAC;EAExCC,MAAM,CAACQ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAET,OAAO,GAAG;IACpCA,OAAO;IACPF,OAAO,EAAEQ;EACX,CAAC,GAAG;IACFR,OAAO,EAAEQ;EACX,CAAC,CAAC;AACJ,CAAC,EAAE;EACDI,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,sDAAsD;MACnEC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVZ,QAAQ,EAAE;UACRQ,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClDK,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEC,IAAI,EAAE;YACR,CAAC,EACD;cACEJ,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVjB,OAAO,EAAE;kBACPoB,IAAI,EAAE;gBACR,CAAC;gBACDtB,OAAO,EAAE;kBACPsB,IAAI,EAAE;gBACR,CAAC;gBACDX,OAAO,EAAE;kBACPW,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDC,QAAQ,EAAE,CACR,UAAU,CACX;MACDD,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR,CAAC;EACDE,iBAAiB,EAAE;AACrB,CAAC,CAAC;AAAAC,MAAA,CAAA3B,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"noRestrictedSyntax.cjs","names":["_buildForbidRuleDefinition","require","_default","exports","default","buildForbidRuleDefinition","getContexts","context","report","options","length","contexts","schema","additionalProperties","properties","description","items","anyOf","type","comment","message","required","url","module"],"sources":["../../src/rules/noRestrictedSyntax.js"],"sourcesContent":["import {\n  buildForbidRuleDefinition,\n} from '../buildForbidRuleDefinition.js';\n\nexport default buildForbidRuleDefinition({\n  getContexts (context, report) {\n    if (!context.options.length) {\n      report('Rule `no-restricted-syntax` is missing a `contexts` option.');\n      return false;\n    }\n\n    const {\n      contexts,\n    } = context.options[0];\n\n    return contexts;\n  },\n  schema: [\n    {\n      additionalProperties: false,\n      properties: {\n        contexts: {\n          description: `Set this to an array of strings representing the AST context (or an object with\n\\`context\\` and \\`comment\\` properties) where you wish the rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nUse the \\`message\\` property to indicate the specific error to be shown when an\nerror is reported for that context being found. Defaults to\n\\`\"Syntax is restricted: {{context}}\"\\`, or with a comment, to\n\\`\"Syntax is restricted: {{context}} with {{comment}}\"\\`.\n\nSet to \\`\"any\"\\` if you want the rule to apply to any JSDoc block throughout\nyour files (as is necessary for finding function blocks not attached to a\nfunction declaration or expression, i.e., \\`@callback\\` or \\`@function\\` (or its\naliases \\`@func\\` or \\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../#advanced-ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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                  message: {\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n            ],\n          },\n          type: 'array',\n        },\n      },\n      required: [\n        'contexts',\n      ],\n      type: 'object',\n    },\n  ],\n  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header',\n});\n"],"mappings":";;;;;;AAAA,IAAAA,0BAAA,GAAAC,OAAA;AAEyC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAE1B,IAAAC,oDAAyB,EAAC;EACvCC,WAAWA,CAAEC,OAAO,EAAEC,MAAM,EAAE;IAC5B,IAAI,CAACD,OAAO,CAACE,OAAO,CAACC,MAAM,EAAE;MAC3BF,MAAM,CAAC,6DAA6D,CAAC;MACrE,OAAO,KAAK;IACd;IAEA,MAAM;MACJG;IACF,CAAC,GAAGJ,OAAO,CAACE,OAAO,CAAC,CAAC,CAAC;IAEtB,OAAOE,QAAQ;EACjB,CAAC;EACDC,MAAM,EAAE,CACN;IACEC,oBAAoB,EAAE,KAAK;IAC3BC,UAAU,EAAE;MACVH,QAAQ,EAAE;QACRI,WAAW,EAAE;AACvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;QACpDC,KAAK,EAAE;UACLC,KAAK,EAAE,CACL;YACEC,IAAI,EAAE;UACR,CAAC,EACD;YACEL,oBAAoB,EAAE,KAAK;YAC3BC,UAAU,EAAE;cACVK,OAAO,EAAE;gBACPD,IAAI,EAAE;cACR,CAAC;cACDX,OAAO,EAAE;gBACPW,IAAI,EAAE;cACR,CAAC;cACDE,OAAO,EAAE;gBACPF,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;QAEL,CAAC;QACDA,IAAI,EAAE;MACR;IACF,CAAC;IACDG,QAAQ,EAAE,CACR,UAAU,CACX;IACDH,IAAI,EAAE;EACR,CAAC,CACF;EACDI,GAAG,EAAE;AACP,CAAC,CAAC;AAAAC,MAAA,CAAApB,OAAA,GAAAA,OAAA,CAAAC,OAAA","ignoreList":[]}

package/dist/rules/noRestrictedSyntax.d.ts

@@ -1,3 +1,3 @@
-declare const _default: import("eslint").Rule.RuleModule;
+declare const _default: import("@eslint/core").RuleDefinition<import("@eslint/core").RuleDefinitionTypeOptions>;
 export default _default;
 //# sourceMappingURL=noRestrictedSyntax.d.ts.map

package/dist/rules/requiredTags.cjs

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _buildForbidRuleDefinition = require("../buildForbidRuleDefinition.cjs");
+var _default = exports.default = (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
+  description: 'Requires tags be present, optionally for specific contexts',
+  getContexts(context, report) {
+    // Transformed options to this option in `modifyContext`:
+    if (!context.options[0].contexts) {
+      report('Rule `required-tags` is missing a `tags` option.');
+      return false;
+    }
+    const {
+      contexts
+    } = context.options[0];
+    return contexts;
+  },
+  modifyContext(context) {
+    const tags = /** @type {(string|{tag: string, context: string})[]} */
+    context.options?.[0]?.tags;
+    const cntxts = tags?.map(tag => {
+      const tagName = typeof tag === 'string' ? tag : tag.tag;
+      return {
+        comment: `JsdocBlock:not(*:has(JsdocTag[tag=${tagName}]))`,
+        context: typeof tag === 'string' ? 'any' : tag.context,
+        message: `Missing required tag "${tagName}"`
+      };
+    });
+
+    // Reproduce context object with our own `contexts`
+    const propertyDescriptors = Object.getOwnPropertyDescriptors(context);
+    return Object.create(Object.getPrototypeOf(context), {
+      ...propertyDescriptors,
+      options: {
+        ...propertyDescriptors.options,
+        value: [{
+          contexts: cntxts
+        }]
+      }
+    });
+  },
+  schema: [{
+    additionalProperties: false,
+    properties: {
+      tags: {
+        description: `May be an array of either strings or objects with
+a string \`tag\` property and \`context\` string property.`,
+        items: {
+          anyOf: [{
+            type: 'string'
+          }, {
+            properties: {
+              context: {
+                type: 'string'
+              },
+              tag: {
+                type: 'string'
+              }
+            },
+            type: 'object'
+          }]
+        },
+        type: 'array'
+      }
+    },
+    type: 'object'
+  }],
+  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/required-tags.md#repos-sticky-header'
+});
+module.exports = exports.default;
+//# sourceMappingURL=requiredTags.cjs.map

package/dist/rules/requiredTags.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"requiredTags.cjs","names":["_buildForbidRuleDefinition","require","_default","exports","default","buildForbidRuleDefinition","description","getContexts","context","report","options","contexts","modifyContext","tags","cntxts","map","tag","tagName","comment","message","propertyDescriptors","Object","getOwnPropertyDescriptors","create","getPrototypeOf","value","schema","additionalProperties","properties","items","anyOf","type","url","module"],"sources":["../../src/rules/requiredTags.js"],"sourcesContent":["import {\n  buildForbidRuleDefinition,\n} from '../buildForbidRuleDefinition.js';\n\nexport default buildForbidRuleDefinition({\n  description: 'Requires tags be present, optionally for specific contexts',\n  getContexts (context, report) {\n    // Transformed options to this option in `modifyContext`:\n    if (!context.options[0].contexts) {\n      report('Rule `required-tags` is missing a `tags` option.');\n      return false;\n    }\n\n    const {\n      contexts,\n    } = context.options[0];\n\n    return contexts;\n  },\n  modifyContext (context) {\n    const tags = /** @type {(string|{tag: string, context: string})[]} */ (\n      context.options?.[0]?.tags\n    );\n\n    const cntxts = tags?.map((tag) => {\n      const tagName = typeof tag === 'string' ? tag : tag.tag;\n      return {\n        comment: `JsdocBlock:not(*:has(JsdocTag[tag=${\n          tagName\n        }]))`,\n        context: typeof tag === 'string' ? 'any' : tag.context,\n        message: `Missing required tag \"${tagName}\"`,\n      };\n    });\n\n    // Reproduce context object with our own `contexts`\n    const propertyDescriptors = Object.getOwnPropertyDescriptors(context);\n    return Object.create(\n      Object.getPrototypeOf(context),\n      {\n        ...propertyDescriptors,\n        options: {\n          ...propertyDescriptors.options,\n          value: [\n            {\n              contexts: cntxts,\n            },\n          ],\n        },\n      },\n    );\n  },\n  schema: [\n    {\n      additionalProperties: false,\n      properties: {\n        tags: {\n          description: `May be an array of either strings or objects with\na string \\`tag\\` property and \\`context\\` string property.`,\n          items: {\n            anyOf: [\n              {\n                type: 'string',\n              },\n              {\n                properties: {\n                  context: {\n                    type: 'string',\n                  },\n                  tag: {\n                    type: 'string',\n                  },\n                },\n                type: 'object',\n              },\n            ],\n          },\n          type: 'array',\n        },\n      },\n      type: 'object',\n    },\n  ],\n  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/required-tags.md#repos-sticky-header',\n});\n"],"mappings":";;;;;;AAAA,IAAAA,0BAAA,GAAAC,OAAA;AAEyC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAE1B,IAAAC,oDAAyB,EAAC;EACvCC,WAAW,EAAE,4DAA4D;EACzEC,WAAWA,CAAEC,OAAO,EAAEC,MAAM,EAAE;IAC5B;IACA,IAAI,CAACD,OAAO,CAACE,OAAO,CAAC,CAAC,CAAC,CAACC,QAAQ,EAAE;MAChCF,MAAM,CAAC,kDAAkD,CAAC;MAC1D,OAAO,KAAK;IACd;IAEA,MAAM;MACJE;IACF,CAAC,GAAGH,OAAO,CAACE,OAAO,CAAC,CAAC,CAAC;IAEtB,OAAOC,QAAQ;EACjB,CAAC;EACDC,aAAaA,CAAEJ,OAAO,EAAE;IACtB,MAAMK,IAAI,GAAG;IACXL,OAAO,CAACE,OAAO,GAAG,CAAC,CAAC,EAAEG,IACvB;IAED,MAAMC,MAAM,GAAGD,IAAI,EAAEE,GAAG,CAAEC,GAAG,IAAK;MAChC,MAAMC,OAAO,GAAG,OAAOD,GAAG,KAAK,QAAQ,GAAGA,GAAG,GAAGA,GAAG,CAACA,GAAG;MACvD,OAAO;QACLE,OAAO,EAAE,qCACPD,OAAO,KACJ;QACLT,OAAO,EAAE,OAAOQ,GAAG,KAAK,QAAQ,GAAG,KAAK,GAAGA,GAAG,CAACR,OAAO;QACtDW,OAAO,EAAE,yBAAyBF,OAAO;MAC3C,CAAC;IACH,CAAC,CAAC;;IAEF;IACA,MAAMG,mBAAmB,GAAGC,MAAM,CAACC,yBAAyB,CAACd,OAAO,CAAC;IACrE,OAAOa,MAAM,CAACE,MAAM,CAClBF,MAAM,CAACG,cAAc,CAAChB,OAAO,CAAC,EAC9B;MACE,GAAGY,mBAAmB;MACtBV,OAAO,EAAE;QACP,GAAGU,mBAAmB,CAACV,OAAO;QAC9Be,KAAK,EAAE,CACL;UACEd,QAAQ,EAAEG;QACZ,CAAC;MAEL;IACF,CACF,CAAC;EACH,CAAC;EACDY,MAAM,EAAE,CACN;IACEC,oBAAoB,EAAE,KAAK;IAC3BC,UAAU,EAAE;MACVf,IAAI,EAAE;QACJP,WAAW,EAAE;AACvB,2DAA2D;QACjDuB,KAAK,EAAE;UACLC,KAAK,EAAE,CACL;YACEC,IAAI,EAAE;UACR,CAAC,EACD;YACEH,UAAU,EAAE;cACVpB,OAAO,EAAE;gBACPuB,IAAI,EAAE;cACR,CAAC;cACDf,GAAG,EAAE;gBACHe,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;QAEL,CAAC;QACDA,IAAI,EAAE;MACR;IACF,CAAC;IACDA,IAAI,EAAE;EACR,CAAC,CACF;EACDC,GAAG,EAAE;AACP,CAAC,CAAC;AAAAC,MAAA,CAAA9B,OAAA,GAAAA,OAAA,CAAAC,OAAA","ignoreList":[]}

package/dist/rules/requiredTags.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@eslint/core").RuleDefinition<import("@eslint/core").RuleDefinitionTypeOptions>;
+export default _default;
+//# sourceMappingURL=requiredTags.d.ts.map

package/dist/rules.d.ts

@@ -2580,6 +2580,26 @@ export interface Rules {
   /** Requires a type for `@yields` tags */
   "jsdoc/require-yields-type": [];
 
+  /** Requires tags be present, optionally for specific contexts */
+  "jsdoc/required-tags": 
+    | []
+    | [
+        {
+          /**
+           * May be an array of either strings or objects with
+           * a string `tag` property and `context` string property.
+           */
+          tags?: (
+            | string
+            | {
+                context?: string;
+                tag?: string;
+                [k: string]: unknown;
+              }
+          )[];
+        }
+      ];
+
   /** Sorts tags by a specified sequence according to tag name, optionally adding line breaks between tag groups. */
   "jsdoc/sort-tags": 
     | []

package/package.json

@@ -172,5 +172,5 @@
     "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
     "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "59.0.2"
+  "version": "59.1.0"
 }

package/src/buildForbidRuleDefinition.js

@@ -1,14 +1,24 @@
 import iterateJsdoc from './iterateJsdoc.js';
 
+/**
+ * @typedef {(string|{
+ *   comment: string,
+ *   context: string,
+ *   message?: string
+ * })[]} Contexts
+ */
+
 /**
  * @param {{
- *   contexts: (string|{
- *     comment: string,
- *     context: string,
- *     message: string
- *   })[],
+ *   contexts?: Contexts,
  *   description?: string,
- *   contextName?: string
+ *   getContexts?: (
+ *     ctxt: import('eslint').Rule.RuleContext,
+ *     report: import('./iterateJsdoc.js').Report
+ *   ) => Contexts|false,
+ *   contextName?: string,
+ *   modifyContext?: (context: import('eslint').Rule.RuleContext) => import('eslint').Rule.RuleContext,
+ *   schema?: import('eslint').Rule.RuleMetaData['schema']
  *   url?: string,
  * }} cfg
  * @returns {import('@eslint/core').RuleDefinition<
@@ -17,22 +27,35 @@ import iterateJsdoc from './iterateJsdoc.js';
  */
 export const buildForbidRuleDefinition = ({
   contextName,
-  contexts,
+  contexts: cntxts,
   description,
+  getContexts,
+  modifyContext,
+  schema,
   url,
 }) => {
   return iterateJsdoc(({
-    // context,
+    context,
     info: {
       comment,
     },
     report,
     utils,
   }) => {
+    /** @type {Contexts|boolean|undefined} */
+    let contexts = cntxts;
+
+    if (getContexts) {
+      contexts = getContexts(context, report);
+      if (!contexts) {
+        return;
+      }
+    }
+
     const {
       contextStr,
       foundContext,
-    } = utils.findContext(contexts, comment);
+    } = utils.findContext(/** @type {Contexts} */ (contexts), comment);
 
     // We are not on the *particular* matching context/comment, so don't assume
     //   we need reporting
@@ -59,10 +82,10 @@ export const buildForbidRuleDefinition = ({
         description: description ?? contextName ?? 'Reports when certain comment structures are present.',
         url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules',
       },
-      schema: [],
+      schema: schema ?? [],
       type: 'suggestion',
     },
-    modifyContext: (context) => {
+    modifyContext: modifyContext ?? (getContexts ? undefined : (context) => {
       // Reproduce context object with our own `contexts`
       const propertyDescriptors = Object.getOwnPropertyDescriptors(context);
       return Object.create(
@@ -73,13 +96,13 @@ export const buildForbidRuleDefinition = ({
             ...propertyDescriptors.options,
             value: [
               {
-                contexts,
+                contexts: cntxts,
               },
             ],
           },
         },
       );
-    },
+    }),
     nonGlobalSettings: true,
   });
 };

package/src/index-cjs.js

@@ -40,6 +40,7 @@ import noUndefinedTypes from './rules/noUndefinedTypes.js';
 import requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';
 import requireDescription from './rules/requireDescription.js';
 import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';
+import requiredTags from './rules/requiredTags.js';
 import requireExample from './rules/requireExample.js';
 import requireFileOverview from './rules/requireFileOverview.js';
 import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';
@@ -226,6 +227,7 @@ index.rules = {
     description: 'Requires a type for `@yields` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header',
   }),
+  'required-tags': requiredTags,
   'sort-tags': sortTags,
   'tag-lines': tagLines,
   'text-escaping': textEscaping,
@@ -312,6 +314,7 @@ const createRecommendedRuleset = (warnOrError, flatName) => {
       'jsdoc/require-yields-check': warnOrError,
       'jsdoc/require-yields-description': 'off',
       'jsdoc/require-yields-type': warnOrError,
+      'jsdoc/required-tags': 'off',
       'jsdoc/sort-tags': 'off',
       'jsdoc/tag-lines': warnOrError,
       'jsdoc/text-escaping': 'off',

package/src/index.js

@@ -46,6 +46,7 @@ import noUndefinedTypes from './rules/noUndefinedTypes.js';
 import requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';
 import requireDescription from './rules/requireDescription.js';
 import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';
+import requiredTags from './rules/requiredTags.js';
 import requireExample from './rules/requireExample.js';
 import requireFileOverview from './rules/requireFileOverview.js';
 import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';
@@ -232,6 +233,7 @@ index.rules = {
     description: 'Requires a type for `@yields` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header',
   }),
+  'required-tags': requiredTags,
   'sort-tags': sortTags,
   'tag-lines': tagLines,
   'text-escaping': textEscaping,
@@ -318,6 +320,7 @@ const createRecommendedRuleset = (warnOrError, flatName) => {
       'jsdoc/require-yields-check': warnOrError,
       'jsdoc/require-yields-description': 'off',
       'jsdoc/require-yields-type': warnOrError,
+      'jsdoc/required-tags': 'off',
       'jsdoc/sort-tags': 'off',
       'jsdoc/tag-lines': warnOrError,
       'jsdoc/text-escaping': 'off',

package/src/rules/noRestrictedSyntax.js

@@ -1,59 +1,26 @@
-import iterateJsdoc from '../iterateJsdoc.js';
+import {
+  buildForbidRuleDefinition,
+} from '../buildForbidRuleDefinition.js';
 
-export default iterateJsdoc(({
-  context,
-  info: {
-    comment,
-  },
-  report,
-  utils,
-}) => {
-  if (!context.options.length) {
-    report('Rule `no-restricted-syntax` is missing a `contexts` option.');
-
-    return;
-  }
-
-  const {
-    contexts,
-  } = context.options[0];
+export default buildForbidRuleDefinition({
+  getContexts (context, report) {
+    if (!context.options.length) {
+      report('Rule `no-restricted-syntax` is missing a `contexts` option.');
+      return false;
+    }
 
-  const {
-    contextStr,
-    foundContext,
-  } = utils.findContext(contexts, comment);
+    const {
+      contexts,
+    } = context.options[0];
 
-  // We are not on the *particular* matching context/comment, so don't assume
-  //   we need reporting
-  if (!foundContext) {
-    return;
-  }
-
-  const message = /** @type {import('../iterateJsdoc.js').ContextObject} */ (
-    foundContext
-  )?.message ??
-    'Syntax is restricted: {{context}}' +
-      (comment ? ' with {{comment}}' : '');
-
-  report(message, null, null, comment ? {
-    comment,
-    context: contextStr,
-  } : {
-    context: contextStr,
-  });
-}, {
-  contextSelected: true,
-  meta: {
-    docs: {
-      description: 'Reports when certain comment structures are present.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header',
-    },
-    schema: [
-      {
-        additionalProperties: false,
-        properties: {
-          contexts: {
-            description: `Set this to an array of strings representing the AST context (or an object with
+    return contexts;
+  },
+  schema: [
+    {
+      additionalProperties: false,
+      properties: {
+        contexts: {
+          description: `Set this to an array of strings representing the AST context (or an object with
 \`context\` and \`comment\` properties) where you wish the rule to be applied.
 
 \`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
@@ -70,38 +37,36 @@ aliases \`@func\` or \`@method\`) (including those associated with an \`@interfa
 
 See the ["AST and Selectors"](../#advanced-ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
-            items: {
-              anyOf: [
-                {
-                  type: 'string',
-                },
-                {
-                  additionalProperties: false,
-                  properties: {
-                    comment: {
-                      type: 'string',
-                    },
-                    context: {
-                      type: 'string',
-                    },
-                    message: {
-                      type: 'string',
-                    },
+          items: {
+            anyOf: [
+              {
+                type: 'string',
+              },
+              {
+                additionalProperties: false,
+                properties: {
+                  comment: {
+                    type: 'string',
+                  },
+                  context: {
+                    type: 'string',
+                  },
+                  message: {
+                    type: 'string',
                   },
-                  type: 'object',
                 },
-              ],
-            },
-            type: 'array',
+                type: 'object',
+              },
+            ],
           },
+          type: 'array',
         },
-        required: [
-          'contexts',
-        ],
-        type: 'object',
       },
-    ],
-    type: 'suggestion',
-  },
-  nonGlobalSettings: true,
+      required: [
+        'contexts',
+      ],
+      type: 'object',
+    },
+  ],
+  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header',
 });