react-doctor 0.2.14-dev.ac3ca1a → 0.2.14-dev.b3c3aa9
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 -0
- package/dist/cli.js +14449 -5737
- package/dist/index.d.ts +92 -11
- package/dist/index.js +946 -233
- package/package.json +7 -4
- package/dist/cli-logger-Cqq0L4Uo.js +0 -7718
- package/dist/rolldown-runtime-uZX_iqCz.js +0 -35
package/README.md
CHANGED
|
@@ -27,6 +27,14 @@ npx react-doctor@latest
|
|
|
27
27
|
|
|
28
28
|
https://github.com/user-attachments/assets/07cc88d9-9589-44c3-aa73-5d603cb1c570
|
|
29
29
|
|
|
30
|
+
On a large repo, add `--experimental-parallel` to fan the scan out across your CPU cores:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx react-doctor@latest --experimental-parallel
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
React Doctor's rules run as oxlint JS plugins, which are single-threaded per process, so the scan scales nearly linearly with the number of worker processes — typically 3–4x faster on large codebases. Pass `--experimental-parallel <n>` to cap the worker count, or set `REACT_DOCTOR_PARALLEL=<n>` (handy in CI). Diagnostics are identical to a serial run.
|
|
37
|
+
|
|
30
38
|
### 2. Install for agents
|
|
31
39
|
|
|
32
40
|
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.
|
|
@@ -69,6 +77,8 @@ jobs:
|
|
|
69
77
|
|
|
70
78
|
React Doctor scans the files changed in the pull request, emits inline annotations, blocks on error-level findings, and updates one sticky PR comment with the score and issue summary. The built-in GitHub token is used automatically; no secret or PAT is required. On forked PRs where GitHub withholds write permissions, the scan and annotations still run, but the sticky comment may be skipped.
|
|
71
79
|
|
|
80
|
+
**Permissions:** set `permissions: { contents: read, pull-requests: write }` so React Doctor can read the pull request's changed files for a changed-files-only scan and post the sticky summary comment. If `pull-requests: read` is unavailable (for example on fork PRs or with a restricted default token), the action degrades gracefully to a full-project scan instead of failing.
|
|
81
|
+
|
|
72
82
|
[Add GitHub Action →](https://github.com/marketplace/actions/react-doctor)
|
|
73
83
|
|
|
74
84
|
### 4. Configure rules in `react-doctor.config.json`
|