npmpackage.info

Gathering detailed insights and metrics for cypress-mochawesome-reporter

Other packages similar to cypress-mochawesome-reporter

cypress-slack-reporter

1.5.4

A slack reporter for mochawesome reports generated by Cypress or other test frameworks using Mocha, for runs generated on CircleCI

mochawesome

7.1.3

A gorgeous reporter for Mocha.js

mochawesome-report-generator

6.2.0

Generates gorgeous HTML reports from mochawesome reporter.

mochawesome-screenshots

1.7.3

A Gorgeous HTML/CSS Reporter for Mocha.js

Gathering detailed insights and metrics for cypress-mochawesome-reporter

cypress-mochawesome-reporter

Zero config Mochawesome reporter for Cypress with screenshots and videos

3.8.2

164

MIT

JavaScript

28,795,189 4.9

Installations

npm install cypress-mochawesome-reporter

Pull Requests

Open

0

Total

91

Closed

13

Merged

78

Issues

Open

7

Total

100

Closed

93

Releases

v3.8.3

Published on 12 Jul 2024

v3.8.2

Published on 22 Feb 2024

v3.8.1

Published on 26 Jan 2024

v3.8.0

Published on 29 Dec 2023

v3.7.0

Published on 17 Nov 2023

v3.6.1

Published on 10 Oct 2023

View all 34 releases

Developer

LironEr

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=14

Typescript Support

Yes

Node Version

18.19.1

NPM Version

10.2.4 Statistics

164 Stars

124 Commits

51 Forks

3 Watching

4 Branches

12 Contributors

Updated on 26 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

28,795,189

Last day

-11.2%

57,955

Compared to previous day

Last week

-0.3%

321,980

Compared to previous week

Last month

2.4%

1,386,982

Compared to previous month

Last year

52.2%

14,196,891

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

cypress-mochawesome-reporter

Zero config Mochawesome reporter for Cypress with screenshots attached to tests.

Example report

Mochawesome report with fail test screenshot

Cypress compatibility

reporter version	cypress version	reporter branch
`v3`	node >= 14 >= `6.7.0` >= `6.2.0` with `experimentalRunEvents: true`	`master`
`v2`	>= `6.7.0` >= `6.2.0` with `experimentalRunEvents: true`	`v2`
`v1`	>= `4.0.0`	`v1`

migration guide from v1 to v2

Setup

This setup tutorial works with Cypress >= v10, looking for older version setup? here

install cypress-mochawesome-reporter

npm i --save-dev cypress-mochawesome-reporter

yarn add -D cypress-mochawesome-reporter

Change cypress reporter & setup hooks

Edit config file (cypress.config.js by default)

1const { defineConfig } = require('cypress');
2
3module.exports = defineConfig({
4  reporter: 'cypress-mochawesome-reporter',
5  e2e: {
6    setupNodeEvents(on, config) {
7      require('cypress-mochawesome-reporter/plugin')(on);
8    },
9  },
10});

If you are override before:run or after:run hooks, use this:

1const { defineConfig } = require('cypress');
2const { beforeRunHook, afterRunHook } = require('cypress-mochawesome-reporter/lib');
3
4module.exports = defineConfig({
5  reporter: 'cypress-mochawesome-reporter',
6  e2e: {
7    setupNodeEvents(on, config) {
8      on('before:run', async (details) => {
9        console.log('override before:run');
10        await beforeRunHook(details);
11      });
12
13      on('after:run', async () => {
14        console.log('override after:run');
15        await afterRunHook();
16      });
17    },
18  },
19});

Add to cypress/support/e2e.js

1import 'cypress-mochawesome-reporter/register';

(optional, if your are using cypress-cucumber-preprocessor) Add to cypress/support/step_definitions/index.js
```
1import 'cypress-mochawesome-reporter/cucumberSupport';
```
⚠️ cypress-cucumber-preprocessor uses the same hooks as cypress-mochawesome-reporter, you also need to install cypress-on-fix. Full example of using cypress-mochawesome-reporter with cypress-cucumber-preprocessor can be found here.
run cypress

Custom options

If you want to customize your HTML report with mochawesome-report-generator flags just add the flags you want to reporterOptions

1const { defineConfig } = require('cypress');
2
3module.exports = defineConfig({
4  reporter: 'cypress-mochawesome-reporter',
5  reporterOptions: {
6    charts: true,
7    reportPageTitle: 'custom-title',
8    embeddedScreenshots: true,
9    inlineAssets: true,
10    saveAllAttempts: false,
11  },
12  e2e: {
13    setupNodeEvents(on, config) {
14      require('cypress-mochawesome-reporter/plugin')(on);
15    },
16  },
17});

Additional reporter options:

name	type	default	description
`embeddedScreenshots`	`boolean`	`false`	Embedded external screenshots into HTML using base64, use with `inlineAssets` option to produce a single HTML file
`ignoreVideos`	`boolean`	`false`	Will not copy videos recorded by Cypress nor show them in the mochawesome report. Requires that Cypress config option `video` is set to `true` for the option to have any effect Because mochawesome doesn't support context per spec file, each test will have the whole spec file video. More info can be found here
`videoOnFailOnly`	`boolean`	`false`	If Videos are recorded and added to the report, setting this to `true` will add the videos only to tests with failures. Do note that this will NOT cause video's to only record failed tests, just they not be added to passed tests in the mochawesome report
`quiet`	`boolean`	`false`	Silence console messages
`saveAllAttempts`	`boolean`	`true`	Save screenshots of all test attempts, set to `false` to save only the last attempt
`debug`	`boolean`	`false`	Creates log file with debug data
`saveJson`	`boolean`	`false`	Keeps the json file used to create html report

Add extra information to report

Add extra information to the report manually by using cy.addTestContext() as seen in the simple-typescript example test 2

Examples

Run npm i in root directory then:

cd examples/<example-project>

npm i
npm test

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

6

SAST

Determines if the project uses static code analysis.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

4.9

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to cypress-mochawesome-reporter

Other packages similar to cypress-mochawesome-reporter

cypress-mochawesome-reporter

Installations

Pull Requests

0

91

13

78

Issues

7

100

93

Releases

Developer

LironEr

Developer Guide

CommonJS

>=14

Yes

18.19.1

10.2.4

Statistics

Languages

Total Downloads

28,795,189

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

cypress-mochawesome-reporter

Cypress compatibility

Setup

Custom options

Add extra information to report

Examples

10

10

10

10

8

6

3

3

2

0

0

0

0

4.9

/10