Skip to content

Commit

Permalink
docs: add link to and fix custom formatters doc
Browse files Browse the repository at this point in the history
  • Loading branch information
charlierudolph committed Dec 22, 2016
1 parent 416d081 commit 8430b21
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -47,6 +47,7 @@ $ npm install cucumber
## Documentation

* [CLI](/docs/cli.md)
* [Custom Formatters](/docs/custom_formatters.md)
* [NodeJs Example](/docs/nodejs_example.md)
* Support Files
* [World](/docs/support_files/world.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/custom_formatter.md → docs/custom_formatters.md
Expand Up @@ -2,7 +2,7 @@

Custom formatters should be a javascript class. The constructor will be an options object which is the options defined with `--format-options` and the following:

* `colorFns`: a series of helper functions for outputting colors. See [here](/src/formatters/get_color_fns). Respects `colorsEnabled` option
* `colorFns`: a series of helper functions for outputting colors. See [here](/src/formatter/get_color_fns.js). Respects `colorsEnabled` option
* `cwd`: the current working directory
* `log`: function which will write the passed string to the the designated stream (stdout or the to file the formatter output is being redirected to).
* `snippetBuilder`: an object with a `build` method that should be called with a [step](/src/models/step.js) to get the snippet for an undefined step
Expand Down

0 comments on commit 8430b21

Please sign in to comment.