react-doctor 0.2.14-dev.b9e9bcb → 0.2.14-dev.bdb9e36

package/README.md

@@ -81,9 +81,23 @@ React Doctor scans the files changed in the pull request, emits inline annotatio
 
 [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`
 
-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.
+Configure with a `doctor.config.ts` (or `.js`, `.mjs`, `.cjs`, `.json`, `.jsonc`) in your project root — or a `"reactDoctor"` key in `package.json`.
+
+```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
 {
@@ -92,6 +106,30 @@ 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
+```
+
+## Telemetry
+
+The CLI reports crashes and basic run traces to [Sentry](https://sentry.io) to help us fix bugs. Events include the version, platform, Node version, how the CLI was invoked (which command, package manager, and whether it ran locally vs. CI vs. a coding agent), the detected project shape (framework, React version, TypeScript, project size — never the contents of your files), and de-minified stack traces.
+
+Telemetry is **anonymized** before it leaves your machine: no IP address is collected, your hostname and machine name are stripped, your OS username is removed from every path (your home directory is replaced with `~`), captured local variables are dropped, and known secrets/API keys/emails are masked. No source code or diagnostic findings are sent.
+
+Opt out at any time:
+
+- `npx react-doctor@latest --no-score` disables Sentry entirely (crash reporting and tracing) for that run, alongside the hosted score API.
+- `SENTRY_TRACES_SAMPLE_RATE=0` keeps crash reporting but turns off performance tracing.
+
+Telemetry is also skipped automatically under test runs, and the programmatic `react-doctor/api` library never initializes Sentry. Advanced overrides: `SENTRY_DSN` (point at your own Sentry project), `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`, and `SENTRY_DEBUG=1`.
+
 ## Contributing
 
 [Issues welcome!](https://github.com/millionco/react-doctor/issues)