Merge branch 'cucumber-main'

Author: eman2673

CHANGELOG.md

@@ -11,16 +11,32 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 ### Added
 
-* 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
 
+* Clarify that the JSON formatter will not be removed any time soon
+
 ### Deprecated
 
 ### Removed
 
 ### Fixed
 
+* Json formatter now works with tagged examples
+  ([#1621](https://github.com/cucumber/cucumber-js/issues/1621)
+   [#1651](https://github.com/cucumber/cucumber-js/pull/1651))
+
+## [7.2.1] (2021-04-21)
+
+### Fixed
+
+* Temporarily remove ESM changes due to impact on formatters
+
+## [7.2.0] (2021-04-20)
+
+### Added
+
+* 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))
+
 ## [7.1.0] (2021-04-06)
 
 ### Added
@@ -1815,7 +1831,9 @@ 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.1.0...master
+[Unreleased]:   https://github.com/cucumber/cucumber-js/compare/v7.2.1...master
+[7.2.1]:        https://github.com/cucumber/cucumber-js/compare/7.2.1-rc.0...7.0.0
+[7.2.0]:        https://github.com/cucumber/cucumber-js/compare/7.2.0-rc.0...7.0.0
 [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

CONTRIBUTING.md

@@ -77,9 +77,13 @@ Start the container:
 
     make docker-run
 
-Inside the container, update dependencies:
+Inside the container, install the correct versions of Node and Yarn:
 
+    nvm install --lts
     npm install -g yarn
+
+Then update the dependencies and test:
+
     yarn update-dependencies
     yarn
     yarn test

dependency-lint.yml

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

docs/cli.md

@@ -59,7 +59,7 @@ If multiple formats are specified with the same output, only the last is used.
 
 * **message** - prints each [message](https://github.com/cucumber/cucumber/tree/master/cucumber-messages) in NDJSON form, which can then be consumed by other tools.
 * **html** - prints a rich HTML report to a standalone page
-* **json** - prints the feature as JSON. *Note: this formatter is deprecated and will be removed in the next major release. Where you need a structured data representation of your test run, it's best to use the `message` formatter. For legacy tools that depend on the deprecated JSON format, a standalone formatter is available (see https://github.com/cucumber/cucumber/tree/master/json-formatter).
+* **json** - prints the feature as JSON. *Note: this formatter is in maintenance mode and won't have new features added to it. Where you need a structured data representation of your test run, it's best to use the `message` formatter. Tools that rely on this formatter will continue to work, but are encouraged to migrate to consume the `message` output instead.*
 * **progress** - prints one character per scenario (default).
 * **progress-bar** - prints a progress bar and outputs errors/warnings along the way.
 * **rerun** - prints the paths of any non-passing scenarios ([example](/features/rerun_formatter.feature))
@@ -81,22 +81,6 @@ 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}'`
@@ -109,16 +93,16 @@ By default, cucumber exits when the event loop drains. Use the `--exit` flag in
 * [Node.js Async Hooks](https://nodejs.org/dist/latest-v8.x/docs/api/async_hooks.html)
 * Isolating what scenario or scenarios causes the hang
 
-## Undefined Step Snippets
-
-Undefined steps snippets are printed in JavaScript using the callback interface by default.
-
 ## --no-strict
 
 disable _strict_ mode.
 
 By default, cucumber works in _strict_ mode, meaning it will fail if there are pending steps.
 
+## Undefined Step Snippets
+
+Undefined steps snippets are printed in JavaScript using the callback interface by default.
+
 ### Interface
 
 Override the snippet interface with `--format-options '{"snippetInterface": "<interface>"}'`.
@@ -196,7 +180,9 @@ If your files end with an extension other than `js`, make sure to also include t
 --require-module coffeescript/register --require 'features/**/*.coffee'
 ```
 
-### Typescript
+### TypeScript
+
+Your `tsconfig.json` should have the `resolveJsonModule` compiler option switched on. Other than that, a pretty standard TypeScript setup should work as expected.
 
 #### With ts-node
 
@@ -227,6 +213,7 @@ require('ts-node').register({
   transpileOnly: true,
   compilerOptions: {
     "module": "commonjs",
+    "resolveJsonModule": true,
   },
 });
 ```

docs/migration.md

@@ -48,3 +48,5 @@ There are a few minor differences to be aware of:
 
 - The type for data tables was named `TableDefinition` - it's now named `DataTable`
 - `World` was typed as an interface, but it's actually a class - you should `extend` it when [building a custom formatter](./custom_formatters.md)
+
+Also, your `tsconfig.json` should have the `resolveJsonModule` compiler option switched on. Other than that, a pretty standard TypeScript setup should work as expected.

features/esm.feature

@@ -93,3 +93,55 @@ Feature: Scenario Outlines and Examples
     When I run cucumber-js
     Then it fails
     And it runs 4 scenarios
+
+  Scenario: scenario outlines with tagged examples
+    Given a file named "features/scenario_outline.feature" with:
+      """
+      Feature: a feature
+        Scenario Outline: a scenario
+          Given a step <id>
+
+        @examples @tag
+        Examples:
+          | id |
+          | 1  |
+          | 2  |
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+
+      Given('a step {int}', function(int) {})
+      """
+    When I run cucumber-js with `-f json`
+    Then it passes
+    And it runs 2 scenarios
+
+  Scenario: scenario outlines with multiple example tables
+    Given a file named "features/scenario_outline.feature" with:
+      """
+      Feature: a feature
+        Scenario Outline: a scenario
+          Given a step <id>
+
+        @example @id-1-2
+        Examples:
+          | id |
+          | 1  |
+          | 2  |
+
+        @example @id-3-4
+        Examples:
+          | id |
+          | 3  |
+          | 4  |
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+
+      Given('a step {int}', function(int) {})
+      """
+    When I run cucumber-js with `-f json`
+    Then it passes
+    And it runs 4 scenarios

features/scenario_outlines.feature

@@ -13,7 +13,7 @@ Before('@debug', function (this: World) {
   this.debug = true
 })
 
-Before('@spawn or @esm', function (this: World) {
+Before('@spawn', function (this: World) {
   this.spawn = true
 })
 
@@ -43,18 +43,6 @@ 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 })