react-doctor 0.2.5 → 0.2.7

package/dist/index.d.ts

@@ -49,7 +49,7 @@ type DiagnosticSurface = "cli" | "prComment" | "score" | "ciFailure";
 type RuleSeverityOverride = "error" | "warn" | "off";
 /**
  * Internal shape consumed by `resolveRuleSeverityOverride` and
- * `applySeverityControls`. Assembled at runtime from the top-level
+ * `buildDiagnosticPipeline`. 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.
  */
@@ -374,6 +374,24 @@ interface InspectResult {
   project: ProjectInfo;
   elapsedMilliseconds: number;
 }
+/**
+ * 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`,
+ *     `configOverride`, `respectInlineDisables`) — flow into
+ *     `runInspect`'s `InspectInput` and shape what the engine
+ *     actually does.
+ *   - **Rendering / orchestration knobs** (`scoreOnly`, `noScore`,
+ *     `silent`, `verbose`, `outputSurface`, `isCi`) — consumed by
+ *     the public-API shell to decide what to print, which surface
+ *     to filter for, and whether to mark the run as CI-originated.
+ *
+ * A full type split was investigated as the plan's T4 follow-up but
+ * deferred — every call site builds the union anyway, so the gain
+ * was purely documentary. Grouping the fields here captures the
+ * same intent without churning a published-API type.
+ */
 interface DiffInfo {
   /**
    * `null` when `HEAD` is detached (e.g. GitHub Actions `pull_request`
@@ -567,24 +585,22 @@ declare const ReactDoctorError_base: Schema.Class<ReactDoctorError, Schema.Tagge
 declare class ReactDoctorError extends ReactDoctorError_base {
   get message(): string;
 }
-declare const isReactDoctorError: (error: unknown) => error is ReactDoctorError; //#endregion
-//#region src/observability.d.ts
+declare const isReactDoctorError: (error: unknown) => error is ReactDoctorError;
 /**
- * Opt-in OpenTelemetry layer. The default `Effect.fn(...)` spans
- * already populate the in-process tracer; this layer plugs an OTLP
- * HTTP exporter into the runtime when the user opts in via:
- *
- *   REACT_DOCTOR_OTLP_ENDPOINT      e.g. https://api.axiom.co
- *   REACT_DOCTOR_OTLP_AUTH_HEADER   e.g. "Bearer <token>"
+ * Tagged-reason → legacy thrown-class boundary shared by every public
+ * shell (`inspect()` in `react-doctor`, `diagnose()` in `@react-doctor/api`).
  *
- * Both env vars are required to enable export — if either is
- * missing, the layer is a no-op (matches the pattern from
- * `react-doctor-evals/src/Observability.ts`, where the equivalent
- * absent-env path returns `Layer.empty`).
+ * `Effect.catchReasons` dispatches on the tagged-error sub-channel
+ * without manual `instanceof` checks. Each handler converts a tagged
+ * reason into the historical thrown class advertised by the legacy
+ * public-API contract (via `Effect.die`, which `Effect.runPromise`
+ * re-throws unchanged). The `orElse` branch re-`die`s the original
+ * `ReactDoctorError` instance so advanced callers can still narrow on
+ * `error.reason._tag` while grep-stderr users keep the same
+ * `error.message` they always saw.
  *
- * No setup is required for users who don't care about tracing — the
- * inspect / diagnose orchestrators always run, this layer just
- * dictates whether the spans they emit get shipped to a backend.
+ * Adding a new legacy thrown class is a one-line change on the
+ * `Effect.catchReasons` map — both shells pick it up automatically.
  */
 //#endregion
 //#region src/build-json-report-error.d.ts