Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gherking/gpc-filter
The Filter precompiler is responsible for including or excluding the elements of a feature file in the result, which match a cucumber-tag-expression (e.g., has a given tag, does not have a given tag)
https://github.com/gherking/gpc-filter
cucumber feature-file gherkin gherking gpc hacktoberfest precompiler typescript
Last synced: 18 days ago
JSON representation
The Filter precompiler is responsible for including or excluding the elements of a feature file in the result, which match a cucumber-tag-expression (e.g., has a given tag, does not have a given tag)
- Host: GitHub
- URL: https://github.com/gherking/gpc-filter
- Owner: gherking
- License: mit
- Created: 2022-02-13T10:38:58.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T04:29:46.000Z (7 months ago)
- Last Synced: 2024-11-14T14:21:54.594Z (about 2 months ago)
- Topics: cucumber, feature-file, gherkin, gherking, gpc, hacktoberfest, precompiler, typescript
- Language: Gherkin
- Homepage: https://gherking.github.io/gpc-filter/
- Size: 679 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gpc-filter
The Filter precompiler is responsible for including or excluding the elements of a feature file in the result, which match a cucumber-tag-expression (e.g., has a given tag, does not have a given tag)
## Usage
```javascript
'use strict';
const compiler = require('gherking');
const Filter = require('gpc-filter');
let ast = await compiler.load('./features/src/login.feature');
ast = compiler.process(
ast,
new Filter({
// config
})
);
await compiler.save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
```
```typescript
'use strict';
import {load, process, save} from "gherking";
import Filter = require("gpc-filter");
let ast = await load("./features/src/login.feature");
ast = process(
ast,
new Filter({
// config
})
);
await save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
```
## Configuration
The precompiler accepts the following configuration:
| Type | Description | Necessity | Default value |
|:----:|:------------|:----------|:--------------|
| `string` | Cucumber-tag-expression the filtering is based on | Optional | `not @wip` |
## Example
Keeping elements with @current tag
new Filter("@current")
```@wip
Scenario: One tag
Given A scenario with one tag is created
When this Scenario is compiled
Then something should happen
@current
Scenario: Another tag
Given A scenario with another tag is created
When this Scenario is compiled
Then something should happen
Scenario Outline: Multiple tags in multiple examples
Given A scenarioOutline with tags in multiple examples is created
When this Scenario Outline is compiled
Then something should happen
Examples:
| multiple examples no tag column |
| multiple examples no tag row |
@wip
Examples:
| multiple examples one tag column |
| multiple examples one tag row |
@current
Examples:
| multiple examples other tag column |
| multiple examples other tag row |
```
Will be processed into:
```
@current
Scenario: Another tag
Given A scenario with another tag is created
When this Scenario is compiled
Then something should happen
Scenario Outline: Multiple tags in multiple examples
Given A scenarioOutline with tags in multiple examples is created
When this Scenario Outline is compiled
Then something should happen
@current
Examples:
| multiple examples other tag column |
| multiple examples other tag row |
```
## Other
This package uses [debug](https://www.npmjs.com/package/debug) for logging, use `gpc:filter` :
```shell
DEBUG=gpc:filter* gherking ...
```
For detailed documentation see the [TypeDocs documentation](https://gherking.github.io/gpc-filter/).