racejar 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.1.0](https://github.com/portabletext/editor/compare/racejar-v1.0.3...racejar-v1.1.0) (2024-12-02)
+
+
+### Features
+
+* **`compileFeature`:** allow passing context to each `step` ([05d6a23](https://github.com/portabletext/editor/commit/05d6a233d18eada7a46ff52520155f22d58f6ae4))
+* add initial version of `racejar/playwright` ([2cac384](https://github.com/portabletext/editor/commit/2cac3846db0f01a157c00d55b0b7ba802278fe0a))
+
+## [1.0.3](https://github.com/portabletext/editor/compare/racejar-v1.0.2...racejar-v1.0.3) (2024-12-01)
+
+
+### Bug Fixes
+
+* fix type error when defining inline steps without using generics ([d371044](https://github.com/portabletext/editor/commit/d371044dae46e87188bfc52cbadd8708748bb0ce))
+
 ## [1.0.2](https://github.com/portabletext/editor/compare/racejar-v1.0.1...racejar-v1.0.2) (2024-11-29)
 
 

package/README.md

@@ -130,13 +130,13 @@ Feature({
         When greeting the person
         Then the greeting is "Hello, Herman!"`,
   stepDefinitions: [
-    Given<Context, string>('the person {string}', (context, person) => {
+    Given('the person {string}', (context: Context, person: string) => {
       context.person = person
     }),
-    When<Context>('greeting the person', (context) => {
+    When('greeting the person', (context: Context) => {
       context.greeting = greet(context.person)
     }),
-    Then<Context, string>('the greeting is {string}', (context, greeting) => {
+    Then('the greeting is {string}', (context: Context, greeting: string) => {
       expect(context.greeting).toBe(greeting)
     }),
   ],

package/example/hello-herman.test.ts

@@ -19,13 +19,13 @@ Feature({
         When greeting the person
         Then the greeting is "Hello, Herman!"`,
   stepDefinitions: [
-    Given<Context, string>('the person {string}', (context, person) => {
+    Given('the person {string}', (context: Context, person: string) => {
       context.person = person
     }),
-    When<Context>('greeting the person', (context) => {
+    When('greeting the person', (context: Context) => {
       context.greeting = greet(context.person)
     }),
-    Then<Context, string>('the greeting is {string}', (context, greeting) => {
+    Then('the greeting is {string}', (context: Context, greeting: string) => {
       expect(context.greeting).toBe(greeting)
     }),
   ],

package/example-playwright/playwright-homepage.test.ts

@@ -0,0 +1,35 @@
+import {expect} from '@playwright/test'
+import {Feature, type PlaywrightContext} from '../src/playwright'
+import {Given, Then, When} from '../src/step-definitions'
+
+type Context = PlaywrightContext
+
+Feature({
+  featureText: `
+    Feature: Playwright Homepage
+      Scenario: Navigating to Get Started
+        Given the homepage
+        When clicking the "Get started" link
+        Then the heading is "Installation"`,
+  stepDefinitions: [
+    Given('the homepage', async (context: Context) => {
+      await context.playwright.page.goto('https://playwright.dev/')
+    }),
+    When(
+      'clicking the {string} link',
+      async (context: Context, linkName: string) => {
+        await context.playwright.page
+          .getByRole('link', {name: linkName})
+          .click()
+      },
+    ),
+    Then(
+      'the heading is {string}',
+      async (context: Context, heading: string) => {
+        await expect(
+          context.playwright.page.getByRole('heading', {name: heading}),
+        ).toBeVisible()
+      },
+    ),
+  ],
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "racejar",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A testing framework agnostic Gherkin driver",
   "keywords": [
     "cucumber",
@@ -30,6 +30,10 @@
       "default": "./src/jest/index.ts",
       "types": "./src/jest/index.ts"
     },
+    "./playwright": {
+      "default": "./src/playwright/index.ts",
+      "types": "./src/playwright/index.ts"
+    },
     "./vitest": {
       "default": "./src/vitest/index.ts",
       "types": "./src/vitest/index.ts"
@@ -40,12 +44,14 @@
     "@cucumber/gherkin": "^30.0.4",
     "@cucumber/messages": "^27.0.2",
     "@jest/globals": "^29.7.0",
+    "@playwright/test": "^1.49.0",
     "@sanity/pkg-utils": "^6.11.13",
     "typescript": "5.7.2",
     "vitest": "^2.1.5"
   },
   "peerDependencies": {
     "@jest/globals": "^29.7.0",
+    "@playwright/test": "^1.49.0",
     "vitest": "^2.1.5"
   },
   "scripts": {

package/src/compile-feature.ts

@@ -5,28 +5,29 @@ import {
 } from '@cucumber/cucumber-expressions'
 import * as Gherkin from '@cucumber/gherkin'
 import * as Messages from '@cucumber/messages'
-import type {
-  StepDefinition,
-  StepDefinitionCallbackParameters,
-} from './step-definitions'
+import type {StepDefinition} from './step-definitions'
 
 /**
  * @public
  */
-export type CompiledFeature = {
-  name: string
-  tag?: 'only' | 'skip'
-  scenarios: Array<{
+export type CompiledFeature<TStepContext extends Record<string, any> = object> =
+  {
     name: string
     tag?: 'only' | 'skip'
-    steps: Array<() => Promise<void> | void>
-  }>
-}
+    scenarios: Array<{
+      name: string
+      tag?: 'only' | 'skip'
+      steps: Array<(stepContext?: TStepContext) => Promise<void> | void>
+    }>
+  }
 
 /**
  * @public
  */
-export function compileFeature<TContext extends Record<string, any> = object>({
+export function compileFeature<
+  TContext extends Record<string, any> = object,
+  TStepContext extends Record<string, any> = object,
+>({
   featureText,
   stepDefinitions,
   parameterTypes,
@@ -34,7 +35,7 @@ export function compileFeature<TContext extends Record<string, any> = object>({
   featureText: string
   stepDefinitions: Array<StepDefinition<TContext, any, any, any>>
   parameterTypes?: Array<ParameterType<unknown>>
-}): CompiledFeature {
+}): CompiledFeature<TStepContext> {
   const uuidFn = Messages.IdGenerator.uuid()
   const builder = new Gherkin.AstBuilder(uuidFn)
   const matcher = new Gherkin.GherkinClassicTokenMatcher()
@@ -116,11 +117,15 @@ export function compileFeature<TContext extends Record<string, any> = object>({
         throw new Error(`Multiple implementations found for step: ${step.text}`)
       }
 
-      const args = matchingStep.args.map((arg) =>
-        arg.getValue(matchingStep),
-      ) as StepDefinitionCallbackParameters<any, any, any>
+      const args = matchingStep.args.map((arg) => arg.getValue(matchingStep))
 
-      return () => matchingStep.callback(context, ...args)
+      return (stepContext: TStepContext | undefined) =>
+        matchingStep.callback(
+          Object.assign(context, stepContext),
+          args[0],
+          args[1],
+          args[2],
+        )
     })
 
     return {

package/src/playwright/index.ts

@@ -0,0 +1 @@
+export * from './playwright-gherkin-driver'

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

@@ -0,0 +1,64 @@
+import type {ParameterType} from '@cucumber/cucumber-expressions'
+import {test, type BrowserContext, type Page} from '@playwright/test'
+import {compileFeature} from '../compile-feature'
+import type {StepDefinition} from '../step-definitions'
+
+/**
+ * @public
+ */
+export type PlaywrightContext = {
+  playwright: {
+    page: Page
+    context: BrowserContext
+  }
+}
+
+/**
+ * @public
+ */
+export function Feature<
+  TContext extends PlaywrightContext = PlaywrightContext,
+>({
+  featureText,
+  stepDefinitions,
+  parameterTypes,
+}: {
+  featureText: string
+  stepDefinitions: Array<StepDefinition<TContext, any, any, any>>
+  parameterTypes?: Array<ParameterType<unknown>>
+}) {
+  const feature = compileFeature({
+    featureText,
+    stepDefinitions,
+    parameterTypes,
+  })
+
+  const describeFn =
+    feature.tag === 'only'
+      ? test.describe.only
+      : feature.tag === 'skip'
+        ? test.describe.skip
+        : test.describe
+
+  describeFn(feature.name, async () => {
+    for (const scenario of feature.scenarios) {
+      const testFn =
+        scenario.tag === 'only'
+          ? test.only
+          : scenario.tag === 'skip'
+            ? test.skip
+            : test
+
+      testFn(scenario.name, async ({page, context}) => {
+        for (const step of scenario.steps) {
+          await step({
+            playwright: {
+              page,
+              context,
+            },
+          })
+        }
+      })
+    }
+  })
+}

package/src/step-definitions.ts

@@ -1,30 +1,27 @@
 /**
  * @public
  */
-export type StepDefinitionCallbackParameters<
+export type StepDefinitionCallback<
+  TContext extends Record<string, any> = object,
   TParamA = undefined,
   TParamB = undefined,
   TParamC = undefined,
 > = TParamA extends undefined
-  ? []
+  ? (context: TContext) => Promise<void> | void
   : TParamB extends undefined
-    ? [TParamA]
+    ? (context: TContext, paramA: TParamA) => Promise<void> | void
     : TParamC extends undefined
-      ? [TParamA, TParamB]
-      : [TParamA, TParamB, TParamC]
-
-/**
- * @public
- */
-export type StepDefinitionCallback<
-  TContext extends Record<string, any> = object,
-  TParamA = undefined,
-  TParamB = undefined,
-  TParamC = undefined,
-> = (
-  context: TContext,
-  ...args: StepDefinitionCallbackParameters<TParamA, TParamB, TParamC>
-) => Promise<void> | void
+      ? (
+          context: TContext,
+          paramA: TParamA,
+          paramB: TParamB,
+        ) => Promise<void> | void
+      : (
+          context: TContext,
+          paramA: TParamA,
+          paramB: TParamB,
+          paramC: TParamC,
+        ) => Promise<void> | void
 
 /**
  * @public

package/vitest.workspace.ts

@@ -6,12 +6,14 @@ export default defineWorkspace([
     plugins: [],
     test: {
       name: 'unit',
+      exclude: ['example-playwright'],
     },
   },
   {
     plugins: [],
     test: {
       name: 'chromium',
+      exclude: ['example-playwright'],
     },
   },
 ])