@driftdev/cli 0.37.0 → 0.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -2
- package/dist/drift.js +2689 -2570
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -2,6 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
Command-line interface for documentation coverage analysis and drift detection. Ships as the `drift` binary.
|
|
4
4
|
|
|
5
|
+
## Who This CLI Is For
|
|
6
|
+
|
|
7
|
+
- Maintainers of TypeScript libraries, SDKs, and CLI packages.
|
|
8
|
+
- Teams that want docs quality enforced in CI.
|
|
9
|
+
- Engineers building automation around machine-readable docs diagnostics.
|
|
10
|
+
|
|
11
|
+
## Why Use It
|
|
12
|
+
|
|
13
|
+
- Catch stale JSDoc, examples, and markdown references before release.
|
|
14
|
+
- Enforce quality thresholds with standard exit codes.
|
|
15
|
+
- Produce structured output that agents and tooling can act on directly.
|
|
16
|
+
|
|
5
17
|
## Install
|
|
6
18
|
|
|
7
19
|
```bash
|
|
@@ -24,7 +36,7 @@ drift lint
|
|
|
24
36
|
drift examples
|
|
25
37
|
```
|
|
26
38
|
|
|
27
|
-
Entry auto-detects from `package.json`
|
|
39
|
+
Entry auto-detects from `package.json` (`types`, `exports`, `main`, `module`, `bin`) for TypeScript packages with an exported API surface.
|
|
28
40
|
|
|
29
41
|
## Commands
|
|
30
42
|
|
|
@@ -189,7 +201,7 @@ All commands return structured JSON when piped or with `--json`:
|
|
|
189
201
|
{
|
|
190
202
|
"ok": true,
|
|
191
203
|
"data": { "score": 88, "documented": 243, "total": 275 },
|
|
192
|
-
"meta": { "command": "coverage", "duration": 1234, "version": "0.
|
|
204
|
+
"meta": { "command": "coverage", "duration": 1234, "version": "0.38.0" }
|
|
193
205
|
}
|
|
194
206
|
```
|
|
195
207
|
|