pickle-jar 3.0.0 → 4.0.0

package/README.md

@@ -1,7 +1,7 @@
 # pickle-jar
-pickle-jar is an alternative to jest-cucumber and and Cucumber.js that runs on top of jest. `pickle-jar`
-allows defining test scnearios using Gherkin language and translates them into define/it blocks that run using jest.
-Compared to jest-cucumber, the output is more explicit and all steps are reperesented by jest describe blocks.
+pickle-jar is an alternative to jest-cucumber and Cucumber.js that runs on top of Jest or Vitest. `pickle-jar`
+allows defining test scenarios using Gherkin language and translates them into describe/it blocks.
+Compared to jest-cucumber, the output is more explicit and all steps are represented by describe blocks.
 
 [//]: <> (start placeholder for auto-badger)
 
@@ -162,10 +162,10 @@ const tagFilter = (tags: string[])=> {
 ```
 There are several builtin tags which are handled differently than custom tags:
 
-* `@skip` - when used, the step and sub-steps are completely skipped (they are handled as Jest `describe.only` or `it.only` calls)
-* `@only` - when used, only the steps and sub-steps are executed (they are handled as Jest `describe.only` or `it.only` calls)
-* `@todo` - when used, the step is marked as a TODO and no step code is executed (they are handled as Jest `it.todo` calls)
-* `@fail` - when used, the step is expected to fail (thye are handled as Jest `it.failed` calls)
+* `@skip` - when used, the step and sub-steps are completely skipped (maps to `describe.skip` or `it.skip`)
+* `@only` - when used, only the steps and sub-steps are executed (maps to `describe.only` or `it.only`)
+* `@todo` - when used, the step is marked as a TODO and no step code is executed (maps to `it.todo`)
+* `@fail` - when used, the step is expected to fail (maps to `it.failing` in Jest or `it.fails` in Vitest)
 
 ## Jest configuration
 Create a `jest.config.js` file in the project root (or update the existing one) to match the `runner.ts` file:
@@ -182,4 +182,65 @@ module.exports = {
     moduleFileExtensions: ['ts', 'js', 'html'],
     coverageDirectory: '../coverage/',
 };
-```
+```
+
+## Using with Vitest
+
+pickle-jar supports Vitest as an alternative to Jest. To use Vitest, pass the `vitestAdapter` in the options:
+
+### Install dependencies
+```shell
+npm install vitest --dev
+```
+
+### Update runner.ts for Vitest
+```ts
+import {StepDefinition, testRunner, vitestAdapter} from "pickle-jar";
+
+interface World {
+    password: string | undefined;
+    grantedAccess: boolean;
+}
+
+const stepDefinitions: StepDefinition<World>[] = [{
+    match: /^Given I have previously created a password$/, step: (world) => {
+        world.password = "my password";
+    }
+}, {
+    match: /^When I enter my password correctly$/, step: (world) => {
+        world.grantedAccess = world.password === 'my password';
+    }
+}, {
+    match: /^I should be granted access$/, step: (world) => {
+        expect(world.grantedAccess).toBeTruthy();
+    }
+}];
+
+const createWorld = () => ({
+    password: undefined,
+    grantedAccess: false
+});
+
+testRunner<World>(
+    `${__dirname}/features/**/*.feature`,
+    stepDefinitions,
+    createWorld,
+    () => true,
+    { adapter: vitestAdapter }
+);
+```
+
+### Vitest configuration
+Create a `vitest.config.ts` file:
+```ts
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        include: ['test/runner.ts'],
+        globals: true,
+    },
+});
+```
+
+Note: Vitest must be configured with `globals: true` for the adapter to work correctly.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pickle-jar",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -17,7 +17,7 @@
   ],
   "devDependencies": {
     "@types/glob": "^8.1.0",
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^30.0.0",
     "@typescript-eslint/eslint-plugin": "^8.27.0",
     "@typescript-eslint/parser": "^8.27.0",
     "antlr4": "^4.13.2",
@@ -25,15 +25,21 @@
     "antlr4ts-cli": "^0.5.0-alpha.4",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",
-    "glob": "^11.0.1",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.6",
-    "tsc-watch": "^6.2.1",
+    "glob": "^13.0.0",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "tsc-watch": "^7.2.0",
     "typescript": "^5.8.2"
   },
   "peerDependencies": {
     "antlr4": "^4.13.0",
     "antlr4ts": "^0.5.0-alpha.4",
-    "glob": "^10.2.6"
+    "glob": "^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0",
+    "vitest": "^1.0.0 || ^2.0.0 || ^3.0.0 || ^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
   }
 }