react-doctor 0.2.0-beta.4 → 0.2.0-beta.6

package/dist/index.d.ts

@@ -11,6 +11,70 @@ interface ReactDoctorIgnoreConfig {
   overrides?: ReactDoctorIgnoreOverride[];
   tags?: string[];
 }
+/**
+ * Discrete output channels a diagnostic can flow through after a scan.
+ * Each surface is filtered independently so a rule can be visible
+ * locally but excluded from PR comments, the score, or the CI gate:
+ *
+ * - `cli` — local terminal output from `react-doctor` (`printDiagnostics`).
+ * - `prComment` — output captured by the GitHub Action for the sticky
+ *   PR comment. Enabled when the CLI is run with `--pr-comment` (the
+ *   action sets this automatically when `github-token` is provided).
+ * - `score` — diagnostics shipped to the React Doctor score API
+ *   (or counted toward local score calculations).
+ * - `ciFailure` — diagnostics that count toward the `--fail-on` exit
+ *   code gate. A diagnostic excluded from this surface never fails the
+ *   build, regardless of severity.
+ *
+ * Defaults: design rules (tag `"design"`) are excluded from `prComment`,
+ * `score`, and `ciFailure` so style cleanup doesn't dilute meaningful
+ * React findings. They remain in `cli` so locally-running developers
+ * still see the suggestion when they touch the file.
+ */
+type DiagnosticSurface = "cli" | "prComment" | "score" | "ciFailure";
+/**
+ * Severity value accepted by the top-level `rules` and `categories`
+ * config fields. Exactly the same form ESLint and oxlint accept:
+ * `"off"` skips registration entirely (the rule never runs and
+ * never enters any surface); `"error"` / `"warn"` change the rule's
+ * registered severity.
+ *
+ * For visibility-only adjustments (silence on PR comments but keep
+ * on CLI / score), prefer `surfaces` instead — severity applies
+ * before lint runs and is the most aggressive control.
+ */
+type RuleSeverityOverride = "error" | "warn" | "off";
+/**
+ * Internal shape consumed by `resolveRuleSeverityOverride` and
+ * `applySeverityControls`. Assembled at runtime from the top-level
+ * `rules` and `categories` fields on `ReactDoctorConfig`. Per-rule
+ * wins over per-category when both match the same diagnostic.
+ */
+interface SurfaceControls {
+  /**
+   * Tag names whose diagnostics should be force-included on the surface,
+   * even if a default or category-level exclusion would otherwise drop
+   * them. Include wins over exclude when both apply to the same rule.
+   */
+  includeTags?: string[];
+  /**
+   * Tag names whose diagnostics should be excluded from the surface.
+   * Use this to silence whole rule families (e.g. `["design"]`,
+   * `["test-noise"]`) for a single channel without touching others.
+   */
+  excludeTags?: string[];
+  /** Category names (e.g. `"Architecture"`) to force-include. */
+  includeCategories?: string[];
+  /** Category names (e.g. `"Architecture"`) to exclude. */
+  excludeCategories?: string[];
+  /**
+   * Fully-qualified rule keys (`"<plugin>/<rule>"`, e.g.
+   * `"react-doctor/design-no-redundant-size-axes"`) to force-include.
+   */
+  includeRules?: string[];
+  /** Fully-qualified rule keys to exclude from this surface. */
+  excludeRules?: string[];
+}
 interface ReactDoctorConfig {
   ignore?: ReactDoctorIgnoreConfig;
   lint?: boolean;
@@ -56,6 +120,20 @@ interface ReactDoctorConfig {
    * suppresses regardless of sibling content.
    */
   rawTextWrapperComponents?: string[];
+  /**
+   * Project-level allowlist of function names that the
+   * `server-auth-actions` rule treats as an auth check at the top of
+   * a server action. Names are accepted whether called as a bare
+   * identifier (`myAuthGuard()`) or as the final property of a
+   * member call (`ctx.myAuthGuard()`); unlike the built-in default
+   * list, user-provided names are treated as distinctive and never
+   * subject to receiver-object disambiguation.
+   *
+   * Use this to teach react-doctor about custom auth guards in
+   * codebases that wrap their auth library — e.g. a project-local
+   * `requireWorkspaceMember` or `ensureSignedIn`.
+   */
+  serverAuthFunctionNames?: string[];
   /**
    * Whether to respect inline `// eslint-disable*`, `// oxlint-disable*`,
    * and `// react-doctor-disable*` comments in source files. Default: `true`.
@@ -96,6 +174,63 @@ interface ReactDoctorConfig {
    * Set to `false` to scan only react-doctor's curated rule set.
    */
   adoptExistingLintConfig?: boolean;
+  /**
+   * Per-surface include/exclude controls. Each `DiagnosticSurface` is
+   * resolved independently against rule tags, category, and id so a
+   * single rule can be visible locally yet hidden from PR comments,
+   * neutralized from the score, and excluded from `--fail-on` — all
+   * without touching the rule's severity or activation.
+   *
+   * Defaults (applied before user overrides):
+   *
+   * - `prComment` excludes tag `"design"`
+   * - `score` excludes tag `"design"`
+   * - `ciFailure` excludes tag `"design"`
+   *
+   * Pass any controls block (even an empty `{}`) to keep the default
+   * exclusions; the user's include/exclude entries layer on top.
+   * Include entries always win over exclude entries — handy for
+   * promoting a single high-signal `design-*` rule back into the
+   * score or PR-comment surface.
+   */
+  surfaces?: Partial<Record<DiagnosticSurface, SurfaceControls>>;
+  /**
+   * Per-rule severity map — the exact ESLint / oxlint top-level
+   * `rules` field. Keys are fully-qualified rule keys
+   * (`"<plugin>/<rule>"`, e.g. `"react-doctor/no-array-index-as-key"`),
+   * values are `"error" | "warn" | "off"`.
+   *
+   * `"off"` skips registration in the generated lint config so the
+   * rule never runs; `"error"` / `"warn"` re-stamp the registered
+   * severity and the post-lint diagnostic, so downstream consumers
+   * (`--fail-on`, the score, the printed list) all see the
+   * user-chosen severity.
+   *
+   * For visibility-only changes (silence on PR comments but keep on
+   * CLI / score), prefer `surfaces` instead. Most specific control
+   * wins: `rules` > `categories` > `tags`.
+   *
+   * ```json
+   * { "rules": { "react-doctor/no-array-index-as-key": "error" } }
+   * ```
+   */
+  rules?: Record<string, RuleSeverityOverride>;
+  /**
+   * Per-category severity map. Mirrors oxlint's top-level
+   * `categories` field, but keyed by React Doctor's display
+   * categories (`"Server"`, `"React Native"`, `"Architecture"`,
+   * `"Bundle Size"`, `"State & Effects"`, `"Security"`,
+   * `"Accessibility"`, `"Performance"`, `"Correctness"`, …).
+   *
+   * ```json
+   * { "categories": { "React Native": "warn", "Server": "off" } }
+   * ```
+   *
+   * To silence a whole tag-defined rule family (e.g. `"design"`,
+   * `"test-noise"`, `"migration-hint"`) that doesn't align with a
+   * single category, use `ignore.tags` instead.
+   */
+  categories?: Record<string, RuleSeverityOverride>;
 } //#endregion
 //#region src/diagnostic.d.ts
 interface Diagnostic {
@@ -124,6 +259,20 @@ interface ProjectInfo {
   hasTypeScript: boolean;
   hasReactCompiler: boolean;
   hasTanStackQuery: boolean;
+  /**
+   * `true` when the project (or any of its workspace packages) declares
+   * React Native or Expo as a dependency. Enables the `react-native`
+   * capability — and therefore every `rn-*` rule — even on web-rooted
+   * monorepos where the entry-point `package.json` is Next / Vite /
+   * Remix but a sibling workspace (`apps/mobile`, `packages/native-ui`)
+   * targets React Native. The file-level package-boundary check in
+   * `oxlint-plugin-react-doctor` still keeps the rules silent on the
+   * web workspaces.
+   *
+   * `false` collapses the gate to the legacy "framework is RN" behavior
+   * — no `rn-*` rules load for the project at all.
+   */
+  hasReactNativeWorkspace: boolean;
   sourceFileCount: number;
 }
 //#endregion