fix(workspace): update examples and docs

push-based · Aug 26, 2024 · e3fa1d9 · e3fa1d9
1 parent 3ea4393
commit e3fa1d9
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 27 deletions.
diff --git a/packages/cli/src/lib/commands/collect/utils/replay/types.ts b/packages/cli/src/lib/commands/collect/utils/replay/types.ts
@@ -13,7 +13,7 @@ export type MeasureModes = 'navigate' |'snapshot' | 'startTimespan' | 'endTimesp
 }>;*/
 export type MeasurementStep = {
   type: MeasureModes;
-  stepOptions?: { stepName?: string; }
+  stepOptions?: { name?: string; }
   url?: string;
 }
 

diff --git a/packages/cli/src/lib/commands/collect/utils/user-flow/types.ts b/packages/cli/src/lib/commands/collect/utils/user-flow/types.ts
@@ -17,7 +17,7 @@ export type UserFlowContext = {
 };
 
 export type StepOptions = {
-  stepName: string;
+  name: string;
 } & {
   /*page: Page,*/ config?: Config /*configContext?: LH.Config.FRContext*/;
 };
@@ -59,4 +59,3 @@ export type UserFlowProvider = {
   interactions: UserFlowInteractionsFn;
   launchOptions?: LaunchOptions;
 };
-
diff --git a/packages/cli/src/lib/commands/collect/utils/user-flow/user-flow.mock.ts b/packages/cli/src/lib/commands/collect/utils/user-flow/user-flow.mock.ts
@@ -282,8 +282,8 @@ export class UserFlowMock {
    * @param {LH.NavigationRequestor} requestor
    * @param {StepOptions=} stepOptions
    */
-  async navigate(requestor: any, { stepName }: StepOptions = {} as StepOptions): Promise<any> {
-    logVerbose(`flow#navigate: ${stepName || requestor}`);
+  async navigate(requestor: any, { name }: StepOptions = {} as StepOptions): Promise<any> {
+    logVerbose(`flow#navigate: ${name || requestor}`);
     return this.page.goto(requestor);
   }
 
@@ -296,21 +296,21 @@ export class UserFlowMock {
   /**
    * @param {StepOptions=} stepOptions
    */
-  async startTimespan({ stepName }: StepOptions = {} as StepOptions): Promise<void> {
-    logVerbose(`flow#startTimespan: ${stepName}`);
+  async startTimespan({ name }: StepOptions = {} as StepOptions): Promise<void> {
+    logVerbose(`flow#startTimespan: ${name}`);
     return Promise.resolve();
   }
 
-  async endTimespan({ stepName }: StepOptions = {} as StepOptions): Promise<void> {
-    logVerbose(`flow#endTimespan: ${stepName}`);
+  async endTimespan({ name }: StepOptions = {} as StepOptions): Promise<void> {
+    logVerbose(`flow#endTimespan: ${name}`);
     return Promise.resolve();
   }
 
   /**
    * @param {StepOptions=} stepOptions
    */
-  async snapshot({ stepName }: StepOptions = {} as StepOptions): Promise<void> {
-    logVerbose(`flow#snapshot: ${stepName}`);
+  async snapshot({ name }: StepOptions = {} as StepOptions): Promise<void> {
+    logVerbose(`flow#snapshot: ${name}`);
     return Promise.resolve();
   }
 
@@ -344,8 +344,8 @@ export class UserFlowReportMock {
    * @param {LH.NavigationRequestor} requestor
    * @param {StepOptions=} stepOptions
    */
-  async navigate(requestor: any, { stepName }: StepOptions = {} as StepOptions): Promise<any> {
-    logVerbose(`flow#navigate: ${stepName || requestor}`);
+  async navigate(requestor: any, { name }: StepOptions = {} as StepOptions): Promise<any> {
+    logVerbose(`flow#navigate: ${name || requestor}`);
     return Promise.resolve();
   }
 
@@ -356,21 +356,21 @@ export class UserFlowReportMock {
   /**
    * @param {StepOptions=} stepOptions
    */
-  async startTimespan({ stepName }: StepOptions = {} as StepOptions): Promise<void> {
-    logVerbose(`flow#startTimespan: ${stepName}`);
+  async startTimespan({ name }: StepOptions = {} as StepOptions): Promise<void> {
+    logVerbose(`flow#startTimespan: ${name}`);
     return Promise.resolve();
   }
 
-  async endTimespan({ stepName }: StepOptions = {} as StepOptions): Promise<void> {
-    logVerbose(`flow#endTimespan: ${stepName}`);
+  async endTimespan({ name }: StepOptions = {} as StepOptions): Promise<void> {
+    logVerbose(`flow#endTimespan: ${name}`);
     return Promise.resolve();
   }
 
   /**
    * @param {StepOptions=} stepOptions
    */
-  async snapshot({ stepName }: StepOptions = {} as StepOptions): Promise<void> {
-    logVerbose(`flow#snapshot: ${stepName}`);
+  async snapshot({ name }: StepOptions = {} as StepOptions): Promise<void> {
+    logVerbose(`flow#snapshot: ${name}`);
     return Promise.resolve();
   }
 

diff --git a/packages/nx-plugin-integration/tsconfig.app.json b/packages/nx-plugin-integration/tsconfig.app.json
@@ -6,12 +6,7 @@
       "node"
     ]
   },
-  "exclude": [
-    "jest.config.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.ts"
-  ],
   "include": [
-    "src/**/*.ts"
+    "**/*"
   ]
 }
diff --git a/...gration/user-flows/basic-navigation.uf.ts → ...ration/user-flows/basic-navigation.uf.mts b/...gration/user-flows/basic-navigation.uf.ts → ...ration/user-flows/basic-navigation.uf.mts
@@ -5,7 +5,7 @@ const interactions: UserFlowInteractionsFn = async (ctx: UserFlowContext): Promi
   const { url} = collectOptions;
 
   await flow.navigate(url, {
-    stepName: '🧭 Navigate to Home',
+    name: '🧭 Navigate to Home',
   });
 };
 

diff --git a/packages/user-flow-gh-integration/data/checkout.data.ts b/packages/user-flow-gh-integration/data/checkout.data.ts