react-doctor 0.2.1 → 0.2.2

package/dist/index.d.ts

@@ -79,6 +79,14 @@ interface SurfaceControls {
 interface ReactDoctorConfig {
   ignore?: ReactDoctorIgnoreConfig;
   lint?: boolean;
+  /**
+   * Whether to run dead-code analysis (via `deslop-js`) alongside lint.
+   * Reports unused files, unused exports, unused dependencies, and
+   * circular imports under the "Dead Code" category. Default: `true`.
+   * Always skipped in `--diff` / `--staged` modes because reachability
+   * is a whole-project property.
+   */
+  deadCode?: boolean;
   verbose?: boolean;
   diff?: boolean | string;
   failOn?: FailOnLevel;
@@ -285,6 +293,8 @@ interface ScoreResult {
 //#region src/diagnose.d.ts
 interface DiagnoseOptions {
   lint?: boolean;
+  /** See `ReactDoctorConfig.deadCode`. Ignored in diff mode. */
+  deadCode?: boolean;
   verbose?: boolean;
   includePaths?: string[];
   /**
@@ -296,6 +306,14 @@ 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`.
+   */
+  skippedChecks: string[];
+  /** See `InspectResult.skippedCheckReasons`. */
+  skippedCheckReasons?: Record<string, string>;
   project: ProjectInfo;
   elapsedMilliseconds: number;
 } //#endregion
@@ -319,7 +337,13 @@ interface InspectResult {
   elapsedMilliseconds: number;
 }
 interface DiffInfo {
-  currentBranch: string;
+  /**
+   * `null` when `HEAD` is detached (e.g. GitHub Actions `pull_request`
+   * runs that check out `refs/pull/N/merge`). The diff itself still
+   * resolves via `git merge-base <base> HEAD`; callers should render
+   * this case as `"(detached HEAD)"` or similar.
+   */
+  currentBranch: string | null;
   baseBranch: string;
   changedFiles: string[];
   isCurrentChanges?: boolean;
@@ -327,7 +351,8 @@ interface DiffInfo {
 type JsonReportMode = "full" | "diff" | "staged";
 interface JsonReportDiffInfo {
   baseBranch: string;
-  currentBranch: string;
+  /** `null` when `HEAD` is detached — see `DiffInfo.currentBranch`. */
+  currentBranch: string | null;
   changedFileCount: number;
   isCurrentChanges: boolean;
 }