Release to NPM via GitHub actions

Minor fixes

Author: jasny

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    versioning-strategy: "increase"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/automerge.yml

@@ -0,0 +1,40 @@
+name: Automerge dependabot PRs
+on:
+  workflow_run:
+    workflows:
+      - CI
+    types:
+      - completed
+
+jobs:
+  Automerge:
+    runs-on: ubuntu-latest
+    if: |
+      github.event.workflow_run.event == 'pull_request' &&
+      github.event.workflow_run.conclusion == 'success'
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - name: 'Merge PR'
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const pr = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.payload.workflow_run.pull_requests[0].number,
+            });
+            if (pr.data.user.login !== 'dependabot[bot]') {
+              console.log('Not Merged 🚫');
+              console.log(`User '${pr.data.user.login}' does not equal 'dependabot[bot]'`);
+            } else {
+              await github.rest.pulls.merge({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: context.payload.workflow_run.pull_requests[0].number,
+              });
+              console.log('Merged 🎉');
+            }
+

.github/workflows/main.yml

@@ -0,0 +1,78 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '*'
+          check-latest: true
+      - name: Install Dependencies
+        run: yarn
+      - name: Run Tests 👩🏽‍💻
+        run: yarn test
+
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - name: Install Dependencies
+        run: yarn
+      - name: Lint ✨
+        run: yarn lint
+
+  Build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - name: Install Dependencies
+        run: yarn
+      - name: Build 🗜️
+        run: yarn build
+
+  ############ Requires NPM_TOKEN in secrets ############
+  Release:
+    needs: [Test, Lint, Build]
+    if: |
+      github.ref == 'refs/heads/main' &&
+      github.event.repository.fork == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - name: Install Dependencies
+        run: yarn
+      - name: Build 🗜️
+        run: yarn build
+      - name: Release 🎉
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package.json

@@ -1,12 +1,14 @@
 {
   "name": "@letsflow/testing",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "Test suite for LetsFlow",
   "author": "Arnold Daniels <[email protected]>",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "dependencies": {
     "@cucumber/cucumber": "^11.2.0",
     "@letsflow/core": "^1.5.0",
@@ -28,11 +30,10 @@
   },
   "files": [
     "lib",
-    "src",
     "cucumber.example.yaml"
   ],
   "scripts": {
-    "clean": "rm -rf ./lib ./dist",
+    "clean": "rm -rf ./lib",
     "build": "tsc --project tsconfig.build.json",
     "test": "cucumber-js",
     "lint": "eslint \"{src,test}/**/*.ts\" --fix"

src/assert-current.ts

@@ -16,10 +16,10 @@ function assertStateVar(property: string, processName: string, expectedRaw: any)
 
   expect(actualValue).to.eq(expected, `The ${property} of the current state does not have the expected value`);
 }
-Then('the state {property} of the {string} process has {string} is {string}', assertStateVar);
-Then('the state {property} is {string}', (property, expected) => assertStateVar(property, 'main', expected));
-Then('the state {property} of the {string} process is:', (property, process, expected) => assertStateVar(property, process, parseData(expected)));
-Then('the state {property} is:', (property, expected) => assertStateVar(property, 'main', parseData(expected)));
+Then('the state {property} of the {string} process has {string} is/are {string}', assertStateVar);
+Then('the state {property} is/are {string}', (property, expected) => assertStateVar(property, 'main', expected));
+Then('the state {property} of the {string} process is:/are:', (property, process, expected) => assertStateVar(property, process, parseData(expected)));
+Then('the state {property} is:/are:', (property, expected) => assertStateVar(property, 'main', parseData(expected)));
 
 function assertInstructions(actorKey: string, processName: string, expectedRaw: string) {
   const process = world.getProcess(processName);
@@ -32,7 +32,7 @@ function assertInstructions(actorKey: string, processName: string, expectedRaw:
 
   expect(instructions.trim()).to.eq(expected.trim(), `Actor '${actorKey}' does not have the expected instructions`);
 }
-Then('actor {string} in the {string} process has instructions {string}', assertInstructions);
-Then('actor {string} has instructions {string}', (actorKey, expected) => assertInstructions(actorKey, 'main', expected));
-Then('actor {string} in the {string} process has instructions:', assertInstructions);
-Then('actor {string} has instructions:', (actorKey, expected) => assertInstructions(actorKey, 'main', expected));
+Then('actor {string} in the {string} process has (the )instruction(s) {string}', assertInstructions);
+Then('actor {string} has (the )instruction(s) {string}', (actorKey, expected) => assertInstructions(actorKey, 'main', expected));
+Then('actor {string} in the {string} process has (the )instruction(s):', assertInstructions);
+Then('actor {string} has (the )instruction(s):', (actorKey, expected) => assertInstructions(actorKey, 'main', expected));

src/assert-event.ts

@@ -43,7 +43,7 @@ function nothingIsSkipped(processName: string) {
 
   expect(skippedEvents).to.have.length(0, 'Some events were skipped');
 }
-Then('nothing is skipped of the {string} process', nothingIsSkipped);
+Then('nothing is skipped of/from the {string} process', nothingIsSkipped);
 Then('nothing is skipped', () => nothingIsSkipped('main'));
 
 function assertEventIsTimeout(processName: string) {

src/assert-state.ts

@@ -1,5 +1,4 @@
 import { DataTable, Then } from '@cucumber/cucumber';
-import { hasEnded } from '@letsflow/core/process';
 import { expect } from "chai";
 import { world } from "./world"
 import { parseData } from "./utils"

src/assert-vars.ts

@@ -1,4 +1,4 @@
-import { DataTable, Then } from "@cucumber/cucumber";
+import { Then } from "@cucumber/cucumber";
 import { expect } from "chai";
 import getValue from 'get-value';
 import { world } from "./world"
@@ -33,5 +33,13 @@ function assertTag(processName: string, tag: string) {
 
   expect(process.tags).to.include(tag, `The process does not have the tag "${tag}"`);
 }
-Then('the {string} process has tag {string}', assertTag);
-Then('the process has tag {string}', (tag) => assertTag('main', tag));
+Then('the {string} process has (the )tag {string}', assertTag);
+Then('the process has (the )tag {string}', (tag) => assertTag('main', tag));
+
+function assertNotTag(processName: string, tag: string) {
+  const process = world.getProcess(processName);
+
+  expect(process.tags).to.not.include(tag, `The process does have the tag "${tag}"`);
+}
+Then('the {string} process doesn\'t have (the )tag {string}', assertNotTag);
+Then('the process doesn\'t have (the )tag {string}', (tag) => assertNotTag('main', tag));

src/index.ts

@@ -0,0 +1 @@
+export * from './world';

src/timeout.ts

@@ -7,12 +7,10 @@ function timePasses(seconds: number) {
     world.setProcess(processName, timeout(process, { timePassed: seconds }));
   });
 }
-When('{time} pass', timePasses);
-When('{time} passes', timePasses);
+When('{time} pass(es)', timePasses);
 
 function timePassesFor(seconds: number, processName: string) {
   const process = world.getProcess(processName);
   world.setProcess(processName, timeout(process, { timePassed: seconds }));
 }
-When('{time} pass for the {string} process', timePassesFor);
-When('{time} passes for the {string} process', timePassesFor);
+When('{time} pass(es) for the {string} process', timePassesFor);