format: add support for gherkin rule/example syntax

.editorconfig

@@ -0,0 +1,9 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# 4 space indentation
+[*]
+indent_style = space
+indent_size = 2

CHANGELOG.md

@@ -2,6 +2,10 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 ### [Unreleased](https://github.com/cucumber/cucumber-js/compare/v6.0.5...master) (In Git)
 
+#### New Features
+
+* Add support for Gherkin's [Rule/Example syntax](https://cucumber.io/docs/gherkin/reference/#rule)
+
 #### Breaking changes
 
 * Drop support for Node.js 8

features/background.feature

@@ -46,3 +46,35 @@ Feature: Background
       | IDENTIFIER                 |
       | Given a background step    |
       | When another scenario step |
+
+  Scenario: Two examples within a rule with a background, plus a feature-level background
+    Given a file named "features/background.feature" with:
+      """
+      Feature: a feature
+        Background:
+          Given a feature-level background step
+
+        Rule: a rule
+          Background:
+            Given a rule-level background step
+
+          Example: first example
+            When an example step
+
+          Example: second example
+            When an example step
+            When another example step
+      """
+    When I run cucumber-js
+    Then it fails
+    And the scenario "first example" has the steps:
+      | IDENTIFIER                            |
+      | Given a feature-level background step |
+      | Given a rule-level background step    |
+      | When an example step                  |
+    And the scenario "second example" has the steps:
+      | IDENTIFIER                            |
+      | Given a feature-level background step |
+      | Given a rule-level background step    |
+      | When an example step                  |
+      | When another example step             |

features/fixtures/formatters/passed-rule.json.ts

@@ -0,0 +1,37 @@
+module.exports = [
+  {
+    description: '',
+    elements: [
+      {
+        description: '',
+        id: 'a-feature;a-rule;an-example',
+        keyword: 'Example',
+        line: 3,
+        name: 'an example',
+        steps: [
+          {
+            arguments: [],
+            keyword: 'Given ',
+            line: 4,
+            match: {
+              location: 'features/step_definitions/steps.js:3',
+            },
+            name: 'a step',
+            result: {
+              duration: 0,
+              status: 'passed',
+            },
+          },
+        ],
+        tags: [],
+        type: 'scenario',
+      },
+    ],
+    id: 'a-feature',
+    keyword: 'Feature',
+    line: 1,
+    name: 'a feature',
+    tags: [],
+    uri: 'features/a.feature',
+  },
+]

features/fixtures/formatters/passed-rule.message.json.ts

@@ -0,0 +1,143 @@
+module.exports = [
+  {
+    source: {
+      uri: 'features/a.feature',
+      data:
+        'Feature: a feature\n  Rule: a rule\n    Example: an example\n      Given a step',
+      media: {
+        encoding: 'UTF8',
+        contentType: 'text/x.cucumber.gherkin+plain',
+      },
+    },
+  },
+  {
+    gherkinDocument: {
+      uri: 'features/a.feature',
+      feature: {
+        location: {
+          line: 1,
+          column: 1,
+        },
+        language: 'en',
+        keyword: 'Feature',
+        name: 'a feature',
+        children: [
+          {
+            rule: {
+              location: {
+                line: 2,
+                column: 3,
+              },
+              keyword: 'Rule',
+              name: 'a rule',
+              children: [
+                {
+                  scenario: {
+                    location: {
+                      line: 3,
+                      column: 5,
+                    },
+                    keyword: 'Example',
+                    name: 'an example',
+                    steps: [
+                      {
+                        location: {
+                          line: 4,
+                          column: 7,
+                        },
+                        keyword: 'Given ',
+                        text: 'a step',
+                        id: '1',
+                      },
+                    ],
+                    id: '2',
+                  },
+                },
+              ],
+            },
+          },
+        ],
+      },
+    },
+  },
+  {
+    pickle: {
+      id: '4',
+      uri: 'features/a.feature',
+      name: 'an example',
+      language: 'en',
+      steps: [
+        {
+          text: 'a step',
+          id: '3',
+          astNodeIds: ['1'],
+        },
+      ],
+      astNodeIds: ['2'],
+    },
+  },
+  {
+    pickleAccepted: {
+      pickleId: '4',
+    },
+  },
+  {
+    testRunStarted: {},
+  },
+  {
+    testCase: {
+      id: '5',
+      pickleId: '4',
+      testSteps: [
+        {
+          id: '6',
+          pickleStepId: '3',
+          stepDefinitionIds: ['0'],
+        },
+      ],
+    },
+  },
+  {
+    testCaseStarted: {
+      attempt: 0,
+      testCaseId: '5',
+      id: '7',
+    },
+  },
+  {
+    testStepStarted: {
+      testStepId: '6',
+      testCaseStartedId: '7',
+    },
+  },
+  {
+    testStepFinished: {
+      testResult: {
+        status: 'PASSED',
+        duration: {
+          seconds: '0',
+          nanos: 0,
+        },
+      },
+      testStepId: '6',
+      testCaseStartedId: '7',
+    },
+  },
+  {
+    testCaseFinished: {
+      testResult: {
+        status: 'PASSED',
+        duration: {
+          seconds: '0',
+          nanos: 0,
+        },
+      },
+      testCaseStartedId: '7',
+    },
+  },
+  {
+    testRunFinished: {
+      success: true,
+    },
+  },
+]

features/formatters.feature

@@ -1,17 +1,17 @@
 Feature: Formatters
 
-  Scenario: rejected pickle
+  Scenario: rejected pickle from Scenario
     Given a file named "features/a.feature" with:
       """
       Feature: a feature
         Scenario: a scenario
           Given a step
       """
     When I run cucumber-js with all formatters and `--tags @a`
-    Then the "message" formatter output matches the fixture "formatters/rejected-pickle.message.json"
+    Then the "message" formatter output matches the fixture "formatters/rejected-pickle-scenario.message.json"
     Then the "json" formatter output matches the fixture "formatters/rejected-pickle.json"
 
-  Scenario: passed
+  Scenario: passed from Scenario
     Given a file named "features/a.feature" with:
       """
       Feature: a feature
@@ -25,10 +25,28 @@ Feature: Formatters
       Given(/^a step$/, function() {})
       """
     When I run cucumber-js with all formatters
-    Then the "message" formatter output matches the fixture "formatters/passed.message.json"
-    Then the "json" formatter output matches the fixture "formatters/passed.json"
+    Then the "message" formatter output matches the fixture "formatters/passed-scenario.message.json"
+    Then the "json" formatter output matches the fixture "formatters/passed-scenario.json"
 
-  Scenario: failed
+  Scenario: passed from Rule
+    Given a file named "features/a.feature" with:
+      """
+      Feature: a feature
+        Rule: a rule
+          Example: an example
+            Given a step
+      """
+    Given a file named "features/step_definitions/steps.js" with:
+      """
+      const {Given} = require('cucumber')
+
+      Given(/^a step$/, function() {})
+      """
+    When I run cucumber-js with all formatters
+    Then the "message" formatter output matches the fixture "formatters/passed-rule.message.json"
+    Then the "json" formatter output matches the fixture "formatters/passed-rule.json"
+
+  Scenario: failed from Scenario
     Given a file named "features/a.feature" with:
       """
       Feature: a feature
@@ -42,8 +60,8 @@ Feature: Formatters
       Given(/^a step$/, function(callback) { callback(new Error('my error')) })
       """
     When I run cucumber-js with all formatters
-    Then the "message" formatter output matches the fixture "formatters/failed.message.json"
-    Then the "json" formatter output matches the fixture "formatters/failed.json"
+    Then the "message" formatter output matches the fixture "formatters/failed-scenario.message.json"
+    Then the "json" formatter output matches the fixture "formatters/failed-scenario.json"
     And it fails
 
   Scenario: retried and passed