https://github.com/funkwerk/gherkin_readability

Determine readability of gherkin files
https://github.com/funkwerk/gherkin_readability

cucumber feature gherkin readability

Last synced: 2 months ago
JSON representation

Determine readability of gherkin files

• Host: GitHub
• URL: https://github.com/funkwerk/gherkin_readability
• Owner: funkwerk
• License: mit
• Created: 2015-10-31T10:17:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-12T20:04:51.000Z (over 8 years ago)
• Last Synced: 2025-04-12T03:37:33.414Z (3 months ago)
• Topics: cucumber, feature, gherkin, readability
• Language: Ruby
• Size: 12.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Check Readability of Gherkin Files

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

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

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

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

This tool checks the readability of gherkin files.

## Usage

run `gherkin_readability` on a list of files

    gherkin_readability FEATURE_FILES

### Usage with Docker

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

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

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

## Installation

Install it with:

`sudo gem install gherkin_readability`

After that `gherkin_readability` executable is available.