rerender-lens 0.4.0 → 0.5.0

package/dist/vitest.d.cts

@@ -1,44 +1,28 @@
-import { O as Options, R as RenderReport } from './types-BzUEVkxJ.cjs';
-import { C as Collector } from './notifiers-BGQtWKfX.cjs';
-export { c as checkBudget, f as formatFixes } from './budget-COBu7jBU.cjs';
+import { R as ReporterOptions } from './runner-report-B8Sc3FZO.cjs';
+export { L as LensSetup, O as OUT_ENV, a as RunResult, S as SetupHooks, b as SetupOptions, r as readRun, s as setupRerenderLens } from './runner-report-B8Sc3FZO.cjs';
+export { c as checkBudget, f as formatFixes } from './budget-CRswn-nC.cjs';
+import './types-DW5-N2XH.cjs';
+import './notifiers-DwKlvv4H.cjs';
 
-declare const OUT_ENV = "RERENDER_LENS_OUT";
-interface SetupOptions extends Omit<Options, 'notifier'> {
-    /** Also fail each test file that recorded avoidable re-renders (default false: the reporter decides). */
-    failFast?: boolean;
-}
-/** How the setup ties into the test runner (`{ afterAll }` from 'vitest'; `rerender-lens/vitest/setup` does this). */
-interface SetupHooks {
-    afterAll?: (fn: () => void) => void;
-    /** Path of the current test file, for the reporter's output. */
-    testPath?: () => string | undefined;
-}
-interface LensSetup {
-    collector: Collector;
-    /** Append this file's reports to the shared output and clear the collector; registered with `afterAll` when given. */
-    flush(): void;
-}
 /**
- * Call from a `setupFiles` entry. Creates the DevTools hook before react-dom loads, starts the
- * library with a collector, and appends this file's reports to the shared output when it ends.
- * The collector is returned for per-test assertions (`assertNoAvoidable`, `assertWithinBudget`).
+ * Vitest integration: one `setupFiles` line collects every avoidable re-render across the run,
+ * and a reporter prints the ranked fixes (and enforces a budget file) when the run ends.
+ *
+ *   // vitest.config.ts
+ *   test: {
+ *     setupFiles: ['rerender-lens/vitest/setup'],
+ *     reporters: ['default', ['rerender-lens/vitest', { budget: 'rerender-budget.json' }]],
+ *   }
+ *
+ * Custom options: write your own setup file and call `setupRerenderLens(options, { afterAll })`.
+ *
+ * Everything that is not Vitest-specific lives in `src/runner-report.ts`, shared with
+ * `rerender-lens/jest`.
  */
-declare function setupRerenderLens(options?: SetupOptions, hooks?: SetupHooks): LensSetup;
-interface ReporterOptions {
-    /** Path to a budget JSON (`{ "*": 0, "Row": 2 }`). When set, the run fails on violations. */
-    budget?: string;
-    /** Print at most this many fixes. Default 10. */
-    limit?: number;
-    /** Also write the collected reports here as a panel-compatible export (`Sessions > Import`). */
-    exportTo?: string;
-    /** Where the lines go. Default `process.stdout`. */
-    write?: (line: string) => void;
-}
+
 /** Vitest reporter (`reporters: [['rerender-lens/vitest', { budget }]]`). */
 declare class RerenderLensReporter {
-    private options;
-    private file;
-    private done;
+    private core;
     constructor(options?: ReporterOptions);
     onInit(): void;
     onTestRunEnd(): void;
@@ -46,7 +30,5 @@ declare class RerenderLensReporter {
     onFinished(): void;
     private finish;
 }
-/** Reports from every worker of a run. */
-declare function readRun(file: string): RenderReport[];
 
-export { type LensSetup, OUT_ENV, type ReporterOptions, type SetupHooks, type SetupOptions, RerenderLensReporter as default, readRun, setupRerenderLens };
+export { ReporterOptions, RerenderLensReporter as default };

package/dist/vitest.d.ts

@@ -1,44 +1,28 @@
-import { O as Options, R as RenderReport } from './types-BzUEVkxJ.js';
-import { C as Collector } from './notifiers-BjjGSHpp.js';
-export { c as checkBudget, f as formatFixes } from './budget-LkNjGtRc.js';
+import { R as ReporterOptions } from './runner-report-CW8X5RwK.js';
+export { L as LensSetup, O as OUT_ENV, a as RunResult, S as SetupHooks, b as SetupOptions, r as readRun, s as setupRerenderLens } from './runner-report-CW8X5RwK.js';
+export { c as checkBudget, f as formatFixes } from './budget-BnJlYwrV.js';
+import './types-DW5-N2XH.js';
+import './notifiers-FNzKHs0a.js';
 
-declare const OUT_ENV = "RERENDER_LENS_OUT";
-interface SetupOptions extends Omit<Options, 'notifier'> {
-    /** Also fail each test file that recorded avoidable re-renders (default false: the reporter decides). */
-    failFast?: boolean;
-}
-/** How the setup ties into the test runner (`{ afterAll }` from 'vitest'; `rerender-lens/vitest/setup` does this). */
-interface SetupHooks {
-    afterAll?: (fn: () => void) => void;
-    /** Path of the current test file, for the reporter's output. */
-    testPath?: () => string | undefined;
-}
-interface LensSetup {
-    collector: Collector;
-    /** Append this file's reports to the shared output and clear the collector; registered with `afterAll` when given. */
-    flush(): void;
-}
 /**
- * Call from a `setupFiles` entry. Creates the DevTools hook before react-dom loads, starts the
- * library with a collector, and appends this file's reports to the shared output when it ends.
- * The collector is returned for per-test assertions (`assertNoAvoidable`, `assertWithinBudget`).
+ * Vitest integration: one `setupFiles` line collects every avoidable re-render across the run,
+ * and a reporter prints the ranked fixes (and enforces a budget file) when the run ends.
+ *
+ *   // vitest.config.ts
+ *   test: {
+ *     setupFiles: ['rerender-lens/vitest/setup'],
+ *     reporters: ['default', ['rerender-lens/vitest', { budget: 'rerender-budget.json' }]],
+ *   }
+ *
+ * Custom options: write your own setup file and call `setupRerenderLens(options, { afterAll })`.
+ *
+ * Everything that is not Vitest-specific lives in `src/runner-report.ts`, shared with
+ * `rerender-lens/jest`.
  */
-declare function setupRerenderLens(options?: SetupOptions, hooks?: SetupHooks): LensSetup;
-interface ReporterOptions {
-    /** Path to a budget JSON (`{ "*": 0, "Row": 2 }`). When set, the run fails on violations. */
-    budget?: string;
-    /** Print at most this many fixes. Default 10. */
-    limit?: number;
-    /** Also write the collected reports here as a panel-compatible export (`Sessions > Import`). */
-    exportTo?: string;
-    /** Where the lines go. Default `process.stdout`. */
-    write?: (line: string) => void;
-}
+
 /** Vitest reporter (`reporters: [['rerender-lens/vitest', { budget }]]`). */
 declare class RerenderLensReporter {
-    private options;
-    private file;
-    private done;
+    private core;
     constructor(options?: ReporterOptions);
     onInit(): void;
     onTestRunEnd(): void;
@@ -46,7 +30,5 @@ declare class RerenderLensReporter {
     onFinished(): void;
     private finish;
 }
-/** Reports from every worker of a run. */
-declare function readRun(file: string): RenderReport[];
 
-export { type LensSetup, OUT_ENV, type ReporterOptions, type SetupHooks, type SetupOptions, RerenderLensReporter as default, readRun, setupRerenderLens };
+export { ReporterOptions, RerenderLensReporter as default };