malukenho/kawaii-gherkin

A small library to check and fix annoying gherkin code style

1.0.0 2024-07-03 14:57 UTC

Requires

• php: ^8.0
• behat/gherkin: >=4.9
• sebastian/diff: >=6.0
• symfony/console: >=7.0
• symfony/finder: >=7.0

Requires (Dev)

• phpunit/phpunit: >=4.0

MIT

• Jefersson Nathan

• gherkin
• Code style
• code standard

README

Kawaii Gherkin is a small tool to fix and verify gherkin code style.

Installing

$ composer require --dev malukenho/kawaii-gherkin

Analyzing code

To analyze code style, simple run:

$ vendor/bin/kawaii gherkin:check [--align [right|left]] <directory>

Fixing code

To fix code style, simple run:

$ vendor/bin/kawaii gherkin:fix [--align [right|left]] <directory>

Example

Before

 @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 |
                          | [e-mail] | foo1sasdasdasdadsasd     |
             And the following customers exist:
                         | email              |
                 | [e-mail] |
             And the following zones are defined:
                        | name         | type    | members |
                         | Poland       | country | Poland  |
             And the following orders exist:
                 | customer                | address                                        |
                 | [e-mail]      | Jan Kowalski, Wawel 5 , 31-001, Kraków, Poland |

After

@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             |
            | [e-mail] | foo1sasdasdasdadsasd |
          And the following customers exist:
            | email              |
            | [e-mail] |
          And the following zones are defined:
            | name   | type    | members |
            | Poland | country | Poland  |
          And the following orders exist:
            | customer           | address                                        |
            | [e-mail] | Jan Kowalski, Wawel 5 , 31-001, Kraków, Poland |

Author

• Jefersson Nathan (@malukenho)