@schemasentry/cli 0.3.1 → 0.3.2
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 +70 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# @schemasentry/cli
|
|
2
|
+
|
|
3
|
+
CLI for Schema Sentry validation and reporting.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -D @schemasentry/cli
|
|
9
|
+
npm install -D @schemasentry/cli
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
### `init`
|
|
15
|
+
|
|
16
|
+
Generate starter manifest and data files:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pnpm schemasentry init
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
With route scanning:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
pnpm schemasentry init --scan
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### `validate`
|
|
29
|
+
|
|
30
|
+
Check schema coverage and validation:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pnpm schemasentry validate --manifest ./schema-sentry.manifest.json --data ./schema-sentry.data.json
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
With GitHub annotations:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pnpm schemasentry validate --annotations github
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### `audit`
|
|
43
|
+
|
|
44
|
+
Analyze site-wide schema health:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
pnpm schemasentry audit --data ./schema-sentry.data.json --manifest ./schema-sentry.manifest.json
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
With HTML report:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pnpm schemasentry audit \
|
|
54
|
+
--data ./schema-sentry.data.json \
|
|
55
|
+
--format html \
|
|
56
|
+
--output ./report.html
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Options
|
|
60
|
+
|
|
61
|
+
| Option | Description |
|
|
62
|
+
|--------|-------------|
|
|
63
|
+
| `--format json\|html` | Output format |
|
|
64
|
+
| `--annotations none\|github` | CI annotations |
|
|
65
|
+
| `-o, --output <path>` | Write output to file |
|
|
66
|
+
| `--recommended / --no-recommended` | Enable recommended field checks |
|
|
67
|
+
|
|
68
|
+
## Documentation
|
|
69
|
+
|
|
70
|
+
See [Schema Sentry Docs](https://github.com/arindamdawn/schema-sentry#readme)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@schemasentry/cli",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"description": "CLI for Schema Sentry validation and reporting.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"commander": "^12.0.0",
|
|
36
|
-
"@schemasentry/core": "0.3.
|
|
36
|
+
"@schemasentry/core": "0.3.2"
|
|
37
37
|
},
|
|
38
38
|
"scripts": {
|
|
39
39
|
"build": "tsup src/index.ts --format esm --dts --clean --tsconfig tsconfig.build.json",
|