https://github.com/cucumber/html-formatter

HTML formatter for reporting Cucumber results
https://github.com/cucumber/html-formatter

bdd cucumber java javascript polyglot-release ruby tidelift

Last synced: 29 days ago
JSON representation

HTML formatter for reporting Cucumber results

• Host: GitHub
• URL: https://github.com/cucumber/html-formatter
• Owner: cucumber
• License: mit
• Created: 2019-10-21T13:50:58.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T13:55:08.000Z (7 months ago)
• Last Synced: 2024-04-14T02:29:19.412Z (7 months ago)
• Topics: bdd, cucumber, java, javascript, polyglot-release, ruby, tidelift
• Language: Java
• Homepage: https://cucumber.io/
• Size: 3.61 MB
• Stars: 12
• Watchers: 78
• Forks: 4
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cucumber HTML Formatter

This is a cross-platform formatter that produces a pretty HTML report for Cucumber runs.

It is built on top of [@cucumber/react-components](https://github.com/cucumber/react-components) and works with *any*

Cucumber implementation with a `message` formatter that outputs [cucumber messages](https://github.com/cucumber/common/tree/main/messages).

This formatter is built into the following Cucumber implementations:

* [cucumber-ruby](https://github.com/cucumber/cucumber-ruby/blob/main/lib/cucumber/formatter/html.rb)

* [cucumber-jvm](https://github.com/cucumber/cucumber-jvm/blob/main/core/src/main/java/io/cucumber/core/plugin/HtmlFormatter.java)

* [cucumber-js](https://github.com/cucumber/cucumber-js/blob/main/src/formatter/html_formatter.ts)

## Contributing

The Java and Ruby packages are wrappers that bundle the build artefacts from the Javascript package.

Thus, to work on either the Java or Ruby packages, you will need to have installed Node.js first.

Once you have Node.js installed, you can use:

    make prepare

This will build the Javascript package and copy the required artifacts to the Java and Ruby packages.