useSingleJsDocAsterisk

JavaScript (and super languages)

Summary

Diagnostic Category: lint/nursery/useSingleJsDocAsterisk
This rule has an unsafe fix.
The default severity of this rule is information.
Sources:
- Same as jsdoc/no-multi-asterisks

Description

Enforce JSDoc comment lines to start with a single asterisk, except for the first one.

This rule ensures that every line in a JSDoc block, except the opening one, starts with exactly one asterisk (*). Extra asterisks are unnecessary in JSDoc comments and are often introduced by mistake.

Double asterisks (**) are still allowed, because they mark the start of bold text.

Examples

Invalid

1
/**
2
** Description
3
*/

code-block.js:2:1 lint/nursery/useSingleJsDocAsterisk  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ JSDoc comment line should start with a single asterisk.
  
    1 │ /**
  > 2 │ ** Description
      │ ^^^^^^^^^^^^^^
    3 │ */
    4 │ 
  
  ℹ In JSDoc comments, extra asterisks beyond the first are unnecessary and are often added by mistake.
  
  ℹ Unsafe fix: Remove additional asterisks.
  
    2 │ **·Description
      │  -

1
/**
2
* Description
3
* */

code-block.js:3:1 lint/nursery/useSingleJsDocAsterisk  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ JSDoc comment line should end with a single asterisk.
  
    1 │ /**
    2 │ * Description
  > 3 │ * */
      │ ^^^^
    4 │ 
  
  ℹ In JSDoc comments, extra asterisks beyond the first are unnecessary and are often added by mistake.
  
  ℹ Unsafe fix: Remove additional asterisks.
  
    3 │ *·*/
      │  --

1
/** @ts-ignore **/

code-block.js:1:1 lint/nursery/useSingleJsDocAsterisk  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ JSDoc comment line should end with a single asterisk.
  
  > 1 │ /** @ts-ignore **/
      │ ^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ In JSDoc comments, extra asterisks beyond the first are unnecessary and are often added by mistake.
  
  ℹ Unsafe fix: Remove additional asterisks.
  
    1 │ /**·@ts-ignore·**/
      │                 -

Valid

1
/**
2
 * Description
3
 * @public
4
 */

1
/** @ts-ignore */

1
/**
2
 * **Bold** text
3
 */

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useSingleJsDocAsterisk": "error"
6
      }
7
    }
8
  }
9
}