Cypress Basic Reporter

Cypress Basic Reporter is a custom reporter for Cypress that generates JSON reports and a user-friendly HTML report for your Cypress test results.

Features

• Generates JSON reports for each test run
• Combines multiple JSON reports into a single consolidated report
• Provides a visually appealing HTML report with charts and statistics
• Customizable report title through the reportConfig.json file
• Easy to integrate with your Cypress test suite

Installation

Simply run this command in your terminal:

npm install cypress-basic-reporter

Configuration

1. Add the following code to your package.json file.

"scripts": {
    // Existing scripts
    "combine:reports": "node ./node_modules/cypress-basic-reporter/bin/combine-files.js"
  },

2. Added the following code to your cypress.config.js file within the setupNodeEvents(on, config) section.

on("task", {
  writeFile({ filePath, data }) {
    return writeFile(filePath, data);
  },
});

3. Add the following code to your e2e.js file within your support folder.

const { reporter } = require("../../../reporter");

reporter(({ filePath, allTestResults }) => {
  cy.task("writeFile", { filePath: filePath, data: allTestResults });
});

after(() => {});

4. Run your tests as normal.

Usage

After running at least one test, you may create the report data.

From the terminal, simply run:

npm run combine:reports

This will generate a consolidated report named allReports.json in the reports/finalReports directory.

Local Report Viewing

To view the HTML report locally:

1. Find the report.html inside your root/reports/finalReports directory.
2. Open report.html with the Live Server extension.

Customization

If you would like to customize the report title:

1. Find the reportConfig.json file in your root/reports/finalReports directory.
2. Update the JSON key-value pair for reportTitle

{
    "reportTitle": "My Custom Report Name"
}
``
The default report title is "Cypress Report" if not specified in the reportConfig.json file.


# Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

# License

This package is licensed under the MIT License.