False positive with no-multi-asterisks

[Drarig29]

Expected behavior

With the default rules (no-multi-asterisks enabled), the following JSDoc should pass the linting:

/**
 * Some description here.
 *
 * **Example:** An example here.
 */

The bold text in Markdown should stay.

Actual behavior

The plugin auto-fixes the JSDoc like the following:

/**
 * Some description here.
 *
 * Example:** An example here.
 */

ESLint Config

Just the defaults.

module.exports = {
  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
  parserOptions: {
    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
    sourceType: 'module', // Allows for the use of imports
  },
  ignorePatterns: ['dist/', 'webpack.config.js'],
  extends: [
    'plugin:@typescript-eslint/recommended',
    'plugin:jsdoc/recommended',
  ],
}

ESLint sample

/**
 * Some description here.
 *
 * **Example:** An example here.
 */
function foo() {

}

Environment

• Node version: v14.15.5
• ESLint version: v7.31.0
• eslint-plugin-jsdoc version: 35.5.1

[brettz9]

We can look to overcome this for cases where the asterisk count is even, e.g.,: 4 (extra asterisks) % 2 = 0.

/**
 * **bold** 
 */

However, I'm not sure we want to get into the harder and more error prone area of trying to fix cases like this:

/**
 * Here's a list:
 * * item 1
 * * item 2 
 */

I think in the latter cases, we should just recommend people use the equally valid Markdown operator - in place of *. (Getting in the habit of using this operator also has the advantage that naive syntax highlighters do not consider the asterisk as the beginning of a bold statement.)

[alvis]

Can we simply only count leading/ending asterisks without spaces?
e.g.

// OK
/**
 * Here's a list:
 * * item 1
 * * item 2 
 *  **BOLD**
 */

// FAIL
/**
 ** Here's a list:
 ** * item 1
 ** * item 2 
 ** **BOLD**
 */

[Drarig29]

I will work on this issue.

[Drarig29]

Can we simply only count leading/ending asterisks without spaces? e.g.

// OK
/**
 * Here's a list:
 * * item 1
 * * item 2 
 *  **BOLD**
 */

// FAIL
/**
 ** Here's a list:
 ** * item 1
 ** * item 2 
 ** **BOLD**
 */

You are missing the case (one of my use) where you have a line not ending with the end of the bold block. For example:

/**
 ** Here's a list:
 ** * item 1
 ** * item 2
 ** **Note:** Hello there.
 */

[alvis]

Aren't they all fail?

/**
 ** Here's a list:
 ** * item 1
 ** * item 2
 ** **Note:** Hello there.
 */

Actually out use case is about a file header like the following

/*
 *                           *** INTERNAL ONLY ***
 * -------------------------------------------------------------------------
 * Unauthorized copying of this file, via any medium is strictly prohibited.
 * -------------------------------------------------------------------------
 *
 * @summary   ...
 *
 * @license   Proprietary
 * @copyright Copyright (c) 2021 - All Rights Reserved.
 * -------------------------------------------------------------------------
 */

The easiest way to fix it of cause is us changing the format, but it wasn't a problem and I don't see it should be a problem.
The current rule is just too sensitive.

[gajus]

🎉 This issue has been resolved in version 37.0.2 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀