@driftdev/cli 1.3.0 → 1.5.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 +10 -8
- package/dist/drift.js +674 -205
- package/package.json +23 -19
package/README.md
CHANGED
|
@@ -44,8 +44,8 @@ Entry auto-detects from `package.json` (`types`, `exports`, `main`, `module`, `b
|
|
|
44
44
|
|
|
45
45
|
| Command | Description |
|
|
46
46
|
|---------|-------------|
|
|
47
|
-
| `drift scan [entry]` | Coverage + lint + prose drift + health in one pass |
|
|
48
|
-
| `drift health [entry]` | Documentation health score
|
|
47
|
+
| `drift scan [entry]` | Coverage + lint + prose drift + health in one pass (default command) |
|
|
48
|
+
| `drift health [entry]` | Documentation health score |
|
|
49
49
|
| `drift ci` | CI checks on changed packages with PR comments |
|
|
50
50
|
|
|
51
51
|
### Analysis
|
|
@@ -61,8 +61,8 @@ Entry auto-detects from `package.json` (`types`, `exports`, `main`, `module`, `b
|
|
|
61
61
|
| Command | Description |
|
|
62
62
|
|---------|-------------|
|
|
63
63
|
| `drift extract [entry]` | Extract full API spec as JSON |
|
|
64
|
-
| `drift list [
|
|
65
|
-
| `drift get <name
|
|
64
|
+
| `drift list [searchOrEntry]` | List all exports with kinds |
|
|
65
|
+
| `drift get <name>` | Inspect single export detail + types (entry auto-detected; `drift get <entry> <name>` to override) |
|
|
66
66
|
|
|
67
67
|
### Spec Operations
|
|
68
68
|
|
|
@@ -112,8 +112,10 @@ drift --tools
|
|
|
112
112
|
|
|
113
113
|
Run coverage + lint + prose drift + health in one pass.
|
|
114
114
|
|
|
115
|
+
Default command — bare `drift` runs this.
|
|
116
|
+
|
|
115
117
|
```bash
|
|
116
|
-
drift scan # single package
|
|
118
|
+
drift scan # single package (bare `drift` does the same)
|
|
117
119
|
drift scan --min 80 # fail if health below 80%
|
|
118
120
|
drift scan --all # all workspace packages
|
|
119
121
|
drift scan --all --private # include private packages
|
|
@@ -121,7 +123,7 @@ drift scan --all --private # include private packages
|
|
|
121
123
|
|
|
122
124
|
## lint
|
|
123
125
|
|
|
124
|
-
Cross-reference JSDoc against code signatures. Detects
|
|
126
|
+
Cross-reference JSDoc against code signatures. Detects 16 drift types across 4 categories (structural, semantic, example, prose). Prose detection scans markdown files for broken import references and method calls that don't exist on any exported type.
|
|
125
127
|
|
|
126
128
|
```bash
|
|
127
129
|
drift lint # single package
|
|
@@ -144,7 +146,7 @@ drift coverage --all # all workspace packages
|
|
|
144
146
|
Weighted health score: completeness (coverage) + accuracy (lint).
|
|
145
147
|
|
|
146
148
|
```bash
|
|
147
|
-
drift health
|
|
149
|
+
drift health
|
|
148
150
|
drift health --min 80
|
|
149
151
|
drift health --all
|
|
150
152
|
```
|
|
@@ -201,7 +203,7 @@ All commands return structured JSON when piped or with `--json`:
|
|
|
201
203
|
{
|
|
202
204
|
"ok": true,
|
|
203
205
|
"data": { "score": 88, "documented": 243, "total": 275 },
|
|
204
|
-
"meta": { "command": "coverage", "duration": 1234, "version": "
|
|
206
|
+
"meta": { "command": "coverage", "duration": 1234, "version": "1.4.0" }
|
|
205
207
|
}
|
|
206
208
|
```
|
|
207
209
|
|