Add source maps to rescript tests

Author: gaspard

README.md

@@ -393,6 +393,8 @@ And finally, here are some nice extensions for VS Code that can support your BDD
 
 # Changelog
 
+- **0.4.0** (2025-08-17)
+  - Add support for ReScript unit tests (with source maps!)
 - **0.3.0** (2025-07-26)
   - Add options for markdown extension (and default support for .mdx)
 - **0.2.0** (2025-07-23)

launch.json

@@ -0,0 +1,33 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Vitest - bdd",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": [
+        "run",
+        "test:watch"
+      ],
+      "cwd": "${workspaceRoot}/vitest-bdd",
+      "protocol": "inspector",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "name": "Vitest - app",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": [
+        "run",
+        "test:watch"
+      ],
+      "cwd": "${workspaceRoot}/test-app",
+      "protocol": "inspector",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    }
+  ]
+}

package.json

@@ -13,6 +13,8 @@
     "canary": "./bin/publish.sh --canary",
     "beta": "./bin/publish.sh --beta",
     "pub": "./bin/publish.sh",
+    "app": "pnpm -filter test-app",
+    "bdd": "pnpm -filter vitest-bdd",
     "test": "pnpm -r test"
   },
   "author": "Gaspard Anna Bucher <g.a.bucher@midasum.com>",

test-app/src/domain/test/rescript/Some_test.mjs

@@ -0,0 +1,27 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Vitest from "vitest";
+
+Vitest.describe("ReScript tests and source maps", (function () {
+        Vitest.it("should add two numbers", (function () {
+                Vitest.expect(4).toBe(4);
+              }));
+        Vitest.it("should work with async", (async function () {
+                return Vitest.expect(9).toBe(9);
+              }));
+        Vitest.it("should have more tests", (function () {
+                Vitest.expect(3).toBe(3);
+              }));
+        Vitest.it("should have more and more tests", (function () {
+                Vitest.expect(3).toBe(3);
+              }));
+        Vitest.it.todo("todo");
+        Vitest.it.skip("skipped test", (function () {
+                Vitest.expect(3).toBe(3);
+              }));
+      }));
+
+export {
+  
+}
+/*  Not a pure module */

test-app/src/domain/test/rescript/Some_test.res

@@ -0,0 +1,24 @@
+open VitestBdd
+
+describe("ReScript tests and source maps", () => {
+  it("should add two numbers", () => {
+    expect(2 + 2).toBe(4)
+  })
+
+  it("should work with async", async () => {
+    expect(11 - 2).toBe(9)
+  })
+
+  it("should have more tests", () => {
+    expect(5 - 2).toBe(3)
+  })
+
+  it("should have more and more tests", () => {
+    expect(5 - 2).toBe(3)
+  })
+
+  Todo.it("todo")
+  Skip.it("skipped test", () => {
+    expect(5 - 2).toBe(3)
+  })
+})

test-app/vitest.config.ts

@@ -12,7 +12,8 @@ export default defineConfig({
   ],
   test: {
     pool: "threads",
-    include: ["**/*.feature", "**/*.md", "**/*.spec.ts"],
+    // include: ["**/*.feature", "**/*.md", "**/*.spec.ts", "**/*_test.res"],
+    include: ["**/*_test.res"],
   },
 });
 

vitest-bdd/src/VitestBdd.mjs

@@ -1,2 +1,15 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-/* This output is empty. Its source's type definitions, externals and/or unused code got optimized away. */
+
+
+var Skip = {};
+
+var Only = {};
+
+var Todo = {};
+
+export {
+  Skip ,
+  Only ,
+  Todo ,
+}
+/* No side effect */

vitest-bdd/src/VitestBdd.res

@@ -1,8 +1,93 @@
 type given = {step: 'a. (string, 'a) => unit}
 type assertions<'a> = {toBe: 'a => unit, toEqual: 'a => unit}
 
+// ========= Gherkin ==========
+
 @module("vitest-bdd")
 external given: (string, (given, 'args) => unit) => unit = "Given"
 
+// ========= Vitest ==========
+
+type rec testContext = {
+  onTestFailed: 'a. (testContext => 'a) => unit,
+  onTestFinished: 'a. (testContext => 'a) => unit,
+}
+
 @module("vitest")
 external expect: 'a => assertions<'a> = "expect"
+
+@module("vitest")
+external concurrent: (string, unit => unit) => unit = "describe.concurrent"
+
+@module("vitest")
+external beforeAll: (string, 'a) => unit = "beforeAll"
+
+@module("vitest")
+external beforeEach: (string, 'a) => unit = "beforeEach"
+
+@module("vitest")
+external afterAll: (string, 'a) => unit = "afterAll"
+
+@module("vitest")
+external afterEach: (string, 'a) => unit = "afterEach"
+
+@module("vitest")
+external onTestFinished: (unit => unit) => unit = "onTestFinished"
+
+@module("vitest")
+external onTestFailed: (unit => unit) => unit = "onTestFinished"
+// ========= Modes ==========
+
+@module("vitest")
+external describe: (string, unit => unit) => unit = "describe"
+
+@module("vitest")
+external bench: (string, unit => unit) => unit = "bench"
+
+@module("vitest")
+external test: (string, 'a) => unit = "test"
+
+@module("vitest")
+external it: (string, 'a) => unit = "it"
+
+module Skip = {
+  @module("vitest") @scope("describe")
+  external describe: (string, unit => unit) => unit = "skip"
+
+  @module("vitest") @scope("bench")
+  external bench: (string, unit => unit) => unit = "skip"
+
+  @module("vitest") @scope("test")
+  external test: (string, 'a) => unit = "skip"
+
+  @module("vitest") @scope("it")
+  external it: (string, 'a) => unit = "skip"
+}
+
+module Only = {
+  @module("vitest") @scope("describe")
+  external describe: (string, unit => unit) => unit = "only"
+
+  @module("vitest") @scope("bench")
+  external bench: (string, unit => unit) => unit = "only"
+
+  @module("vitest") @scope("test")
+  external test: (string, 'a) => unit = "only"
+
+  @module("vitest") @scope("it")
+  external it: (string, 'a) => unit = "only"
+}
+
+module Todo = {
+  @module("vitest") @scope("describe")
+  external describe: string => unit = "todo"
+
+  @module("vitest") @scope("bench")
+  external bench: string => unit = "todo"
+
+  @module("vitest") @scope("test")
+  external test: string => unit = "todo"
+
+  @module("vitest") @scope("it")
+  external it: string => unit = "todo"
+}

vitest-bdd/src/index.ts

@@ -3,20 +3,25 @@ import { extname } from "node:path";
 import { SourceMapGenerator } from "source-map";
 import type { Plugin } from "vite";
 import { parse, type SourceLocation } from "./parser";
+import { resCompile, resCompiledResolver } from "./resCompile";
 export * from "./steps";
 
 export type VitestBddOptions = {
   debug?: boolean;
   markdownExtensions?: string[];
   gherkinExtensions?: string[];
+  rescriptExtensions?: string[];
   stepsResolver?: (path: string) => string | null;
+  resCompiledResolver?: (path: string) => string | null;
 };
 
 const defaultOptions: Required<VitestBddOptions> = {
   debug: false,
   markdownExtensions: [".md", ".mdx", ".markdown"],
   gherkinExtensions: [".feature"],
+  rescriptExtensions: [".res"],
   stepsResolver,
+  resCompiledResolver,
 };
 
 export function vitestBdd(opts: VitestBddOptions = {}): Plugin {
@@ -33,24 +38,25 @@ export function vitestBdd(opts: VitestBddOptions = {}): Plugin {
         return id;
     },
     load(id) {
-      const ext = extname(id);
-      const markdown = options.markdownExtensions.includes(ext);
-      if (markdown || options.gherkinExtensions.includes(ext)) {
-        return compile(id, markdown, options);
-      }
+      return compile(id, options);
     },
   };
 }
 
-function compile(
-  path: string,
-  markdown: boolean,
-  opts: Required<VitestBddOptions>
-) {
-  const { debug } = opts;
+function compile(path: string, opts: Required<VitestBddOptions>) {
+  const { debug, rescriptExtensions, markdownExtensions, gherkinExtensions } =
+    opts;
+  const ext = extname(path);
+  if (rescriptExtensions.includes(ext)) {
+    return resCompile(path, opts);
+  }
+  const isMarkdown = markdownExtensions.includes(ext);
+  if (!gherkinExtensions.includes(ext) && !isMarkdown) {
+    return;
+  }
   const text = readFileSync(path, "utf8");
   const lines = text.split("\n");
-  const feature = parse(text, markdown);
+  const feature = parse(text, isMarkdown);
   if (!feature) {
     return `
     import { describe} from "vitest";

vitest-bdd/src/parser.spec.ts

@@ -2,7 +2,7 @@ import { describe, expect, it } from "vitest";
 import { mdToGherkin, parse, parseStep } from "./parser";
 
 describe("parse", () => {
-  it("Should parse a simple feature", () => {
+  it("Should parse a simple feature", (r) => {
     const text = `Feature: Calculator
 
   Scenario: Add two numbers