https://github.com/funkwerk/gherkin_format

Format Gherkin Files
https://github.com/funkwerk/gherkin_format

cucumber format gherkin template

Last synced: about 1 month ago
JSON representation

Format Gherkin Files

• Host: GitHub
• URL: https://github.com/funkwerk/gherkin_format
• Owner: funkwerk
• License: mit
• Created: 2015-05-18T10:04:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-09-10T17:20:55.000Z (over 6 years ago)
• Last Synced: 2024-10-07T14:06:28.679Z (3 months ago)
• Topics: cucumber, format, gherkin, template
• Language: Gherkin
• Size: 19.5 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Formatter for Gherkin Files

[![Build Status](https://travis-ci.org/funkwerk/gherkin_format.svg)](https://travis-ci.org/funkwerk/gherkin_format)

[![Docker Build](https://img.shields.io/docker/automated/gherkin/format.svg)](https://hub.docker.com/r/gherkin/format/)

[![Downloads](https://img.shields.io/gem/dt/gherkin_format.svg)](https://rubygems.org/gems/gherkin_format)

[![Latest Tag](https://img.shields.io/github/tag/funkwerk/gherkin_format.svg)](https://rubygems.org/gems/gherkin_format)

This tool formats gherkin files.

## Usage

run `gherkin_format` on a list of files

    gherkin_format FEATURE_FILES

To replace files with their formatted counterpart add the option `--replace`.

To get detailed information in case of errors use `--verbose`.

To format gherkin files using a custom format, it's possible to specify a template using `--template TEMPLATE`.

The template provided is a erb-template.

These templates are predefined:

 - markdown

 - multi_markdown

### Usage with Docker

Assuming there are feature files in the current directory. Then call.

`docker run -ti -v $(pwd):/src -w /src gherkin/format *.feature`

This will mount the current directory within the Gherkin Format Docker Container and then check all feature files.

## Installation

Install it with:

`sudo gem install gherkin_format`

After that `gherkin_format` executable is available.