Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gherking/gpc-replacer
The Replacer precompiler is responsible for exchanging predefined strings in the feature files. It inserts the provided text in the place held for them.
https://github.com/gherking/gpc-replacer
cucumber feature-file gherkin gherking gpc hacktoberfest precompiler typescript
Last synced: 18 days ago
JSON representation
The Replacer precompiler is responsible for exchanging predefined strings in the feature files. It inserts the provided text in the place held for them.
- Host: GitHub
- URL: https://github.com/gherking/gpc-replacer
- Owner: gherking
- License: mit
- Created: 2019-11-03T20:40:20.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T04:30:48.000Z (7 months ago)
- Last Synced: 2024-11-15T22:45:22.402Z (about 2 months ago)
- Topics: cucumber, feature-file, gherkin, gherking, gpc, hacktoberfest, precompiler, typescript
- Language: Gherkin
- Homepage: https://gherking.github.io/gpc-replacer/
- Size: 255 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gpc-replacer
This GherKing Precompiler is responsible to replace keys in feature files with given values.
## Usage
```javascript
'use strict';
const compiler = require('gherking');
const { default: Replacer } = require('gpc-replacer');
let ast = await compiler.load('./features/src/login.feature');
ast = compiler.process(
ast,
new Replacer({
// config
stringToBeReplaced1: "stringToReplaceWith1",
stringToBeReplaced2: "stringToReplaceWith2",
})
);
await compiler.save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
```
```typescript
'use strict';
import {load, process, save} from "gherking";
import Replacer, { ReplacerConfig } from "gpc-replacer";
let ast = await load("./features/src/login.feature");
ast = process(
ast,
new Replacer({
// config
stringToBeReplaced1: "stringToReplaceWith1",
stringToBeReplaced2: "stringToReplaceWith2",
})
);
await save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
```
This Replacer is responsible for exchanging predefined strings in the
feature files. It inserts the provided text in the place held for them.
As an input it needs the feature file to be modified, and a config
json file, which contains the words to be replaced, and the words
to replace them with. It is a regular json, where the keys are the
words need replacing, and their values are the words they will get
replaced by.
In case the config file is not available, or its format is incorrect
the Replacer throws an error.
It replaces strings given in a format `${to_replace}` in the input
feature.
It can find and replace such strings in the textual parts of a
feature file:
* **Document**: comments
* **Feature**: name, description, comments
* **Rule**: name, description, comments
* **Background**: name, description, comments
* **Scenario Outline**: name, decription, comments
* **Scenario**: name, description, comments
* **Step**: text, comment
* **Tag**: name, value, comments
* **Examples**: name, comments
* **Doc String**: content, comment
* **Data Table**, **Table Rows**: cell values, comments
See examples for the input files and an output in the test/data folder.
## Other
This package uses [debug](https://www.npmjs.com/package/debug) for logging, use `gpc:replacer` :
```shell
DEBUG=gpc:replacer* gherking ...
```
For detailed documentation see the [TypeDocs documentation](https://gherking.github.io/gpc-replacer/).