chore: rename options

Author: fabioh8010

README.md

@@ -374,8 +374,8 @@ interface MeasureRendersOptions {
   wrapper?: React.ComponentType<{ children: ReactElement }>;
   scenario?: (view?: RenderResult) => Promise<any>;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
@@ -385,8 +385,8 @@ interface MeasureRendersOptions {
 - **`wrapper`**: React component, such as a `Provider`, which the `ui` will be wrapped with. Note: the render duration of the `wrapper` itself is excluded from the results; only the wrapped component is measured.
 - **`scenario`**: a custom async function, which defines user interaction within the UI by utilising RNTL or RTL functions
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 #### `measureFunction` function
 
@@ -407,17 +407,17 @@ interface MeasureFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
 - **`runs`**: number of runs per series for the particular test
 - **`warmupRuns`**: number of additional warmup runs that will be done and discarded before the actual runs
 - **`removeOutliers`**: should remove statistical outlier results (default: `true`)
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 #### `measureAsyncFunction` function
 
@@ -440,17 +440,17 @@ interface MeasureAsyncFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
 - **`runs`**: number of runs per series for the particular test
 - **`warmupRuns`**: number of additional warmup runs that will be done and discarded before the actual runs
 - **`removeOutliers`**: should remove statistical outlier results (default: `true`)
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 ### Configuration
 

docusaurus/docs/api.md

@@ -54,8 +54,8 @@ interface MeasureRendersOptions {
   wrapper?: React.ComponentType<{ children: ReactElement }>;
   scenario?: (view?: RenderResult) => Promise<any>;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
@@ -65,8 +65,8 @@ interface MeasureRendersOptions {
 - **`wrapper`**: React component, such as a `Provider`, which the `ui` will be wrapped with. Note: the render duration of the `wrapper` itself is excluded from the results, only the wrapped component is measured.
 - **`scenario`**: a custom async function, which defines user interaction within the ui by utilized RNTL functions
 - **`writeFile`**: (default `true`) should write output to file.
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 ### `measureFunction` function {#measure-function}
 
@@ -99,17 +99,17 @@ interface MeasureFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
 - **`runs`**: number of runs per series for the particular test
 - **`warmupRuns`**: number of additional warmup runs that will be done and discarded before the actual runs
 - **`removeOutliers`**: should remove statistical outlier results (default: `true`)
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 ### `measureAsyncFunction` function {#measure-async-function}
 
@@ -150,17 +150,17 @@ interface MeasureAsyncFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
 - **`runs`**: number of runs per series for the particular test
 - **`warmupRuns`**: number of additional warmup runs that will be done and discarded before the actual runs
 - **`removeOutliers`**: should remove statistical outlier results (default: `true`)
 - **`writeFile`**: (default `true`) should write output to file
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 ## Configuration
 

packages/measure/src/__tests__/measure-function.test.tsx

@@ -65,8 +65,8 @@ test('measureFunction executes setup and cleanup functions for each run', async
     runs: 10,
     warmupRuns: 1,
     writeFile: false,
-    beforeEachRun: beforeFn,
-    afterEachRun: afterFn,
+    beforeEach: beforeFn,
+    afterEach: afterFn,
   });
 
   expect(beforeFn).toHaveBeenCalledTimes(11);
@@ -88,8 +88,8 @@ test('measureAsyncFunction executes setup and cleanup functions for each run', a
     runs: 10,
     warmupRuns: 1,
     writeFile: false,
-    beforeEachRun: beforeFn,
-    afterEachRun: afterFn,
+    beforeEach: beforeFn,
+    afterEach: afterFn,
   });
 
   expect(beforeFn).toHaveBeenCalledTimes(11);

packages/measure/src/__tests__/measure-renders.test.tsx

@@ -47,8 +47,8 @@ test('measureRenders executes setup and cleanup functions for each run', async (
     warmupRuns: 1,
     scenario,
     writeFile: false,
-    beforeEachRun: beforeFn,
-    afterEachRun: afterFn,
+    beforeEach: beforeFn,
+    afterEach: afterFn,
   });
 
   expect(beforeFn).toHaveBeenCalledTimes(11);

packages/measure/src/measure-async-function.tsx

@@ -31,13 +31,13 @@ async function measureAsyncFunctionInternal(
 
   const runResults: RunResult[] = [];
   for (let i = 0; i < runs + warmupRuns; i += 1) {
-    await options?.beforeEachRun?.();
+    await options?.beforeEach?.();
 
     const timeStart = getCurrentTime();
     await fn();
     const timeEnd = getCurrentTime();
 
-    await options?.afterEachRun?.();
+    await options?.afterEach?.();
 
     const duration = timeEnd - timeStart;
     runResults.push({ duration, count: 1 });

packages/measure/src/measure-function.tsx

@@ -8,8 +8,8 @@ export interface MeasureFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 
 export async function measureFunction(fn: () => void, options?: MeasureFunctionOptions): Promise<MeasureResults> {
@@ -31,13 +31,13 @@ async function measureFunctionInternal(fn: () => void, options?: MeasureFunction
 
   const runResults: RunResult[] = [];
   for (let i = 0; i < runs + warmupRuns; i += 1) {
-    await options?.beforeEachRun?.();
+    await options?.beforeEach?.();
 
     const timeStart = getCurrentTime();
     fn();
     const timeEnd = getCurrentTime();
 
-    await options?.afterEachRun?.();
+    await options?.afterEach?.();
 
     const duration = timeEnd - timeStart;
     runResults.push({ duration, count: 1 });

packages/measure/src/measure-renders.tsx

@@ -20,8 +20,8 @@ export interface MeasureRendersOptions {
   wrapper?: React.ComponentType<{ children: React.ReactElement }>;
   scenario?: (screen: any) => Promise<any>;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 
 export async function measureRenders(
@@ -71,7 +71,7 @@ async function measureRendersInternal(
   let initialRenderCount = 0;
 
   for (let iteration = 0; iteration < runs + warmupRuns; iteration += 1) {
-    await options?.beforeEachRun?.();
+    await options?.beforeEach?.();
 
     let duration = 0;
     let count = 0;
@@ -112,7 +112,7 @@ async function measureRendersInternal(
     cleanup();
     global.gc?.();
 
-    await options?.afterEachRun?.();
+    await options?.afterEach?.();
 
     runResults.push({ duration, count });
   }

packages/reassure/README.md

@@ -374,8 +374,8 @@ interface MeasureRendersOptions {
   wrapper?: React.ComponentType<{ children: ReactElement }>;
   scenario?: (view?: RenderResult) => Promise<any>;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
@@ -385,8 +385,8 @@ interface MeasureRendersOptions {
 - **`wrapper`**: React component, such as a `Provider`, which the `ui` will be wrapped with. Note: the render duration of the `wrapper` itself is excluded from the results; only the wrapped component is measured.
 - **`scenario`**: a custom async function, which defines user interaction within the UI by utilising RNTL or RTL functions
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 #### `measureFunction` function
 
@@ -407,17 +407,17 @@ interface MeasureFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
 - **`runs`**: number of runs per series for the particular test
 - **`warmupRuns`**: number of additional warmup runs that will be done and discarded before the actual runs
 - **`removeOutliers`**: should remove statistical outlier results (default: `true`)
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 #### `measureAsyncFunction` function
 
@@ -440,17 +440,17 @@ interface MeasureAsyncFunctionOptions {
   warmupRuns?: number;
   removeOutliers?: boolean;
   writeFile?: boolean;
-  beforeEachRun?: () => Promise<void> | void;
-  afterEachRun?: () => Promise<void> | void;
+  beforeEach?: () => Promise<void> | void;
+  afterEach?: () => Promise<void> | void;
 }
 ```
 
 - **`runs`**: number of runs per series for the particular test
 - **`warmupRuns`**: number of additional warmup runs that will be done and discarded before the actual runs
 - **`removeOutliers`**: should remove statistical outlier results (default: `true`)
 - **`writeFile`**: should write output to file (default `true`)
-- **`beforeEachRun`**: function to execute before each test run.
-- **`afterEachRun`**: function to execute after each test run.
+- **`beforeEach`**: function to execute before each test run.
+- **`afterEach`**: function to execute after each test run.
 
 ### Configuration