eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/noDefaults.cjs

@@ -1,56 +1,83 @@
-const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+"use strict";
 
-//#region src/rules/noDefaults.js
-var noDefaults_default = require_iterateJsdoc.default(({ context, utils }) => {
-	const { noOptionalParamNames } = context.options[0] || {};
-	const paramTags = utils.getPresentTags([
-		"param",
-		"arg",
-		"argument"
-	]);
-	for (const tag of paramTags) if (noOptionalParamNames && tag.optional) utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {
-		utils.changeTag(tag, { name: tag.name.replace(/([^=]*)(=.+)?/v, "$1") });
-	});
-	else if (tag.default) utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {
-		utils.changeTag(tag, { name: tag.name.replace(/([^=]*)(=.+)?/v, "[$1]") });
-	});
-	const defaultTags = utils.getPresentTags(["default", "defaultvalue"]);
-	for (const tag of defaultTags) if (tag.description.trim()) utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {
-		utils.changeTag(tag, {
-			description: "",
-			postTag: ""
-		});
-	});
+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,
+  utils
+}) => {
+  const {
+    noOptionalParamNames
+  } = context.options[0] || {};
+  const paramTags = utils.getPresentTags(['param', 'arg', 'argument']);
+  for (const tag of paramTags) {
+    if (noOptionalParamNames && tag.optional) {
+      utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {
+        utils.changeTag(tag, {
+          name: tag.name.replace(/([^=]*)(=.+)?/v, '$1')
+        });
+      });
+    } else if (tag.default) {
+      utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {
+        utils.changeTag(tag, {
+          name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]')
+        });
+      });
+    }
+  }
+  const defaultTags = utils.getPresentTags(['default', 'defaultvalue']);
+  for (const tag of defaultTags) {
+    if (tag.description.trim()) {
+      utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {
+        utils.changeTag(tag, {
+          description: '',
+          postTag: ''
+        });
+      });
+    }
+  }
 }, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "This rule reports defaults being used on the relevant portion of `@param` or `@default`.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				noOptionalParamNames: { type: "boolean" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
+  contextDefaults: true,
+  meta: {
+    docs: {
+      description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        contexts: {
+          items: {
+            anyOf: [{
+              type: 'string'
+            }, {
+              additionalProperties: false,
+              properties: {
+                comment: {
+                  type: 'string'
+                },
+                context: {
+                  type: 'string'
+                }
+              },
+              type: 'object'
+            }]
+          },
+          type: 'array'
+        },
+        noOptionalParamNames: {
+          type: 'boolean'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
 });
-
-//#endregion
-exports.default = noDefaults_default;
+module.exports = exports.default;
 //# sourceMappingURL=noDefaults.cjs.map

package/dist/rules/noDefaults.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"noDefaults.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noDefaults.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  utils,\n}) => {\n  const {\n    noOptionalParamNames,\n  } = context.options[0] || {};\n  const paramTags = utils.getPresentTags([\n    'param', 'arg', 'argument',\n  ]);\n  for (const tag of paramTags) {\n    if (noOptionalParamNames && tag.optional) {\n      utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {\n        utils.changeTag(tag, {\n          name: tag.name.replace(/([^=]*)(=.+)?/v, '$1'),\n        });\n      });\n    } else if (tag.default) {\n      utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {\n        utils.changeTag(tag, {\n          name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]'),\n        });\n      });\n    }\n  }\n\n  const defaultTags = utils.getPresentTags([\n    'default', 'defaultvalue',\n  ]);\n  for (const tag of defaultTags) {\n    if (tag.description.trim()) {\n      utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {\n        utils.changeTag(tag, {\n          description: '',\n          postTag: '',\n        });\n      });\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header',\n    },\n    fixable: 'code',\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          noOptionalParamNames: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,yBAAeA,6BAAa,CAAC,EAC3B,SACA,OACD,KAAK;CACJ,MAAM,EACJ,sBACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,YAAY,MAAM,eAAe;EACrC;EAAS;EAAO;CACjB,EAAC;AACF,MAAK,MAAM,OAAO,UAChB,KAAI,wBAAwB,IAAI,UAC9B,MAAM,YAAY,CAAC,2CAA2C,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EACrF,MAAM,UAAU,KAAK,EACnB,MAAM,IAAI,KAAK,QAAQ,kBAAkB,KAAK,CAC/C,EAAC;CACH,EAAC;UACO,IAAI,SACb,MAAM,YAAY,CAAC,+BAA+B,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EACzE,MAAM,UAAU,KAAK,EACnB,MAAM,IAAI,KAAK,QAAQ,kBAAkB,OAAO,CACjD,EAAC;CACH,EAAC;CAIN,MAAM,cAAc,MAAM,eAAe,CACvC,WAAW,cACZ,EAAC;AACF,MAAK,MAAM,OAAO,YAChB,KAAI,IAAI,YAAY,MAAM,EACxB,MAAM,YAAY,CAAC,qCAAqC,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EAC/E,MAAM,UAAU,KAAK;GACnB,aAAa;GACb,SAAS;EACV,EAAC;CACH,EAAC;AAGP,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,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,sBAAsB,EACpB,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
+{"version":3,"file":"noDefaults.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","context","utils","noOptionalParamNames","options","paramTags","getPresentTags","tag","optional","reportJSDoc","changeTag","name","replace","defaultTags","description","trim","postTag","contextDefaults","meta","docs","url","fixable","schema","additionalProperties","properties","contexts","items","anyOf","type","comment","module"],"sources":["../../src/rules/noDefaults.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  utils,\n}) => {\n  const {\n    noOptionalParamNames,\n  } = context.options[0] || {};\n  const paramTags = utils.getPresentTags([\n    'param', 'arg', 'argument',\n  ]);\n  for (const tag of paramTags) {\n    if (noOptionalParamNames && tag.optional) {\n      utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {\n        utils.changeTag(tag, {\n          name: tag.name.replace(/([^=]*)(=.+)?/v, '$1'),\n        });\n      });\n    } else if (tag.default) {\n      utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {\n        utils.changeTag(tag, {\n          name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]'),\n        });\n      });\n    }\n  }\n\n  const defaultTags = utils.getPresentTags([\n    'default', 'defaultvalue',\n  ]);\n  for (const tag of defaultTags) {\n    if (tag.description.trim()) {\n      utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {\n        utils.changeTag(tag, {\n          description: '',\n          postTag: '',\n        });\n      });\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header',\n    },\n    fixable: 'code',\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          noOptionalParamNames: {\n            type: 'boolean',\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;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC;EACF,CAAC,GAAGF,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAC5B,MAAMC,SAAS,GAAGH,KAAK,CAACI,cAAc,CAAC,CACrC,OAAO,EAAE,KAAK,EAAE,UAAU,CAC3B,CAAC;EACF,KAAK,MAAMC,GAAG,IAAIF,SAAS,EAAE;IAC3B,IAAIF,oBAAoB,IAAII,GAAG,CAACC,QAAQ,EAAE;MACxCN,KAAK,CAACO,WAAW,CAAC,8CAA8CF,GAAG,CAACA,GAAG,GAAG,EAAEA,GAAG,EAAE,MAAM;QACrFL,KAAK,CAACQ,SAAS,CAACH,GAAG,EAAE;UACnBI,IAAI,EAAEJ,GAAG,CAACI,IAAI,CAACC,OAAO,CAAC,gBAAgB,EAAE,IAAI;QAC/C,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIL,GAAG,CAACV,OAAO,EAAE;MACtBK,KAAK,CAACO,WAAW,CAAC,kCAAkCF,GAAG,CAACA,GAAG,GAAG,EAAEA,GAAG,EAAE,MAAM;QACzEL,KAAK,CAACQ,SAAS,CAACH,GAAG,EAAE;UACnBI,IAAI,EAAEJ,GAAG,CAACI,IAAI,CAACC,OAAO,CAAC,gBAAgB,EAAE,MAAM;QACjD,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;EACF;EAEA,MAAMC,WAAW,GAAGX,KAAK,CAACI,cAAc,CAAC,CACvC,SAAS,EAAE,cAAc,CAC1B,CAAC;EACF,KAAK,MAAMC,GAAG,IAAIM,WAAW,EAAE;IAC7B,IAAIN,GAAG,CAACO,WAAW,CAACC,IAAI,CAAC,CAAC,EAAE;MAC1Bb,KAAK,CAACO,WAAW,CAAC,wCAAwCF,GAAG,CAACA,GAAG,GAAG,EAAEA,GAAG,EAAE,MAAM;QAC/EL,KAAK,CAACQ,SAAS,CAACH,GAAG,EAAE;UACnBO,WAAW,EAAE,EAAE;UACfE,OAAO,EAAE;QACX,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;EACF;AACF,CAAC,EAAE;EACDC,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJL,WAAW,EAAE,0FAA0F;MACvGM,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,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;gBACD3B,OAAO,EAAE;kBACP2B,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDzB,oBAAoB,EAAE;UACpByB,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAE,MAAA,CAAA/B,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/noMissingSyntax.cjs

@@ -1,126 +1,176 @@
-const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+"use strict";
 
-//#region src/rules/noMissingSyntax.js
+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 }; }
 /**
-* @typedef {{
-*   comment: string,
-*   context: string,
-*   message: string,
-*   minimum: import('../iterateJsdoc.js').Integer
-* }} ContextObject
-*/
+ * @typedef {{
+ *   comment: string,
+ *   context: string,
+ *   message: string,
+ *   minimum: import('../iterateJsdoc.js').Integer
+ * }} ContextObject
+ */
+
 /**
-* @typedef {string|ContextObject} Context
-*/
+ * @typedef {string|ContextObject} Context
+ */
+
 /**
-* @param {import('../iterateJsdoc.js').StateObject} state
-* @returns {void}
-*/
-const setDefaults = (state) => {
-	if (!state.selectorMap) state.selectorMap = {};
+ * @param {import('../iterateJsdoc.js').StateObject} state
+ * @returns {void}
+ */
+const setDefaults = state => {
+  if (!state.selectorMap) {
+    state.selectorMap = {};
+  }
 };
+
 /**
-* @param {import('../iterateJsdoc.js').StateObject} state
-* @param {string} selector
-* @param {string} comment
-* @returns {void}
-*/
+ * @param {import('../iterateJsdoc.js').StateObject} state
+ * @param {string} selector
+ * @param {string} comment
+ * @returns {void}
+ */
 const incrementSelector = (state, selector, comment) => {
-	if (!state.selectorMap[selector]) state.selectorMap[selector] = {};
-	if (!state.selectorMap[selector][comment]) state.selectorMap[selector][comment] = 0;
-	state.selectorMap[selector][comment]++;
+  if (!state.selectorMap[selector]) {
+    state.selectorMap[selector] = {};
+  }
+  if (!state.selectorMap[selector][comment]) {
+    state.selectorMap[selector][comment] = 0;
+  }
+  state.selectorMap[selector][comment]++;
 };
-var noMissingSyntax_default = require_iterateJsdoc.default(({ context, info: { comment }, state, utils }) => {
-	if (!context.options[0]) return;
-	/**
-	* @type {Context[]}
-	*/
-	const contexts = context.options[0].contexts;
-	const { contextStr } = utils.findContext(contexts, comment);
-	setDefaults(state);
-	incrementSelector(state, contextStr, String(comment));
+var _default = exports.default = (0, _iterateJsdoc.default)(({
+  context,
+  info: {
+    comment
+  },
+  state,
+  utils
+}) => {
+  if (!context.options[0]) {
+    // Handle error later
+    return;
+  }
+
+  /**
+   * @type {Context[]}
+   */
+  const contexts = context.options[0].contexts;
+  const {
+    contextStr
+  } = utils.findContext(contexts, comment);
+  setDefaults(state);
+  incrementSelector(state, contextStr, String(comment));
 }, {
-	contextSelected: true,
-	exit({ context, settings, state }) {
-		if (!context.options.length && !settings.contexts) {
-			context.report({
-				loc: {
-					end: {
-						column: 1,
-						line: 1
-					},
-					start: {
-						column: 1,
-						line: 1
-					}
-				},
-				message: "Rule `no-missing-syntax` is missing a `contexts` option."
-			});
-			return;
-		}
-		setDefaults(state);
-		/**
-		* @type {Context[]}
-		*/
-		const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;
-		contexts.some((cntxt) => {
-			const contextStr = typeof cntxt === "object" ? cntxt.context ?? "any" : cntxt;
-			const comment = typeof cntxt === "string" ? "" : cntxt?.comment;
-			const contextKey = contextStr === "any" ? "undefined" : contextStr;
-			if ((!state.selectorMap[contextKey] || !state.selectorMap[contextKey][comment] || state.selectorMap[contextKey][comment] < (cntxt?.minimum ?? 1)) && (contextStr !== "any" || Object.values(state.selectorMap).every((cmmnt) => {
-				return !cmmnt[comment] || cmmnt[comment] < (cntxt?.minimum ?? 1);
-			}))) {
-				const message = typeof cntxt === "string" ? "Syntax is required: {{context}}" : cntxt?.message ?? "Syntax is required: {{context}}" + (comment ? " with {{comment}}" : "");
-				context.report({
-					data: {
-						comment,
-						context: contextStr
-					},
-					loc: {
-						end: {
-							column: 1,
-							line: 1
-						},
-						start: {
-							column: 1,
-							line: 1
-						}
-					},
-					message
-				});
-				return true;
-			}
-			return false;
-		});
-	},
-	matchContext: true,
-	meta: {
-		docs: {
-			description: "Reports when certain comment structures are always expected.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: { contexts: {
-				items: { anyOf: [{ type: "string" }, {
-					additionalProperties: false,
-					properties: {
-						comment: { type: "string" },
-						context: { type: "string" },
-						message: { type: "string" },
-						minimum: { type: "integer" }
-					},
-					type: "object"
-				}] },
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
+  contextSelected: true,
+  exit({
+    context,
+    settings,
+    state
+  }) {
+    if (!context.options.length && !settings.contexts) {
+      context.report({
+        loc: {
+          end: {
+            column: 1,
+            line: 1
+          },
+          start: {
+            column: 1,
+            line: 1
+          }
+        },
+        message: 'Rule `no-missing-syntax` is missing a `contexts` option.'
+      });
+      return;
+    }
+    setDefaults(state);
 
-//#endregion
-exports.default = noMissingSyntax_default;
+    /**
+     * @type {Context[]}
+     */
+    const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;
+
+    // Report when MISSING
+    contexts.some(cntxt => {
+      const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;
+      const comment = typeof cntxt === 'string' ? '' : cntxt?.comment;
+      const contextKey = contextStr === 'any' ? 'undefined' : contextStr;
+      if ((!state.selectorMap[contextKey] || !state.selectorMap[contextKey][comment] || state.selectorMap[contextKey][comment] < (
+      // @ts-expect-error comment would need an object, not string
+      cntxt?.minimum ?? 1)) && (contextStr !== 'any' || Object.values(state.selectorMap).every(cmmnt => {
+        return !cmmnt[comment] || cmmnt[comment] < (
+        // @ts-expect-error comment would need an object, not string
+        cntxt?.minimum ?? 1);
+      }))) {
+        const message = typeof cntxt === 'string' ? 'Syntax is required: {{context}}' : cntxt?.message ?? 'Syntax is required: {{context}}' + (comment ? ' with {{comment}}' : '');
+        context.report({
+          data: {
+            comment,
+            context: contextStr
+          },
+          loc: {
+            end: {
+              column: 1,
+              line: 1
+            },
+            start: {
+              column: 1,
+              line: 1
+            }
+          },
+          message
+        });
+        return true;
+      }
+      return false;
+    });
+  },
+  matchContext: true,
+  meta: {
+    docs: {
+      description: 'Reports when certain comment structures are always expected.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        contexts: {
+          items: {
+            anyOf: [{
+              type: 'string'
+            }, {
+              additionalProperties: false,
+              properties: {
+                comment: {
+                  type: 'string'
+                },
+                context: {
+                  type: 'string'
+                },
+                message: {
+                  type: 'string'
+                },
+                minimum: {
+                  type: 'integer'
+                }
+              },
+              type: 'object'
+            }]
+          },
+          type: 'array'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
 //# sourceMappingURL=noMissingSyntax.cjs.map

package/dist/rules/noMissingSyntax.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"noMissingSyntax.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noMissingSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {{\n *   comment: string,\n *   context: string,\n *   message: string,\n *   minimum: import('../iterateJsdoc.js').Integer\n * }} ContextObject\n */\n\n/**\n * @typedef {string|ContextObject} Context\n */\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n  if (!state.selectorMap) {\n    state.selectorMap = {};\n  }\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @param {string} selector\n * @param {string} comment\n * @returns {void}\n */\nconst incrementSelector = (state, selector, comment) => {\n  if (!state.selectorMap[selector]) {\n    state.selectorMap[selector] = {};\n  }\n\n  if (!state.selectorMap[selector][comment]) {\n    state.selectorMap[selector][comment] = 0;\n  }\n\n  state.selectorMap[selector][comment]++;\n};\n\nexport default iterateJsdoc(({\n  context,\n  info: {\n    comment,\n  },\n  state,\n  utils,\n}) => {\n  if (!context.options[0]) {\n    // Handle error later\n    return;\n  }\n\n  /**\n   * @type {Context[]}\n   */\n  const contexts = context.options[0].contexts;\n\n  const {\n    contextStr,\n  } = utils.findContext(contexts, comment);\n\n  setDefaults(state);\n\n  incrementSelector(state, contextStr, String(comment));\n}, {\n  contextSelected: true,\n  exit ({\n    context,\n    settings,\n    state,\n  }) {\n    if (!context.options.length && !settings.contexts) {\n      context.report({\n        loc: {\n          end: {\n            column: 1,\n            line: 1,\n          },\n          start: {\n            column: 1,\n            line: 1,\n          },\n        },\n        message: 'Rule `no-missing-syntax` is missing a `contexts` option.',\n      });\n\n      return;\n    }\n\n    setDefaults(state);\n\n    /**\n     * @type {Context[]}\n     */\n    const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;\n\n    // Report when MISSING\n    contexts.some((cntxt) => {\n      const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;\n      const comment = typeof cntxt === 'string' ? '' : cntxt?.comment;\n\n      const contextKey = contextStr === 'any' ? 'undefined' : contextStr;\n\n      if (\n        (!state.selectorMap[contextKey] ||\n        !state.selectorMap[contextKey][comment] ||\n        state.selectorMap[contextKey][comment] < (\n          // @ts-expect-error comment would need an object, not string\n          cntxt?.minimum ?? 1\n        )) &&\n        (contextStr !== 'any' || Object.values(state.selectorMap).every((cmmnt) => {\n          return !cmmnt[comment] || cmmnt[comment] < (\n            // @ts-expect-error comment would need an object, not string\n            cntxt?.minimum ?? 1\n          );\n        }))\n      ) {\n        const message = typeof cntxt === 'string' ?\n          'Syntax is required: {{context}}' :\n          cntxt?.message ?? ('Syntax is required: {{context}}' +\n            (comment ? ' with {{comment}}' : ''));\n        context.report({\n          data: {\n            comment,\n            context: contextStr,\n          },\n          loc: {\n            end: {\n              column: 1,\n              line: 1,\n            },\n            start: {\n              column: 1,\n              line: 1,\n            },\n          },\n          message,\n        });\n\n        return true;\n      }\n\n      return false;\n    });\n  },\n  matchContext: true,\n  meta: {\n    docs: {\n      description: 'Reports when certain comment structures are always expected.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header',\n    },\n    fixable: 'code',\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                    message: {\n                      type: 'string',\n                    },\n                    minimum: {\n                      type: 'integer',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;AAmBA,MAAM,cAAc,CAAC,UAAU;AAC7B,KAAI,CAAC,MAAM,aACT,MAAM,cAAc,CAAE;AAEzB;;;;;;;AAQD,MAAM,oBAAoB,CAAC,OAAO,UAAU,YAAY;AACtD,KAAI,CAAC,MAAM,YAAY,WACrB,MAAM,YAAY,YAAY,CAAE;AAGlC,KAAI,CAAC,MAAM,YAAY,UAAU,UAC/B,MAAM,YAAY,UAAU,WAAW;CAGzC,MAAM,YAAY,UAAU;AAC7B;AAED,8BAAeA,6BAAa,CAAC,EAC3B,SACA,MAAM,EACJ,SACD,EACD,OACA,OACD,KAAK;AACJ,KAAI,CAAC,QAAQ,QAAQ,GAEnB;;;;CAMF,MAAM,WAAW,QAAQ,QAAQ,GAAG;CAEpC,MAAM,EACJ,YACD,GAAG,MAAM,YAAY,UAAU,QAAQ;CAExC,YAAY,MAAM;CAElB,kBAAkB,OAAO,YAAY,OAAO,QAAQ,CAAC;AACtD,GAAE;CACD,iBAAiB;CACjB,KAAM,EACJ,SACA,UACA,OACD,EAAE;AACD,MAAI,CAAC,QAAQ,QAAQ,UAAU,CAAC,SAAS,UAAU;GACjD,QAAQ,OAAO;IACb,KAAK;KACH,KAAK;MACH,QAAQ;MACR,MAAM;KACP;KACD,OAAO;MACL,QAAQ;MACR,MAAM;KACP;IACF;IACD,SAAS;GACV,EAAC;AAEF;EACD;EAED,YAAY,MAAM;;;;EAKlB,MAAM,YAAY,QAAQ,QAAQ,MAAM,CAAE,GAAE,YAAY,UAAU;EAGlE,SAAS,KAAK,CAAC,UAAU;GACvB,MAAM,aAAa,OAAO,UAAU,WAAW,MAAM,WAAW,QAAQ;GACxE,MAAM,UAAU,OAAO,UAAU,WAAW,KAAK,OAAO;GAExD,MAAM,aAAa,eAAe,QAAQ,cAAc;AAExD,QACG,CAAC,MAAM,YAAY,eACpB,CAAC,MAAM,YAAY,YAAY,YAC/B,MAAM,YAAY,YAAY,YAE5B,OAAO,WAAW,QAEnB,eAAe,SAAS,OAAO,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,UAAU;AACzE,WAAO,CAAC,MAAM,YAAY,MAAM,YAE9B,OAAO,WAAW;GAErB,EAAC,GACF;IACA,MAAM,UAAU,OAAO,UAAU,WAC/B,oCACA,OAAO,WAAY,qCAChB,UAAU,sBAAsB;IACrC,QAAQ,OAAO;KACb,MAAM;MACJ;MACA,SAAS;KACV;KACD,KAAK;MACH,KAAK;OACH,QAAQ;OACR,MAAM;MACP;MACD,OAAO;OACL,QAAQ;OACR,MAAM;MACP;KACF;KACD;IACD,EAAC;AAEF,WAAO;GACR;AAED,UAAO;EACR,EAAC;CACH;CACD,cAAc;CACd,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,UACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
+{"version":3,"file":"noMissingSyntax.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","setDefaults","state","selectorMap","incrementSelector","selector","comment","_default","exports","iterateJsdoc","context","info","utils","options","contexts","contextStr","findContext","String","contextSelected","exit","settings","length","report","loc","end","column","line","start","message","some","cntxt","contextKey","minimum","Object","values","every","cmmnt","data","matchContext","meta","docs","description","url","fixable","schema","additionalProperties","properties","items","anyOf","type","module"],"sources":["../../src/rules/noMissingSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {{\n *   comment: string,\n *   context: string,\n *   message: string,\n *   minimum: import('../iterateJsdoc.js').Integer\n * }} ContextObject\n */\n\n/**\n * @typedef {string|ContextObject} Context\n */\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n  if (!state.selectorMap) {\n    state.selectorMap = {};\n  }\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @param {string} selector\n * @param {string} comment\n * @returns {void}\n */\nconst incrementSelector = (state, selector, comment) => {\n  if (!state.selectorMap[selector]) {\n    state.selectorMap[selector] = {};\n  }\n\n  if (!state.selectorMap[selector][comment]) {\n    state.selectorMap[selector][comment] = 0;\n  }\n\n  state.selectorMap[selector][comment]++;\n};\n\nexport default iterateJsdoc(({\n  context,\n  info: {\n    comment,\n  },\n  state,\n  utils,\n}) => {\n  if (!context.options[0]) {\n    // Handle error later\n    return;\n  }\n\n  /**\n   * @type {Context[]}\n   */\n  const contexts = context.options[0].contexts;\n\n  const {\n    contextStr,\n  } = utils.findContext(contexts, comment);\n\n  setDefaults(state);\n\n  incrementSelector(state, contextStr, String(comment));\n}, {\n  contextSelected: true,\n  exit ({\n    context,\n    settings,\n    state,\n  }) {\n    if (!context.options.length && !settings.contexts) {\n      context.report({\n        loc: {\n          end: {\n            column: 1,\n            line: 1,\n          },\n          start: {\n            column: 1,\n            line: 1,\n          },\n        },\n        message: 'Rule `no-missing-syntax` is missing a `contexts` option.',\n      });\n\n      return;\n    }\n\n    setDefaults(state);\n\n    /**\n     * @type {Context[]}\n     */\n    const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;\n\n    // Report when MISSING\n    contexts.some((cntxt) => {\n      const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;\n      const comment = typeof cntxt === 'string' ? '' : cntxt?.comment;\n\n      const contextKey = contextStr === 'any' ? 'undefined' : contextStr;\n\n      if (\n        (!state.selectorMap[contextKey] ||\n        !state.selectorMap[contextKey][comment] ||\n        state.selectorMap[contextKey][comment] < (\n          // @ts-expect-error comment would need an object, not string\n          cntxt?.minimum ?? 1\n        )) &&\n        (contextStr !== 'any' || Object.values(state.selectorMap).every((cmmnt) => {\n          return !cmmnt[comment] || cmmnt[comment] < (\n            // @ts-expect-error comment would need an object, not string\n            cntxt?.minimum ?? 1\n          );\n        }))\n      ) {\n        const message = typeof cntxt === 'string' ?\n          'Syntax is required: {{context}}' :\n          cntxt?.message ?? ('Syntax is required: {{context}}' +\n            (comment ? ' with {{comment}}' : ''));\n        context.report({\n          data: {\n            comment,\n            context: contextStr,\n          },\n          loc: {\n            end: {\n              column: 1,\n              line: 1,\n            },\n            start: {\n              column: 1,\n              line: 1,\n            },\n          },\n          message,\n        });\n\n        return true;\n      }\n\n      return false;\n    });\n  },\n  matchContext: true,\n  meta: {\n    docs: {\n      description: 'Reports when certain comment structures are always expected.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header',\n    },\n    fixable: 'code',\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                    message: {\n                      type: 'string',\n                    },\n                    minimum: {\n                      type: 'integer',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\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;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,MAAMG,WAAW,GAAIC,KAAK,IAAK;EAC7B,IAAI,CAACA,KAAK,CAACC,WAAW,EAAE;IACtBD,KAAK,CAACC,WAAW,GAAG,CAAC,CAAC;EACxB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,iBAAiB,GAAGA,CAACF,KAAK,EAAEG,QAAQ,EAAEC,OAAO,KAAK;EACtD,IAAI,CAACJ,KAAK,CAACC,WAAW,CAACE,QAAQ,CAAC,EAAE;IAChCH,KAAK,CAACC,WAAW,CAACE,QAAQ,CAAC,GAAG,CAAC,CAAC;EAClC;EAEA,IAAI,CAACH,KAAK,CAACC,WAAW,CAACE,QAAQ,CAAC,CAACC,OAAO,CAAC,EAAE;IACzCJ,KAAK,CAACC,WAAW,CAACE,QAAQ,CAAC,CAACC,OAAO,CAAC,GAAG,CAAC;EAC1C;EAEAJ,KAAK,CAACC,WAAW,CAACE,QAAQ,CAAC,CAACC,OAAO,CAAC,EAAE;AACxC,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAR,OAAA,GAEa,IAAAS,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI,EAAE;IACJL;EACF,CAAC;EACDJ,KAAK;EACLU;AACF,CAAC,KAAK;EACJ,IAAI,CAACF,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,EAAE;IACvB;IACA;EACF;;EAEA;AACF;AACA;EACE,MAAMC,QAAQ,GAAGJ,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,CAACC,QAAQ;EAE5C,MAAM;IACJC;EACF,CAAC,GAAGH,KAAK,CAACI,WAAW,CAACF,QAAQ,EAAER,OAAO,CAAC;EAExCL,WAAW,CAACC,KAAK,CAAC;EAElBE,iBAAiB,CAACF,KAAK,EAAEa,UAAU,EAAEE,MAAM,CAACX,OAAO,CAAC,CAAC;AACvD,CAAC,EAAE;EACDY,eAAe,EAAE,IAAI;EACrBC,IAAIA,CAAE;IACJT,OAAO;IACPU,QAAQ;IACRlB;EACF,CAAC,EAAE;IACD,IAAI,CAACQ,OAAO,CAACG,OAAO,CAACQ,MAAM,IAAI,CAACD,QAAQ,CAACN,QAAQ,EAAE;MACjDJ,OAAO,CAACY,MAAM,CAAC;QACbC,GAAG,EAAE;UACHC,GAAG,EAAE;YACHC,MAAM,EAAE,CAAC;YACTC,IAAI,EAAE;UACR,CAAC;UACDC,KAAK,EAAE;YACLF,MAAM,EAAE,CAAC;YACTC,IAAI,EAAE;UACR;QACF,CAAC;QACDE,OAAO,EAAE;MACX,CAAC,CAAC;MAEF;IACF;IAEA3B,WAAW,CAACC,KAAK,CAAC;;IAElB;AACJ;AACA;IACI,MAAMY,QAAQ,GAAG,CAACJ,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAEC,QAAQ,IAAIM,QAAQ,EAAEN,QAAQ;;IAE1E;IACAA,QAAQ,CAACe,IAAI,CAAEC,KAAK,IAAK;MACvB,MAAMf,UAAU,GAAG,OAAOe,KAAK,KAAK,QAAQ,GAAGA,KAAK,CAACpB,OAAO,IAAI,KAAK,GAAGoB,KAAK;MAC7E,MAAMxB,OAAO,GAAG,OAAOwB,KAAK,KAAK,QAAQ,GAAG,EAAE,GAAGA,KAAK,EAAExB,OAAO;MAE/D,MAAMyB,UAAU,GAAGhB,UAAU,KAAK,KAAK,GAAG,WAAW,GAAGA,UAAU;MAElE,IACE,CAAC,CAACb,KAAK,CAACC,WAAW,CAAC4B,UAAU,CAAC,IAC/B,CAAC7B,KAAK,CAACC,WAAW,CAAC4B,UAAU,CAAC,CAACzB,OAAO,CAAC,IACvCJ,KAAK,CAACC,WAAW,CAAC4B,UAAU,CAAC,CAACzB,OAAO,CAAC;MACpC;MACAwB,KAAK,EAAEE,OAAO,IAAI,CAAC,CACpB,MACAjB,UAAU,KAAK,KAAK,IAAIkB,MAAM,CAACC,MAAM,CAAChC,KAAK,CAACC,WAAW,CAAC,CAACgC,KAAK,CAAEC,KAAK,IAAK;QACzE,OAAO,CAACA,KAAK,CAAC9B,OAAO,CAAC,IAAI8B,KAAK,CAAC9B,OAAO,CAAC;QACtC;QACAwB,KAAK,EAAEE,OAAO,IAAI,CAAC,CACpB;MACH,CAAC,CAAC,CAAC,EACH;QACA,MAAMJ,OAAO,GAAG,OAAOE,KAAK,KAAK,QAAQ,GACvC,iCAAiC,GACjCA,KAAK,EAAEF,OAAO,IAAK,iCAAiC,IACjDtB,OAAO,GAAG,mBAAmB,GAAG,EAAE,CAAE;QACzCI,OAAO,CAACY,MAAM,CAAC;UACbe,IAAI,EAAE;YACJ/B,OAAO;YACPI,OAAO,EAAEK;UACX,CAAC;UACDQ,GAAG,EAAE;YACHC,GAAG,EAAE;cACHC,MAAM,EAAE,CAAC;cACTC,IAAI,EAAE;YACR,CAAC;YACDC,KAAK,EAAE;cACLF,MAAM,EAAE,CAAC;cACTC,IAAI,EAAE;YACR;UACF,CAAC;UACDE;QACF,CAAC,CAAC;QAEF,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd,CAAC,CAAC;EACJ,CAAC;EACDU,YAAY,EAAE,IAAI;EAClBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,8DAA8D;MAC3EC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVhC,QAAQ,EAAE;UACRiC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEC,IAAI,EAAE;YACR,CAAC,EACD;cACEJ,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVxC,OAAO,EAAE;kBACP2C,IAAI,EAAE;gBACR,CAAC;gBACDvC,OAAO,EAAE;kBACPuC,IAAI,EAAE;gBACR,CAAC;gBACDrB,OAAO,EAAE;kBACPqB,IAAI,EAAE;gBACR,CAAC;gBACDjB,OAAO,EAAE;kBACPiB,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAA1C,OAAA,GAAAA,OAAA,CAAAR,OAAA","ignoreList":[]}