Skip to content

feat(oxlint-config)!: ban JSDoc blocks and cap line-comment runs - #78

Merged
zgeoff merged 1 commit into
mainfrom
feat/no-jsdoc
Sep 2, 2026
Merged

feat(oxlint-config)!: ban JSDoc blocks and cap line-comment runs#78
zgeoff merged 1 commit into
mainfrom
feat/no-jsdoc

Conversation

@zgeoff

@zgeoff zgeoff commented Sep 2, 2026

Copy link
Copy Markdown
Owner

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-jsdoc reports every /** … */ block; inline @type/@lends casts stay exempt.
  • zgeoff/max-consecutive-line-comments reports a run of own-line // comments over max (default 3); tool directives neither count nor join the prose around them.
  • zgeoff/no-single-line-jsdoc is removed: it cannot fire once no-jsdoc is on. A consumer naming it must drop the entry, hence the !.
  • Neither rule fixes. Deleting prose is a decision, and a silent --fix would hide the report that teaches.
  • The repo's own 64 JSDoc blocks are deleted. Nine facts whose reason lives outside the file (an ESLint quirk, a Bun/Node difference, a parser folding rule) return as // lines at the declaration.

Testing

  • bun run typecheck passes
  • bun test passes
  • New tests added for new functionality

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.
@zgeoff
zgeoff merged commit 98319f3 into main Sep 2, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant