rename files

Author: phryneas

src/assertable.ts

@@ -1,4 +1,4 @@
-import { RenderStream } from "./profile/profile.js";
+import { RenderStream } from "./renderStream/createRenderStream.js";
 
 export const assertableSymbol = Symbol.for(
   "@testing-library/react-render-stream:assertable"

src/index.ts

@@ -3,14 +3,14 @@ export type {
   RenderStream,
   RenderStreamWithRenderFn,
   RenderStreamOptions,
-} from "./profile/profile.js";
+} from "./renderStream/createRenderStream.js";
 export {
   createRenderStream,
   useTrackRenders,
   WaitForRenderTimeoutError,
-} from "./profile/profile.js";
+} from "./renderStream/createRenderStream.js";
 
-export type { SyncScreen } from "./profile/Render.js";
+export type { SyncScreen } from "./renderStream/Render.js";
 
 export { renderToRenderStream } from "./renderToRenderStream.js";
 export type { RenderStreamWithRenderResult } from "./renderToRenderStream.js";

src/jest/index.ts

@@ -1,31 +1,14 @@
 import { expect } from "@jest/globals";
-import { toRerender, toRenderExactlyTimes } from "./ProfiledComponent.js";
-import type {
-  NextRenderOptions,
-  RenderStream,
-  Assertable,
-} from "@testing-library/react-render-stream";
+import { toRerender, toRenderExactlyTimes } from "./renderStreamMatchers.js";
+import type { RenderStreamMatchers } from "./renderStreamMatchers.js";
 
 expect.extend({
   toRerender,
   toRenderExactlyTimes,
 });
-interface CustomMatchers<R = void, T = {}> {
-  toRerender: T extends RenderStream<any> | Assertable
-    ? (options?: NextRenderOptions) => Promise<R>
-    : {
-        error: "matcher needs to be called on a `takeRender` function, `takeSnapshot` function or `RenderStream` instance";
-      };
-
-  toRenderExactlyTimes: T extends RenderStream<any> | Assertable
-    ? (count: number, options?: NextRenderOptions) => Promise<R>
-    : {
-        error: "matcher needs to be called on a `takeRender` function, `takeSnapshot` function or `RenderStream` instance";
-      };
-}
 
 declare global {
   namespace jest {
-    interface Matchers<R = void, T = {}> extends CustomMatchers<R, T> {}
+    interface Matchers<R = void, T = {}> extends RenderStreamMatchers<R, T> {}
   }
 }

src/jest/ProfiledComponent.ts renamed to src/jest/renderStreamMatchers.ts

@@ -9,6 +9,20 @@ import type {
 // this will bundle the `Symbol.for` call twice, but we keep it private
 import { assertableSymbol } from "../assertable.js";
 
+export interface RenderStreamMatchers<R = void, T = {}> {
+  toRerender: T extends RenderStream<any> | Assertable
+    ? (options?: NextRenderOptions) => Promise<R>
+    : {
+        error: "matcher needs to be called on a `takeRender` function, `takeSnapshot` function or `RenderStream` instance";
+      };
+
+  toRenderExactlyTimes: T extends RenderStream<any> | Assertable
+    ? (count: number, options?: NextRenderOptions) => Promise<R>
+    : {
+        error: "matcher needs to be called on a `takeRender` function, `takeSnapshot` function or `RenderStream` instance";
+      };
+}
+
 export const toRerender: MatcherFunction<[options?: NextRenderOptions]> =
   async function (actual, options) {
     const _stream = actual as RenderStream<any> | Assertable;

src/renderHookToSnapshotStream.ts

@@ -1,6 +1,8 @@
 import { RenderHookOptions } from "@testing-library/react";
-import { createRenderStream, NextRenderOptions } from "./profile/profile.js";
-import { Render } from "./profile/Render.js";
+import { createRenderStream } from "./renderStream/createRenderStream.js";
+import type { NextRenderOptions } from "./renderStream/createRenderStream.js";
+
+import { Render } from "./renderStream/Render.js";
 import { createElement } from "react";
 import { Assertable, assertableSymbol, markAssertable } from "./assertable.js";
 

src/profile/Render.tsx renamed to src/renderStream/Render.tsx

@@ -141,7 +141,7 @@ export function createRenderStream<Snapshot extends ValidSnapshot = void>({
     }));
   };
 
-  const profilerContext: RenderStreamContextValue = {
+  const renderStreamContext: RenderStreamContextValue = {
     renderedComponents: [],
   };
 
@@ -155,7 +155,7 @@ export function createRenderStream<Snapshot extends ValidSnapshot = void>({
   ) => {
     if (
       skipNonTrackingRenders &&
-      profilerContext.renderedComponents.length === 0
+      renderStreamContext.renderedComponents.length === 0
     ) {
       return;
     }
@@ -191,9 +191,9 @@ export function createRenderStream<Snapshot extends ValidSnapshot = void>({
         baseRender,
         snapshot,
         domSnapshot,
-        profilerContext.renderedComponents
+        renderStreamContext.renderedComponents
       );
-      profilerContext.renderedComponents = [];
+      renderStreamContext.renderedComponents = [];
       stream.renders.push(render);
       resolveNextRender?.(render);
     } catch (error) {
@@ -211,7 +211,7 @@ export function createRenderStream<Snapshot extends ValidSnapshot = void>({
   let iteratorPosition = 0;
   function Wrapper({ children }: { children: React.ReactNode }) {
     return (
-      <RenderStreamContextProvider value={profilerContext}>
+      <RenderStreamContextProvider value={renderStreamContext}>
         <React.Profiler id="test" onRender={profilerOnRender}>
           {children}
         </React.Profiler>
@@ -373,7 +373,7 @@ export function useTrackRenders({ name }: { name?: string } = {}) {
 
   if (!ctx) {
     throw new Error(
-      "useTrackComponentRender: A Profiler must be created and rendered to track component renders"
+      "useTrackComponentRender: A Render Stream must be created and rendered to track component renders"
     );
   }