drift

Documentation coverage for TypeScript. Scan for missing JSDoc, outdated READMEs, and undocumented exports — in your CLI or CI pipeline.

bun add -d @driftdev/cli

stars2coverage100%licenseMIT

CLI

Run scan to detect missing JSDoc, outdated README sections, and undocumented exports across your entire package.

CI/CD

Add to your CI pipeline. Block PRs with doc regressions and auto-generate fix suggestions as review comments.

SDK

Use the TypeScript SDK to build custom doc tooling. Analyze coverage, generate reports, and integrate with your workflow.

Spec

A formal specification for measuring documentation coverage. Consistent scoring across JSDoc, README, and examples.

Overview

Everything you need to keep your documentation in sync with your code.

Ships with everything you need to keep docs in sync with code:

Built on the TypeScript compiler API — accurate AST analysis, not regex heuristics
15 drift detection rules across structural, semantic, example, and prose categories
Example validation — type-checks and runs @example blocks in a sandbox
Coverage ratchet prevents documentation regression — coverage can only go up
First-class monorepo support with auto-detected workspaces and batch analysis
GitHub Action with PR comments, step summaries, and release gates
AI-powered doc sync — auto-generates PRs to update external docs on breaking changes