npmpackage.info

Gathering detailed insights and metrics for @percy/cypress

@percy/cypress - 3.1.6 | npmpackage.info

@percy/cypress

Visual testing with Cypress and Percy

3.1.6

348

MIT

JavaScript

10.96 kB

4.3

Installations

npm install @percy/cypress

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.21.3

NPM Version

6.14.18 Pull Requests

Open

7

Total

817

Closed

388

Merged

422

Issues

Open

1

Total

114

Closed

113

Releases

v3.1.6

Updated on Apr 18, 2025

v3.1.6-beta.1

Updated on Apr 10, 2025

v3.1.6-beta.0

Updated on Apr 04, 2025

v3.1.5

Updated on Mar 17, 2025

v3.1.4

Updated on Feb 17, 2025

v3.1.3

Updated on Dec 11, 2024

View All 13 releases

Languages

JavaScript

TypeScript

JavaScript (97.53%)

TypeScript (2.47%)

Developer

percy

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

348 Stars

474 Commits

42 Forks

14 Watchers

33 Branches

46 Contributors

Updated on Apr 23, 2025

Maintainers

View All 46 Contributors

Package Meta Information

Latest Version

3.1.6

Package Id

@percy/cypress@3.1.6

Unpacked Size

10.96 kB

Size

4.61 kB

File Count

NPM Version

6.14.18

Node Version

14.21.3

Published on

Apr 18, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

@percy/cypress

Percy visual testing for Cypress.

Installation

1$ npm install --save-dev @percy/cli @percy/cypress

Then add to your cypress/support/index.js file

1import '@percy/cypress'

Usage

This is an example using the cy.percySnapshot command.

1describe('My app', () => {
2  it('should look good', () => {
3    cy.get('body').should('have.class', 'finished-loading');
4    cy.percySnapshot();
5
6    cy.get('button').click();
7    cy.percySnapshot('Clicked button');
8  });
9});

Running the test above will result in the following log:

1$ cypress run
2...
3[percy] Percy is not running, disabling snapshots

When running with percy exec, and your project's PERCY_TOKEN, a new Percy build will be created and snapshots will be uploaded to your project.

1$ export PERCY_TOKEN=[your-project-token]
2$ percy exec -- cypress run
3[percy] Percy has started!
4[percy] Created build #1: https://percy.io/[your-project]
5[percy] Running "cypress run"
6...
7[percy] Snapshot taken "My app should look good"
8[percy] Snapshot taken "Clicked button"
9...
10[percy] Stopping percy...
11[percy] Finalized build #1: https://percy.io/[your-project]
12[percy] Done!

Configuration

cy.percySnapshot([name][, options])

name - The snapshot name; must be unique to each snapshot; defaults to the full test title
options - See per-snapshot configuration options

Cypress Config

percyThrowErrorOnFailure - If set to true, it will throw an error when one is encountered. By default, it is set to false, and errors are suppressed. If you are using uncaught exeception then test test will pass.

cy.on("uncaught:exception", (e, runnable) => {});

Upgrading

Automatically with `@percy/migrate`

We built a tool to help automate migrating to the new CLI toolchain! Migrating can be done by running the following commands and following the prompts:

1$ npx @percy/migrate
2? Are you currently using @percy/cypress? Yes
3? Install @percy/cli (required to run percy)? Yes
4? Migrate Percy config file? Yes
5? Upgrade SDK to @percy/cypress@3.0.0? Yes

This will automatically run the changes described below for you.

Manually

Installing `@percy/cli`

If you're coming from a pre-3.0 version of this package, make sure to install @percy/cli after upgrading to retain any existing scripts that reference the Percy CLI command.

1$ npm install --save-dev @percy/cli

Removing tasks

If you're coming from 2.x the health check task, @percy/cypress/task, is no longer needed and no longer exists. You should remove this task from your cypress/plugins/index.js file.

Migrating Config

If you have a previous Percy configuration file, migrate it to the newest version with the config:migrate command:

1$ percy config:migrate

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

Code-Review

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

4

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

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

0

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/changelog.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/changelog.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/stale.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/typecheck.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/typecheck.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-cypress/typecheck.yml/master?enable=pin
Info: 2 out of 15 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned

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.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.3

/10

Last Scanned on 2025-07-07

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

@percy/cypress

Installations

Developer Guide

Yes

CommonJS

14.21.3

6.14.18

Pull Requests

7

817

388

422

Issues

1

114

113

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

@percy/cypress

Installation

Usage

Configuration

Cypress Config

Upgrading

Automatically with @percy/migrate

Manually

Installing @percy/cli

Removing tasks

Migrating Config

10

10

10

10

8

4

0

0

0

0

0

0

0

4.3

/10

Automatically with `@percy/migrate`

Installing `@percy/cli`