eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/rules/requireParam.js

@@ -1,344 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireParam.js
-/**
-* @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn
-*/
-/**
-* @param {string[]} desiredRoots
-* @param {number} currentIndex
-* @returns {RootNamerReturn}
-*/
-const rootNamer = (desiredRoots, currentIndex) => {
-	/** @type {string} */
-	let name;
-	let idx = currentIndex;
-	const incremented = desiredRoots.length <= 1;
-	if (incremented) {
-		const base = desiredRoots[0];
-		const suffix = idx++;
-		name = `${base}${suffix}`;
-	} else name = desiredRoots.shift();
-	return [
-		name,
-		incremented,
-		() => {
-			return rootNamer(desiredRoots, idx);
-		}
-	];
-};
-var requireParam_default = iterateJsdoc(({ context, jsdoc, utils }) => {
-	if (utils.avoidDocs()) return;
-	if (utils.hasTag("type")) return;
-	const { autoIncrementBase = 0, checkDestructured = true, checkDestructuredRoots = true, checkRestProperty = false, checkTypesPattern = "/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/", enableFixer = true, enableRestElementFixer = true, enableRootFixer = true, ignoreWhenAllParamsMissing = false, unnamedRootBase = ["root"], useDefaultObjectProperties = false } = context.options[0] || {};
-	const preferredTagName = utils.getPreferredTagName({ tagName: "param" });
-	if (!preferredTagName) return;
-	const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);
-	if (!functionParameterNames.length) return;
-	const jsdocParameterNames = utils.getJsdocTagsDeep(preferredTagName);
-	if (ignoreWhenAllParamsMissing && !jsdocParameterNames.length) return;
-	const shallowJsdocParameterNames = jsdocParameterNames.filter((tag) => {
-		return !tag.name.includes(".");
-	}).map((tag, idx) => {
-		return {
-			...tag,
-			idx
-		};
-	});
-	const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);
-	/**
-	* @type {{
-	*   functionParameterIdx: import('../iterateJsdoc.js').Integer,
-	*   functionParameterName: string,
-	*   inc: boolean|undefined,
-	*   remove?: true,
-	*   type?: string|undefined
-	* }[]}
-	*/
-	const missingTags = [];
-	const flattenedRoots = utils.flattenRoots(functionParameterNames).names;
-	/**
-	* @type {{
-	*   [key: string]: import('../iterateJsdoc.js').Integer
-	* }}
-	*/
-	const paramIndex = {};
-	/**
-	* @param {string} cur
-	* @returns {boolean}
-	*/
-	const hasParamIndex = (cur) => {
-		return utils.dropPathSegmentQuotes(String(cur)) in paramIndex;
-	};
-	/**
-	*
-	* @param {string|number|undefined} cur
-	* @returns {import('../iterateJsdoc.js').Integer}
-	*/
-	const getParamIndex = (cur) => {
-		return paramIndex[utils.dropPathSegmentQuotes(String(cur))];
-	};
-	/**
-	*
-	* @param {string} cur
-	* @param {import('../iterateJsdoc.js').Integer} idx
-	* @returns {void}
-	*/
-	const setParamIndex = (cur, idx) => {
-		paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;
-	};
-	for (const [idx, cur] of flattenedRoots.entries()) setParamIndex(cur, idx);
-	/**
-	*
-	* @param {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {
-	*   newAdd?: boolean
-	* })[]} jsdocTags
-	* @param {import('../iterateJsdoc.js').Integer} indexAtFunctionParams
-	* @returns {import('../iterateJsdoc.js').Integer}
-	*/
-	const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {
-		const remainingRoots = functionParameterNames.slice(indexAtFunctionParams || 0);
-		const foundIndex = jsdocTags.findIndex(({ name, newAdd }) => {
-			return !newAdd && remainingRoots.some((remainingRoot) => {
-				if (Array.isArray(remainingRoot)) return remainingRoot[1].names.includes(name);
-				if (typeof remainingRoot === "object") return name === remainingRoot.name;
-				return name === remainingRoot;
-			});
-		});
-		const tags = foundIndex > -1 ? jsdocTags.slice(0, foundIndex) : jsdocTags.filter(({ tag }) => {
-			return tag === preferredTagName;
-		});
-		let tagLineCount = 0;
-		for (const { source } of tags) for (const { tokens: { end } } of source) if (!end) tagLineCount++;
-		return tagLineCount;
-	};
-	let [nextRootName, incremented, namer] = rootNamer([...unnamedRootBase], autoIncrementBase);
-	const thisOffset = functionParameterNames[0] === "this" ? 1 : 0;
-	for (const [functionParameterIdx, functionParameterName] of functionParameterNames.entries()) {
-		let inc;
-		if (Array.isArray(functionParameterName)) {
-			const matchedJsdoc = shallowJsdocParameterNames[functionParameterIdx - thisOffset];
-			/** @type {string} */
-			let rootName;
-			if (functionParameterName[0]) rootName = functionParameterName[0];
-			else if (matchedJsdoc && matchedJsdoc.name) {
-				rootName = matchedJsdoc.name;
-				if (matchedJsdoc.type && matchedJsdoc.type.search(checkTypesRegex) === -1) continue;
-			} else {
-				rootName = nextRootName;
-				inc = incremented;
-			}
-			[nextRootName, incremented, namer] = namer();
-			const { hasPropertyRest, hasRestElement, names, rests } = functionParameterName[1];
-			const notCheckingNames = [];
-			if (!enableRestElementFixer && hasRestElement) continue;
-			if (!checkDestructuredRoots) continue;
-			for (const [idx, paramName] of names.entries()) {
-				if (!jsdocParameterNames.find(({ name }) => {
-					return name === rootName;
-				}) && !missingTags.find(({ functionParameterName: fpn }) => {
-					return fpn === rootName;
-				})) {
-					const emptyParamIdx = jsdocParameterNames.findIndex(({ name }) => {
-						return !name;
-					});
-					if (emptyParamIdx > -1) missingTags.push({
-						functionParameterIdx: emptyParamIdx,
-						functionParameterName: rootName,
-						inc,
-						remove: true
-					});
-					else missingTags.push({
-						functionParameterIdx: hasParamIndex(rootName) ? getParamIndex(rootName) : getParamIndex(paramName),
-						functionParameterName: rootName,
-						inc
-					});
-				}
-				if (!checkDestructured) continue;
-				if (!checkRestProperty && rests[idx]) continue;
-				const fullParamName = `${rootName}.${paramName}`;
-				const notCheckingName = jsdocParameterNames.find(({ name, type: paramType }) => {
-					return utils.comparePaths(name)(fullParamName) && paramType.search(checkTypesRegex) === -1 && paramType !== "";
-				});
-				if (notCheckingName !== void 0) notCheckingNames.push(notCheckingName.name);
-				if (notCheckingNames.find((name) => {
-					return fullParamName.startsWith(name);
-				})) continue;
-				if (jsdocParameterNames && !jsdocParameterNames.find(({ name }) => {
-					return utils.comparePaths(name)(fullParamName);
-				})) missingTags.push({
-					functionParameterIdx: getParamIndex(functionParameterName[0] ? fullParamName : paramName),
-					functionParameterName: fullParamName,
-					inc,
-					type: hasRestElement && !hasPropertyRest ? "{...any}" : void 0
-				});
-			}
-			continue;
-		}
-		/** @type {string} */
-		let funcParamName;
-		let type;
-		if (typeof functionParameterName === "object") {
-			if (!enableRestElementFixer && functionParameterName.restElement) continue;
-			funcParamName = functionParameterName.name;
-			type = "{...any}";
-		} else funcParamName = functionParameterName;
-		if (jsdocParameterNames && !jsdocParameterNames.find(({ name }) => {
-			return name === funcParamName;
-		}) && funcParamName !== "this") missingTags.push({
-			functionParameterIdx: getParamIndex(funcParamName),
-			functionParameterName: funcParamName,
-			inc,
-			type
-		});
-	}
-	/**
-	*
-	* @param {{
-	*   functionParameterIdx: import('../iterateJsdoc.js').Integer,
-	*   functionParameterName: string,
-	*   remove?: true,
-	*   inc?: boolean,
-	*   type?: string
-	* }} cfg
-	*/
-	const fix = ({ functionParameterIdx, functionParameterName, inc, remove, type }) => {
-		if (inc && !enableRootFixer) return;
-		/**
-		*
-		* @param {import('../iterateJsdoc.js').Integer} tagIndex
-		* @param {import('../iterateJsdoc.js').Integer} sourceIndex
-		* @param {import('../iterateJsdoc.js').Integer} spliceCount
-		* @returns {void}
-		*/
-		const createTokens = (tagIndex, sourceIndex, spliceCount) => {
-			const tokens = {
-				number: sourceIndex + 1,
-				source: "",
-				tokens: {
-					delimiter: "*",
-					description: "",
-					end: "",
-					lineEnd: "",
-					name: functionParameterName,
-					newAdd: true,
-					postDelimiter: " ",
-					postName: "",
-					postTag: " ",
-					postType: type ? " " : "",
-					start: jsdoc.source[sourceIndex].tokens.start,
-					tag: `@${preferredTagName}`,
-					type: type ?? ""
-				}
-			};
-			/**
-			* @type {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {
-			*   newAdd?: true
-			* })[]}
-			*/ jsdoc.tags.splice(tagIndex, spliceCount, {
-				description: "",
-				inlineTags: [],
-				name: functionParameterName,
-				newAdd: true,
-				optional: false,
-				problems: [],
-				source: [tokens],
-				tag: preferredTagName,
-				type: type ?? ""
-			});
-			const firstNumber = jsdoc.source[0].number;
-			jsdoc.source.splice(sourceIndex, spliceCount, tokens);
-			for (const [idx, src] of jsdoc.source.slice(sourceIndex).entries()) src.number = firstNumber + sourceIndex + idx;
-		};
-		const offset = jsdoc.source.findIndex(({ tokens: { end, tag } }) => {
-			return tag || end;
-		});
-		if (remove) createTokens(functionParameterIdx, offset + functionParameterIdx, 1);
-		else {
-			const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx);
-			createTokens(expectedIdx, offset + expectedIdx, 0);
-		}
-	};
-	/**
-	* @returns {void}
-	*/
-	const fixer = () => {
-		for (const missingTag of missingTags) fix(missingTag);
-	};
-	if (missingTags.length && jsdoc.source.length === 1) utils.makeMultiline();
-	for (const { functionParameterName } of missingTags) utils.reportJSDoc(`Missing JSDoc @${preferredTagName} "${functionParameterName}" declaration.`, null, enableFixer ? fixer : null);
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that all function parameters are documented.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				autoIncrementBase: {
-					default: 0,
-					type: "integer"
-				},
-				checkConstructors: {
-					default: true,
-					type: "boolean"
-				},
-				checkDestructured: {
-					default: true,
-					type: "boolean"
-				},
-				checkDestructuredRoots: {
-					default: true,
-					type: "boolean"
-				},
-				checkGetters: {
-					default: false,
-					type: "boolean"
-				},
-				checkRestProperty: {
-					default: false,
-					type: "boolean"
-				},
-				checkSetters: {
-					default: false,
-					type: "boolean"
-				},
-				checkTypesPattern: { type: "string" },
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				enableFixer: { type: "boolean" },
-				enableRestElementFixer: { type: "boolean" },
-				enableRootFixer: { type: "boolean" },
-				exemptedBy: {
-					items: { type: "string" },
-					type: "array"
-				},
-				ignoreWhenAllParamsMissing: { type: "boolean" },
-				unnamedRootBase: {
-					items: { type: "string" },
-					type: "array"
-				},
-				useDefaultObjectProperties: { type: "boolean" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	},
-	noTracking: true
-});
-
-//#endregion
-export { requireParam_default as default };
-//# sourceMappingURL=requireParam.js.map

package/dist/rules/requireParam.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireParam.js","names":[],"sources":["../../src/rules/requireParam.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn\n */\n\n/**\n * @param {string[]} desiredRoots\n * @param {number} currentIndex\n * @returns {RootNamerReturn}\n */\nconst rootNamer = (desiredRoots, currentIndex) => {\n  /** @type {string} */\n  let name;\n  let idx = currentIndex;\n  const incremented = desiredRoots.length <= 1;\n  if (incremented) {\n    const base = desiredRoots[0];\n    const suffix = idx++;\n    name = `${base}${suffix}`;\n  } else {\n    name = /** @type {string} */ (desiredRoots.shift());\n  }\n\n  return [\n    name,\n    incremented,\n    () => {\n      return rootNamer(desiredRoots, idx);\n    },\n  ];\n};\n\n/* eslint-disable complexity -- Temporary */\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  /* eslint-enable complexity -- Temporary */\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  // Param type is specified by type in @type\n  if (utils.hasTag('type')) {\n    return;\n  }\n\n  const {\n    autoIncrementBase = 0,\n    checkDestructured = true,\n    checkDestructuredRoots = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    enableFixer = true,\n    enableRestElementFixer = true,\n    enableRootFixer = true,\n    ignoreWhenAllParamsMissing = false,\n    unnamedRootBase = [\n      'root',\n    ],\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  if (!preferredTagName) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n  if (!functionParameterNames.length) {\n    return;\n  }\n\n  const jsdocParameterNames =\n    /**\n     * @type {{\n     *   idx: import('../iterateJsdoc.js').Integer;\n     *   name: string;\n     *   type: string;\n     * }[]}\n     */ (utils.getJsdocTagsDeep(preferredTagName));\n\n  if (ignoreWhenAllParamsMissing && !jsdocParameterNames.length) {\n    return;\n  }\n\n  const shallowJsdocParameterNames = jsdocParameterNames.filter((tag) => {\n    return !tag.name.includes('.');\n  }).map((tag, idx) => {\n    return {\n      ...tag,\n      idx,\n    };\n  });\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  /**\n   * @type {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   inc: boolean|undefined,\n   *   remove?: true,\n   *   type?: string|undefined\n   * }[]}\n   */\n  const missingTags = [];\n  const flattenedRoots = utils.flattenRoots(functionParameterNames).names;\n\n  /**\n   * @type {{\n   *   [key: string]: import('../iterateJsdoc.js').Integer\n   * }}\n   */\n  const paramIndex = {};\n\n  /**\n   * @param {string} cur\n   * @returns {boolean}\n   */\n  const hasParamIndex = (cur) => {\n    return utils.dropPathSegmentQuotes(String(cur)) in paramIndex;\n  };\n\n  /**\n   *\n   * @param {string|number|undefined} cur\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const getParamIndex = (cur) => {\n    return paramIndex[utils.dropPathSegmentQuotes(String(cur))];\n  };\n\n  /**\n   *\n   * @param {string} cur\n   * @param {import('../iterateJsdoc.js').Integer} idx\n   * @returns {void}\n   */\n  const setParamIndex = (cur, idx) => {\n    paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;\n  };\n\n  for (const [\n    idx,\n    cur,\n  ] of flattenedRoots.entries()) {\n    setParamIndex(cur, idx);\n  }\n\n  /**\n   *\n   * @param {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n   *   newAdd?: boolean\n   * })[]} jsdocTags\n   * @param {import('../iterateJsdoc.js').Integer} indexAtFunctionParams\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {\n    const remainingRoots = functionParameterNames.slice(indexAtFunctionParams || 0);\n    const foundIndex = jsdocTags.findIndex(({\n      name,\n      newAdd,\n    }) => {\n      return !newAdd && remainingRoots.some((remainingRoot) => {\n        if (Array.isArray(remainingRoot)) {\n          return (\n            /**\n             * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string|undefined;\n             * }}\n             */ (remainingRoot[1]).names.includes(name)\n          );\n        }\n\n        if (typeof remainingRoot === 'object') {\n          return name === remainingRoot.name;\n        }\n\n        return name === remainingRoot;\n      });\n    });\n\n    const tags = foundIndex > -1 ?\n      jsdocTags.slice(0, foundIndex) :\n      jsdocTags.filter(({\n        tag,\n      }) => {\n        return tag === preferredTagName;\n      });\n\n    let tagLineCount = 0;\n    for (const {\n      source,\n    } of tags) {\n      for (const {\n        tokens: {\n          end,\n        },\n      } of source) {\n        if (!end) {\n          tagLineCount++;\n        }\n      }\n    }\n\n    return tagLineCount;\n  };\n\n  let [\n    nextRootName,\n    incremented,\n    namer,\n  ] = rootNamer([\n    ...unnamedRootBase,\n  ], autoIncrementBase);\n\n  const thisOffset = functionParameterNames[0] === 'this' ? 1 : 0;\n\n  for (const [\n    functionParameterIdx,\n    functionParameterName,\n  ] of functionParameterNames.entries()) {\n    let inc;\n    if (Array.isArray(functionParameterName)) {\n      const matchedJsdoc = shallowJsdocParameterNames[functionParameterIdx - thisOffset];\n\n      /** @type {string} */\n      let rootName;\n      if (functionParameterName[0]) {\n        rootName = functionParameterName[0];\n      } else if (matchedJsdoc && matchedJsdoc.name) {\n        rootName = matchedJsdoc.name;\n        if (matchedJsdoc.type && matchedJsdoc.type.search(checkTypesRegex) === -1) {\n          continue;\n        }\n      } else {\n        rootName = nextRootName;\n        inc = incremented;\n      }\n\n      [\n        nextRootName,\n        incremented,\n        namer,\n      ] = namer();\n\n      const {\n        hasPropertyRest,\n        hasRestElement,\n        names,\n        rests,\n      } = /**\n           * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n           *   annotationParamName?: string | undefined;\n           * }}\n           */ (functionParameterName[1]);\n      const notCheckingNames = [];\n      if (!enableRestElementFixer && hasRestElement) {\n        continue;\n      }\n\n      if (!checkDestructuredRoots) {\n        continue;\n      }\n\n      for (const [\n        idx,\n        paramName,\n      ] of names.entries()) {\n        // Add root if the root name is not in the docs (and is not already\n        //  in the tags to be fixed)\n        if (!jsdocParameterNames.find(({\n          name,\n        }) => {\n          return name === rootName;\n        }) && !missingTags.find(({\n          functionParameterName: fpn,\n        }) => {\n          return fpn === rootName;\n        })) {\n          const emptyParamIdx = jsdocParameterNames.findIndex(({\n            name,\n          }) => {\n            return !name;\n          });\n\n          if (emptyParamIdx > -1) {\n            missingTags.push({\n              functionParameterIdx: emptyParamIdx,\n              functionParameterName: rootName,\n              inc,\n              remove: true,\n            });\n          } else {\n            missingTags.push({\n              functionParameterIdx: hasParamIndex(rootName) ?\n                getParamIndex(rootName) :\n                getParamIndex(paramName),\n              functionParameterName: rootName,\n              inc,\n            });\n          }\n        }\n\n        if (!checkDestructured) {\n          continue;\n        }\n\n        if (!checkRestProperty && rests[idx]) {\n          continue;\n        }\n\n        const fullParamName = `${rootName}.${paramName}`;\n\n        const notCheckingName = jsdocParameterNames.find(({\n          name,\n          type: paramType,\n        }) => {\n          return utils.comparePaths(name)(fullParamName) && paramType.search(checkTypesRegex) === -1 && paramType !== '';\n        });\n\n        if (notCheckingName !== undefined) {\n          notCheckingNames.push(notCheckingName.name);\n        }\n\n        if (notCheckingNames.find((name) => {\n          return fullParamName.startsWith(name);\n        })) {\n          continue;\n        }\n\n        if (jsdocParameterNames && !jsdocParameterNames.find(({\n          name,\n        }) => {\n          return utils.comparePaths(name)(fullParamName);\n        })) {\n          missingTags.push({\n            functionParameterIdx: getParamIndex(\n              functionParameterName[0] ? fullParamName : paramName,\n            ),\n            functionParameterName: fullParamName,\n            inc,\n            type: hasRestElement && !hasPropertyRest ? '{...any}' : undefined,\n          });\n        }\n      }\n\n      continue;\n    }\n\n    /** @type {string} */\n    let funcParamName;\n    let type;\n    if (typeof functionParameterName === 'object') {\n      if (!enableRestElementFixer && functionParameterName.restElement) {\n        continue;\n      }\n\n      funcParamName = /** @type {string} */ (functionParameterName.name);\n      type = '{...any}';\n    } else {\n      funcParamName = /** @type {string} */ (functionParameterName);\n    }\n\n    if (jsdocParameterNames && !jsdocParameterNames.find(({\n      name,\n    }) => {\n      return name === funcParamName;\n    }) && funcParamName !== 'this') {\n      missingTags.push({\n        functionParameterIdx: getParamIndex(funcParamName),\n        functionParameterName: funcParamName,\n        inc,\n        type,\n      });\n    }\n  }\n\n  /**\n   *\n   * @param {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   remove?: true,\n   *   inc?: boolean,\n   *   type?: string\n   * }} cfg\n   */\n  const fix = ({\n    functionParameterIdx,\n    functionParameterName,\n    inc,\n    remove,\n    type,\n  }) => {\n    if (inc && !enableRootFixer) {\n      return;\n    }\n\n    /**\n     *\n     * @param {import('../iterateJsdoc.js').Integer} tagIndex\n     * @param {import('../iterateJsdoc.js').Integer} sourceIndex\n     * @param {import('../iterateJsdoc.js').Integer} spliceCount\n     * @returns {void}\n     */\n    const createTokens = (tagIndex, sourceIndex, spliceCount) => {\n      // console.log(sourceIndex, tagIndex, jsdoc.tags, jsdoc.source);\n      const tokens = {\n        number: sourceIndex + 1,\n        source: '',\n        tokens: {\n          delimiter: '*',\n          description: '',\n          end: '',\n          lineEnd: '',\n          name: functionParameterName,\n          newAdd: true,\n          postDelimiter: ' ',\n          postName: '',\n          postTag: ' ',\n          postType: type ? ' ' : '',\n          start: jsdoc.source[sourceIndex].tokens.start,\n          tag: `@${preferredTagName}`,\n          type: type ?? '',\n        },\n      };\n\n      /**\n       * @type {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n       *   newAdd?: true\n       * })[]}\n       */ (jsdoc.tags).splice(tagIndex, spliceCount, {\n        description: '',\n        inlineTags: [],\n        name: functionParameterName,\n        newAdd: true,\n        optional: false,\n        problems: [],\n        source: [\n          tokens,\n        ],\n        tag: preferredTagName,\n        type: type ?? '',\n      });\n      const firstNumber = jsdoc.source[0].number;\n      jsdoc.source.splice(sourceIndex, spliceCount, tokens);\n      for (const [\n        idx,\n        src,\n      ] of jsdoc.source.slice(sourceIndex).entries()) {\n        src.number = firstNumber + sourceIndex + idx;\n      }\n    };\n\n    const offset = jsdoc.source.findIndex(({\n      tokens: {\n        end,\n        tag,\n      },\n    }) => {\n      return tag || end;\n    });\n    if (remove) {\n      createTokens(functionParameterIdx, offset + functionParameterIdx, 1);\n    } else {\n      const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx);\n      createTokens(expectedIdx, offset + expectedIdx, 0);\n    }\n  };\n\n  /**\n   * @returns {void}\n   */\n  const fixer = () => {\n    for (const missingTag of missingTags) {\n      fix(missingTag);\n    }\n  };\n\n  if (missingTags.length && jsdoc.source.length === 1) {\n    utils.makeMultiline();\n  }\n\n  for (const {\n    functionParameterName,\n  } of missingTags) {\n    utils.reportJSDoc(\n      `Missing JSDoc @${preferredTagName} \"${functionParameterName}\" declaration.`,\n      null,\n      enableFixer ? fixer : null,\n    );\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all function parameters are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          autoIncrementBase: {\n            default: 0,\n            type: 'integer',\n          },\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructured: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructuredRoots: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            default: false,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\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          enableFixer: {\n            type: 'boolean',\n          },\n          enableRestElementFixer: {\n            type: 'boolean',\n          },\n          enableRootFixer: {\n            type: 'boolean',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreWhenAllParamsMissing: {\n            type: 'boolean',\n          },\n          unnamedRootBase: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n\n  // We cannot cache comment nodes as the contexts may recur with the\n  //  same comment node but a different JS node, and we may need the different\n  //  JS node to ensure we iterate its context\n  noTracking: true,\n});\n"],"mappings":";;;;;;;;;;;AAWA,MAAM,YAAY,CAAC,cAAc,iBAAiB;;CAEhD,IAAI;CACJ,IAAI,MAAM;CACV,MAAM,cAAc,aAAa,UAAU;AAC3C,KAAI,aAAa;EACf,MAAM,OAAO,aAAa;EAC1B,MAAM,SAAS;EACf,OAAO,GAAG,OAAO,QAAQ;CAC1B,OACC,OAA8B,aAAa,OAAO;AAGpD,QAAO;EACL;EACA;EACA,MAAM;AACJ,UAAO,UAAU,cAAc,IAAI;EACpC;CACF;AACF;AAGD,2BAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;AAEJ,KAAI,MAAM,WAAW,CACnB;AAIF,KAAI,MAAM,OAAO,OAAO,CACtB;CAGF,MAAM,EACJ,oBAAoB,GACpB,oBAAoB,MACpB,yBAAyB,MACzB,oBAAoB,OACpB,oBAAoB,kEACpB,cAAc,MACd,yBAAyB,MACzB,kBAAkB,MAClB,6BAA6B,OAC7B,kBAAkB,CAChB,MACD,GACD,6BAA6B,OAC9B,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,SAAS,QACV,EAAC;AACF,KAAI,CAAC,iBACH;CAGF,MAAM,yBAAyB,MAAM,0BAA0B,2BAA2B;AAC1F,KAAI,CAAC,uBAAuB,OAC1B;CAGF,MAAM,sBAOC,MAAM,iBAAiB,iBAAiB;AAE/C,KAAI,8BAA8B,CAAC,oBAAoB,OACrD;CAGF,MAAM,6BAA6B,oBAAoB,OAAO,CAAC,QAAQ;AACrE,SAAO,CAAC,IAAI,KAAK,SAAS,IAAI;CAC/B,EAAC,CAAC,IAAI,CAAC,KAAK,QAAQ;AACnB,SAAO;GACL,GAAG;GACH;EACD;CACF,EAAC;CAEF,MAAM,kBAAkB,MAAM,mBAAmB,kBAAkB;;;;;;;;;;CAWnE,MAAM,cAAc,CAAE;CACtB,MAAM,iBAAiB,MAAM,aAAa,uBAAuB,CAAC;;;;;;CAOlE,MAAM,aAAa,CAAE;;;;;CAMrB,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,SAAO,MAAM,sBAAsB,OAAO,IAAI,CAAC,IAAI;CACpD;;;;;;CAOD,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,SAAO,WAAW,MAAM,sBAAsB,OAAO,IAAI,CAAC;CAC3D;;;;;;;CAQD,MAAM,gBAAgB,CAAC,KAAK,QAAQ;EAClC,WAAW,MAAM,sBAAsB,OAAO,IAAI,CAAC,IAAI;CACxD;AAED,MAAK,MAAM,CACT,KACA,IACD,IAAI,eAAe,SAAS,EAC3B,cAAc,KAAK,IAAI;;;;;;;;;CAWzB,MAAM,oBAAoB,CAAC,WAAW,0BAA0B;EAC9D,MAAM,iBAAiB,uBAAuB,MAAM,yBAAyB,EAAE;EAC/E,MAAM,aAAa,UAAU,UAAU,CAAC,EACtC,MACA,QACD,KAAK;AACJ,UAAO,CAAC,UAAU,eAAe,KAAK,CAAC,kBAAkB;AACvD,QAAI,MAAM,QAAQ,cAAc,CAC9B,QAKO,cAAc,GAAI,MAAM,SAAS,KAAK;AAI/C,QAAI,OAAO,kBAAkB,SAC3B,QAAO,SAAS,cAAc;AAGhC,WAAO,SAAS;GACjB,EAAC;EACH,EAAC;EAEF,MAAM,OAAO,aAAa,KACxB,UAAU,MAAM,GAAG,WAAW,GAC9B,UAAU,OAAO,CAAC,EAChB,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC;EAEJ,IAAI,eAAe;AACnB,OAAK,MAAM,EACT,QACD,IAAI,KACH,MAAK,MAAM,EACT,QAAQ,EACN,KACD,EACF,IAAI,OACH,KAAI,CAAC,KACH;AAKN,SAAO;CACR;CAED,IAAI,CACF,cACA,aACA,MACD,GAAG,UAAU,CACZ,GAAG,eACJ,GAAE,kBAAkB;CAErB,MAAM,aAAa,uBAAuB,OAAO,SAAS,IAAI;AAE9D,MAAK,MAAM,CACT,sBACA,sBACD,IAAI,uBAAuB,SAAS,EAAE;EACrC,IAAI;AACJ,MAAI,MAAM,QAAQ,sBAAsB,EAAE;GACxC,MAAM,eAAe,2BAA2B,uBAAuB;;GAGvE,IAAI;AACJ,OAAI,sBAAsB,IACxB,WAAW,sBAAsB;YACxB,gBAAgB,aAAa,MAAM;IAC5C,WAAW,aAAa;AACxB,QAAI,aAAa,QAAQ,aAAa,KAAK,OAAO,gBAAgB,KAAK,GACrE;GAEH,OAAM;IACL,WAAW;IACX,MAAM;GACP;GAED,CACE,cACA,aACA,MACD,GAAG,OAAO;GAEX,MAAM,EACJ,iBACA,gBACA,OACA,OACD,GAIQ,sBAAsB;GAC/B,MAAM,mBAAmB,CAAE;AAC3B,OAAI,CAAC,0BAA0B,eAC7B;AAGF,OAAI,CAAC,uBACH;AAGF,QAAK,MAAM,CACT,KACA,UACD,IAAI,MAAM,SAAS,EAAE;AAGpB,QAAI,CAAC,oBAAoB,KAAK,CAAC,EAC7B,MACD,KAAK;AACJ,YAAO,SAAS;IACjB,EAAC,IAAI,CAAC,YAAY,KAAK,CAAC,EACvB,uBAAuB,KACxB,KAAK;AACJ,YAAO,QAAQ;IAChB,EAAC,EAAE;KACF,MAAM,gBAAgB,oBAAoB,UAAU,CAAC,EACnD,MACD,KAAK;AACJ,aAAO,CAAC;KACT,EAAC;AAEF,SAAI,gBAAgB,IAClB,YAAY,KAAK;MACf,sBAAsB;MACtB,uBAAuB;MACvB;MACA,QAAQ;KACT,EAAC;UAEF,YAAY,KAAK;MACf,sBAAsB,cAAc,SAAS,GAC3C,cAAc,SAAS,GACvB,cAAc,UAAU;MAC1B,uBAAuB;MACvB;KACD,EAAC;IAEL;AAED,QAAI,CAAC,kBACH;AAGF,QAAI,CAAC,qBAAqB,MAAM,KAC9B;IAGF,MAAM,gBAAgB,GAAG,SAAS,CAAC,EAAE,WAAW;IAEhD,MAAM,kBAAkB,oBAAoB,KAAK,CAAC,EAChD,MACA,MAAM,WACP,KAAK;AACJ,YAAO,MAAM,aAAa,KAAK,CAAC,cAAc,IAAI,UAAU,OAAO,gBAAgB,KAAK,MAAM,cAAc;IAC7G,EAAC;AAEF,QAAI,oBAAoB,QACtB,iBAAiB,KAAK,gBAAgB,KAAK;AAG7C,QAAI,iBAAiB,KAAK,CAAC,SAAS;AAClC,YAAO,cAAc,WAAW,KAAK;IACtC,EAAC,CACA;AAGF,QAAI,uBAAuB,CAAC,oBAAoB,KAAK,CAAC,EACpD,MACD,KAAK;AACJ,YAAO,MAAM,aAAa,KAAK,CAAC,cAAc;IAC/C,EAAC,EACA,YAAY,KAAK;KACf,sBAAsB,cACpB,sBAAsB,KAAK,gBAAgB,UAC5C;KACD,uBAAuB;KACvB;KACA,MAAM,kBAAkB,CAAC,kBAAkB,aAAa;IACzD,EAAC;GAEL;AAED;EACD;;EAGD,IAAI;EACJ,IAAI;AACJ,MAAI,OAAO,0BAA0B,UAAU;AAC7C,OAAI,CAAC,0BAA0B,sBAAsB,YACnD;GAGF,gBAAuC,sBAAsB;GAC7D,OAAO;EACR,OACC,gBAAuC;AAGzC,MAAI,uBAAuB,CAAC,oBAAoB,KAAK,CAAC,EACpD,MACD,KAAK;AACJ,UAAO,SAAS;EACjB,EAAC,IAAI,kBAAkB,QACtB,YAAY,KAAK;GACf,sBAAsB,cAAc,cAAc;GAClD,uBAAuB;GACvB;GACA;EACD,EAAC;CAEL;;;;;;;;;;;CAYD,MAAM,MAAM,CAAC,EACX,sBACA,uBACA,KACA,QACA,MACD,KAAK;AACJ,MAAI,OAAO,CAAC,gBACV;;;;;;;;EAUF,MAAM,eAAe,CAAC,UAAU,aAAa,gBAAgB;GAE3D,MAAM,SAAS;IACb,QAAQ,cAAc;IACtB,QAAQ;IACR,QAAQ;KACN,WAAW;KACX,aAAa;KACb,KAAK;KACL,SAAS;KACT,MAAM;KACN,QAAQ;KACR,eAAe;KACf,UAAU;KACV,SAAS;KACT,UAAU,OAAO,MAAM;KACvB,OAAO,MAAM,OAAO,aAAa,OAAO;KACxC,KAAK,CAAC,CAAC,EAAE,kBAAkB;KAC3B,MAAM,QAAQ;IACf;GACF;;;;;MAMI,MAAM,KAAM,OAAO,UAAU,aAAa;IAC7C,aAAa;IACb,YAAY,CAAE;IACd,MAAM;IACN,QAAQ;IACR,UAAU;IACV,UAAU,CAAE;IACZ,QAAQ,CACN,MACD;IACD,KAAK;IACL,MAAM,QAAQ;GACf,EAAC;GACF,MAAM,cAAc,MAAM,OAAO,GAAG;GACpC,MAAM,OAAO,OAAO,aAAa,aAAa,OAAO;AACrD,QAAK,MAAM,CACT,KACA,IACD,IAAI,MAAM,OAAO,MAAM,YAAY,CAAC,SAAS,EAC5C,IAAI,SAAS,cAAc,cAAc;EAE5C;EAED,MAAM,SAAS,MAAM,OAAO,UAAU,CAAC,EACrC,QAAQ,EACN,KACA,KACD,EACF,KAAK;AACJ,UAAO,OAAO;EACf,EAAC;AACF,MAAI,QACF,aAAa,sBAAsB,SAAS,sBAAsB,EAAE;OAC/D;GACL,MAAM,cAAc,kBAAkB,MAAM,MAAM,qBAAqB;GACvE,aAAa,aAAa,SAAS,aAAa,EAAE;EACnD;CACF;;;;CAKD,MAAM,QAAQ,MAAM;AAClB,OAAK,MAAM,cAAc,aACvB,IAAI,WAAW;CAElB;AAED,KAAI,YAAY,UAAU,MAAM,OAAO,WAAW,GAChD,MAAM,eAAe;AAGvB,MAAK,MAAM,EACT,uBACD,IAAI,aACH,MAAM,YACJ,CAAC,eAAe,EAAE,iBAAiB,EAAE,EAAE,sBAAsB,cAAc,CAAC,EAC5E,MACA,cAAc,QAAQ,KACvB;AAEJ,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,wBAAwB;KACtB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,mBAAmB,EACjB,MAAM,SACP;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,aAAa,EACX,MAAM,UACP;IACD,wBAAwB,EACtB,MAAM,UACP;IACD,iBAAiB,EACf,MAAM,UACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,4BAA4B,EAC1B,MAAM,UACP;IACD,iBAAiB;KACf,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,4BAA4B,EAC1B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;CAKD,YAAY;AACb,EAAC"}

package/dist/rules/requireParamDescription.js

@@ -1,59 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireParamDescription.js
-var requireParamDescription_default = iterateJsdoc(({ context, report, settings, utils }) => {
-	const { defaultDestructuredRootDescription = "The root object", setDefaultDestructuredRootDescription = false } = context.options[0] || {};
-	const functionParameterNames = utils.getFunctionParameterNames();
-	let rootCount = -1;
-	utils.forEachPreferredTag("param", (jsdocParameter, targetTagName) => {
-		rootCount += jsdocParameter.name.includes(".") ? 0 : 1;
-		if (!jsdocParameter.description.trim()) {
-			if (Array.isArray(functionParameterNames[rootCount])) {
-				if (settings.exemptDestructuredRootsFromChecks) return;
-				if (setDefaultDestructuredRootDescription) {
-					utils.reportJSDoc(`Missing root description for @${targetTagName}.`, jsdocParameter, () => {
-						utils.changeTag(jsdocParameter, {
-							description: defaultDestructuredRootDescription,
-							postName: " "
-						});
-					});
-					return;
-				}
-			}
-			report(`Missing JSDoc @${targetTagName} "${jsdocParameter.name}" description.`, null, jsdocParameter);
-		}
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that each `@param` tag has a `description` value.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.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"
-				},
-				defaultDestructuredRootDescription: { type: "string" },
-				setDefaultDestructuredRootDescription: { type: "boolean" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireParamDescription_default as default };
-//# sourceMappingURL=requireParamDescription.js.map

package/dist/rules/requireParamDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireParamDescription.js","names":[],"sources":["../../src/rules/requireParamDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    defaultDestructuredRootDescription = 'The root object',\n    setDefaultDestructuredRootDescription = false,\n  } = context.options[0] || {};\n\n  const functionParameterNames = utils.getFunctionParameterNames();\n\n  let rootCount = -1;\n  utils.forEachPreferredTag('param', (jsdocParameter, targetTagName) => {\n    rootCount += jsdocParameter.name.includes('.') ? 0 : 1;\n    if (!jsdocParameter.description.trim()) {\n      if (Array.isArray(functionParameterNames[rootCount])) {\n        if (settings.exemptDestructuredRootsFromChecks) {\n          return;\n        }\n\n        if (setDefaultDestructuredRootDescription) {\n          utils.reportJSDoc(`Missing root description for @${targetTagName}.`, jsdocParameter, () => {\n            utils.changeTag(jsdocParameter, {\n              description: defaultDestructuredRootDescription,\n              postName: ' ',\n            });\n          });\n          return;\n        }\n      }\n\n      report(\n        `Missing JSDoc @${targetTagName} \"${jsdocParameter.name}\" description.`,\n        null,\n        jsdocParameter,\n      );\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that each `@param` tag has a `description` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.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          defaultDestructuredRootDescription: {\n            type: 'string',\n          },\n          setDefaultDestructuredRootDescription: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,sCAAe,aAAa,CAAC,EAC3B,SACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,qCAAqC,mBACrC,wCAAwC,OACzC,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,yBAAyB,MAAM,2BAA2B;CAEhE,IAAI,YAAY;CAChB,MAAM,oBAAoB,SAAS,CAAC,gBAAgB,kBAAkB;EACpE,aAAa,eAAe,KAAK,SAAS,IAAI,GAAG,IAAI;AACrD,MAAI,CAAC,eAAe,YAAY,MAAM,EAAE;AACtC,OAAI,MAAM,QAAQ,uBAAuB,WAAW,EAAE;AACpD,QAAI,SAAS,kCACX;AAGF,QAAI,uCAAuC;KACzC,MAAM,YAAY,CAAC,8BAA8B,EAAE,cAAc,CAAC,CAAC,EAAE,gBAAgB,MAAM;MACzF,MAAM,UAAU,gBAAgB;OAC9B,aAAa;OACb,UAAU;MACX,EAAC;KACH,EAAC;AACF;IACD;GACF;GAED,OACE,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,eAAe,KAAK,cAAc,CAAC,EACvE,MACA,eACD;EACF;CACF,EAAC;AACH,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,oCAAoC,EAClC,MAAM,SACP;IACD,uCAAuC,EACrC,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireParamName.js

@@ -1,36 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireParamName.js
-var requireParamName_default = iterateJsdoc(({ report, utils }) => {
-	utils.forEachPreferredTag("param", (jsdocParameter, targetTagName) => {
-		if (jsdocParameter.tag && jsdocParameter.name === "") report(`There must be an identifier after @${targetTagName} ${jsdocParameter.type === "" ? "type" : "tag"}.`, null, jsdocParameter);
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that all function parameters have names.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { contexts: {
-				items: { anyOf: [{ type: "string" }, {
-					additionalProperties: false,
-					properties: {
-						comment: { type: "string" },
-						context: { type: "string" }
-					},
-					type: "object"
-				}] },
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireParamName_default as default };
-//# sourceMappingURL=requireParamName.js.map

package/dist/rules/requireParamName.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireParamName.js","names":[],"sources":["../../src/rules/requireParamName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('param', (jsdocParameter, targetTagName) => {\n    if (jsdocParameter.tag && jsdocParameter.name === '') {\n      report(\n        `There must be an identifier after @${targetTagName} ${jsdocParameter.type === '' ? 'type' : 'tag'}.`,\n        null,\n        jsdocParameter,\n      );\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all function parameters have names.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,+BAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,SAAS,CAAC,gBAAgB,kBAAkB;AACpE,MAAI,eAAe,OAAO,eAAe,SAAS,IAChD,OACE,CAAC,mCAAmC,EAAE,cAAc,CAAC,EAAE,eAAe,SAAS,KAAK,SAAS,MAAM,CAAC,CAAC,EACrG,MACA,eACD;CAEJ,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,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;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireParamType.js

@@ -1,59 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireParamType.js
-var requireParamType_default = iterateJsdoc(({ context, report, settings, utils }) => {
-	const { defaultDestructuredRootType = "object", setDefaultDestructuredRootType = false } = context.options[0] || {};
-	const functionParameterNames = utils.getFunctionParameterNames();
-	let rootCount = -1;
-	utils.forEachPreferredTag("param", (jsdocParameter, targetTagName) => {
-		rootCount += jsdocParameter.name.includes(".") ? 0 : 1;
-		if (!jsdocParameter.type) {
-			if (Array.isArray(functionParameterNames[rootCount])) {
-				if (settings.exemptDestructuredRootsFromChecks) return;
-				if (setDefaultDestructuredRootType) {
-					utils.reportJSDoc(`Missing root type for @${targetTagName}.`, jsdocParameter, () => {
-						utils.changeTag(jsdocParameter, {
-							postType: " ",
-							type: `{${defaultDestructuredRootType}}`
-						});
-					});
-					return;
-				}
-			}
-			report(`Missing JSDoc @${targetTagName} "${jsdocParameter.name}" type.`, null, jsdocParameter);
-		}
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that each `@param` tag has a `type` value.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-type.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"
-				},
-				defaultDestructuredRootType: { type: "string" },
-				setDefaultDestructuredRootType: { type: "boolean" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireParamType_default as default };
-//# sourceMappingURL=requireParamType.js.map

package/dist/rules/requireParamType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireParamType.js","names":[],"sources":["../../src/rules/requireParamType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    defaultDestructuredRootType = 'object',\n    setDefaultDestructuredRootType = false,\n  } = context.options[0] || {};\n\n  const functionParameterNames = utils.getFunctionParameterNames();\n\n  let rootCount = -1;\n  utils.forEachPreferredTag('param', (jsdocParameter, targetTagName) => {\n    rootCount += jsdocParameter.name.includes('.') ? 0 : 1;\n    if (!jsdocParameter.type) {\n      if (Array.isArray(functionParameterNames[rootCount])) {\n        if (settings.exemptDestructuredRootsFromChecks) {\n          return;\n        }\n\n        if (setDefaultDestructuredRootType) {\n          utils.reportJSDoc(`Missing root type for @${targetTagName}.`, jsdocParameter, () => {\n            utils.changeTag(jsdocParameter, {\n              postType: ' ',\n              type: `{${defaultDestructuredRootType}}`,\n            });\n          });\n          return;\n        }\n      }\n\n      report(\n        `Missing JSDoc @${targetTagName} \"${jsdocParameter.name}\" type.`,\n        null,\n        jsdocParameter,\n      );\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that each `@param` tag has a `type` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-type.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          defaultDestructuredRootType: {\n            type: 'string',\n          },\n          setDefaultDestructuredRootType: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,+BAAe,aAAa,CAAC,EAC3B,SACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,8BAA8B,UAC9B,iCAAiC,OAClC,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,yBAAyB,MAAM,2BAA2B;CAEhE,IAAI,YAAY;CAChB,MAAM,oBAAoB,SAAS,CAAC,gBAAgB,kBAAkB;EACpE,aAAa,eAAe,KAAK,SAAS,IAAI,GAAG,IAAI;AACrD,MAAI,CAAC,eAAe,MAAM;AACxB,OAAI,MAAM,QAAQ,uBAAuB,WAAW,EAAE;AACpD,QAAI,SAAS,kCACX;AAGF,QAAI,gCAAgC;KAClC,MAAM,YAAY,CAAC,uBAAuB,EAAE,cAAc,CAAC,CAAC,EAAE,gBAAgB,MAAM;MAClF,MAAM,UAAU,gBAAgB;OAC9B,UAAU;OACV,MAAM,CAAC,CAAC,EAAE,4BAA4B,CAAC,CAAC;MACzC,EAAC;KACH,EAAC;AACF;IACD;GACF;GAED,OACE,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,eAAe,KAAK,OAAO,CAAC,EAChE,MACA,eACD;EACF;CACF,EAAC;AACH,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,6BAA6B,EAC3B,MAAM,SACP;IACD,gCAAgC,EAC9B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireProperty.js

@@ -1,35 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireProperty.js
-var requireProperty_default = iterateJsdoc(({ utils }) => {
-	const propertyAssociatedTags = utils.filterTags(({ tag }) => {
-		return ["namespace", "typedef"].includes(tag);
-	});
-	if (!propertyAssociatedTags.length) return;
-	const targetTagName = utils.getPreferredTagName({ tagName: "property" });
-	if (utils.hasATag([targetTagName])) return;
-	for (const propertyAssociatedTag of propertyAssociatedTags) {
-		if (![
-			"object",
-			"Object",
-			"PlainObject"
-		].includes(propertyAssociatedTag.type)) continue;
-		utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {
-			utils.addTag(targetTagName);
-		});
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header"
-		},
-		fixable: "code",
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireProperty_default as default };
-//# sourceMappingURL=requireProperty.js.map

package/dist/rules/requireProperty.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireProperty.js","names":[],"sources":["../../src/rules/requireProperty.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  utils,\n}) => {\n  const propertyAssociatedTags = utils.filterTags(({\n    tag,\n  }) => {\n    return [\n      'namespace', 'typedef',\n    ].includes(tag);\n  });\n  if (!propertyAssociatedTags.length) {\n    return;\n  }\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'property',\n  }));\n\n  if (utils.hasATag([\n    targetTagName,\n  ])) {\n    return;\n  }\n\n  for (const propertyAssociatedTag of propertyAssociatedTags) {\n    if (![\n      'object', 'Object', 'PlainObject',\n    ].includes(propertyAssociatedTag.type)) {\n      continue;\n    }\n\n    utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {\n      utils.addTag(targetTagName);\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,8BAAe,aAAa,CAAC,EAC3B,OACD,KAAK;CACJ,MAAM,yBAAyB,MAAM,WAAW,CAAC,EAC/C,KACD,KAAK;AACJ,SAAO,CACL,aAAa,SACd,EAAC,SAAS,IAAI;CAChB,EAAC;AACF,KAAI,CAAC,uBAAuB,OAC1B;CAGF,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,SAAS,WACV,EAAC;AAEF,KAAI,MAAM,QAAQ,CAChB,aACD,EAAC,CACA;AAGF,MAAK,MAAM,yBAAyB,wBAAwB;AAC1D,MAAI,CAAC;GACH;GAAU;GAAU;EACrB,EAAC,SAAS,sBAAsB,KAAK,CACpC;EAGF,MAAM,YAAY,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC,EAAE,MAAM,MAAM;GAChE,MAAM,OAAO,cAAc;EAC5B,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requirePropertyDescription.js

@@ -1,21 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requirePropertyDescription.js
-var requirePropertyDescription_default = iterateJsdoc(({ report, utils }) => {
-	utils.forEachPreferredTag("property", (jsdoc, targetTagName) => {
-		if (!jsdoc.description.trim()) report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`, null, jsdoc);
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires that each `@property` tag has a `description` value.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header"
-		},
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requirePropertyDescription_default as default };
-//# sourceMappingURL=requirePropertyDescription.js.map

package/dist/rules/requirePropertyDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requirePropertyDescription.js","names":[],"sources":["../../src/rules/requirePropertyDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n    if (!jsdoc.description.trim()) {\n      report(\n        `Missing JSDoc @${targetTagName} \"${jsdoc.name}\" description.`,\n        null,\n        jsdoc,\n      );\n    }\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires that each `@property` tag has a `description` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,yCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,YAAY,CAAC,OAAO,kBAAkB;AAC9D,MAAI,CAAC,MAAM,YAAY,MAAM,EAC3B,OACE,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,MAAM,KAAK,cAAc,CAAC,EAC9D,MACA,MACD;CAEJ,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}