racejar 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.0.2](https://github.com/portabletext/editor/compare/racejar-v1.0.1...racejar-v1.0.2) (2024-11-29)
+
+
+### Bug Fixes
+
+* allow synchronous step callbacks ([a8b1848](https://github.com/portabletext/editor/commit/a8b18489a5beaa1bd013d4753361357d53f44650))
+* make parameter types optional ([3f35c97](https://github.com/portabletext/editor/commit/3f35c97cc2fcb7790f2edcd733132cefc35ae17d))
+
 ## [1.0.1](https://github.com/portabletext/editor/compare/racejar-v1.0.0...racejar-v1.0.1) (2024-11-26)
 
 

package/README.md

@@ -106,7 +106,44 @@ import {createParameterType} from 'racejar'
 const parameterTypes = [createParameterType(/* ... */)]
 ```
 
-## Example Usage
+## Basic Example
+
+```ts
+import {Given, Then, When} from 'racejar'
+import {Feature} from 'racejar/vitest'
+import {expect} from 'vitest'
+
+function greet(name: string) {
+  return `Hello, ${name}!`
+}
+
+type Context = {
+  person: string
+  greeting: string
+}
+
+Feature({
+  featureText: `
+    Feature: Greeting
+      Scenario: Greeting a person
+        Given the person "Herman"
+        When greeting the person
+        Then the greeting is "Hello, Herman!"`,
+  stepDefinitions: [
+    Given<Context, string>('the person {string}', (context, person) => {
+      context.person = person
+    }),
+    When<Context>('greeting the person', (context) => {
+      context.greeting = greet(context.person)
+    }),
+    Then<Context, string>('the greeting is {string}', (context, greeting) => {
+      expect(context.greeting).toBe(greeting)
+    }),
+  ],
+})
+```
+
+## Advanced Example
 
 The following example is taken from the [`editor`](/packages/editor/) package in this repository. For a full example of how to use `racejar`, head over to [/packages/editor/gherkin-tests/](/packages/editor/gherkin-tests/). The package uses `racejar` to run a [Playwright](https://playwright.dev/) E2E test suite powered by [Vitest Browser Mode](https://vitest.dev/guide/browser/).
 

package/example/hello-herman.test.ts

@@ -0,0 +1,32 @@
+import {expect} from 'vitest'
+import {Given, Then, When} from '../src/step-definitions'
+import {Feature} from '../src/vitest'
+
+function greet(name: string) {
+  return `Hello, ${name}!`
+}
+
+type Context = {
+  person: string
+  greeting: string
+}
+
+Feature({
+  featureText: `
+    Feature: Greeting
+      Scenario: Greeting a person
+        Given the person "Herman"
+        When greeting the person
+        Then the greeting is "Hello, Herman!"`,
+  stepDefinitions: [
+    Given<Context, string>('the person {string}', (context, person) => {
+      context.person = person
+    }),
+    When<Context>('greeting the person', (context) => {
+      context.greeting = greet(context.person)
+    }),
+    Then<Context, string>('the greeting is {string}', (context, greeting) => {
+      expect(context.greeting).toBe(greeting)
+    }),
+  ],
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "racejar",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A testing framework agnostic Gherkin driver",
   "keywords": [
     "cucumber",
@@ -40,8 +40,8 @@
     "@cucumber/gherkin": "^30.0.4",
     "@cucumber/messages": "^27.0.2",
     "@jest/globals": "^29.7.0",
-    "@sanity/pkg-utils": "^6.11.12",
-    "typescript": "5.6.3",
+    "@sanity/pkg-utils": "^6.11.13",
+    "typescript": "5.7.2",
     "vitest": "^2.1.5"
   },
   "peerDependencies": {
@@ -51,6 +51,8 @@
   "scripts": {
     "check:lint": "biome lint .",
     "check:types": "tsc",
-    "lint:fix": "biome lint --write ."
+    "lint:fix": "biome lint --write .",
+    "test": "vitest --run",
+    "test:watch": "vitest"
   }
 }

package/src/compile-feature.ts

@@ -19,7 +19,7 @@ export type CompiledFeature = {
   scenarios: Array<{
     name: string
     tag?: 'only' | 'skip'
-    steps: Array<() => Promise<void>>
+    steps: Array<() => Promise<void> | void>
   }>
 }
 
@@ -33,7 +33,7 @@ export function compileFeature<TContext extends Record<string, any> = object>({
 }: {
   featureText: string
   stepDefinitions: Array<StepDefinition<TContext, any, any, any>>
-  parameterTypes: Array<ParameterType<unknown>>
+  parameterTypes?: Array<ParameterType<unknown>>
 }): CompiledFeature {
   const uuidFn = Messages.IdGenerator.uuid()
   const builder = new Gherkin.AstBuilder(uuidFn)
@@ -48,9 +48,11 @@ export function compileFeature<TContext extends Record<string, any> = object>({
   )
 
   const parameterTypeRegistry = new ParameterTypeRegistry()
-  parameterTypes.forEach((parameterType) =>
-    parameterTypeRegistry.defineParameterType(parameterType),
-  )
+  if (parameterTypes) {
+    parameterTypes.forEach((parameterType) =>
+      parameterTypeRegistry.defineParameterType(parameterType),
+    )
+  }
 
   if (!gherkinDocument.feature) {
     throw new Error('No feature found')

package/src/jest/jest-gherkin-driver.ts

@@ -13,7 +13,7 @@ export function Feature<TContext extends Record<string, any> = object>({
 }: {
   featureText: string
   stepDefinitions: Array<StepDefinition<TContext, any, any, any>>
-  parameterTypes: Array<ParameterType<unknown>>
+  parameterTypes?: Array<ParameterType<unknown>>
 }) {
   const feature = compileFeature({
     featureText,

package/src/step-definitions.ts

@@ -24,7 +24,7 @@ export type StepDefinitionCallback<
 > = (
   context: TContext,
   ...args: StepDefinitionCallbackParameters<TParamA, TParamB, TParamC>
-) => Promise<void>
+) => Promise<void> | void
 
 /**
  * @public

package/src/vitest/vitest-gherkin-driver.ts

@@ -13,7 +13,7 @@ export function Feature<TContext extends Record<string, any> = object>({
 }: {
   featureText: string
   stepDefinitions: Array<StepDefinition<TContext, any, any, any>>
-  parameterTypes: Array<ParameterType<unknown>>
+  parameterTypes?: Array<ParameterType<unknown>>
 }) {
   const feature = compileFeature({
     featureText,

package/vitest.workspace.ts

@@ -0,0 +1,17 @@
+/// <reference types="vitest" />
+import {defineWorkspace} from 'vitest/config'
+
+export default defineWorkspace([
+  {
+    plugins: [],
+    test: {
+      name: 'unit',
+    },
+  },
+  {
+    plugins: [],
+    test: {
+      name: 'chromium',
+    },
+  },
+])