New linter rules erase some JSDoc formatting

[andretchen0]

Problem

A linter rule added in #388 erases valid Markdown.

Italics

This is an italicized word in valid Markdown in a JSDoc.

/**
 * *italic*
 **/

Linted:

/**
 * italic*
 **/

Bulleted lists

This is a bulleted list in valid Markdown in a JSDoc.

/**
 * * list item 1
 * * list item 2
 * * list item 3
 **/

Linted:

/**
 * list item 1
 * list item 2
 * list item 3
 **/

Solution

• Change this setting: "jsdoc/no-multi-asterisks": ["error"|"warn", {"allowWhitespace":true}]
• Revert the incorrectly linted changes.

See also

• False positive with no-multi-asterisks gajus/eslint-plugin-jsdoc#773
• no-multi-asterisks should not trigger when there's whitespace between asterisks gajus/eslint-plugin-jsdoc#803

Steps to reproduce

• Add this to a Cientos component:

/**
 * * list item 1
 * * list item 2
 * * list item 3
 **/
interface List {}

• Save
• Run pnpm run lint --fix
• The result will be:

/**
 * list item 1
 * list item 2
 * list item 3
 **/
interface List {}

Code of Conduct

• I agree to follow this project's Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• The provided reproduction is a minimal reproducible example of the bug.

[alvarosabu]

Hi @andretchen0 thanks for raising this, we could change this setting directly on https://github.com/Tresjs/eslint-config so the whole ecosystem is protected against the issue, wdyt?

[andretchen0]

Hi @andretchen0 thanks for raising this, we could change this setting directly on https://github.com/Tresjs/eslint-config so the whole ecosystem is protected against the issue, wdyt?

Sounds good.

[JaimeTorrealba]

I'll close this one, feel free to re-open if the problem still persist