react-render-detective 0.3.0 → 0.4.0

package/dist/testing.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+var chunkH5RG2EPP_cjs = require('./chunk-H5RG2EPP.cjs');
+
+
+
+Object.defineProperty(exports, "assertNoRenderRegressions", {
+  enumerable: true,
+  get: function () { return chunkH5RG2EPP_cjs.assertNoRenderRegressions; }
+});
+Object.defineProperty(exports, "compareProfiles", {
+  enumerable: true,
+  get: function () { return chunkH5RG2EPP_cjs.compareProfiles; }
+});
+Object.defineProperty(exports, "profileFromEvents", {
+  enumerable: true,
+  get: function () { return chunkH5RG2EPP_cjs.profileFromEvents; }
+});
+//# sourceMappingURL=testing.cjs.map
+//# sourceMappingURL=testing.cjs.map

package/dist/testing.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"testing.cjs"}

package/dist/testing.d.cts

@@ -0,0 +1,62 @@
+import { b as RenderEvent } from './types-gl13xwmN.cjs';
+
+/**
+ * Render-regression testing.
+ *
+ * Fixing a render problem once is easy; keeping it fixed is the hard part. This
+ * turns render behaviour into something a pull request can fail on: record a
+ * profile for a scripted interaction, commit it, and compare on every run.
+ *
+ * Deliberately assertion-library agnostic — it returns data and a message, and
+ * your test framework decides what to do with it.
+ */
+
+interface ComponentProfile {
+    renders: number;
+    remounts: number;
+    avoidableRenders: number;
+}
+interface RenderProfile {
+    /** Free-form label, e.g. "search: type one character". */
+    scenario: string;
+    components: Record<string, ComponentProfile>;
+}
+interface RegressionOptions {
+    /**
+     * Allowed growth before a component counts as regressed, as a fraction.
+     * `0.2` tolerates a 20% increase. Defaults to 0 — exact.
+     */
+    tolerance?: number;
+    /** Ignore components below this render count in the baseline. */
+    ignoreBelow?: number;
+    /** Component names to skip entirely. */
+    ignore?: string[];
+    /** Fail when a component is rendering *fewer* times too. Off by default. */
+    failOnImprovement?: boolean;
+}
+interface Regression {
+    component: string;
+    metric: "renders" | "remounts" | "avoidableRenders";
+    baseline: number;
+    current: number;
+    delta: number;
+}
+interface RegressionResult {
+    ok: boolean;
+    scenario: string;
+    regressions: Regression[];
+    improvements: Regression[];
+    /** Components present now but absent from the baseline. */
+    added: string[];
+    message: string;
+}
+/** Builds a profile from recorded events. Pass `getEvents()`. */
+declare function profileFromEvents(scenario: string, events: RenderEvent[], remounts?: Record<string, number>): RenderProfile;
+declare function compareProfiles(baseline: RenderProfile, current: RenderProfile, options?: RegressionOptions): RegressionResult;
+/**
+ * Throws when the current profile is worse than the baseline. The one-liner for
+ * a test file; use `compareProfiles` when you want the data.
+ */
+declare function assertNoRenderRegressions(baseline: RenderProfile, current: RenderProfile, options?: RegressionOptions): void;
+
+export { type ComponentProfile, type Regression, type RegressionOptions, type RegressionResult, type RenderProfile, assertNoRenderRegressions, compareProfiles, profileFromEvents };

package/dist/testing.d.ts

@@ -0,0 +1,62 @@
+import { b as RenderEvent } from './types-gl13xwmN.js';
+
+/**
+ * Render-regression testing.
+ *
+ * Fixing a render problem once is easy; keeping it fixed is the hard part. This
+ * turns render behaviour into something a pull request can fail on: record a
+ * profile for a scripted interaction, commit it, and compare on every run.
+ *
+ * Deliberately assertion-library agnostic — it returns data and a message, and
+ * your test framework decides what to do with it.
+ */
+
+interface ComponentProfile {
+    renders: number;
+    remounts: number;
+    avoidableRenders: number;
+}
+interface RenderProfile {
+    /** Free-form label, e.g. "search: type one character". */
+    scenario: string;
+    components: Record<string, ComponentProfile>;
+}
+interface RegressionOptions {
+    /**
+     * Allowed growth before a component counts as regressed, as a fraction.
+     * `0.2` tolerates a 20% increase. Defaults to 0 — exact.
+     */
+    tolerance?: number;
+    /** Ignore components below this render count in the baseline. */
+    ignoreBelow?: number;
+    /** Component names to skip entirely. */
+    ignore?: string[];
+    /** Fail when a component is rendering *fewer* times too. Off by default. */
+    failOnImprovement?: boolean;
+}
+interface Regression {
+    component: string;
+    metric: "renders" | "remounts" | "avoidableRenders";
+    baseline: number;
+    current: number;
+    delta: number;
+}
+interface RegressionResult {
+    ok: boolean;
+    scenario: string;
+    regressions: Regression[];
+    improvements: Regression[];
+    /** Components present now but absent from the baseline. */
+    added: string[];
+    message: string;
+}
+/** Builds a profile from recorded events. Pass `getEvents()`. */
+declare function profileFromEvents(scenario: string, events: RenderEvent[], remounts?: Record<string, number>): RenderProfile;
+declare function compareProfiles(baseline: RenderProfile, current: RenderProfile, options?: RegressionOptions): RegressionResult;
+/**
+ * Throws when the current profile is worse than the baseline. The one-liner for
+ * a test file; use `compareProfiles` when you want the data.
+ */
+declare function assertNoRenderRegressions(baseline: RenderProfile, current: RenderProfile, options?: RegressionOptions): void;
+
+export { type ComponentProfile, type Regression, type RegressionOptions, type RegressionResult, type RenderProfile, assertNoRenderRegressions, compareProfiles, profileFromEvents };

package/dist/testing.js

@@ -0,0 +1,3 @@
+export { assertNoRenderRegressions, compareProfiles, profileFromEvents } from './chunk-LILK23YH.js';
+//# sourceMappingURL=testing.js.map
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"testing.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-render-detective",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Know WHY your React components render \u2014 not just that they did.",
   "keywords": [
     "react",
@@ -61,6 +61,11 @@
       "import": "./dist/vite.js",
       "require": "./dist/vite.cjs"
     },
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "import": "./dist/testing.js",
+      "require": "./dist/testing.cjs"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {