gherkin-parser

Parse gherkin feature files.

Installation

$ npm install gherkin-parser

Usage

const gherkin = require('gherkin-parser')
const fs = require('fs')
 
fs.createReadStream('some-gherkin-file.feature')
  .pipe(gherkin())
  .pipe(process.stdout)

The parser turns cucumber files into AST. An example:

Feature: Can drink beer when thirsty
  As a drinker
  I want to take beer off the wall
  In order to satisfy my thirst
 
  Scenario: Can take a single beer
    Given 100 bottles of beer on the wall
    When a bottle is taken down
    Then there are 99 bottles of beer on the wall

[
  {
    feature: 'Can drink beer when thirsty',
    perspective: 'drinker',
    desire: 'to take beer off the wall',
    reason: 'to satisfy my thirst',
    scenarios: [
      {
        scenario: 'Can take a single beer',
        given: [
          '100 bottles of beer on the wall'
        ],
        when: [
          'a bottle is taken down'
        ],
        then: [
          'there are 99 bottles of beer on the wall'
        ]
      }
    ]
  }
]

API

transformStream = gherkin()

Create a gherkin transform stream. Transforms gherkin .feature files into an AST object.

See Also

• gherk.js

License

MIT