react-doctor 0.8.1-dev.5332cb6 → 0.8.1-dev.5b468f8
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 -4
- package/dist/cli.js +680 -158
- package/dist/index.d.ts +41 -0
- package/dist/index.js +589 -114
- package/dist/lsp.js +589 -114
- package/dist/skills/react-doctor/SKILL.md +5 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -27,7 +27,17 @@ npx react-doctor@latest
|
|
|
27
27
|
|
|
28
28
|
https://github.com/user-attachments/assets/07cc88d9-9589-44c3-aa73-5d603cb1c570
|
|
29
29
|
|
|
30
|
-
### 2.
|
|
30
|
+
### 2. Run a focused design audit
|
|
31
|
+
|
|
32
|
+
Use the design command when you only want UI composition, typography, interaction, accessibility, and motion findings:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx react-doctor@latest design
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This activates the complete design rule family, including focused rules that stay opt-in during a general health scan, and skips unrelated dead-code, supply-chain, custom-plugin, and health-score passes. It accepts the normal scan flags, including `--scope`, `--project`, `--verbose`, and `--json`.
|
|
39
|
+
|
|
40
|
+
### 3. Install for agents
|
|
31
41
|
|
|
32
42
|
Once you have an audit, you can install the skill for your coding agent to learn from the issues and fix them in the future.
|
|
33
43
|
|
|
@@ -37,7 +47,7 @@ npx react-doctor@latest install
|
|
|
37
47
|
|
|
38
48
|
Works with Claude Code, Cursor, Codex, OpenCode, and many more.
|
|
39
49
|
|
|
40
|
-
###
|
|
50
|
+
### 4. Run in CI
|
|
41
51
|
|
|
42
52
|
React Doctor reviews every pull request and reports only the issues your change introduced, not your existing backlog. Set it up with one command:
|
|
43
53
|
|
|
@@ -49,13 +59,13 @@ This adds the workflow, scans every pull request, and posts a summary comment. C
|
|
|
49
59
|
|
|
50
60
|
[CI docs →](https://react.doctor/ci)
|
|
51
61
|
|
|
52
|
-
###
|
|
62
|
+
### 5. Configure rules
|
|
53
63
|
|
|
54
64
|
You can configure which rules to run and how to run them in `doctor.config.ts`.
|
|
55
65
|
|
|
56
66
|
[Learn more →](https://react.doctor/docs/configuration/config-files)
|
|
57
67
|
|
|
58
|
-
###
|
|
68
|
+
### 6. Consume JSON
|
|
59
69
|
|
|
60
70
|
Use `--json` for stdout or `--json-out <path>` for a file. The default
|
|
61
71
|
`schemaVersion: 3` report includes deterministic diagnostic IDs and exact
|