feat: validate JSDoc/TSDoc quality on existing doc comments - #6
Merged
Merged
Conversation
Mearman
marked this pull request as ready for review
September 12, 2026 08:48
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Mearman
force-pushed
the
feat/jsdoc-tsdoc-rules
branch
from
September 12, 2026 09:01
5bfc429 to
d08f2bc
Compare
Add eslint-plugin-jsdoc and eslint-plugin-tsdoc to the default config,
using eslint-plugin-jsdoc's flat/recommended-tsdoc-error preset (tuned
for TSDoc-flavoured comments such as {@link} and @remarks) with its
requirements tier turned off: a missing doc comment is not flagged,
only an existing one that is internally inconsistent, has an
unresolvable type, or uses an invalid tag. eslint-plugin-tsdoc's
tsdoc/syntax rule is registered separately, since that plugin ships no
configs export of its own, to validate that a doc comment actually
parses as valid TSDoc.
The requirements tier (require-jsdoc, require-param, require-returns,
and siblings) is deliberately excluded: forcing every function
everywhere to carry a doc comment is a much larger policy this change
isn't making, and eslint-plugin-jsdoc's own autofix for a missing
block inserts an empty, contentless stub rather than anything useful.
@typescript-eslint/rule-tester runs a real TypeScript program (parse and type-check) per test case for every type-aware custom rule under src/rules/, which routinely exceeds vitest's generic 5000ms default, especially under contention on a shared developer machine running other concurrent CPU-heavy work. Each case's actual check is still a small, synchronous operation, so a longer ceiling tolerates slow execution without masking a real regression.
Mearman
force-pushed
the
feat/jsdoc-tsdoc-rules
branch
from
September 12, 2026 09:15
d08f2bc to
8783f52
Compare
Mearman
enabled auto-merge (rebase)
September 12, 2026 09:15
|
🎉 This PR is included in version 2.11.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
1 participant
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.
Adds
eslint-plugin-jsdocandeslint-plugin-tsdocto the default config, usingeslint-plugin-jsdoc'sflat/recommended-tsdoc-errorpreset (tuned for TSDoc-flavoured comments such as{@link}and@remarks) with its presence/"requirements" tier turned off — a missing doc comment is not flagged, only an existing one that's internally inconsistent, has an unresolvable type, or uses an invalid tag.eslint-plugin-tsdoc'stsdoc/syntaxrule is registered separately (that plugin ships noconfigsexport) to validate that a doc comment actually parses as valid TSDoc.The requirements tier (
require-jsdoc,require-param,require-returns, and siblings) is deliberately excluded: forcing every function everywhere to carry a doc comment is a much bigger policy than "add these two plugins," andeslint-plugin-jsdoc's own autofix for a missing block inserts an empty, contentless stub rather than anything useful — confirmed directly, it did this to 22 files in this repo's own source on the first pass before the tier was excluded.Second commit raises the vitest suite timeout for
@typescript-eslint/rule-testercases (unrelated pre-existing flakiness this PR's own CI run surfaced under host contention, not caused by the jsdoc/tsdoc change) — each case runs a real TS program per type-aware rule test, which exceeds vitest's 5000ms default under load.