gherkin-precompiler
Advanced tools
Simple pre-compiler for Gherkin feature files.
It is based on the AST what is provided by gherkin-assembler.
'use strict';
const compiler = require('gherkin-precompiler');
let ast = compiler.load('./features/src/login.feature');
ast = compiler.process(
ast,
new compiler.builtIn.Replacer({
name: 'Hello'
})
);
compiler.save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
The package provides a command line interface to be able to easily precompile feature files.
# install package globally
npm install -g gherkin-precompiler
# use precompile or gherkin-precompiler commands
precompile --config precompiler.json --base e2e/features/src --destination e2e/features/dist
| Argument | Description | Example |
|---|---|---|
--config-c | Mandatory, The location of the configuration which contains the precompiler configuration and could contain all the other configuration options as well. | precompiler.json |
--source-s | The source glob pattern or a folder path where the source feature files are located. | e2e/features/src/**/*.feature |
--base-b | The base directory or the feature files/precompile process. The location in the desctination directory of each precompiled feature file is determined by the base directory. | e2e/features/src |
--destination-d | The destination directory where the precompiled feature files should be stored. | e2e/features/dist |
--verbose | If set, precompiler prints out the final configuration and the status of the process. | |
--help | If set, no precompile process is applied, only the usage guidelines are printed out. |
config is a mandatory option, since that is the only way to specify the precompilersbase: "e2e/features" set, then source will be e2e/features/**/*.feature and destination will be e2e/features/distsource directory is set, then base will be the source directory, destination will be {source}/dist and source will be modified to a glob pattern: {source}/**/*.featureThe configuration must contain the precompilers configuration and optionally all options which could be specified by command line arguments. It can be a JSON file of a JS file
// precompiler.json
{
// compilers should be an array of precompiler configurations
"compilers": [
// one option is to set built-in precompilers,
{
// by setting the type of it
"type": "Replacer",
// any by setting the configuration which
// is passed to the constructor
"configuration": {
"user": "ta.user1@example.com"
}
},
// other option is to set precompiler object
{
// by setting the path to the JS file
"path": "e2e/utils/myCompiler.js"
}
],
// source can also be set here
"source": "e2e/features/src/**/*.feature",
// base can also be set here
"base": "e2e/features/src",
// destination can also be set here
"destination": "e2e/features/dist"
}
//gulpfile.js
//...
const gulpCompiler = require('gherkin-precompiler/gulp');
const compiler = require('gherkin-precompiler');
const compilers = [
new compiler.builtIn.Replacer({
name: 'Hello'
})
];
const compilerFormat = {
lineBreak: '\r\n'
};
gulp.task('precompile', () => {
return gulp.src('./features/**/*.feature')
.pipe(gulpCompiler(compilers, compilerFormat))
.pipe(gulp.dest('./dist/features'));
});
loadIt loads the given feature file to a GherkinDocument.
Params:
{string} pathToFile - the path of the feature file which needs to be loadedReturns: {GherkinDocument} the AST of the given feature file
saveSaves the given AST ast feature file to the given path.
Params:
{string} pathToFile - the path of the feature file where the AST needs to be saved{GherkinDocument} ast - the AST needs to be saved to the file{AssemblerConfig} [options] - configuration of formatting, see AssemblerConfigprocessApplies the given pre-compilers to the given AST.
Params:
{GherkinDocument} ast - the AST needs to be processed{...DefaultConfig|Object} pre-compilers - the pre-compilers needs to be applied to the given ASTReturns: {GherkinDocument} the processed AST
formatFormats the given GherkinDocument to text.
Equivalent of gherkin-assembler's format method. See API here.
If you want to create own pre-compiler, you only have to extends the Default class and override the filter and/or event methods, that you want to use; or create and object with the desired methods.
Every element can be modified by using it's correspondent event methods.
All event methods (except onFeature) receives the given element, it's parent and - if applicable - the index of the element.
Given that all event receives the given element as an Object, those can be easily modified by modifying the object itself.
If you return
null, then the given element will be deletedThe following methods are available, to see exact signature of the given method, click on the name of it:
Every element list in the AST can be filtered by using it's correspondent pre- or post filter methods. A pre filter methods is applied before the processing of the event, the post applied after it.
All filter methods receives the given element, it's parent and the index of the element.
If the methods returns false the given element will be excluded from the final list, otherwise not.
The following methods are available, to see exact signature of the given method, click on the name of it:
(gherkin-precompiler) 1.3.0 - 2018-04-19
FAQs
Simple pre-compiler for Gherkin feature files
We found that gherkin-precompiler demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious PyPI package ‘set-utils’ steals Ethereum private keys by exfiltrating them through blockchain transactions via the Polygon RPC.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.