https://github.com/naturalintelligence/cucumon
Gherkin like feature file parser with a dash of lemon
https://github.com/naturalintelligence/cucumon
Last synced: 4 months ago
JSON representation
Gherkin like feature file parser with a dash of lemon
- Host: GitHub
- URL: https://github.com/naturalintelligence/cucumon
- Owner: NaturalIntelligence
- License: mit
- Created: 2020-07-04T13:12:23.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T09:59:09.000Z (almost 2 years ago)
- Last Synced: 2025-04-21T06:08:11.460Z (about 1 year ago)
- Language: JavaScript
- Size: 261 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cucumon
Gherkin like feature file parser with a dash of lemon.
## How to use
```bash
$ npm install cucumon
```
```js
const Cucumon = require("cucumon");
const options = {
tagExpression : "", //@focus
//clubBgSteps : true,
}
const cucumonSlice = new Cucumon(options);
const output = cucumonSlice.parse(featureFileAsString);
```
## Documentation
### Feature file format
Cucumon supports gherkin feature file format.
```feature
@tag @tag2
@tag3
Feature: statement
Description
Rule: some rule
Background: statement
Given some step
Scenario: statment
When some step
Scenario Outline: statement
Then some step
And data table
#> {}
|header||
But doc string
#> json
"""
{ header: "" }
"""
Examples:
|header|
|val|
Rule: Other sub feature
Background: statement
Given some step
Example: statment
When some step
@taghere
Scenario Template: statement
Then some step
Scenarios:
|header|
|val|
```
Note the **instruction statment** `#> {}`. Instruction statments are special comments which can help parser to take some extra steps. Currently, they are supported with scenario, steps, docstring, and data table inputs.
### Result format
```js
{
feature: {
"keyword": "Feature",
"description": "",
"statement": "Special Characters",
"lineNumber": 1,
"tags": [],
rules: [
{
"keyword": "Rule",
"description": "",
"statement": "some rule",
"lineNumber": 2,
"hasBgSection": true,
"background": {
"keyword": "Background",
"statement": "one per rule",
"description": "Background can have description",
"lineNumber": 14,
"id": -1,
"steps": [
{
"keyword": "Given",
"statement": "a string tokenizer",
"lineNumber": 17,
"arg": null
}
]
},
scenarios: [
{
"keyword": "Scenario",
"statement": "normal scenario",
"description": "",
"lineNumber": 3,
"id": 1,
"tags": [],
"steps": [
{
"keyword": "Given",
"statement": "an example",
"lineNumber": 4,
"arg": {
"content": "some docstring",
"type": "DocString",
"lineNumber": 26,
"instruction": "no format; single line;"
}
}
]
},{
"keyword": "Scenario Template",
"statement": "scenario outline",
"description": "",
"lineNumber": 3,
"id": 1,
"tags": ["@wip"],
"expanded" : [
{
"keyword": "Scenario Template",
"statement": "scenario outline",
"description": "",
"lineNumber": 3,
"id": 1,
"steps": [
{
"keyword": "Given",
"statement": "an example",
"lineNumber": 4,
"arg": null
}
],
"tags": [ "@wip", "@examples" ],
"examplesLineNumber": [ 19 ]
}
],
"examples": [
{
"lineNumber": 10,
"rows": [
{
"lineNumber": 11,
"regex": [ {} ],
"cells": [ "data" ]
}, {
"lineNumber": 19,
"cells": [ "" ]
}
],
"instruction": "instruction",
"tags": [ "@examples" ]
}
]
}
]
}
]
}
}
```
### Options
```js
new Cucumon({clubBgSteps: false});
```
You can set `clubBgSteps: true` to club background steps with scenario steps.
Check [sample](test/Inputs.json) parsed response for better idea;
### Additional Features
* Cucumon supports multiple examples
* You can use your own logic to generate scenarios for scenario outline
```feature
Feature: Matrix Outliner
Scenario Template: Matrix example
Given an example
And I can Multiply with
#> matrix: row 1
Examples:
| a |
| 3 |
#> matrix: row 2
Examples:
| b |
| 4 |
```
Note that `#>` is a special statment considered as instruction statement. You'll get it's value as `outline.examples[0].instruction`.
```js
const cucumon = new Cucumon({clubBgSteps: false});
cucumon.registerOutlineExpander((outline) => {});
```
### Other
* Check [bexp](https://github.com/NaturalIntelligence/bexp/) to evaluate tag expression.