Repository navigation
chore: require 100% JSDoc coverage with docov - #129
Merged
Merged
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Draft
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.
Adds docov (
@docov/cli0.1.1, pinned) as a root dev dependency and runs it at the end ofnpm run lint, so the existing lint job in CI fails when anything a module exports lacks JSDoc.docov.jsoncsets the threshold to 100 and leaves out tests, the vendored anti-slop oxlint plugin, and the generated*/types/**. The generated types are left out because TypeScript 7 drops@typedefdescriptions from its declaration output (tsc 5.9 keeps them), so those files can't reach 100% from the source.Five exports had no JSDoc: the dev helpers in
core/util/dev/(beforeEachTemplate,at,write),static/util/dev/write.js, and the docs theme'sNavigation.jsx. Two of them already had//comments, which are now/** */blocks. The README's development section mentions the new check.