behat/gherkin

Gherkin DSL parser for PHP

v4.11.0 2024-12-06 10:07 UTC

Requires

• php: 8.1.* || 8.2.* || 8.3.* || 8.4.*

Requires (Dev)

• cucumber/cucumber: dev-gherkin-24.1.0
• phpunit/phpunit: ^9.6
• symfony/yaml: ^5.4 || ^6.4 || ^7.0

Suggests

• symfony/yaml: If you want to parse features, represented in YAML files

MIT

• Konstantin Kudryashov

• BDD
• parser
• DSL
• Behat
• gherkin
• Cucumber

README

This is the php Gherkin parser for Behat. It comes bundled with more than 40 native languages (see i18n.php) support and clean architecture.

Useful Links

• Behat Site
• Note on Patches/Pull Requests

Usage Example

<?php

$keywords = new Behat\Gherkin\Keywords\ArrayKeywords(array(
    'en' => array(
        'feature'          => 'Feature',
        'background'       => 'Background',
        'scenario'         => 'Scenario',
        'scenario_outline' => 'Scenario Outline|Scenario Template',
        'examples'         => 'Examples|Scenarios',
        'given'            => 'Given',
        'when'             => 'When',
        'then'             => 'Then',
        'and'              => 'And',
        'but'              => 'But'
    ),
    'en-pirate' => array(
        'feature'          => 'Ahoy matey!',
        'background'       => 'Yo-ho-ho',
        'scenario'         => 'Heave to',
        'scenario_outline' => 'Shiver me timbers',
        'examples'         => 'Dead men tell no tales',
        'given'            => 'Gangway!',
        'when'             => 'Blimey!',
        'then'             => 'Let go and haul',
        'and'              => 'Aye',
        'but'              => 'Avast!'
    )
));
$lexer  = new Behat\Gherkin\Lexer($keywords);
$parser = new Behat\Gherkin\Parser($lexer);

$feature = $parser->parse(file_get_contents('some.feature'));

Installing Dependencies

curl https://getcomposer.org/installer | php
php composer.phar update

Contributors

• Konstantin Kudryashov everzet [lead developer]
• Other awesome developers