Skip to content

chore(deps-dev): update docov to 0.2.1 and check what the JSDoc says - #168

Merged
botandbang merged 1 commit into
mainfrom
bnb/docov-0.2.1
Nov 18, 2026
Merged

botandbang merged 1 commit into
mainfrom
bnb/docov-0.2.1

Conversation

@botandbang

Copy link
Copy Markdown
Contributor

Updates @docov/cli from 0.1.1 to 0.2.1 and turns on its doc checks, so npm run lint fails 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-tags flags @type in aliases/index.js, @template in translate/index.js and @satisfies in doc-kit.config.mjs.
  • In docov.jsonc: requireDescription, so a block holding only tags no longer counts as documented, and these checks at error: 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-tags and valid-link. docov's checks doc describes each one.

Changed

  • Descriptions for what the checks found: the three blocks that had only tags (parseOptions and schedule in core/util/prod/, and doc-kit's config), 22 @param and @returns tags without a description, and three summaries over 120 characters (fixtures/index.js, fixtures/beforeEachTemplate.js, parsefiles/index.js). @nodevu/core in fixtures/index.js is now in backticks, like the other package names, so it doesn't read as a tag.
  • The types in each types/ folder, regenerated with npm run types to carry the new descriptions.
  • The README's line on npm run lint, to say what docov checks now and what tsdoc.json is for.

Left off

  • tsdoc-escapes, tsdoc-html, tsdoc-links and tsdoc-params hold blocks to TSDoc's grammar, which rejects the JSDoc {type}s that npm run types builds the types from (77 tsdoc-params and 60 tsdoc-escapes findings, all on types).
  • require-throws flags the throws in five async functions (core, schedule, fetchindex, ranges and translate), 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 ci installs 0.2.1 from the lockfile. Adding it took --min-release-age=0, since it's newer than .npmrc's three days. .npmrc itself is unchanged.

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.
@botandbang
botandbang requested a review from bnb as a code owner November 18, 2026 03:27
@socket-security

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updated@​docov/​cli@​0.1.1 ⏵ 0.2.167 +1710096 +1391 +4100

View full report

@botandbang
botandbang added this pull request to the merge queue Nov 18, 2026
Merged via the queue into main with commit 2988609 Nov 18, 2026
36 checks passed
@botandbang
botandbang deleted the bnb/docov-0.2.1 branch November 18, 2026 04:02
@nodevu-ci nodevu-ci Bot mentioned this pull request Nov 17, 2026
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.

2 participants