Repository navigation
chore(deps-dev): update docov to 0.2.1 and check what the JSDoc says - #168
Merged
Merged
Conversation
docov 0.2.1 has doc checks, so `npm run lint` now also fails on a block without a description, a tag without one, a @PARAM that doesn't match a parameter, a summary over 120 characters or without a period, an unknown tag and a malformed inline tag. tsdoc.json defines the JSDoc tags nodevu uses so tsdoc-tags only flags unknown ones. tsdoc-escapes, tsdoc-html, tsdoc-links and tsdoc-params stay off, since TSDoc's grammar has no place for the JSDoc {type}s the types are built from. require-throws stays off because it counts a throw in an async function, which rejects. Writes the descriptions the checks asked for and regenerates the types.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
bnb
approved these changes
Nov 18, 2026
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.
Updates
@docov/clifrom 0.1.1 to 0.2.1 and turns on its doc checks, sonpm run lintfails on malformed JSDoc as well as on missing JSDoc.Added
tsdoc.json, which defines the JSDoc tags nodevu uses (@import,@property,@satisfies,@template,@type,@typedef) on top of TSDoc's standard ones. Without it,tsdoc-tagsflags@typeinaliases/index.js,@templateintranslate/index.jsand@satisfiesindoc-kit.config.mjs.docov.jsonc:requireDescription, so a block holding only tags no longer counts as documented, and these checks aterror:doc-markdown,empty-tag-description,informative-docs,param-names,require-param,require-returns,require-template,require-yields,summary-sentence,tsdoc-code,tsdoc-inline-tags,tsdoc-tagsandvalid-link. docov's checks doc describes each one.Changed
parseOptionsandscheduleincore/util/prod/, and doc-kit's config), 22@paramand@returnstags without a description, and three summaries over 120 characters (fixtures/index.js,fixtures/beforeEachTemplate.js,parsefiles/index.js).@nodevu/coreinfixtures/index.jsis now in backticks, like the other package names, so it doesn't read as a tag.types/folder, regenerated withnpm run typesto carry the new descriptions.npm run lint, to say what docov checks now and whattsdoc.jsonis for.Left off
tsdoc-escapes,tsdoc-html,tsdoc-linksandtsdoc-paramshold blocks to TSDoc's grammar, which rejects the JSDoc{type}s thatnpm run typesbuilds the types from (77tsdoc-paramsand 60tsdoc-escapesfindings, all on types).require-throwsflags thethrows in five async functions (core,schedule,fetchindex,rangesandtranslate), where they reject the promise. eslint-plugin-jsdoc's require-throws leaves async functions out for that reason, so it stays off until docov does the same.npm ciinstalls 0.2.1 from the lockfile. Adding it took--min-release-age=0, since it's newer than.npmrc's three days..npmrcitself is unchanged.