feat: add nx-plugin setup and basic test

.github/workflows/user-flow-gh-action-example.yml

@@ -18,5 +18,4 @@ jobs:
       - name: run:user-flow-action
         uses: push-based/[email protected]
         with:
-          customScript: npm run nx -- user-flow user-flow-ci-integration
           rcPath: packages/user-flow-ci-integration/.user-flowrc.json

nx.json

@@ -8,7 +8,7 @@
     }
   },
   "extends": "nx/presets/core.json",
-  "npmScope": "user-flow",
+  "npmScope": "@push-based",
   "affected": {
     "defaultBase": "origin/main"
   },

packages/cli/docs/writing-basic-user-flows.md

@@ -56,9 +56,9 @@ This results in the following file:
 }
 ```
 
-2. Create a `order-coffee.uf.ts` file.
+2. Create a `basic-navigation.uf.ts` file.
 
-**./user-flows/order-coffee.uf.ts**
+**./user-flows/basic-navigation.uf.ts**
 ```typescript
 import {
   UserFlowInteractionsFn,
@@ -113,7 +113,7 @@ Let's start by filling in our interaction logic:
 
 1. Copy and paste the new lines into your flow.
 
-**./user-flows/order-coffee.uf.ts**
+**./user-flows/basic-navigation.uf.ts**
 ```typescript
 const interactions: UserFlowInteractionsFn = async (ctx: UserFlowContext): Promise<any> => {
   // ... 
@@ -150,7 +150,7 @@ const interactions: UserFlowInteractionsFn = async (ctx: UserFlowContext): Promi
 
 2. Wrap the sections interesting for a timespan measure with `await flow.startTimespan({ stepName: 'Select coffee' });` and `await flow.stopTimespan();`.
 
-**./user-flows/order-coffee.uf.ts**
+**./user-flows/basic-navigation.uf.ts**
 ```typescript
 const interactions: UserFlowInteractionsFn = async (ctx: UserFlowContext): Promise<any> => {
   // ...
@@ -182,7 +182,7 @@ const interactions: UserFlowInteractionsFn = async (ctx: UserFlowContext): Promi
 
 2. Wrap the sections interesting for a snapshot measure with `await flow.snapshot({ stepName: 'step name' });`.
 
-**./user-flows/order-coffee.uf.ts**
+**./user-flows/basic-navigation.uf.ts**
 ```typescript
 // Your custom interactions with the page 
 const interactions: UserFlowInteractionsFn = async (ctx: UserFlowContext): Promise<any> => {

packages/nx-plugin-integration/.user-flowrc.json

@@ -0,0 +1 @@
+{}

packages/nx-plugin-integration/project.json

@@ -48,7 +48,8 @@
     "serve": {
       "executor": "@nx/webpack:dev-server",
       "options": {
-        "buildTarget": "nx-plugin-integration:build"
+        "buildTarget": "nx-plugin-integration:build",
+        "port": 4010
       },
       "configurations": {
         "production": {
@@ -82,6 +83,23 @@
           "codeCoverage": true
         }
       }
+    },
+    "user-flow": {
+      "executor": "@push-based/user-flow-nx-plugin:user-flow",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "options": {
+        "url": "http://localhost:4010",
+        "rcPath": "packages/nx-plugin-integration/.user-flowrc.json",
+        "ufPath": "packages/nx-plugin-integration/user-flows",
+        "outputPath": "dist/user-flow/packages/nx-plugin-integration",
+        "format": [
+          "md"
+        ],
+        "serveCommand": "npx run nx -- serve nx-plugin-integration",
+        "awaitServeStdout": "NX  Web Development Server is listening at http://localhost:4010"
+      }
     }
   }
 }