react-doctor 0.9.11 → 0.9.12-dev.025d69d

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { FrameworkToken } from "oxlint-plugin-react-doctor/core";
 import fs from "node:fs";
+import { FrameworkToken } from "oxlint-plugin-react-doctor/core";
 
 //#region ../../node_modules/.pnpm/effect@4.0.0-beta.102/node_modules/effect/dist/Types.d.ts
 /**
@@ -9636,10 +9636,9 @@ interface Diagnostic {
   column: number;
   /**
    * UTF-8 byte offset of the diagnostic's primary span start, straight
-   * from oxlint's label span. Optional because environment / dead-code
-   * diagnostics carry no source span. Editors (LSP) convert this into a
-   * precise range via the in-memory document; non-editor consumers can
-   * ignore it.
+   * from oxlint's label span. Optional because environment / maintainability
+   * diagnostics carry no source span. Consumers can use it to recover a
+   * precise range or ignore it.
    */
   offset?: number;
   /** UTF-8 byte length of the primary span (pairs with `offset`). */
@@ -9697,8 +9696,8 @@ type BlockingLevel = "error" | "warning" | "none";
  * CLI `--scope` flag, the GitHub Action `scope` input, and this config field
  * all share. Ordered widest to narrowest:
  *
- * - `"full"` — whole project, every issue (the default). Whole-project checks
- *   (dead-code, environment, supply-chain) run only at this scope.
+ * - `"full"` — whole project, every issue (the default). Environment and
+ *   supply-chain checks run only at this scope.
  * - `"files"` — only the files changed vs the base, with ALL issues in them
  *   (no compare-to-main). What `--staged` and an uncommitted `--diff` do today.
  * - `"changed"` — only issues the change INTRODUCED vs the base (the baseline
@@ -9836,8 +9835,7 @@ interface SupplyChainConfig {
   /**
    * Whether to run the Socket supply-chain score check. Default: `true`.
    * Set to `false` to opt out — the check performs one network request per
-   * direct dependency. It is always skipped in `--diff` / `--staged` mode
-   * and in editor scans regardless of this setting.
+   * direct dependency. It is always skipped in `--diff` / `--staged` mode.
    */
   enabled?: boolean;
   /**
@@ -9871,11 +9869,8 @@ interface ReactDoctorConfig {
    */
   supplyChain?: SupplyChainConfig;
   /**
-   * Whether to run dead-code analysis (via `deslop-js`) alongside lint.
-   * Reports unused files, unused exports, unused dependencies, and
-   * circular imports under the "Maintainability" category. Default: `true`.
-   * Always skipped in `--diff` / `--staged` modes because reachability
-   * is a whole-project property.
+   * Compatibility switch for React maintainability analysis. Default: `true`.
+   * @deprecated React maintainability checks are part of React Doctor.
    */
   deadCode?: boolean;
   verbose?: boolean;
@@ -10195,6 +10190,28 @@ interface ProjectInfo {
   remotionVersion?: string | null;
   remotionMajorVersion?: number | null;
   hasI18nLibrary?: boolean;
+  /**
+   * `true` when the project (or a workspace package) declares the unified
+   * `radix-ui` package or any `@radix-ui/react-*` primitive (icons excluded).
+   * Drives the `radix-ui` capability, which gates the `radix-*` composition
+   * rules for apps that assemble Radix parts directly.
+   */
+  hasRadixUi?: boolean;
+  /**
+   * `true` when the project (or a workspace package) declares Base UI
+   * (`@base-ui-components/react` or its 1.0 rename `@base-ui/react`).
+   * Drives the `base-ui` capability, which gates the `base-ui-*`
+   * composition rules.
+   */
+  hasBaseUi?: boolean;
+  /** `true` when `react-aria-components` is declared. Drives the `react-aria` capability. */
+  hasReactAriaComponents?: boolean;
+  /** `true` when `@tanstack/react-table` is declared. Drives the `tanstack-table` capability. */
+  hasTanstackTable?: boolean;
+  /** `true` when `@tanstack/react-virtual` is declared. Drives the `tanstack-virtual` capability. */
+  hasTanstackVirtual?: boolean;
+  /** `true` when `@tanstack/react-form` is declared. Drives the `tanstack-form` capability. */
+  hasTanstackForm?: boolean;
   tanstackQueryVersion?: string | null;
   styledComponentsVersion?: string | null;
   /** Whether the project or one of its workspaces declares Three.js, Fiber, or Drei. */
@@ -10294,6 +10311,16 @@ interface ProjectInfo {
    * recommend them to projects pinned below that.
    */
   reanimatedVersion: string | null;
+  /**
+   * `true` when the project (or an ancestor up to the repository boundary)
+   * carries a shadcn `components.json` config. Drives the `shadcn`
+   * capability, which gates the `shadcn-*` component-composition rules —
+   * their part names (`DialogTitle`, `InputGroupInput`, `TabsList`, …) only
+   * carry shadcn's contract in a project that actually generated those
+   * files. Optional so existing `ProjectInfo` consumers remain
+   * source-compatible.
+   */
+  hasShadcnUi?: boolean;
   /**
    * `true` when the project's `tsconfig.json` `compilerOptions.target` or
    * `compilerOptions.lib` indicates the output environment predates ES2023
@@ -10332,7 +10359,7 @@ interface ScoreResult {
 //#region src/types/diagnose.d.ts
 interface DiagnoseOptions {
   lint?: boolean;
-  /** See `ReactDoctorConfig.deadCode`. Ignored in diff mode. */
+  /** @deprecated Compatibility alias for React maintainability analysis. */
   deadCode?: boolean;
   verbose?: boolean;
   /** Restrict linting to supported JS/TS files and inline scripts in HTML files. */
@@ -10352,11 +10379,7 @@ interface DiagnoseOptions {
 interface DiagnoseResult {
   diagnostics: Diagnostic[];
   score: ScoreResult | null;
-  /**
-   * Checks that did not run to completion (e.g. `"dead-code"` when the
-   * `deslop-js` native binding crashed). Empty when everything ran.
-   * Mirrors `InspectResult.skippedChecks`.
-   */
+  /** Checks that did not run to completion. Mirrors `InspectResult.skippedChecks`. */
   skippedChecks: string[];
   /** See `InspectResult.skippedCheckReasons`. */
   skippedCheckReasons?: Record<string, string>;
@@ -10366,11 +10389,11 @@ interface DiagnoseResult {
   scannedFileCount?: number;
   project: ProjectInfo;
   /**
-   * Whether the scanned project resolved a React-compatible runtime (React
-   * or Preact). `false` means every React-runtime rule family was gated
-   * off, so an empty `diagnostics` array is vacuous — NOT the same as a
-   * clean React scan. Consumers gating on the result should treat
-   * `reactDetected === false` as "wrong scan target", not "all clear".
+   * Whether the scanned project resolved a React-compatible runtime directly
+   * or through a React-backed framework. `false` means every React-runtime
+   * rule family was gated off, not that the scan target was unsupported:
+   * other detected framework and library rule families still run, as do
+   * framework-neutral rules on any analyzable project.
    * Mirrors `JsonReport.reactDetected`; same predicate as
    * `hasReactRuntime(result.project)`. Always set by `diagnose()`;
    * optional so hand-constructed results keep compiling.
@@ -10380,7 +10403,7 @@ interface DiagnoseResult {
 }
 /**
  * A single project to scan as part of a `diagnose({ projects })` batch.
- * Scan options (`deadCode`, `lint`, etc.) are flat on the entry and
+ * Scan options (`lint`, etc.) are flat on the entry and
  * layer on top of the global defaults — omitted fields fall through.
  */
 interface ProjectDefinition extends DiagnoseOptions {
@@ -10427,7 +10450,8 @@ interface DiagnoseProjectsResult {
   score: ScoreResult | null;
   /**
    * Whether any successfully scanned project resolved a React-compatible
-   * runtime (React or Preact). Absent when no project scanned successfully.
+   * runtime directly or through a React-backed framework. Absent when no
+   * project scanned successfully.
    * See `DiagnoseResult.reactDetected` for gating guidance; per-project
    * detail is on each `ProjectResultOk.reactDetected`.
    */
@@ -10496,23 +10520,11 @@ interface InspectResult {
    */
   lintSidecarReplayedFileCount?: number | null;
   lintSidecarTotalFileCount?: number | null;
-  /**
-   * Dead-code result cache outcome: `true` when the pass replayed a cached
-   * result (the analysis never ran), `false` on a fresh analysis. Absent when
-   * the pass never consulted the cache — dead-code skipped, the cache
-   * disabled, or a whole-repo cache replay where no analysis ran. The CLI
-   * projects it onto the Sentry wide event as `deadCode.cacheHit`.
-   */
+  /** @deprecated Retained for report compatibility. */
   deadCodeCacheHit?: boolean | null;
-  /**
-   * deslop's incremental summary-cache outcome for the dead-code analysis:
-   * collected files served from cached parse summaries vs freshly parsed.
-   * Both absent whenever no analysis consulted the incremental store — a
-   * whole-result cache hit, the cache disabled, or dead-code skipped. The CLI
-   * projects them onto the Sentry wide event as `deadCode.summaryCacheHits` /
-   * `deadCode.summaryCacheMisses`.
-   */
+  /** @deprecated Retained for report compatibility. */
   deadCodeSummaryCacheHits?: number | null;
+  /** @deprecated Retained for report compatibility. */
   deadCodeSummaryCacheMisses?: number | null;
   /**
    * Present only for a baseline run (`InspectOptions.baseline` set). The
@@ -10530,7 +10542,7 @@ interface InspectResult {
  * Options accepted by `inspect()`. Mixes two concern groups; ordered
  * here in the source to make the split visible to future readers:
  *
- *   - **Engine inputs** (`lint`, `deadCode`, `includePaths`,
+ *   - **Engine inputs** (`lint`, `includePaths`,
  *     `configOverride`, `respectInlineDisables`) — flow into
  *     `runInspect`'s `InspectInput` and shape what the engine
  *     actually does.
@@ -10660,14 +10672,13 @@ interface JsonReportV1$1 {
   mode: JsonReportMode;
   baselineDegraded?: boolean;
   /**
-   * Whether any scanned project resolved a React-compatible runtime (React
-   * or Preact). `false` means every React-runtime rule family was gated off,
-   * so an empty `diagnostics` array is vacuous — NOT the same as a clean
-   * React scan. Consumers gating on the report (CI, verifiers, hooks) should
-   * treat `reactDetected === false` as "wrong scan target", not "all clear"
-   * (per project, `projects[].project.reactVersion` / `preactVersion` say
-   * which roots were non-React). Absent when nothing was scanned (`projects`
-   * is empty), on error reports, and on reports from older CLI versions.
+   * Whether any scanned project resolved a React-compatible runtime directly
+   * or through a React-backed framework. `false` means every React-runtime
+   * rule family was gated off, not that the scan target was unsupported:
+   * other detected framework and library rule families still run, as do
+   * framework-neutral rules on any analyzable project. Absent when
+   * nothing was scanned (`projects` is empty), on error reports, and on
+   * reports from older CLI versions.
    */
   reactDetected?: boolean;
   diff: JsonReportDiffInfo | null;
@@ -10738,8 +10749,8 @@ type JsonReport = JsonReportV1$1 | JsonReportV2$1 | JsonReportV3$1; //#endregion
  * Distinguishes the two situations that both surface as "no project here", so
  * the rendered message matches reality:
  *
- * - `no-project` (default): the path exists but has no React project — no
- *   `package.json` at the root and no discoverable nested React subproject.
+ * - `no-project` (default): the path exists but has no supported project — no
+ *   `package.json` at the root and no discoverable nested React or Three.js subproject.
  * - `missing-path`: the resolved scan target does not exist on disk at all
  *   (a typo, a stale temp path, a monorepo subdir that isn't present). The
  *   generic "expected a package.json" guidance is misleading here, so point
@@ -10844,10 +10855,10 @@ declare const ProjectDiscoveryFailed_base: Class<ProjectDiscoveryFailed, TaggedS
 declare class ProjectDiscoveryFailed extends ProjectDiscoveryFailed_base {
   get message(): string;
 }
-declare const DeadCodeAnalysisFailed_base: Class<DeadCodeAnalysisFailed, TaggedStruct<"DeadCodeAnalysisFailed", {
+declare const MaintainabilityAnalysisFailed_base: Class<MaintainabilityAnalysisFailed, TaggedStruct<"MaintainabilityAnalysisFailed", {
   readonly cause: Unknown;
 }>, YieldableError>;
-declare class DeadCodeAnalysisFailed extends DeadCodeAnalysisFailed_base {
+declare class MaintainabilityAnalysisFailed extends MaintainabilityAnalysisFailed_base {
   get message(): string;
 }
 declare const GitInvocationFailed_base: Class<GitInvocationFailed, TaggedStruct<"GitInvocationFailed", {
@@ -10871,7 +10882,7 @@ declare class GitBaseBranchInvalid extends GitBaseBranchInvalid_base {
   get message(): string;
 }
 declare const ReactDoctorError_base: Class<ReactDoctorError, TaggedStruct<"ReactDoctorError", {
-  readonly reason: Union<readonly [typeof OxlintUnavailable, typeof OxlintBatchExceeded, typeof ScanDeadlineExceeded, typeof OxlintSpawnFailed, typeof OxlintOutputUnparseable, typeof ConfigParseFailed, typeof ProjectNotFound, typeof NoReactDependency, typeof AmbiguousProject, typeof ProjectDiscoveryFailed, typeof DeadCodeAnalysisFailed, typeof GitInvocationFailed, typeof GitBaseBranchMissing, typeof GitBaseBranchInvalid]>;
+  readonly reason: Union<readonly [typeof OxlintUnavailable, typeof OxlintBatchExceeded, typeof ScanDeadlineExceeded, typeof OxlintSpawnFailed, typeof OxlintOutputUnparseable, typeof ConfigParseFailed, typeof ProjectNotFound, typeof NoReactDependency, typeof AmbiguousProject, typeof ProjectDiscoveryFailed, typeof MaintainabilityAnalysisFailed, typeof GitInvocationFailed, typeof GitBaseBranchMissing, typeof GitBaseBranchInvalid]>;
 }>, YieldableError>;
 declare class ReactDoctorError extends ReactDoctorError_base {
   get message(): string;
@@ -10972,13 +10983,11 @@ declare const defineConfig: (config: ReactDoctorConfig) => ReactDoctorConfig; //
 //#endregion
 //#region src/utils/has-react-runtime.d.ts
 /**
- * Whether project discovery resolved a React-compatible runtime (React or
- * Preact, which ships the same hooks + JSX model). This is the same
- * predicate that grants the `react` capability, so `false` means every
- * React-runtime rule family was gated off for the project.
+ * Whether project discovery resolved a React-compatible runtime directly or
+ * through a framework whose runtime is necessarily React-compatible.
  */
 declare const hasReactRuntime: (project: ProjectInfo) => boolean; //#endregion
-//#region src/utils/filter-paths-outside-directories.d.ts
+//#region src/utils/has-supported-framework-or-library.d.ts
 //#endregion
 //#region ../api/dist/index.d.ts
 //#region src/diagnose.d.ts