react-doctor 0.2.14-dev.52ecf12 → 0.2.14-dev.5976266

package/README.md

@@ -27,6 +27,14 @@ npx react-doctor@latest
 
 https://github.com/user-attachments/assets/07cc88d9-9589-44c3-aa73-5d603cb1c570
 
+On a large repo, add `--experimental-parallel` to fan the scan out across your CPU cores:
+
+```bash
+npx react-doctor@latest --experimental-parallel
+```
+
+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.
+
 ### 2. Install for agents
 
 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,11 +77,27 @@ jobs:
 
 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.
 
+**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.
+
 [Add GitHub Action →](https://github.com/marketplace/actions/react-doctor)
 
-### 4. Configure rules in `react-doctor.config.json`
+### 4. Configure rules in `doctor.config.ts`
+
+Configure with a `doctor.config.ts` (or `.js`, `.mjs`, `.cjs`, `.json`, `.jsonc`) in your project root — or a `"reactDoctor"` key in `package.json`.
 
-Point the `$schema` key at `https://react.doctor/schema/config.json` to get autocomplete, hover docs, and typo warnings for every option in any editor that understands JSON Schema.
+```ts
+// doctor.config.ts
+import type { ReactDoctorConfig } from "react-doctor/api";
+
+export default {
+  lint: true,
+  rules: {
+    "react-doctor/no-array-index-as-key": "off",
+  },
+} satisfies ReactDoctorConfig;
+```
+
+Prefer JSON? Use `doctor.config.json` and point `$schema` at `https://react.doctor/schema/config.json` for autocomplete, hover docs, and typo warnings in any editor that understands JSON Schema (comments and trailing commas are allowed):
 
 ```jsonc
 {
@@ -82,6 +106,17 @@ Point the `$schema` key at `https://react.doctor/schema/config.json` to get auto
 }
 ```
 
+Don't hand-edit if you'd rather not — the `rules` subcommands list, explain, and configure rules for you (they edit your `doctor.config.*` in place — including TS/JS, preserving formatting — or `package.json#reactDoctor`):
+
+```bash
+npx react-doctor@latest rules list                 # every rule + its effective severity
+npx react-doctor@latest rules explain <rule>        # why a rule matters and how to tune it
+npx react-doctor@latest rules disable <rule>        # turn a rule off
+npx react-doctor@latest rules set <rule> warn       # off | warn | error
+npx react-doctor@latest rules category "React Native" off
+npx react-doctor@latest rules ignore-tag design     # skip a whole rule family
+```
+
 ## Contributing
 
 [Issues welcome!](https://github.com/millionco/react-doctor/issues)