Add steps resolver option, add ReScript bindings

Author: gaspard

README.md

@@ -16,14 +16,14 @@ Tests can run in parallel (no shared state) and are fast and hot reloadable.
 **Features**
 
 - **write with Gherkin, execute with vitest !**
-- Gherkin in markdown
+- Gherkin block inside markdown
+- ReScript step definitions
 - async tests
 - concurrent testing
 - failed tests in steps definitions and Gherkin
 - supports number, string and table parameters
 - steps are explicitly linked to your context (easy to trace usage)
 - supports "Background"
-- experimental "Gherkin in markdown"
 - ESM and CJS projects support
 - Gherkin parsing with [@cucumber/gherkin](https://github.com/cucumber/gherkin).
 
@@ -61,6 +61,43 @@ Options are passed as an object to the vitestBdd function. The default options a
   debug: false,
   markdownExtensions: [".md", ".mdx", ".markdown"],
   gherkinExtensions: [".feature"],
+  stepsResolver: stepsResolver,
+}
+```
+
+And the default stepsResolver function is below. This resulver would find the following files for a "./test/foobar.feature" file:
+
+- `./test/foobar.feature.ts`
+- `./test/foobar.feature.js`
+- ... etc
+- `./test/foobar.steps.ts`
+- `./test/foobar.steps.js`
+- ... etc
+- `./test/foobarSteps.ts`
+- `./test/foobarSteps.js`
+- ... etc
+
+The last setting helps for ReScript users to mach `./test/Foobar.feature` with `./test/FoobarSteps.res` steps files.
+
+```ts
+function baseResolver(path: string): string | null {
+  for (const ext of [".ts", ".js", ".mjs", ".cjs", ".res.mjs"]) {
+    const p = `${path}${ext}`;
+    if (existsSync(p)) {
+      return p;
+    }
+  }
+  return null;
+}
+
+export function stepsResolver(path: string): string | null {
+  for (const r of [".feature", ".steps", "Steps"]) {
+    const p = baseResolver(path.replace(/\.feature$/, r));
+    if (p) {
+      return p;
+    }
+  }
+  return null;
 }
 ```
 
@@ -129,15 +166,15 @@ Given("I have a {string} calculator", async ({ When, And, Then }, type) => {
       And("I subtract {number} and {number}", calculator.subtract);
       And("I multiply {number} by {number}", calculator.multiply);
       And("I divide {number} by {number}", calculator.divide);
-      resultAssertions(calculator);
+      resultAssertions(Then, calculator);
       break;
     }
     case "rpn": {
       const calculator = rpnCalculator();
       When("I enter {number}", calculator.enter);
       And("I enter {number}", calculator.enter);
       And("I divide", calculator.divide);
-      resultAssertions(calculator);
+      resultAssertions(Then, calculator);
       break;
     }
     default:
@@ -146,6 +183,41 @@ Given("I have a {string} calculator", async ({ When, And, Then }, type) => {
 });
 ```
 
+For ReScript, the bindings are a little bit simpler for now:
+
+```rescript
+// src/domain/test/CalculatorSteps.res
+open VitestBdd
+
+// To show assertion reuse (could be just added in the given block).
+let resultAssertions = (step, calculator) => {
+  // We define an async step, just to look cool 😎 (again).
+  step("the result is {number}", async (n: number) => {
+    await calculator.proccessBigComputation()
+    expect(calculator.result.value).toBe(n)
+  })
+}
+
+given("I have a {string} calculator", async ({step}, ctype) => {
+  switch ctype {
+  | "basic" => {
+    let calculator = basicCalculator()
+    step("I add {number} and {number}", calculator.add)
+    step("I subtract {number} and {number}", calculator.subtract)
+    step("I multiply {number} by {number}", calculator.multiply)
+    step("I divide {number} by {number}", calculator.divide)
+    resultAssertions(step, calculator)
+  }
+  | "rpn": {
+    let calculator = rpnCalculator()
+    step("I enter {number}", calculator.enter)
+    step("I enter {number}", calculator.enter)
+    step("I divide", calculator.divide)
+    resultAssertions(step, calculator)
+  }
+})
+```
+
 ### Reuse steps
 
 You can reuse steps in multiple contexts. For example, a preference manager

bin/publish-canary.sh

@@ -2,6 +2,8 @@
 
 set -e
 
+# ============================================ UTILS and basic CHECKS
+
 # Set up environment
 if ! command -v pnpm &>/dev/null; then
   echo "pnpm is not installed. Please install it first."
@@ -28,25 +30,53 @@ is_semver() {
   fi
 }
 
+DATE=$(date +'%Y%m%dT%H%M%S')
+
 # Install dependencies
 pnpm i
-# Check compilation for all projects
+# Rebuild for all projects
 pnpm build
-# Copy README.md
-cp README.md vitest-bdd/README.md
 
-# ================ VITEST-BDD
-cd vitest-bdd
-LIB_VERSION=$(npm pkg get version | sed 's/"//g')
-is_semver "$LIB_VERSION"
+VERSION=$(npm pkg get version | sed 's/"//g')
+is_semver "$VERSION"
+
+# ============================================ PUBLISH
 
-pnpm publish --access public --no-git-checks
+# Update version if publishing beta (--beta argument)
+if [[ $1 == "--beta" ]]; then
+  VERSION=$VERSION-beta.$DATE
+elif [[ $1 == "--canary" ]]; then
+  VERSION=$VERSION-canary.$DATE
+fi
+
+# ================ vitest-bdd
+cd vitest-bdd
+npm --no-git-tag-version version $VERSION
 
+if [[ $1 == "--beta" ]]; then
+  pnpm publish --tag beta --access public --no-git-checks
+elif [[ $1 == "--canary" ]]; then
+  CANARY=true pnpm publish --tag canary --access public --no-git-checks
+else
+  pnpm publish --access public --no-git-checks
+fi
 cd ..
 
+echo "Wait for version to propagate on npm"
+sleep 3
+echo "Wait for version to propagate on npm"
+sleep 3
+echo "Wait for version to propagate on npm"
+sleep 3
+
 # Reset git repo
 git reset --hard HEAD
-git clean -fd
-git tag v$LIB_VERSION
 
-echo "Published successfully!"
+if [[ $1 == "--beta" ]]; then
+  echo "Beta versions published successfully!"
+elif [[ $1 == "--canary" ]]; then
+  echo "Canary versions published successfully!"
+else
+  echo "Published successfully!"
+fi
+

bin/publish.sh

@@ -1,7 +1,7 @@
 {
   "name": "vitest-bdd-monorepo",
   "private": true,
-  "version": "0.0.0",
+  "version": "0.4.0",
   "description": "Monorepo for vitest-bdd plugin and related packages.",
   "homepage": "https://github.com/midasum/vitest-bdd",
   "repository": {
@@ -10,9 +10,10 @@
   },
   "scripts": {
     "build": "pnpm -r build",
-    "test": "pnpm -r test",
-    "canary": "./bin/publish-canary.sh",
-    "pub": "./bin/publish.sh"
+    "canary": "./bin/publish.sh --canary",
+    "beta": "./bin/publish.sh --beta",
+    "pub": "./bin/publish.sh",
+    "test": "pnpm -r test"
   },
   "author": "Gaspard Anna Bucher <g.a.bucher@midasum.com>",
   "license": "MIT"

package.json

@@ -10,13 +10,13 @@
     "res:dev": "rescript -w"
   },
   "devDependencies": {
+    "tilia": "3.0.0-beta.20250817T011709",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.1.3",
-    "vitest-bdd": "workspace:^"
+    "vitest-bdd": "file:../vitest-bdd"
   },
   "dependencies": {
     "@rescript/core": "1.6.1",
-    "rescript": "11.1.4",
-    "tilia": "2.0.0"
+    "rescript": "11.1.4"
   }
 }

pnpm-lock.yaml

@@ -11,6 +11,7 @@
   "suffix": ".mjs",
   "bs-dependencies": [
     "@rescript/core",
+    "vitest-bdd",
     "tilia"
   ],
   "bsc-flags": [

test-app/package.json

@@ -3,27 +3,26 @@
 import * as Tilia from "tilia/src/Tilia.mjs";
 
 function make(name) {
-  var result = Tilia.signal(0);
-  var title = Tilia.signal(name);
+  var match = Tilia.signal(0);
+  var setResult = match[1];
+  var result = match[0];
   return Tilia.tilia({
               add: (function (a, b) {
-                  result.value = a + b;
+                  setResult(a + b);
                 }),
               subtract: (function (a, b) {
-                  result.value = a - b;
+                  setResult(a - b);
                 }),
               multiply: (function (a, b) {
-                  result.value = a * b;
+                  setResult(a * b);
                 }),
               divide: (function (a, b) {
-                  result.value = a / b;
+                  setResult(a / b);
                 }),
               result: Tilia.computed(function () {
                     return result.value;
                   }),
-              title: Tilia.computed(function () {
-                    return title.value;
-                  })
+              title: name
             });
 }