Ghokin 
Ghokin format and apply transformation on gherkin files.
Install
Download the latest binary for your achitecture here.
If you can't find a binary for your architecture, install the go toolchain and run : go get github.com/antham/ghokin.
Usage
Clean and/or apply transformation on gherkin files
Usage:
ghokin [command]
Available Commands:
check Check a file/folder is well formatted
fmt Format a feature file/folder
help Help about any command
Flags:
--config string config file
-h, --help help for ghokin
Use "ghokin [command] --help" for more information about a command.
fmt stdout
Dump a feature file formatted on stdout
ghokin fmt stdout features/test.feature
fmt replace
Format and replace a file or all files in a directory
ghokin fmt replace features/test.feature
or
ghokin fmt replace features/
check
Ensure a file or all files in a directory are well formatted, exit with an error code otherwise
ghokin check features/test.feature
or
ghokin check features/
Documentation
Shell commands
You can run shell commands from within your feature file to transform some datas with annotations, to do so you need first to define in the config an alias and afterwards you can simply "comment" the line before the line you want to transform with that alias. For instance let say @json calls behind the curtain jq, we could validate and format some json in our feature like so :
Feature: A Feature
Description
Scenario: A scenario to test
Given a thing
# @json
"""
{
"test": "test"
}
"""
Config
Defaut config is to use 2 spaces to indent background and scenarios, 4 spaces for steps and 6 for table and docstring; feature description follows table and docstring indentation.
It's possible to override configuration by defining a .ghokin.yml file in the home directory or in the current directory where we are running the binary from :
indent:
backgroundAndScenario: 4
step: 6
tableAndDocString: 8
aliases:
json: "jq ."
Aliases key defined shell commands callable in comments as we discussed earlier.
It's possible to use environments variables instead of a static config file :
export GHOKIN_INDENT_BACKGROUNDANDSCENARIO=4
export GHOKIN_INDENT_STEP=6
export GHOKIN_INDENT_TABLEANDDOCSTRING=8
export GHOKIN_ALIASES='{"json":"jq ."}'
Setup
Download from release page according to your architecture ghokin binary : https://github.com/antham/ghokin/releases
Contribute
If you want to add a new feature to ghokin project, the best way is to open a ticket first to know exactly how to implement your changes in code.
Setup
After cloning the repository you need to install vendors with go mod vendor To test your changes locally you can run go tests with : make test-all
