Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedrotroller/kawaii
A Kawaii and small tool to fix and validate gherkin code styles.
https://github.com/pedrotroller/kawaii
behat cucumber feature formatting gherkin
Last synced: 6 days ago
JSON representation
A Kawaii and small tool to fix and validate gherkin code styles.
- Host: GitHub
- URL: https://github.com/pedrotroller/kawaii
- Owner: PedroTroller
- Fork: true (malukenho/kawaii-gherkin)
- Created: 2021-07-23T09:18:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-23T15:15:51.000Z (about 2 years ago)
- Last Synced: 2024-09-30T07:08:11.906Z (4 months ago)
- Topics: behat, cucumber, feature, formatting, gherkin
- Language: PHP
- Homepage: https://github.com/PedroTroller/kawaii
- Size: 112 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Kawaii - Gherkin Formatter
==========================
*This package is a fork of the awesome [malukenho/kawaii-gerkin](https://github.com/malukenho/kawaii-gherkin) package made by Jefersson NATHAN ([@malukenho](http://github.com/malukenho)).*
**Kawaii** is a small tool to fix and verify gherkin code style.
### Installing
```sh
$ composer require --dev pedrotroller/kawaii
```
### Analyzing code
To analyze code style, simple run:
```sh
$ vendor/bin/kawaii check [--align [right|left]]
```
### Fixing code
To fix code style, simple run:
```sh
$ vendor/bin/kawaii fix [--align [right|left]]
```
# Example
### Before
```gherkin
@users
@another-feature
@kawaii
Feature: User registration
In order to order products
As a visitor
I need to be able to create an account in the store
Background: Nice Background
Given store has default configuration
And there are following users:
| email | password |
| [email protected] | foo1sasdasdasdadsasd |
And the following customers exist:
| email |
| [email protected] |
And the following zones are defined:
| name | type | members |
| Poland | country | Poland |
And the following orders exist:
| customer | address |
| [email protected] | Jan Kowalski, Wawel 5 , 31-001, Kraków, Poland |
```
### After
```gherkin
@users @another-feature @kawaii
Feature: User registration
In order to order products
As a visitor
I need to be able to create an account in the store
Background: Nice Background
Given store has default configuration
And there are following users:
| email | password |
| [email protected] | foo1sasdasdasdadsasd |
And the following customers exist:
| email |
| [email protected] |
And the following zones are defined:
| name | type | members |
| Poland | country | Poland |
And the following orders exist:
| customer | address |
| [email protected] | Jan Kowalski, Wawel 5 , 31-001, Kraków, Poland |
```
### Maintainer
- Pierre PLAZANET ([@pedrotroller](http://github.com/pedrotroller))