README.md
# Reformat-gherkin
[](https://github.com/ducminh-phan/reformat-gherkin/actions/workflows/test.yml)
[](https://coveralls.io/github/ducminh-phan/reformat-gherkin?branch=master)
[](https://codeclimate.com/github/ducminh-phan/reformat-gherkin/maintainability)
[](https://www.codacy.com/app/ducminh-phan/reformat-gherkin)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/reformat-gherkin/)
[](https://github.com/python/black)
## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Usage](#usage)
- [Version control integration](#version-control-integration)
- [Acknowledgements](#acknowledgements)
## About
Reformat-gherkin automatically formats Gherkin files. It ensures a consistent
look regardless of who wrote the file.
It can be used either as a command-line tool, or a
[pre-commit](https://pre-commit.com/) hook.
## Installation
Install reformat-gherkin using [pip](https://pypi.org/project/pip/).
```bash
pip install reformat-gherkin
```
It requires [Python 3.7+](https://www.python.org/downloads/) to run.
## Usage
To get started straight away:
```bash
reformat-gherkin {source_file_or_directory}
```
You should get good results without specifying any options, as reformat-gherkin
uses sensible defaults.
### Command-line options
You can list the available options by running `reformat-gherkin --help`.
```text
Usage: reformat-gherkin [OPTIONS] [SRC]...
Reformat the given SRC files and all .feature files in SRC folders. If -
is passed as a file, reformat stdin and print the result to stdout.
Options:
--check Don't write the files back, just return the
status. Return code 0 means nothing would
change. Return code 1 means some files would
be reformatted. Return code 123 means there
was an internal error.
-a, --alignment [left|right] Specify the alignment of step keywords
(Given, When, Then,...). If specified, all
statements after step keywords are left-
aligned, spaces are inserted before/after
the keywords to right/left align them. By
default, step keywords are left-aligned, and
there is a single space between the step
keyword and the statement.
-n, --newline [LF|CRLF] Specify the line separators when formatting
files inplace. If not specified, line
separators are preserved.
--fast / --safe If --fast given, skip the sanity checks of
file contents. [default: --safe]
--single-line-tags / --multi-line-tags
If --single-line-tags given, output
consecutive tags on one line. If --multi-
line-tags given, output one tag per line.
[default: --single-line-tags]
--tab-width INTEGER Specify the number of spaces per
indentation-level. [default: 2]
--use-tabs Indent lines with tabs instead of spaces.
--config FILE Read configuration from FILE.
--version Show the version and exit.
--help Show this message and exit.
```
Reformat-gherkin is a well-behaved Unix-style command-line tool:
- it does nothing if no sources are passed to it;
- it will read from standard input and write to standard output if - is used as the filename;
- it only outputs messages to users on standard error;
- it exits with code 0 unless an internal error occurred (or --check was used).
### Config file
Reformat-gherkin can read project-specific default values for its command line
options from a `.reformat-gherkin.yaml` file.
By default, `reformat-gherkin` looks for the config file starting from the
common base directory of all files and directories passed on the command line.
If it's not there, it looks in parent directories. It stops looking when it
finds the file, or a .git directory, or a .hg directory, or the root of the file
system, whichever comes first.
Example config file:
```yaml
check: False
alignment: left
tab_width: 4
```
## Version control integration
You can integrate reformat-gherkin into your version control workflow by using
[pre-commit](https://pre-commit.com/). Once you have installed pre-commit, add
this to the `.pre-commit-config.yaml` file in your repository:
```text
repos:
- repo: https://github.com/ducminh-phan/reformat-gherkin
rev: stable
hooks:
- id: reformat-gherkin
```
Then run `pre-commit install` and you're ready to go.
## Acknowledgements
This project is inspired by [black](https://github.com/psf/black). Some
functions are taken from `black`'s source code.