Skip to content
Cucumber Feature Reports Made Easy
JavaScript Gherkin HTML CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update CODEOWNERS Jun 17, 2019
docs initial import Jun 14, 2019
features
src chore: Upgrade to latest dependency versions (#18) Aug 14, 2019
.eslintrc chore: Upgrade to latest dependency versions (#18) Aug 14, 2019
.gitignore initial import Jun 14, 2019
.travis.yml chore: Upgrade to latest dependency versions (#18) Aug 14, 2019
CODE_OF_CONDUCT.md initial import Jun 14, 2019
CONTRIBUTING.md initial import Jun 14, 2019
CONTRIBUTORS.md Fix Generator so Gherkin comments are not included in report (#10) Jul 3, 2019
LICENSE initial import Jun 14, 2019
NOTICE initial import Jun 14, 2019
README.md chore: Setup travis build to publish tags to NPM (#12) Aug 2, 2019
RELEASE.md chore: Upgrade to latest dependency versions (#18) Aug 14, 2019
logo.png initial import Jun 14, 2019
package-lock.json chore: Upgrade to latest dependency versions (#18) Aug 14, 2019
package.json chore: Upgrade to latest dependency versions (#18) Aug 14, 2019

README.md

Cucumber Forge Report Generator

Cerner OSS License Build Status

About

Note: this repository contains the library for generating Cucumber reports. Cucumber Forge Desktop is a user-friendly desktop application for creating reports with cucumber-forge-report-generator.

The cucumber-forge-report-generator can be used to create clean HTML reports without having to build the project or run the tests. Of course, no pass/fail information for the scenarios is included in the report since the tests are not executed.

Many other solutions exist for creating reports based on the output of Cucumber test runs. The goal of cucumber-forge-report-generator is to create reports directly from the feature files without any of the environment/runtime overhead required to build projects and run the Cucumber tests.

Usage

Sample - Generates a report from two feature files with the scenarios filtered by a tag:

const Generator = require('cucumber-forge-report-generator');
const generator = new Generator();
const htmlReportString = generator.generate([filePathString1, filePathString2], 'Project Name', 'TagFilter');

Detailed usage documentation can be found here.

Availability

Artifacts can be downloaded from the latest release.

This library can be added as an NPM dependency via npm i -S cucumber-forge-report-generator

This project is built on Travis.

Building

Development Environment:

To build the project, simply run npm install from the project directory.

Linting is available and can be run via npm lint.

To execute the automated tests, simply run npm test from the project directory.

Conventions

The project extends the eslint-config-airbnb ESLint configuration. This provides formatting standards for breaks, line length, declarations, etc.

Tests for the project are written with cucumber-js

Communication

If you have any issues or questions, please log a Github issue for this repository. See our contribution guidelines for tips on how to submit a helpful issue.

Contributing

See CONTRIBUTING.md

LICENSE

Copyright 2019 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.