@jazpiper/rules-doctor 0.3.0 → 0.3.1
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 +1 -42
- package/dist/index.js +774 -438
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
It is optimized for real project adoption:
|
|
6
6
|
- import existing docs (`init --import`)
|
|
7
|
-
- target presets (`init --preset all|core|copilot`)
|
|
8
7
|
- safe previews by default (`sync` is dry-run unless `--write`)
|
|
9
8
|
- drift detection for CI (`check`)
|
|
10
9
|
|
|
@@ -34,23 +33,6 @@ npx rules-doctor init --import
|
|
|
34
33
|
- Reads existing docs when found (`CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `.cursor/rules/*.mdc`, `.github/copilot-instructions.md`)
|
|
35
34
|
- Writes `.agentrules/import-report.md`
|
|
36
35
|
|
|
37
|
-
Preset example (Copilot only):
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
npx rules-doctor init --preset copilot
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Preset meanings:
|
|
44
|
-
- `all`: all built-in targets enabled
|
|
45
|
-
- `core`: `claude`, `codex`, `opencode`, `cursor`, `gemini`
|
|
46
|
-
- `copilot`: only `copilot` enabled
|
|
47
|
-
|
|
48
|
-
Apply preset to an existing `.agentrules/rules.yaml`:
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
npx rules-doctor preset apply copilot --write
|
|
52
|
-
```
|
|
53
|
-
|
|
54
36
|
### 2) Preview changes safely
|
|
55
37
|
|
|
56
38
|
```bash
|
|
@@ -81,10 +63,6 @@ Returns non-zero when generated targets are out of sync.
|
|
|
81
63
|
|
|
82
64
|
## Supported Targets
|
|
83
65
|
|
|
84
|
-
```bash
|
|
85
|
-
npx rules-doctor targets list
|
|
86
|
-
```
|
|
87
|
-
|
|
88
66
|
Built-in adapters:
|
|
89
67
|
- `claude` -> `CLAUDE.md` (full-managed)
|
|
90
68
|
- `codex` -> `AGENTS.md` (marker-managed)
|
|
@@ -99,13 +77,6 @@ Built-in adapters:
|
|
|
99
77
|
|
|
100
78
|
```bash
|
|
101
79
|
npx rules-doctor init [--import]
|
|
102
|
-
npx rules-doctor init [--import] [--preset all|core|copilot]
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### `preset apply`
|
|
106
|
-
|
|
107
|
-
```bash
|
|
108
|
-
npx rules-doctor preset apply <all|core|copilot> [--diff] [--write]
|
|
109
80
|
```
|
|
110
81
|
|
|
111
82
|
### `sync`
|
|
@@ -120,18 +91,6 @@ npx rules-doctor sync [--target all|claude,codex,...] [--diff] [--write] [--back
|
|
|
120
91
|
npx rules-doctor check [--target all|claude,codex,...] [--diff]
|
|
121
92
|
```
|
|
122
93
|
|
|
123
|
-
### `analyze`
|
|
124
|
-
|
|
125
|
-
```bash
|
|
126
|
-
npx rules-doctor analyze [--strict]
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### `doctor`
|
|
130
|
-
|
|
131
|
-
```bash
|
|
132
|
-
npx rules-doctor doctor [--strict]
|
|
133
|
-
```
|
|
134
|
-
|
|
135
94
|
## CI Template
|
|
136
95
|
|
|
137
96
|
Copy [docs/workflows/rules-doctor-check.yml](docs/workflows/rules-doctor-check.yml) to your repository as `.github/workflows/rules-doctor-check.yml`.
|
|
@@ -166,7 +125,7 @@ jobs:
|
|
|
166
125
|
- Or add an npm script in your project: `"rules:check": "rules-doctor check"`, then run `npm run rules:check`.
|
|
167
126
|
- Global install (`npm i -g @jazpiper/rules-doctor`) works, but local + `npx` is safer for version consistency.
|
|
168
127
|
- `init` says `rules.yaml already exists`:
|
|
169
|
-
-
|
|
128
|
+
- Edit `.agentrules/rules.yaml` directly, then run `npx rules-doctor sync --write`.
|
|
170
129
|
|
|
171
130
|
## Rules Schema (v2 Draft)
|
|
172
131
|
|