www.aleph1.co.uk Git - yaffs-website/blob - vendor/behat/gherkin/README.md

   1 Behat Gherkin Parser
   2 ====================
   3
   4 This is the php Gherkin parser for Behat. It comes bundled with more than 40 native languages
   5 (see `i18n.php`) support & clean architecture.
   6
   7 [![Build Status](https://travis-ci.org/Behat/Gherkin.svg?branch=master)](https://travis-ci.org/Behat/Gherkin)
   8 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Behat/Gherkin/badges/quality-score.png?s=04d9d0237c89f4c45a94ba5304234db861dfd036)](https://scrutinizer-ci.com/g/Behat/Gherkin/)
   9 [![Code Coverage](https://scrutinizer-ci.com/g/Behat/Gherkin/badges/coverage.png?s=204ca44800469d295b73d18c91011cb9d2dc99fc)](https://scrutinizer-ci.com/g/Behat/Gherkin/)
  10
  11 Useful Links
  12 ------------
  13
  14 - Official Google Group is at [http://groups.google.com/group/behat](http://groups.google.com/group/behat)
  15 - IRC channel on [#freenode](http://freenode.net/) is `#behat`
  16 - [Note on Patches/Pull Requests](CONTRIBUTING.md)
  17
  18 Usage Example
  19 -------------
  20
  21 ``` php
  22 <?php
  23
  24 $keywords = new Behat\Gherkin\Keywords\ArrayKeywords(array(
  25     'en' => array(
  26         'feature'          => 'Feature',
  27         'background'       => 'Background',
  28         'scenario'         => 'Scenario',
  29         'scenario_outline' => 'Scenario Outline|Scenario Template',
  30         'examples'         => 'Examples|Scenarios',
  31         'given'            => 'Given',
  32         'when'             => 'When',
  33         'then'             => 'Then',
  34         'and'              => 'And',
  35         'but'              => 'But'
  36     ),
  37     'en-pirate' => array(
  38         'feature'          => 'Ahoy matey!',
  39         'background'       => 'Yo-ho-ho',
  40         'scenario'         => 'Heave to',
  41         'scenario_outline' => 'Shiver me timbers',
  42         'examples'         => 'Dead men tell no tales',
  43         'given'            => 'Gangway!',
  44         'when'             => 'Blimey!',
  45         'then'             => 'Let go and haul',
  46         'and'              => 'Aye',
  47         'but'              => 'Avast!'
  48     )
  49 ));
  50 $lexer  = new Behat\Gherkin\Lexer($keywords);
  51 $parser = new Behat\Gherkin\Parser($lexer);
  52
  53 $feature = $parser->parse(file_get_contents('some.feature'));
  54 ```
  55
  56 Installing Dependencies
  57 -----------------------
  58
  59 ``` bash
  60 $> curl http://getcomposer.org/installer | php
  61 $> php composer.phar update
  62 ```
  63
  64 Contributors
  65 ------------
  66
  67 * Konstantin Kudryashov [everzet](http://github.com/everzet) [lead developer]
  68 * Other [awesome developers](https://github.com/Behat/Gherkin/graphs/contributors)