react-doctor 0.2.0-beta.2 → 0.2.0-beta.3

package/dist/index.d.ts

@@ -1,7 +1,294 @@
-import { buildJsonReport, buildJsonReportError, filterSourceFiles, getDiffInfo, summarizeDiagnostics } from "@react-doctor/core";
-import { AmbiguousProjectError, NoReactDependencyError, PackageJsonNotFoundError, ProjectNotFoundError, ReactDoctorError, isReactDoctorError } from "@react-doctor/project-info";
-import { DiagnoseOptions, DiagnoseResult, Diagnostic, DiffInfo, JsonReport, JsonReportDiffInfo, JsonReportError, JsonReportMode, JsonReportProjectEntry, JsonReportSummary, ProjectInfo, ReactDoctorConfig, ScoreResult } from "@react-doctor/types";
-
+//#region ../types/dist/index.d.ts
+//#region src/config.d.ts
+type FailOnLevel = "error" | "warning" | "none";
+interface ReactDoctorIgnoreOverride {
+  files: string[];
+  rules?: string[];
+}
+interface ReactDoctorIgnoreConfig {
+  rules?: string[];
+  files?: string[];
+  overrides?: ReactDoctorIgnoreOverride[];
+  tags?: string[];
+}
+interface ReactDoctorConfig {
+  ignore?: ReactDoctorIgnoreConfig;
+  lint?: boolean;
+  verbose?: boolean;
+  diff?: boolean | string;
+  failOn?: FailOnLevel;
+  customRulesOnly?: boolean;
+  share?: boolean;
+  offline?: boolean;
+  /**
+   * Redirect react-doctor at a different project directory than the one
+   * it was invoked against. Resolved relative to the location of the
+   * config file that declared this field (NOT relative to the CWD), so
+   * the redirect is stable no matter where the CLI / `diagnose()` is
+   * run from. Absolute paths are used as-is.
+   *
+   * Typical use: a monorepo root holds the only `react-doctor.config.json`
+   * (so editor tooling and child commands all find it), but the React
+   * app lives in `apps/web`. Setting `"rootDir": "apps/web"` makes
+   * every invocation that loads this config scan that subproject
+   * without anyone needing to `cd` first or pass an explicit path.
+   *
+   * Ignored if the resolved path does not exist or is not a directory
+   * (a warning is emitted and react-doctor falls back to the originally
+   * requested directory).
+   */
+  rootDir?: string;
+  textComponents?: string[];
+  /**
+   * Names of components that safely route string-only children through a
+   * React Native `<Text>` internally (e.g. `heroui-native`'s `Button`,
+   * which stringifies its children and renders them through a
+   * `ButtonLabel` → `Text`). For listed components, `rn-no-raw-text`
+   * is suppressed ONLY when the wrapper's children are entirely
+   * stringifiable (no nested JSX elements). A wrapper with mixed
+   * children — e.g. `<Button>Save<Icon /></Button>` — still reports,
+   * because the wrapper can't safely route raw text alongside a
+   * sibling JSX element.
+   *
+   * Use this instead of `textComponents` when the component is not
+   * itself a text element but is known to wrap its string children
+   * in one. `textComponents` is the broader escape hatch and
+   * suppresses regardless of sibling content.
+   */
+  rawTextWrapperComponents?: string[];
+  /**
+   * Whether to respect inline `// eslint-disable*`, `// oxlint-disable*`,
+   * and `// react-doctor-disable*` comments in source files. Default: `true`.
+   *
+   * File-level ignores (`.gitignore`, `.eslintignore`, `.oxlintignore`,
+   * `.prettierignore`, `.gitattributes` `linguist-vendored` /
+   * `linguist-generated`) are ALWAYS honored regardless of this option
+   * — they typically point at vendored or generated code that
+   * genuinely shouldn't be linted at all.
+   *
+   * Set to `false` for "audit mode": every inline suppression is
+   * neutralized so react-doctor reports every diagnostic regardless
+   * of historical hide-comments.
+   */
+  respectInlineDisables?: boolean;
+  /**
+   * Whether to merge the user's existing JSON oxlint / eslint config
+   * (`.oxlintrc.json` or `.eslintrc.json`) into the generated scan via
+   * oxlint's `extends` field, so diagnostics from those rules count
+   * toward the react-doctor score. Default: `true`.
+   *
+   * Detection runs at the scanned directory and walks up to the
+   * nearest project boundary (`.git` directory or monorepo root).
+   * The first match wins, with `.oxlintrc.json` preferred over
+   * `.eslintrc.json`.
+   *
+   * Only JSON-format configs are supported because oxlint's `extends`
+   * cannot evaluate JS/TS configs. Flat configs (`eslint.config.js`),
+   * legacy JS configs (`.eslintrc.js`), and TypeScript oxlint configs
+   * (`oxlint.config.ts`) are silently skipped.
+   *
+   * Category-level enables in the user's config (`"categories": { ... }`)
+   * are NOT honored — react-doctor explicitly disables every oxlint
+   * category to keep the scan scoped to its curated rule surface, and
+   * local config wins over `extends`. Use rule-level severities to
+   * fold rules into the score.
+   *
+   * Set to `false` to scan only react-doctor's curated rule set.
+   */
+  adoptExistingLintConfig?: boolean;
+} //#endregion
+//#region src/diagnostic.d.ts
+interface Diagnostic {
+  filePath: string;
+  plugin: string;
+  rule: string;
+  severity: "error" | "warning";
+  message: string;
+  help: string;
+  url?: string;
+  line: number;
+  column: number;
+  category: string;
+  suppressionHint?: string;
+}
+//#endregion
+//#region src/project-info.d.ts
+type Framework = "nextjs" | "vite" | "cra" | "remix" | "gatsby" | "expo" | "react-native" | "tanstack-start" | "unknown";
+interface ProjectInfo {
+  rootDirectory: string;
+  projectName: string;
+  reactVersion: string | null;
+  reactMajorVersion: number | null;
+  tailwindVersion: string | null;
+  framework: Framework;
+  hasTypeScript: boolean;
+  hasReactCompiler: boolean;
+  hasTanStackQuery: boolean;
+  sourceFileCount: number;
+}
+//#endregion
+//#region src/score.d.ts
+interface ScoreResult {
+  score: number;
+  label: string;
+} //#endregion
+//#region src/diagnose.d.ts
+interface DiagnoseOptions {
+  lint?: boolean;
+  verbose?: boolean;
+  includePaths?: string[];
+  /**
+   * Per-call override for `ReactDoctorConfig.respectInlineDisables`.
+   * See that field's docs for the full contract.
+   */
+  respectInlineDisables?: boolean;
+}
+interface DiagnoseResult {
+  diagnostics: Diagnostic[];
+  score: ScoreResult | null;
+  project: ProjectInfo;
+  elapsedMilliseconds: number;
+} //#endregion
+//#region src/handle-error.d.ts
+//#endregion
+//#region src/inspect.d.ts
+interface InspectResult {
+  diagnostics: Diagnostic[];
+  score: ScoreResult | null;
+  skippedChecks: string[];
+  /**
+   * Human-readable explanation for each entry in `skippedChecks`. Keyed
+   * by check name (e.g. `"lint"`). Optional so existing consumers that
+   * only read `skippedChecks` keep working unchanged — but JSON output
+   * and CI integrations should prefer this for diagnostic clarity
+   * (e.g. distinguishing "oxlint native binding missing" from "oxlint
+   * spawn timed out on a large project").
+   */
+  skippedCheckReasons?: Record<string, string>;
+  project: ProjectInfo;
+  elapsedMilliseconds: number;
+}
+interface DiffInfo {
+  currentBranch: string;
+  baseBranch: string;
+  changedFiles: string[];
+  isCurrentChanges?: boolean;
+}
+type JsonReportMode = "full" | "diff" | "staged";
+interface JsonReportDiffInfo {
+  baseBranch: string;
+  currentBranch: string;
+  changedFileCount: number;
+  isCurrentChanges: boolean;
+}
+interface JsonReportProjectEntry {
+  directory: string;
+  project: ProjectInfo;
+  diagnostics: Diagnostic[];
+  score: ScoreResult | null;
+  skippedChecks: string[];
+  /** Human-readable explanation per skipped check. See `InspectResult.skippedCheckReasons`. */
+  skippedCheckReasons?: Record<string, string>;
+  elapsedMilliseconds: number;
+}
+interface JsonReportSummary {
+  errorCount: number;
+  warningCount: number;
+  affectedFileCount: number;
+  totalDiagnosticCount: number;
+  score: number | null;
+  scoreLabel: string | null;
+}
+interface JsonReportError {
+  message: string;
+  name: string;
+  chain: string[];
+}
+interface JsonReport {
+  schemaVersion: 1;
+  version: string;
+  ok: boolean;
+  directory: string;
+  mode: JsonReportMode;
+  diff: JsonReportDiffInfo | null;
+  projects: JsonReportProjectEntry[];
+  /**
+   * Flattened across `projects[].diagnostics` for convenience. Equivalent to
+   * `projects.flatMap((project) => project.diagnostics)`.
+   */
+  diagnostics: Diagnostic[];
+  summary: JsonReportSummary;
+  elapsedMilliseconds: number;
+  error: JsonReportError | null;
+} //#endregion
+//#region src/prompts.d.ts
+//#endregion
+//#region ../project-info/dist/index.d.ts
+//#endregion
+//#region src/errors.d.ts
+declare class ReactDoctorError extends Error {
+  readonly name: string;
+  constructor(message: string, options?: ErrorOptions);
+}
+declare class ProjectNotFoundError extends ReactDoctorError {
+  readonly name = "ProjectNotFoundError";
+  readonly directory: string;
+  constructor(directory: string, options?: ErrorOptions);
+}
+declare class NoReactDependencyError extends ReactDoctorError {
+  readonly name = "NoReactDependencyError";
+  readonly directory: string;
+  constructor(directory: string, options?: ErrorOptions);
+}
+declare class PackageJsonNotFoundError extends ReactDoctorError {
+  readonly name = "PackageJsonNotFoundError";
+  readonly directory: string;
+  constructor(directory: string, options?: ErrorOptions);
+}
+declare class AmbiguousProjectError extends ReactDoctorError {
+  readonly name = "AmbiguousProjectError";
+  readonly directory: string;
+  readonly candidates: readonly string[];
+  constructor(directory: string, candidates: readonly string[], options?: ErrorOptions);
+}
+declare const isReactDoctorError: (value: unknown) => value is ReactDoctorError; //#endregion
+//#region src/utils/is-file.d.ts
+//#endregion
+//#region ../core/dist/index.d.ts
+//#endregion
+//#region src/build-json-report-error.d.ts
+interface BuildJsonReportErrorInput {
+  version: string;
+  directory: string;
+  error: unknown;
+  elapsedMilliseconds: number;
+  mode?: JsonReportMode;
+}
+declare const buildJsonReportError: (input: BuildJsonReportErrorInput) => JsonReport; //#endregion
+//#region src/build-json-report.d.ts
+interface BuildJsonReportInput {
+  version: string;
+  directory: string;
+  mode: JsonReportMode;
+  diff: DiffInfo | null;
+  scans: Array<{
+    directory: string;
+    result: InspectResult;
+  }>;
+  totalElapsedMilliseconds: number;
+}
+declare const buildJsonReport: (input: BuildJsonReportInput) => JsonReport; //#endregion
+//#region src/calculate-score.d.ts
+//#endregion
+//#region src/get-diff-files.d.ts
+declare const getDiffInfo: (directory: string, explicitBaseBranch?: string) => DiffInfo | null;
+declare const filterSourceFiles: (filePaths: string[]) => string[]; //#endregion
+//#region ../../node_modules/.pnpm/picocolors@1.1.1/node_modules/picocolors/types.d.ts
+//#endregion
+//#region src/summarize-diagnostics.d.ts
+declare const summarizeDiagnostics: (diagnostics: Diagnostic[], worstScore?: number | null, worstScoreLabel?: string | null) => JsonReportSummary; //#endregion
+//#region src/validate-config-types.d.ts
+//#endregion
 //#region src/index.d.ts
 declare const clearCaches: () => void;
 interface ToJsonReportOptions {