Docs

One page per command, the concepts behind them, and the CLI reference.

Concepts

Getting started

What jsdoc-to-tsdoc does, the six commands and the order to run them in, and how to use it without installing anything.

Read

Concepts

JSDoc vs TSDoc

The concepts behind the migration, every difference between the two comment styles, and why each one exists.

Read

Migrate

init

Bootstrap a project for TSDoc, generating tsdoc.json and patching the ESLint flat config without touching source comments.

Read

Migrate

scan

Inventory the JSDoc a migration would touch, or classify how well every export is documented, without writing anything.

Read

Migrate

convert

Rewrite existing JSDoc comments into TSDoc with deterministic, formatting-preserving transformations, and what each rule does.

Read

Migrate

scaffold

Generate a TSDoc stub for every export that has no documentation, with summaries inferred from names and a TODO marker on each one.

Read

Migrate

escalate

Close the migration by turning missing documentation from a warning into a build failure, safely, plus the git merge driver for the one line that conflicts.

Read

Gate

check

The CI gate that validates every TSDoc comment with the official parser, reports undocumented exports and legacy JSDoc, and never writes.

Read

Gate

CI integration

Run check and the scan gates in a pipeline, with the GitHub Action, with a pinned npx call, or with the Bitbucket pipe.

Read

Reference

CLI reference

Every command, every flag, which commands look at test files, and the exit codes, in one place.

Read