rerender-lens 0.3.0 → 0.5.0

package/dist/runner-report-B8Sc3FZO.d.cts

@@ -0,0 +1,46 @@
+import { R as RenderReport, O as Options } from './types-DW5-N2XH.cjs';
+import { C as Collector } from './notifiers-DwKlvv4H.cjs';
+
+/** Environment variable carrying the path of the run's JSONL file from the reporter to the workers. */
+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 the runner's globals). */
+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 setup file. 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`).
+ */
+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;
+}
+interface RunResult {
+    /** Every report of the run, from every worker. */
+    reports: RenderReport[];
+    /** Set when a budget file was given and exceeded; the run must fail. */
+    error: Error | null;
+}
+/** Reports from every worker of a run. */
+declare function readRun(file: string): RenderReport[];
+
+export { type LensSetup as L, OUT_ENV as O, type ReporterOptions as R, type SetupHooks as S, type RunResult as a, type SetupOptions as b, readRun as r, setupRerenderLens as s };

package/dist/runner-report-CW8X5RwK.d.ts

@@ -0,0 +1,46 @@
+import { R as RenderReport, O as Options } from './types-DW5-N2XH.js';
+import { C as Collector } from './notifiers-FNzKHs0a.js';
+
+/** Environment variable carrying the path of the run's JSONL file from the reporter to the workers. */
+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 the runner's globals). */
+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 setup file. 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`).
+ */
+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;
+}
+interface RunResult {
+    /** Every report of the run, from every worker. */
+    reports: RenderReport[];
+    /** Set when a budget file was given and exceeded; the run must fail. */
+    error: Error | null;
+}
+/** Reports from every worker of a run. */
+declare function readRun(file: string): RenderReport[];
+
+export { type LensSetup as L, OUT_ENV as O, type ReporterOptions as R, type SetupHooks as S, type RunResult as a, type SetupOptions as b, readRun as r, setupRerenderLens as s };