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 all commits
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
3 changes: 3 additions & 0 deletions packages/typescript/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- It was a style preference that we may not want, and the auto-fix was broken.
- Loosen `@typescript-eslint/naming-convention` by not enforcing naming conventions for object literal properties ([#428](https://github.com/MetaMask/eslint-config/pull/428))
- Object literals are too often used as parameters for 3rd party libraries/services.
- Disable `jsdoc/check-indentation` ([#430](https://github.com/MetaMask/eslint-config/pull/430))
- Disabled due to a problem with indended sections in TSDoc blocks.

### Fixed

- Prevent non-type imports from being grouped under a type import upon auto-fix ([#427](https://github.com/MetaMask/eslint-config/pull/427))
- This was caused by `import-x/no-duplicates`, which is now disabled.
- Fix false positive lint error on TSDoc blocks with indended sections (e.g. bullet lists) ([#430](https://github.com/MetaMask/eslint-config/pull/430))

## [14.1.0]

Expand Down
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