Merge remote-tracking branch 'origin/main' into renovate/major-eslint-packages

Author: aurelien-reeves

.github/workflows/build.yaml

@@ -37,6 +37,10 @@ jobs:
       - uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/upload-artifact@v2
+        with:
+          name: reports
+          path: reports
 
   audit-dependencies:
     runs-on: ubuntu-latest

.gitignore

@@ -4,12 +4,13 @@
 .nyc_output/
 @rerun.txt
 coverage/
-html-formatter.html
 lib/
-messages.ndjson
 node_modules
 tmp/
-usage.txt
+reports/*.html
+reports/*.ndjson
+reports/*.txt
 yarn-error.log
 .vscode
 .DS_Store
+src/version.ts

CHANGELOG.md

@@ -8,10 +8,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Changed
+- Switched to new `@cucumber/ci-environment` library for CI detection ([#1868](https://github.com/cucumber/cucumber-js/pull/1868))
+
 ### Fixed
+- Handles spaces in paths for developers working on cucumbers's own code ([#1845](https://github.com/cucumber/cucumber-js/issues/1845))
+- Ensure package.json can be imported by consuming projects
+  ([PR#1870](https://github.com/cucumber/cucumber-js/pull/1870)
+   [Issue#1869](https://github.com/cucumber/cucumber-js/issues/1869))
 - Allows for parentheses in paths for developers working on cucumber's own code ([[#1735](https://github.com/cucumber/cucumber-js/issues/1735)])
 - Smoother onboarding for Windows developers ([#1863](https://github.com/cucumber/cucumber-js/pull/1863))
 
+### Added
+- Export cucumber version number. It is now possible to retrieve the current version
+  of cucumber using `import { version } from '@cucumber/cucumber'`.
+  ([PR#1866](https://github.com/cucumber/cucumber-js/pull/1866)
+   [Issue#1853](https://github.com/cucumber/cucumber-js/issues/1853))
+
 ## [8.0.0-rc.1] - 2021-10-19
 ### Added
 - Add `wrapPromiseWithTimeout` to public API ([#1566](https://github.com/cucumber/cucumber-js/pull/1566))

CONTRIBUTING.md

@@ -11,10 +11,12 @@ You can chat with us in the [#committers-js](https://cucumberbdd.slack.com/archi
 
 ## Local setup
 
-To get a local development environment, use [Git] to [fork and clone] the repo, then:
+To get a local development environment:
 
-* If you're running Windows, make sure to enable [Developer Mode].
+* use [Git] to [fork and clone] the repo
+* If you're running Windows, make sure to enable [Developer Mode]
 * install [Node.Js](https://nodejs.org/en/)
+* Make sure you have a recent version of `npm` installed: `npm install -g npm`
 * `npm install` - Install dependencies
 * `npm test` - Compile typescript and run the tests
 

compatibility/cck_spec.ts

@@ -5,7 +5,6 @@ import glob from 'glob'
 import fs from 'fs'
 import path from 'path'
 import { PassThrough, pipeline, Writable } from 'stream'
-import { Cli } from '../src'
 import toString from 'stream-to-string'
 import {
   ignorableKeys,
@@ -14,6 +13,8 @@ import {
 import * as messages from '@cucumber/messages'
 import * as messageStreams from '@cucumber/message-streams'
 import util from 'util'
+import { runCucumber } from '../src/run'
+import { IRunConfiguration } from '../src/configuration'
 
 const asyncPipeline = util.promisify(pipeline)
 const PROJECT_PATH = path.join(__dirname, '..')
@@ -29,27 +30,28 @@ describe('Cucumber Compatibility Kit', () => {
     const suiteName = match[1]
     const extension = match[2]
     it(`passes the cck suite for '${suiteName}'`, async () => {
-      const cliOptions = [
-        `${CCK_FEATURES_PATH}/${suiteName}/${suiteName}${extension}`,
-        '--require',
-        `${CCK_IMPLEMENTATIONS_PATH}/${suiteName}/${suiteName}.ts`,
-        '--profile',
-        'cck',
-      ]
-      if (suiteName === 'retry') {
-        cliOptions.push('--retry', '2')
-      }
-      const args = [
-        'node',
-        path.join(PROJECT_PATH, 'bin', 'cucumber-js'),
-      ].concat(cliOptions)
       const stdout = new PassThrough()
+      const runConfiguration: IRunConfiguration = {
+        sources: {
+          paths: [`${CCK_FEATURES_PATH}/${suiteName}/${suiteName}${extension}`],
+        },
+        support: {
+          transpileWith: ['ts-node/register'],
+          paths: [`${CCK_IMPLEMENTATIONS_PATH}/${suiteName}/${suiteName}.ts`],
+        },
+        formats: {
+          stdout: 'message',
+        },
+        runtime: {
+          retry: suiteName === 'retry' ? 2 : 0,
+        },
+      }
       try {
-        await new Cli({
-          argv: args,
+        await runCucumber(runConfiguration, {
           cwd: PROJECT_PATH,
           stdout,
-        }).run()
+          env: process.env,
+        })
       } catch (ignored) {
         console.error(ignored)
       }

cucumber.js

@@ -1,24 +1,14 @@
-const feature = [
-  '--require-module ts-node/register',
-  '--require features/**/*.ts',
-  `--format progress-bar`,
-  '--format rerun:@rerun.txt',
-  '--format usage:usage.txt',
-  '--format message:messages.ndjson',
-  '--format html:html-formatter.html',
-  '--retry 2',
-  '--retry-tag-filter @flaky',
-  '--publish-quiet',
-].join(' ')
-
-const cck = [
-  '--require-module',
-  'ts-node/register',
-  '--format',
-  'message',
-].join(' ')
-
 module.exports = {
-  default: feature,
-  cck,
+  default: [
+    '--require-module ts-node/register',
+    '--require features/**/*.ts',
+    `--format progress-bar`,
+    '--format rerun:@rerun.txt',
+    '--format usage:reports/usage.txt',
+    '--format message:reports/messages.ndjson',
+    '--format html:reports/html-formatter.html',
+    '--retry 2',
+    '--retry-tag-filter @flaky',
+    '--publish-quiet',
+  ].join(' '),
 }

features/direct_imports.feature

@@ -60,4 +60,26 @@ Feature: Core feature elements execution using direct imports
       Given(/^a step passes$/, function() {});
       """
     When I run cucumber-js
-    Then it passes
+    Then it passes
+
+  Scenario: we can import the version number from package.json and from the library
+    Given a file named "features/a.feature" with:
+      """
+      Feature: some feature
+        Scenario: some scenario
+          Given a step checks the version number
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+      const package_version = require('@cucumber/cucumber/package.json').version
+      const library_version = require('@cucumber/cucumber').version
+
+      Given(/^a step checks the version number$/, function() {
+        if (package_version !== library_version) {
+          throw new Error(`package version: ${package_version} !== library version: ${library_version}`)
+        }
+      });
+      """
+    When I run cucumber-js
+    Then it passes

features/formatter_paths.feature

@@ -25,7 +25,7 @@ Feature: Formatter Paths
 
   Scenario: Absolute path
     Given "{{{tmpDir}}}" is an absolute path
-    When I run cucumber-js with `-f summary:{{{tmpDir}}}/summary.txt`
+    When I run cucumber-js with `-f summary:"{{{tmpDir}}}/summary.txt"`
     Then the file "{{{tmpDir}}}/summary.txt" has the text:
       """
       1 scenario (1 passed)

features/i18n.feature

@@ -1,3 +1,4 @@
+@spawn
 Feature: internationalization
 
   Scenario: view available languages

features/step_definitions/cli_steps.ts

@@ -9,15 +9,18 @@ import {
   valueOrDefault,
 } from '../../src/value_checker'
 import { World } from '../support/world'
-
-const { version } = require('../../package.json') // eslint-disable-line @typescript-eslint/no-var-requires
+import { version } from '../../src/version'
 
 When('my env includes {string}', function (this: World, envString: string) {
   this.sharedEnv = this.parseEnvString(envString)
 })
 
+When('I run cucumber-js', { timeout: 10000 }, async function (this: World) {
+  return await this.run(this.localExecutablePath, [])
+})
+
 When(
-  /^I run cucumber-js(?: with `(|.+)`)?$/,
+  'I run cucumber-js with `{}`',
   { timeout: 10000 },
   async function (this: World, args: string) {
     const renderedArgs = Mustache.render(valueOrDefault(args, ''), this)
@@ -27,7 +30,7 @@ When(
 )
 
 When(
-  /^I run cucumber-js with arguments `(|.+)` and env `(|.+)`$/,
+  'I run cucumber-js with arguments `{}` and env `{}`',
   { timeout: 10000 },
   async function (this: World, args: string, envString: string) {
     const renderedArgs = Mustache.render(valueOrDefault(args, ''), this)
@@ -38,7 +41,7 @@ When(
 )
 
 When(
-  /^I run cucumber-js with env `(|.+)`$/,
+  'I run cucumber-js with env `{}`',
   { timeout: 10000 },
   async function (this: World, envString: string) {
     const env = this.parseEnvString(envString)
@@ -47,7 +50,18 @@ When(
 )
 
 When(
-  /^I run cucumber-js with all formatters(?: and `(|.+)`)?$/,
+  'I run cucumber-js with all formatters',
+  { timeout: 10000 },
+  async function (this: World) {
+    const args = '--format html:html.out --format json:json.out'
+    const renderedArgs = Mustache.render(args, this)
+    const stringArgs = stringArgv(renderedArgs)
+    return await this.run(this.localExecutablePath, stringArgs)
+  }
+)
+
+When(
+  'I run cucumber-js with all formatters and `{}`',
   { timeout: 10000 },
   async function (this: World, args: string) {
     if (doesNotHaveValue(args)) {