eslint-plugin-jsdoc 57.2.0 → 58.0.0

package/src/rules.d.ts

@@ -1,4 +1,7 @@
 export interface Rules {
+  /** Checks that `@access` tags have a valid value. */
+  "jsdoc/check-access": [];
+
   /** Reports invalid alignment of JSDoc block asterisks. */
   "jsdoc/check-alignment": 
     | []
@@ -90,6 +93,9 @@ export interface Rules {
         }
       ];
 
+  /** Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode). */
+  "jsdoc/check-syntax": [];
+
   /** Reports invalid block tag names. */
   "jsdoc/check-tag-names": 
     | []
@@ -102,6 +108,9 @@ export interface Rules {
         }
       ];
 
+  /** Checks that any `@template` names are actually used in the connected `@typedef` or type alias. */
+  "jsdoc/check-template-names": [];
+
   /** Reports invalid types. */
   "jsdoc/check-types": 
     | []
@@ -188,6 +197,9 @@ export interface Rules {
         }
       ];
 
+  /** Reports if JSDoc `import()` statements point to a package which is not listed in `dependencies` or `devDependencies` */
+  "jsdoc/imports-as-dependencies": [];
+
   /** This rule reports doc comments that only restate their attached name. */
   "jsdoc/informative-docs": 
     | []
@@ -300,6 +312,9 @@ export interface Rules {
         }
       ];
 
+  /** Detects and removes extra lines of a blank block description */
+  "jsdoc/no-blank-block-descriptions": [];
+
   /** Removes empty blocks with nothing but possibly line breaks */
   "jsdoc/no-blank-blocks": 
     | []
@@ -395,6 +410,12 @@ export interface Rules {
         }
       ];
 
+  /** Reports use of `any` or `*` type */
+  "jsdoc/reject-any-type": [];
+
+  /** Reports use of `Function` type */
+  "jsdoc/reject-function-type": [];
+
   /** Requires that each JSDoc line starts with an `*`. */
   "jsdoc/require-asterisk-prefix": 
     | []
@@ -542,6 +563,9 @@ export interface Rules {
         }
       ];
 
+  /** Requires a type for `@next` tags */
+  "jsdoc/require-next-type": [];
+
   /** Requires that all function parameters are documented. */
   "jsdoc/require-param": 
     | []
@@ -621,6 +645,18 @@ export interface Rules {
         }
       ];
 
+  /** Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`. */
+  "jsdoc/require-property": [];
+
+  /** Requires that each `@property` tag has a `description` value. */
+  "jsdoc/require-property-description": [];
+
+  /** Requires that all function `@property` tags have names. */
+  "jsdoc/require-property-name": [];
+
+  /** Requires that each `@property` tag has a `type` value. */
+  "jsdoc/require-property-type": [];
+
   /** Requires that returns are documented. */
   "jsdoc/require-returns": 
     | []
@@ -718,6 +754,9 @@ export interface Rules {
         }
       ];
 
+  /** Requires a type for `@throws` tags */
+  "jsdoc/require-throws-type": [];
+
   /** Requires yields are documented. */
   "jsdoc/require-yields": 
     | []
@@ -757,6 +796,9 @@ export interface Rules {
         }
       ];
 
+  /** Requires a type for `@yields` tags */
+  "jsdoc/require-yields-type": [];
+
   /** Sorts tags by a specified sequence according to tag name. */
   "jsdoc/sort-tags": 
     | []