Skip to content

fix: Disable jsdoc/check-indentation to fix bullet list formatting #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gudahtt merged 2 commits into from
Dec 3, 2025
Merged

fix: Disable jsdoc/check-indentation to fix bullet list formatting #430

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcd1063
fix: Disable `jsdoc/check-indentation` to fix bullet list formatting
Gudahtt Dec 3, 2025
9ee5744
Update changelog
Gudahtt Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
fix: Disable jsdoc/check-indentation to fix bullet list formatting 
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
  • Loading branch information
@Gudahtt
Gudahtt committed Dec 3, 2025
commit dcd1063fcc85081023ef4057e2c772a9a6827e9c
2 changes: 1 addition & 1 deletion packages/typescript/rules-snapshot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
"jsdoc/check-access": "error",
"jsdoc/check-alignment": "error",
"jsdoc/check-examples": "off",
"jsdoc/check-indentation": "error",
"jsdoc/check-indentation": "off",
"jsdoc/check-line-alignment": "off",
"jsdoc/check-param-names": "error",
"jsdoc/check-property-names": "error",
Expand Down
7 changes: 4 additions & 3 deletions packages/typescript/src/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,10 @@ const config = createConfig({

'jsdoc/check-syntax': 'error',

// This is enabled here rather than in the base config because it doesn't play nicely with
// multi-line JSDoc types.
'jsdoc/check-indentation': 'error',
// This is disabled because it doesn't work with bullet lists, and other types of indented
// sections. This issue is fixed in later versions, we can re-enable it after updating.
// See https://github.com/gajus/eslint-plugin-jsdoc/issues/541 for details
'jsdoc/check-indentation': 'off',

// Use TypeScript types rather than JSDoc types.
'jsdoc/no-types': 'error',
Expand Down
Loading