react-doctor 0.0.41 → 0.0.44

package/dist/index.d.ts

@@ -8,6 +8,7 @@ interface ProjectInfo {
   framework: Framework;
   hasTypeScript: boolean;
   hasReactCompiler: boolean;
+  hasTanStackQuery: boolean;
   sourceFileCount: number;
 }
 interface Diagnostic {
@@ -20,12 +21,35 @@ interface Diagnostic {
   line: number;
   column: number;
   category: string;
-  weight?: number;
 }
 interface ScoreResult {
   score: number;
   label: string;
 }
+interface DiagnoseOptions {
+  lint?: boolean;
+  deadCode?: 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;
+}
+interface ScanResult {
+  diagnostics: Diagnostic[];
+  score: ScoreResult | null;
+  skippedChecks: string[];
+  project: ProjectInfo;
+  elapsedMilliseconds: number;
+}
 interface DiffInfo {
   currentBranch: string;
   baseBranch: string;
@@ -46,25 +70,108 @@ interface ReactDoctorConfig {
   customRulesOnly?: boolean;
   share?: boolean;
   textComponents?: string[];
+  /**
+   * Whether to respect inline `// eslint-disable*` / `// oxlint-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;
+}
+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[];
+  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/utils/build-json-report.d.ts
+interface BuildJsonReportInput {
+  version: string;
+  directory: string;
+  mode: JsonReportMode;
+  diff: DiffInfo | null;
+  scans: Array<{
+    directory: string;
+    result: ScanResult;
+  }>;
+  totalElapsedMilliseconds: number;
+}
+declare const buildJsonReport: (input: BuildJsonReportInput) => JsonReport;
+//#endregion
+//#region src/utils/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/utils/get-diff-files.d.ts
 declare const getDiffInfo: (directory: string, explicitBaseBranch?: string) => DiffInfo | null;
 declare const filterSourceFiles: (filePaths: string[]) => string[];
 //#endregion
+//#region src/utils/summarize-diagnostics.d.ts
+declare const summarizeDiagnostics: (diagnostics: Diagnostic[], worstScore?: number | null, worstScoreLabel?: string | null) => JsonReportSummary;
+//#endregion
 //#region src/index.d.ts
-interface DiagnoseOptions {
-  lint?: boolean;
-  deadCode?: boolean;
-  includePaths?: string[];
-}
-interface DiagnoseResult {
-  diagnostics: Diagnostic[];
-  score: ScoreResult | null;
-  project: ProjectInfo;
-  elapsedMilliseconds: number;
+declare const clearCaches: () => void;
+interface ToJsonReportOptions {
+  version: string;
+  directory?: string;
+  mode?: JsonReportMode;
 }
+declare const toJsonReport: (result: DiagnoseResult, options: ToJsonReportOptions) => JsonReport;
 declare const diagnose: (directory: string, options?: DiagnoseOptions) => Promise<DiagnoseResult>;
 //#endregion
-export { DiagnoseOptions, DiagnoseResult, type Diagnostic, type DiffInfo, type ProjectInfo, type ReactDoctorConfig, type ScoreResult, diagnose, filterSourceFiles, getDiffInfo };
+export { type DiagnoseOptions, type DiagnoseResult, type Diagnostic, type DiffInfo, type JsonReport, type JsonReportDiffInfo, type JsonReportError, type JsonReportMode, type JsonReportProjectEntry, type JsonReportSummary, type ProjectInfo, type ReactDoctorConfig, type ScoreResult, buildJsonReport, buildJsonReportError, clearCaches, diagnose, filterSourceFiles, getDiffInfo, summarizeDiagnostics, toJsonReport };
 //# sourceMappingURL=index.d.ts.map