Merge pull request #2 from cucumber/master

Updating from master

Author: eman2673

.gitignore

@@ -11,3 +11,4 @@ node_modules
 tmp/
 usage.txt
 yarn-error.log
+.vscode

CHANGELOG.md

@@ -11,7 +11,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 ### Added
 
-- Support attachments that are already base64-encoded via a prefix on the MIME type e.g. `this.attach(base64String, 'base64:image/png')` ([#1552](https://github.com/cucumber/cucumber-js/pull/1552))
+* Experimental support for native ES modules via the [`--esm` flag](./docs/cli.md#es-modules-experimental-nodejs-12) ([#1589](https://github.com/cucumber/cucumber-js/pull/1589))
 
 ### Changed
 
@@ -21,8 +21,19 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 ### Fixed
 
+## [7.1.0] (2021-04-06)
+
+### Added
+
+- Support attachments that are already base64-encoded via a prefix on the MIME type e.g. `this.attach(base64String, 'base64:image/png')` ([#1552](https://github.com/cucumber/cucumber-js/pull/1552))
+- Support tagged rules ([cucumber#1123](https://github.com/cucumber/cucumber/issues/1123))
+
+### Fixed
+
 * Fix types for hook functions so they can return e.g. `'skipped'` ([#1542](https://github.com/cucumber/cucumber-js/pull/1542))
 * Display the response of the reports server when an error is returned before failing. ([#1608](https://github.com/cucumber/cucumber-js/pull/1608))
+* Remove unnecessary implicit dependency on `long` package ([cucumber#1313](https://github.com/cucumber/cucumber/pull/1313))
+* Remove unnecessary transitive dependencies on `react` etc ([cucumber#1308](https://github.com/cucumber/cucumber/pull/1308))
 
 ## [7.0.0] (2020-12-21)
 
@@ -1804,7 +1815,8 @@ be used to get the name / tags of the running scenario. ([#947](https://github.c
 
 
 <!-- Releases -->
-[Unreleased]:   https://github.com/cucumber/cucumber-js/compare/v7.0.0...master
+[Unreleased]:   https://github.com/cucumber/cucumber-js/compare/v7.1.0...master
+[7.1.0]:        https://github.com/cucumber/cucumber-js/compare/7.1.0-rc.0...7.0.0
 [7.0.0]:        https://github.com/cucumber/cucumber-js/compare/7.0.0-rc.0...v7.0.0
 [7.0.0-rc.0]:   https://github.com/cucumber/cucumber-js/compare/v6.0.5...v7.0.0-rc.0
 [6.0.5]:        https://github.com/cucumber/cucumber-js/compare/v6.0.4...v6.0.5

README.md

@@ -2,7 +2,8 @@
 
 [![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
 [![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
-
+[![pull requests](https://oselvar.com/api/badge?label=pull%20requests&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-js%2FpullRequests.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-js)
+[![issues](https://oselvar.com/api/badge?label=issues&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-js%2Fissues.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-js)
 
 [![GitHub Actions](https://github.com/cucumber/cucumber-js/workflows/Build/badge.svg)](https://github.com/cucumber/cucumber-js/actions)
 [![Dependencies](https://david-dm.org/cucumber/cucumber-js.svg)](https://david-dm.org/cucumber/cucumber-js)

dependency-lint.yml

@@ -43,6 +43,7 @@ requiredModules:
       - 'dist/**/*'
       - 'lib/**/*'
       - 'node_modules/**/*'
+      - 'src/importers.js'
       - 'tmp/**/*'
     root: '**/*.{js,ts}'
   stripLoaders: false

docs/cli.md

@@ -81,6 +81,22 @@ You can pass in format options with `--format-options <JSON>`. The JSON string m
 
 * Suggested use: add with profiles so you can define an object and use `JSON.stringify` instead of writing `JSON` manually.
 
+## ES Modules (experimental) (Node.js 12+)
+
+You can optionally write your support code (steps, hooks, etc) with native ES modules syntax - i.e. using `import` and `export` statements without transpiling.
+
+To enable this, run with the `--esm` flag.
+
+This will also expand the default glob for support files to include the `.mjs` file extension.
+
+As well as support code, these things can also be in ES modules syntax:
+
+- Custom formatters
+- Custom snippets
+- Your `cucumber.js` config file
+
+You can use ES modules selectively/incrementally - the module loading strategy that the `--esm` flag activates supports both ES modules and CommonJS.
+
 ## Colors
 
 Colors can be disabled with `--format-options '{"colorsEnabled": false}'`
@@ -174,31 +190,43 @@ For instance, for ES6 support with [Babel](https://babeljs.io/) 7 add:
 
 This will effectively call `require('@babel/register')` prior to requiring any support files.
 
-### Non JS files
+If your files end with an extension other than `js`, make sure to also include the `--require` option to state the required support files. For example, if using [CoffeeScript](https://www.npmjs.com/package/coffeescript):
 
-If your files end in an extension other than `js`, make sure to also include the `--require` option to state the support files to require.
+```
+--require-module coffeescript/register --require 'features/**/*.coffee'
+```
+
+### Typescript
+
+#### With ts-node
 
-For example, with [TypeScript](https://www.typescriptlang.org/):
+If you are using [ts-node](https://github.com/TypeStrong/ts-node):
 
 ```
 --require-module ts-node/register --require 'step-definitions/**/*.ts'
 ```
 
-or [CoffeeScript](https://www.npmjs.com/package/coffeescript):
+> ⚠️ Some TypeScript setups use `esnext` modules by default, 
+>   which doesn't marry well with Node. You may consider using commonjs instead.
+>   See how to add [extra configuration](#extra-configuration) below.
+
+#### With babel
+
+If you are using babel with [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript):
 
 ```
---require-module coffeescript/register --require 'features/**/*.coffee'
+--require-module @babel/register --require 'step-definitions/**/*.ts'
 ```
 
-### Extra configuration
+### Extra Configuration
 
-Sometimes the required module (say `@ts-node/register`) needs extra configuration (e.g. you might want to configure it such that it prevents the compiled JS being written out to files, and pass some compiler options). In such cases, create a script (say, `tests.setup.js`):
+Sometimes the required module (say `@ts-node/register`) needs extra configuration. For example, you might want to configure it such that it prevents the compiled JS being written out to files, and pass some compiler options. In such cases, create a script (say, `tests.setup.js`):
 
 ```js
 require('ts-node').register({
   transpileOnly: true,
   compilerOptions: {
-    // your compiler options here
+    "module": "commonjs",
   },
 });
 ```

features/esm.feature

@@ -0,0 +1,80 @@
+Feature: ES modules support
+
+  cucumber-js works with native ES modules, via a Cli flag `--esm`
+
+  @esm
+  Scenario Outline: native module syntax works when using --esm
+    Given a file named "features/a.feature" with:
+      """
+      Feature:
+        Scenario: one
+          Given a step passes
+
+        Scenario: two
+          Given a step passes
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      import {Given} from '@cucumber/cucumber'
+
+      Given(/^a step passes$/, function() {});
+      """
+    And a file named "cucumber.js" with:
+      """
+      export default {
+        'default': '--format message:messages.ndjson',
+      }
+      """
+    And a file named "custom-formatter.js" with:
+      """
+      import {SummaryFormatter} from '@cucumber/cucumber'
+
+      export default class CustomFormatter extends SummaryFormatter {}
+      """
+    And a file named "custom-snippet-syntax.js" with:
+      """
+      export default class CustomSnippetSyntax {
+          build(opts) {
+              return 'hello world'
+          }
+      }
+      """
+    When I run cucumber-js with `<options> --format ./custom-formatter.js --format-options '{"snippetSyntax": "./custom-snippet-syntax.js"}'`
+    Then it passes
+    Examples:
+      | options            |
+      | --esm              |
+      | --esm --parallel 2 |
+
+  @esm
+  Scenario: .mjs support code files are matched by default when using --esm
+    Given a file named "features/a.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given a step passes
+      """
+    And a file named "features/step_definitions/cucumber_steps.mjs" with:
+      """
+      import {Given} from '@cucumber/cucumber'
+
+      Given(/^a step passes$/, function() {});
+      """
+    When I run cucumber-js with `--esm`
+    Then it passes
+
+  Scenario: native module syntax doesn't work without --esm
+    Given a file named "features/a.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given a step passes
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      import {Given} from '@cucumber/cucumber'
+
+      Given(/^a step passes$/, function() {});
+      """
+    When I run cucumber-js
+    Then it fails

features/rule.feature

@@ -135,3 +135,31 @@ Feature: Rule keyword
     8 steps (1 failed, 1 skipped, 6 passed)
     <duration-stat>
     """
+
+  Scenario: Tags on Rules are honoured
+    Given a file named "features/highlander.feature" with:
+      """
+      Feature: a feature
+
+        @mytag
+        Rule: a rule
+
+          Example: a scenario
+            Given a step
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+
+      Given('a step', function() {})
+      """
+    When I run cucumber-js with arguments `--tags @mytag` and env ``
+    Then it passes
+    And it outputs the text:
+    """
+    .
+
+    1 scenario (1 passed)
+    1 step (1 passed)
+    <duration-stat>
+    """

features/support/hooks.ts

@@ -13,7 +13,7 @@ Before('@debug', function (this: World) {
   this.debug = true
 })
 
-Before('@spawn', function (this: World) {
+Before('@spawn or @esm', function (this: World) {
   this.spawn = true
 })
 
@@ -43,6 +43,18 @@ Before(function (
   this.localExecutablePath = path.join(projectPath, 'bin', 'cucumber-js')
 })
 
+Before('@esm', function (this: World) {
+  const [majorVersion] = process.versions.node.split('.')
+  if (Number(majorVersion) < 12) {
+    return 'skipped'
+  }
+  fsExtra.writeJSONSync(path.join(this.tmpDir, 'package.json'), {
+    name: 'feature-test-pickle',
+    type: 'module',
+  })
+  return undefined
+})
+
 Before('@global-install', function (this: World) {
   const tmpObject = tmp.dirSync({ unsafeCleanup: true })
 

features/target_specific_scenarios_by_tag.feature

@@ -30,29 +30,29 @@ Feature: Target specific scenarios
       """
       const {Given} = require('@cucumber/cucumber')
 
-      Given(/^a step is (.*)$/, function() {})
+      Given('a step', function() {})
       """
 
   Scenario: run a single scenario
     When I run cucumber-js with `--tags @a`
-    Then it fails
+    Then it passes
     And it runs the scenario "first scenario"
 
   Scenario: filter out scenarios with ~
     When I run cucumber-js with `--tags "not @b"`
-    Then it fails
+    Then it passes
     And it runs the scenario "first scenario"
 
   Scenario: merge multiple tag expressions
     When I run cucumber-js with `--tags @b --tags "not @c"`
-    Then it fails
+    Then it passes
     And it runs the scenarios:
       | NAME |
       | second scenario - Z |
 
   Scenario: run a single scenario outline
     When I run cucumber-js with `--tags @b`
-    Then it fails
+    Then it passes
     And it runs the scenarios:
       | NAME |
       | second scenario - X |
@@ -61,7 +61,7 @@ Feature: Target specific scenarios
 
   Scenario: run a single scenario outline examples
     When I run cucumber-js with `--tags @c`
-    Then it fails
+    Then it passes
     And it runs the scenarios:
       | NAME |
       | second scenario - X |