gherkin-io

!Downloads
!Version@npm
!Version@git
!CI
!Docs

Tool to read/write Gherkin feature files and work with Gherking AST

Usage

$3

The parse function can be used to parse feature file content to AST.

``typescript
function parse(content: string, uri: string): Promise
`

In TypeScript:

`typescript
import {parse, Document} from "gherkin-io";
import {TagFormat} from "gherkin-ast";

const document: Document = await parse(
"Feature: Test\n...",
"./features/test.feature",
{tagFormat: TagFormat.FUNCTIONAL} // default
);
`

In JavaScript:
`javascript
const {parse} = require("gherkin-io");
const {TagFormat} = require("gherkin-ast");
const document = await read(
"Feature: Test\n...",
"./features/test.feature",
{tagFormat: TagFormat.FUNCTIONAL} // default
);
`

$3

The read function can be used to parse feature file(s) to AST.

`typescript
function read(pattern: string): Promise
`

In TypeScript:
`typescript
import {read, Document} from "gherkin-io";
import {TagFormat} from "gherkin-ast";

const documents: Document[] = await read(
"./features/*.feature",
{tagFormat: TagFormat.FUNCTIONAL} // default
);
`

In JavaScript:
`javascript
const {read} = require("gherkin-io");
const {TagFormat} = require("gherkin-ast");
const documents = await read(
"./features/*.feature",
{tagFormat: TagFormat.FUNCTIONAL} // default
);
`

$3

The write function can be used to write an AST to a feature file.

`typescript
function write(filePath: string, document: Document, options?: FormatterOptions): Promise
`

In TypeScript:
`typescript
import {Document, write, FormatterOptions} from "gherkin-io";
const document: Document = new Document(/.../);
const options: FormatterOptions = {/.../};
await write("./test.feature", document, options);
`

In JavaScript:
`javascript
const {write, Document} = require("gherkin-io");
const document = new Document(/.../);
const options = {/.../};
await write("./test.feature", document, options);
`

FormatterOptions` is re-exported from gherkin-formatter.

For detailed documentation see the TypeDocs documentation.