eslint-plugin-jsdoc 55.0.5 → 55.1.1

package/dist/tagNames.d.ts

@@ -0,0 +1,16 @@
+export type AliasedTags = {
+    [key: string]: string[];
+};
+/**
+ * @type {AliasedTags}
+ */
+export const closureTags: AliasedTags;
+/**
+ * @type {AliasedTags}
+ */
+export const jsdocTags: AliasedTags;
+/**
+ * @type {AliasedTags}
+ */
+export const typeScriptTags: AliasedTags;
+//# sourceMappingURL=tagNames.d.ts.map

package/dist/utils/hasReturnValue.d.ts

@@ -0,0 +1,20 @@
+export type ESTreeOrTypeScriptNode = import("estree").Node | import("@typescript-eslint/types").TSESTree.Node;
+export type PromiseFilter = (node: ESTreeOrTypeScriptNode | undefined) => boolean;
+/**
+ * Checks if a node has a return statement. Void return does not count.
+ * @param {ESTreeOrTypeScriptNode|undefined|null} node
+ * @param {boolean} [throwOnNullReturn]
+ * @param {PromiseFilter} [promFilter]
+ * @returns {boolean|undefined}
+ */
+export function hasReturnValue(node: ESTreeOrTypeScriptNode | undefined | null, throwOnNullReturn?: boolean, promFilter?: PromiseFilter): boolean | undefined;
+/**
+ * Checks if a Promise executor has no resolve value or an empty value.
+ * An `undefined` resolve does not count.
+ * @param {ESTreeOrTypeScriptNode} node
+ * @param {boolean} anyPromiseAsReturn
+ * @param {boolean} [allBranches]
+ * @returns {boolean}
+ */
+export function hasValueOrExecutorHasNonEmptyResolveValue(node: ESTreeOrTypeScriptNode, anyPromiseAsReturn: boolean, allBranches?: boolean): boolean;
+//# sourceMappingURL=hasReturnValue.d.ts.map

package/package.json

@@ -58,6 +58,7 @@
     "husky": "^9.1.7",
     "jsdoc-type-pratt-parser": "^5.1.1",
     "json-schema": "^0.4.0",
+    "json-schema-to-typescript": "^15.0.4",
     "lint-staged": "^16.1.6",
     "mocha": "^11.7.2",
     "open-editor": "^5.1.0",
@@ -141,6 +142,7 @@
     "package-lock.json": "pnpm run install-offline"
   },
   "scripts": {
+    "ruleTypes": "node ./src/bin/generateRuleTypes.js",
     "tsc": "tsc",
     "tsc-build": "tsc -p tsconfig-prod.json",
     "build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
@@ -158,5 +160,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": "55.0.5"
+  "version": "55.1.1"
 }

package/src/index-esm.js

@@ -16,7 +16,8 @@ export default index;
  *   cfg?: {
  *     mergeSettings?: boolean,
  *     config?: `flat/${import('./index-cjs.js').ConfigGroups}${import('./index-cjs.js').ConfigVariants}${import('./index-cjs.js').ErrorLevelVariants}`,
- *     settings?: Partial<import('./iterateJsdoc.js').Settings>
+ *     settings?: Partial<import('./iterateJsdoc.js').Settings>,
+ *     rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
  *   }
  * ) => import('eslint').Linter.Config)}
  */
@@ -39,6 +40,10 @@ export const jsdoc = function (cfg) {
     outputConfig = index.configs[cfg.config];
   }
 
+  if (cfg?.rules) {
+    outputConfig.rules = cfg.rules;
+  }
+
   outputConfig.settings = {
     jsdoc: cfg?.mergeSettings === false ?
       cfg.settings :

package/src/index.js

@@ -539,7 +539,8 @@ export default index;
  *   cfg?: {
  *     mergeSettings?: boolean,
  *     config?: `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
- *     settings?: Partial<import('./iterateJsdoc.js').Settings>
+ *     settings?: Partial<import('./iterateJsdoc.js').Settings>,
+ *     rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
  *   }
  * ) => import('eslint').Linter.Config)}
  */
@@ -562,6 +563,10 @@ export const jsdoc = function (cfg) {
     outputConfig = index.configs[cfg.config];
   }
 
+  if (cfg?.rules) {
+    outputConfig.rules = cfg.rules;
+  }
+
   outputConfig.settings = {
     jsdoc: cfg?.mergeSettings === false ?
       cfg.settings :

package/src/jsdocUtils.js

@@ -529,7 +529,8 @@ const getTagNamesForMode = (mode, context) => {
     case 'permissive':
       return closureTags;
     case 'jsdoc':
-      return jsdocTags; case 'typescript':
+      return jsdocTags;
+    case 'typescript':
       return typeScriptTags;
     default:
       if (!modeWarnSettings.hasBeenWarned(context, 'mode')) {