| 1 | 🚨🚨🚨
|
| 2 |
|
| 3 | Cucumber is publishing new releases under `@cucumber/cucumber` on npm:
|
| 4 | <https://www.npmjs.com/package/@cucumber/cucumber>
|
| 5 |
|
| 6 | Features in the latest version include:
|
| 7 | - `BeforeEach` and `AfterEach` hooks
|
| 8 | - Searchable HTML reports
|
| 9 | - Native ESM support
|
| 10 | - Write scenarios in Markdown
|
| 11 |
|
| 12 | Full changelog: https://github.com/cucumber/cucumber-js/blob/main/CHANGELOG.md
|
| 13 | Upgrading guide: https://github.com/cucumber/cucumber-js/blob/main/UPGRADING.md
|
| 14 |
|
| 15 | 🚨🚨🚨
|
| 16 |
|
| 17 | # Cucumber
|
| 18 |
|
| 19 | [Cucumber](https://cucumber.io) is a tool for running automated tests written in plain language. Because they're
|
| 20 | written in plain language, they can be read by anyone on your team. Because they can be
|
| 21 | read by anyone, you can use them to help improve communication, collaboration and trust on
|
| 22 | your team.
|
| 23 |
|
| 24 | Cucumber.js is the JavaScript implementation of Cucumber and runs on the [maintained Node.js versions](https://github.com/nodejs/Release) and *modern* web browsers.
|
| 25 |
|
| 26 | ## Help & support
|
| 27 |
|
| 28 | * See here: https://cucumber.io/support
|
| 29 |
|
| 30 | ## Contributing
|
| 31 |
|
| 32 | See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.js.
|
| 33 |
|
| 34 | ## Code of Conduct
|
| 35 |
|
| 36 | Everyone interacting in this codebase and issue tracker is expected to follow the Cucumber [code of conduct](https://github.com/cucumber/cucumber/blob/master/CODE_OF_CONDUCT.md).
|
| 37 |
|
| 38 | ## Install
|
| 39 |
|
| 40 | [](http://npm-stat.com/charts.html?package=cucumber&from=2015-09-01)
|
| 41 |
|
| 42 |
|
| 43 | ### Node
|
| 44 |
|
| 45 | Cucumber.js is available as an npm module.
|
| 46 |
|
| 47 | ``` shell
|
| 48 | $ npm install cucumber
|
| 49 | ```
|
| 50 |
|
| 51 | ### Browser
|
| 52 |
|
| 53 | * Grab the browserified code from the latest release in the [dist](/dist) folder
|
| 54 |
|
| 55 | ## Documentation
|
| 56 |
|
| 57 | The following documentation is for master. See below for documentation for older versions.
|
| 58 |
|
| 59 | * [CLI](/docs/cli.md)
|
| 60 | * [Custom Formatters](/docs/custom_formatters.md)
|
| 61 | * [Custom Snippet Syntaxes](/docs/custom_snippet_syntaxes.md)
|
| 62 | * [NodeJs Example](/docs/nodejs_example.md)
|
| 63 | * Support Files
|
| 64 | * [World](/docs/support_files/world.md)
|
| 65 | * [Step Definitions](/docs/support_files/step_definitions.md)
|
| 66 | * [Hooks](/docs/support_files/hooks.md)
|
| 67 | * [Timeouts](docs/support_files/timeouts.md)
|
| 68 | * [Data Table Interface](/docs/support_files/data_table_interface.md)
|
| 69 | * [Attachments](/docs/support_files/attachments.md)
|
| 70 | * [API Reference](/docs/support_files/api_reference.md)
|
| 71 | * [FAQ](/docs/faq.md)
|
| 72 |
|
| 73 | #### Documentation for older versions
|
| 74 |
|
| 75 | * [`5.x`](https://github.com/cucumber/cucumber-js/tree/5.x)
|
| 76 | * [`4.x`](https://github.com/cucumber/cucumber-js/tree/4.x)
|
| 77 | * [`3.x`](https://github.com/cucumber/cucumber-js/tree/3.x)
|
| 78 | * [`2.x`](https://github.com/cucumber/cucumber-js/tree/2.x)
|
| 79 | * [`1.x`](https://github.com/cucumber/cucumber-js/tree/1.x)
|