eslint-plugin-jsdoc 60.4.1 → 60.6.0

package/src/rules.d.ts

@@ -82,7 +82,6 @@ export interface Rules {
           /**
            * An object with any of the following spacing keys set to an integer.
            * If a spacing is not defined, it defaults to one.
-           *
            */
           customSpacings?: {
             /**
@@ -261,6 +260,12 @@ export interface Rules {
            * Set to `false` to disable auto-removal of types that are redundant with the [`typed` option](#typed).
            */
           enableFixer?: boolean;
+          /**
+           * List of tags to allow inline.
+           *
+           * Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial'`
+           */
+          inlineTags?: string[];
           /**
            * If this is set to `true`, all of the following tags used to control JSX output are allowed:
            *
@@ -431,7 +436,6 @@ export interface Rules {
            *
            * Defaults to `ArrowFunctionExpression`, `FunctionDeclaration`,
            * `FunctionExpression`, `TSDeclareFunction`.
-           *
            */
           contexts?: (
             | string
@@ -490,7 +494,6 @@ export interface Rules {
            * ```
            *
            * Defaults to `multi`.
-           *
            */
           enforceJsdocLineStyle?: "multi" | "single";
           /**
@@ -520,12 +523,36 @@ export interface Rules {
            *   'jsdoc/empty-tags': ['error', {tags: ['event']}]
            * }
            * ```
-           *
            */
           tags?: string[];
         }
       ];
 
+  /** Reports use of JSDoc tags in non-tag positions (in the default "typescript" mode). */
+  "jsdoc/escape-inline-tags": 
+    | []
+    | [
+        {
+          /**
+           * A listing of tags you wish to allow unescaped. Defaults to an empty array.
+           */
+          allowedInlineTags?: string[];
+          /**
+           * Whether to enable the fixer. Defaults to `false`.
+           */
+          enableFixer?: boolean;
+          /**
+           * How to escape the inline tag.
+           *
+           * May be "backticks" to enclose tags in backticks (treating as code segments), or
+           * "backslash" to escape tags with a backslash, i.e., `\@`
+           *
+           * Defaults to "backslash".
+           */
+          fixType?: "backticks" | "backslash";
+        }
+      ];
+
   /** Prohibits use of `@implements` on non-constructor functions (to enforce the tag only being used on classes/constructors). */
   "jsdoc/implements-on-classes": 
     | []
@@ -582,7 +609,6 @@ export interface Rules {
            *   "a": ["an", "our"]
            * }
            * ```
-           *
            */
           aliases?: {
             /**
@@ -604,7 +630,6 @@ export interface Rules {
            * ```
            *
            * No tags are excluded by default.
-           *
            */
           excludedTags?: string[];
           /**
@@ -622,7 +647,6 @@ export interface Rules {
            * ```json
            * ["a", "an", "i", "in", "of", "s", "the"]
            * ```
-           *
            */
           uselessWords?: string[];
         }
@@ -636,26 +660,22 @@ export interface Rules {
           /**
            * Whether to additionally check the start of blocks, such as classes or functions.
            * Defaults to `false`.
-           *
            */
           checkBlockStarts?: boolean;
           /**
            * An array of tags whose presence in the JSDoc block will prevent the
            * application of the rule. Defaults to `['type']` (i.e., if `@type` is present,
            * lines before the block will not be added).
-           *
            */
           excludedTags?: string[];
           /**
            * This option excludes cases where the JSDoc block occurs on the same line as a
            * preceding code or comment. Defaults to `true`.
-           *
            */
           ignoreSameLine?: boolean;
           /**
            * This option excludes cases where the JSDoc block is only one line long.
            * Defaults to `true`.
-           *
            */
           ignoreSingleLines?: boolean;
           /**
@@ -683,7 +703,6 @@ export interface Rules {
            *
            * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
-           *
            */
           contexts?: (
             | string
@@ -765,7 +784,6 @@ export interface Rules {
            *
            * This can be overridden per tag or for the main block description by setting
            * `message` within `tags` or `mainDescription`, respectively.
-           *
            */
           message?: string;
           /**
@@ -863,7 +881,6 @@ export interface Rules {
            * tag of the desired tag and/or name and no `disallowName` (or `allowName`) is
            * supplied. In such a case, only one error will be reported, but no fixer will
            * be applied, however.
-           *
            */
           match: {
             /**
@@ -952,7 +969,6 @@ export interface Rules {
            * lines.
            *
            * Defaults to `['*']`.
-           *
            */
           multilineTags?: "*" | string[];
           /**
@@ -977,7 +993,6 @@ export interface Rules {
            * are whitelisted in `singleLineTags`.
            *
            * Defaults to `false`.
-           *
            */
           noSingleLineBlocks?: boolean;
           /**
@@ -998,7 +1013,6 @@ export interface Rules {
            * descriptions.
            *
            * Defaults to `null`.
-           *
            */
           requireSingleLineUnderCount?: number;
           /**
@@ -1025,7 +1039,6 @@ export interface Rules {
            *
            * Defaults to `['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck']`
            * (some directives [used by TypeScript](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check)).
-           *
            */
           ignore?: string[];
           /**
@@ -1233,7 +1246,6 @@ export interface Rules {
            *
            * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
-           *
            */
           contexts?: (
             | string
@@ -1326,7 +1338,6 @@ export interface Rules {
            *   }]
            * }
            * ```
-           *
            */
           tags?: {
             /**
@@ -1446,7 +1457,6 @@ export interface Rules {
            * its "description" (e.g., for `@returns {someType} some description`, the
            * description is `some description` while for `@some-tag xyz`, the description
            * is `xyz`).
-           *
            */
           tags?: string[];
         }
@@ -1577,8 +1587,6 @@ export interface Rules {
            * in this configuration object regardless of whether you have configured
            * `fileoverview` instead of `file` on `tagNamePreference` (i.e., `fileoverview`
            * will be checked, but you must use `file` on the configuration object).
-           *
-           *
            */
           tags?: {
             /**
@@ -1609,7 +1617,6 @@ export interface Rules {
            *   `'*': 'always'` to apply hyphen checking to any tag (besides the preferred
            *   `@param` tag which follows the main string option setting and besides any
            *   other `tags` entries).
-           *
            */
           tags?:
             | {
@@ -1640,7 +1647,6 @@ export interface Rules {
            * getters should be checked but only when there is no setter. This may be useful
            * if one only wishes documentation on one of the two accessors. Defaults to
            * `false`.
-           *
            */
           checkGetters?: boolean | "no-setter";
           /**
@@ -1695,7 +1701,6 @@ export interface Rules {
            * function/method names are sufficient for themselves as documentation).
            *
            * Defaults to `false`.
-           *
            */
           exemptEmptyFunctions?: boolean;
           /**
@@ -1728,7 +1733,6 @@ export interface Rules {
            * - `esm` - ESM exports are checked for JSDoc comments (Defaults to `true`)
            * - `cjs` - CommonJS exports are checked for JSDoc comments  (Defaults to `true`)
            * - `window` - Window global exports are checked for JSDoc comments
-           *
            */
           publicOnly?:
             | boolean
@@ -1795,13 +1799,11 @@ export interface Rules {
           /**
            * Numeric to indicate the number at which to begin auto-incrementing roots.
            * Defaults to `0`.
-           *
            */
           autoIncrementBase?: number;
           /**
            * A value indicating whether `constructor`s should be checked. Defaults to
            * `true`.
-           *
            */
           checkConstructors?: boolean;
           /**
@@ -1818,7 +1820,6 @@ export interface Rules {
            * implied to be `false` (i.e., the inside of the roots will not be checked
            * either, e.g., it will also not complain if `a` or `b` do not have their own
            * documentation). Defaults to `true`.
-           *
            */
           checkDestructuredRoots?: boolean;
           /**
@@ -1876,7 +1877,6 @@ export interface Rules {
            * function quux ({num, ...extra}) {
            * }
            * ```
-           *
            */
           checkRestProperty?: boolean;
           /**
@@ -1930,7 +1930,6 @@ export interface Rules {
            *
            * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
-           *
            */
           contexts?: (
             | string
@@ -1977,7 +1976,6 @@ export interface Rules {
            * type to use.
            *
            * Defaults to `true`.
-           *
            */
           enableRestElementFixer?: boolean;
           /**
@@ -2128,7 +2126,6 @@ export interface Rules {
            *
            * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
-           *
            */
           contexts?: (
             | string
@@ -2281,7 +2278,6 @@ export interface Rules {
            * - `esm` - ESM exports are checked for `@returns` JSDoc comments (Defaults to `true`)
            * - `cjs` - CommonJS exports are checked for `@returns` JSDoc comments  (Defaults to `true`)
            * - `window` - Window global exports are checked for `@returns` JSDoc comments
-           *
            */
           publicOnly?:
             | boolean
@@ -2438,12 +2434,14 @@ export interface Rules {
            * ```
            *
            * Defaults to `false`.
-           *
            */
           requireSeparateTemplates?: boolean;
         }
       ];
 
+  /** Requires a description for `@template` tags */
+  "jsdoc/require-template-description": [];
+
   /** Requires that throw statements are documented with `@throws` tags. */
   "jsdoc/require-throws": 
     | []
@@ -2839,7 +2837,6 @@ export interface Rules {
            *   'todo',
            * ]}];
            * ```
-           *
            */
           tagSequence?: {
             /**