feat(oxlint-config)!: ban JSDoc blocks and cap line-comment runs - #78
Merged
Conversation
Adds zgeoff/no-jsdoc and zgeoff/max-consecutive-line-comments, both at error in the shared config, and removes zgeoff/no-single-line-jsdoc, which no-jsdoc subsumes. BREAKING CHANGE: zgeoff/no-single-line-jsdoc no longer exists; a consumer that names it must drop the entry.
Merged
4 tasks
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
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.
Description
Adds two comment rules to the shared config and removes the one they subsume. A comment now holds only what neither the code, a type, a test name, nor the subsystem doc can hold.
zgeoff/no-jsdocreports every/** … */block; inline@type/@lendscasts stay exempt.zgeoff/max-consecutive-line-commentsreports a run of own-line//comments overmax(default 3); tool directives neither count nor join the prose around them.zgeoff/no-single-line-jsdocis removed: it cannot fire onceno-jsdocis on. A consumer naming it must drop the entry, hence the!.--fixwould hide the report that teaches.//lines at the declaration.Testing
bun run typecheckpassesbun testpasses