fix: Disable jsdoc/check-indentation to fix bullet list formatting
#430
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bulleted lists and other types of indented sections are incorrectly flagged by the current version of the `jsdoc/check-indentation` rule, so it has been temporarily disabled. We can bring it back in a later version after updating the plugin to 61.4, which includes a new option that can fix this problem. That has been postponed for now because it requires bumping the minimum supported Node.js version. Fixes #404
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bulleted lists and other types of indented sections are incorrectly flagged by the current version of the
jsdoc/check-indentationrule, so it has been temporarily disabled.We can bring it back in a later version after updating the plugin to 61.4, which includes a new option that can fix this problem. That has been postponed for now because it requires bumping the minimum supported Node.js version.
Fixes #404
Note
Turns off
jsdoc/check-indentationin the TypeScript ESLint config and updates the changelog and rule snapshot accordingly.packages/typescript/src/index.mjs):jsdoc/check-indentation('off') with notes about issues on indented sections/bullet lists.packages/typescript/rules-snapshot.json):jsdoc/check-indentationfrom"error"to"off".packages/typescript/CHANGELOG.md):jsdoc/check-indentation.Written by Cursor Bugbot for commit 9ee5744. This will update automatically on new commits. Configure here.