Merge branch 'main' into main

Author: davidjgoss

.github/workflows/build.yaml

@@ -24,7 +24,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: with Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
         uses: actions/setup-node@v4
         with:
@@ -34,7 +34,7 @@ jobs:
   coverage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22.x
@@ -47,7 +47,7 @@ jobs:
   audit-dependencies:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22.x

.github/workflows/release-github.yaml

@@ -12,7 +12,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: cucumber/[email protected]
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-npm-latest.yaml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: Release
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: '22'

.github/workflows/release-npm-next.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: Release
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: '22'

.github/workflows/site.yaml

@@ -9,7 +9,7 @@ jobs:
   upload-artifact:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22.6

compatibility/cck_spec.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs'
 import path from 'node:path'
-import { PassThrough, pipeline, Writable } from 'node:stream'
-import util from 'node:util'
+import { PassThrough, Writable } from 'node:stream'
+import { pipeline } from 'node:stream/promises'
 import { describe, it } from 'mocha'
 import { config, expect, use } from 'chai'
 import chaiExclude from 'chai-exclude'
@@ -12,7 +12,6 @@ import { Envelope } from '@cucumber/messages'
 import { ignorableKeys } from '../features/support/formatter_output_helpers'
 import { runCucumber, IRunConfiguration } from '../src/api'
 
-const asyncPipeline = util.promisify(pipeline)
 const PROJECT_PATH = path.join(__dirname, '..')
 const CCK_FEATURES_PATH = 'node_modules/@cucumber/compatibility-kit/features'
 const CCK_IMPLEMENTATIONS_PATH = 'compatibility/features'
@@ -21,36 +20,37 @@ config.truncateThreshold = 100
 use(chaiExclude)
 
 describe('Cucumber Compatibility Kit', () => {
-  const ndjsonFiles = glob.sync(`${CCK_FEATURES_PATH}/**/*.ndjson`)
-  ndjsonFiles.forEach((fixturePath) => {
-    const match = /^.+[/\\](.+)(\.feature(?:\.md)?)\.ndjson$/.exec(fixturePath)
-    const suiteName = match[1]
-    const extension = match[2]
-    it(`passes the cck suite for '${suiteName}'`, async () => {
+  const directories = glob.sync(`${CCK_FEATURES_PATH}/*`, { nodir: false })
+
+  for (const directory of directories) {
+    const suite = path.basename(directory)
+
+    it(suite, async () => {
       const actualMessages: Envelope[] = []
       const stdout = new PassThrough()
       const stderr = new PassThrough()
       const runConfiguration: IRunConfiguration = {
         sources: {
           defaultDialect: 'en',
-          paths: [`${CCK_FEATURES_PATH}/${suiteName}/${suiteName}${extension}`],
+          paths: [
+            `${CCK_FEATURES_PATH}/${suite}/*.feature`,
+            `${CCK_FEATURES_PATH}/${suite}/*.feature.md`,
+          ],
           names: [],
           tagExpression: '',
           order: 'defined',
           shard: '',
         },
         support: {
           requireModules: ['ts-node/register'],
-          requirePaths: [
-            `${CCK_IMPLEMENTATIONS_PATH}/${suiteName}/${suiteName}.ts`,
-          ],
+          requirePaths: [`${CCK_IMPLEMENTATIONS_PATH}/${suite}/*.ts`],
         },
         runtime: {
           dryRun: false,
           failFast: false,
           filterStacktraces: true,
           parallel: 0,
-          retry: suiteName === 'retry' ? 2 : 0,
+          retry: suite === 'retry' ? 2 : 0,
           retryTagFilter: '',
           strict: true,
           worldParameters: {},
@@ -75,8 +75,10 @@ describe('Cucumber Compatibility Kit', () => {
       stderr.end()
 
       const expectedMessages: messages.Envelope[] = []
-      await asyncPipeline(
-        fs.createReadStream(fixturePath, { encoding: 'utf-8' }),
+      await pipeline(
+        fs.createReadStream(path.join(directory, suite + '.ndjson'), {
+          encoding: 'utf-8',
+        }),
         new messageStreams.NdjsonToMessageStream(),
         new Writable({
           objectMode: true,
@@ -91,5 +93,5 @@ describe('Cucumber Compatibility Kit', () => {
         .excludingEvery(ignorableKeys)
         .to.deep.eq(expectedMessages)
     })
-  })
+  }
 })

compatibility/features/attachments/attachments.ts

@@ -35,40 +35,6 @@ When(
   }
 )
 
-When('a JPEG image is attached', async function () {
-  await this.attach(
-    fs.createReadStream(
-      path.join(
-        process.cwd(),
-        'node_modules',
-        '@cucumber',
-        'compatibility-kit',
-        'features',
-        'attachments',
-        'cucumber.jpeg'
-      )
-    ),
-    'image/jpeg'
-  )
-})
-
-When('a PNG image is attached', async function () {
-  await this.attach(
-    fs.createReadStream(
-      path.join(
-        process.cwd(),
-        'node_modules',
-        '@cucumber',
-        'compatibility-kit',
-        'features',
-        'attachments',
-        'cucumber.png'
-      )
-    ),
-    'image/png'
-  )
-})
-
 When('a PDF document is attached and renamed', async function () {
   await this.attach(
     fs.createReadStream(

docs/profiles.md

@@ -14,7 +14,7 @@ The short tag is `-p`
 cucumber-js -p my_profile
 ```
 
-## Simple Example
+## Simple example
 
 Let's take the common case of having some things a bit different locally than on a continuous integration server. Here's the configuration we've been running locally:
 
@@ -67,6 +67,31 @@ Now, if we just run `cucumber-js` with no arguments, it will pick up our profile
 cucumber-js -p ci
 ```
 
+## ESM example
+
+When using ES modules, you should use a default export for your default profile and named exports for additional profiles:
+
+```javascript
+const common = {
+  requireModule: ['ts-node/register'],
+  require: ['support/**/*.ts'],
+  worldParameters: {
+    appUrl: process.env.MY_APP_URL || 'http://localhost:3000/'
+  }
+}
+
+export default {
+  ...common,
+  format: ['progress-bar', 'html:cucumber-report.html'],
+}
+
+export const ci = {
+  ...common,
+  format: ['html:cucumber-report.html'],
+  publish: true
+}
+```
+
 ## Defining profiles dynamically
 
 If you need to define your profiles dynamically (including asynchronously), you can use the `default` profile key/export to provide an async function that resolves to your profiles. This can be particularly useful in an ESM context where the profiles are static exports. Here's an example:

features/support/hooks.ts

@@ -53,7 +53,6 @@ Before('@esm', function (this: World) {
 })
 
 Before('@without-require-esm', function (this: World) {
-  // @ts-expect-error require_module flag not in @types/node yet
   if (process.features.require_module) {
     return 'skipped'
   }