chore: Selectively disable jsodc/check-tag-names ESLint rule
#7152
+29
−43
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
Gudahtt
force-pushed
the
disable-check-tag-names
branch
from
ac83629 to
628ee38
Compare
Gudahtt
changed the title
jsodc/check-tag-names ESLint rulejsodc/check-tag-names ESLint rule
Gudahtt
force-pushed
the
disable-check-tag-names
branch
from
628ee38 to
2177cb5
Compare
The ESLint rule `jsdoc/check-tag-names` mangles a lot of comment blocks we have for types. The types are currently written in a way that doesn't comply with the TSDoc spec, and we should fix them, but leaving the rule enabled (even with error suppression!) prevents us from using `--fix`.
Gudahtt
force-pushed
the
disable-check-tag-names
branch
from
2177cb5 to
bc83018
Compare
cryptodev-2s
approved these changes
Nov 13, 2025
| 'import-x/namespace': 'warn', | ||
| 'import-x/no-named-as-default': 'warn', | ||
| 'import-x/order': 'warn', | ||
| 'jsdoc/check-tag-names': 'warn', |
Contributor
There was a problem hiding this comment.
Just to confirm, this will error by default now (excluding the files listed below)?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explanation
The ESLint rule
jsdoc/check-tag-namesmangles a lot of comment blocks we have for types. The types are currently written in a way that doesn't comply with the TSDoc spec, and we should fix them, but leaving the rule enabled (even with error suppression!) prevents us from using--fix.The rule has been selectively disabled in each file that has malformed doc blocks impacted by this problem. We can remove these files one-by-one as we fix the inline docs.
References
Relates to #6790
These changes were extracted from the draft PR #7148
Checklist
Note
Disables
jsdoc/check-tag-namesfor specific files via ESLint overrides and updates warning thresholds accordingly.jsdoc/check-tag-nameswarning from TypeScript rules.jsdoc/check-tag-namesfor specific files (e.g., various controllers, message-manager files, tests).eslint-warning-thresholds.jsonto dropjsdoc/check-tag-namesentries for affected files.TokensController.ts,siwe.ts,tests/fake-provider.ts).Written by Cursor Bugbot for commit bc83018. This will update automatically on new commits. Configure here.