Gathering detailed insights and metrics for @percy/env
Gathering detailed insights and metrics for @percy/env
Gathering detailed insights and metrics for @percy/env
Gathering detailed insights and metrics for @percy/env
@percy/client
Communicate with Percy's API to create builds and snapshots, upload resources, and finalize builds and snapshots. Uses [`@percy/env`](.packages/env) to send environment information with new builds. Can also be used to query for a project's builds using a
@percy/cli
[![Test](https://github.com/percy/cli/workflows/Test/badge.svg)](https://github.com/percy/cli/actions)
@percy/cli-build
Commands for interacting with Percy builds
@percy/cli-upload
Percy CLI command to upload a directory of static images to Percy for diffing.
The Percy CLI is used to interact with, and upload snapshots to, percy.io via the command line.
npm install @percy/env
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
71 Stars
1,482 Commits
47 Forks
10 Watching
32 Branches
56 Contributors
Updated on 28 Nov 2024
JavaScript (99.37%)
TypeScript (0.44%)
Shell (0.19%)
Cumulative downloads
Total Downloads
Last day
-10.8%
64,372
Compared to previous day
Last week
-3.3%
351,385
Compared to previous week
Last month
-1.7%
1,463,443
Compared to previous month
Last year
7.6%
19,967,239
Compared to previous year
1
The Percy CLI is used to interact with, and upload snapshots to, percy.io via the command line.
1$ npm install --save-dev @percy/cli
percy exec
- capture and upload snapshotspercy snapshot
- snapshot a static directory or a list of pagespercy upload
- upload a static directory of imagespercy config
- manage configuration filespercy build
- interact with Percy buildsIn addition to the CLI packages, this repo contains core libraries responsible for Percy's CI/CD integrations, Percy API communication, DOM serialization, asset discovery, etc.
@percy/core
- performs snapshot asset discovery and uploading@percy/client
- handles communicating with the Percy API@percy/dom
- serializes DOM snapshots@percy/env
- captures CI build environment variables@percy/config
- loads Percy configuration files@percy/logger
- common logger used throughout the CLI@percy/sdk-utils
- shared helpers for JavaScript SDKs@percy/cli-command
- Percy CLI command frameworkFor problems directly related to the CLI, add an issue on GitHub.
For other issues, open a support request.
This project is built with lerna. The core libaries and CLI plugins are
located in ./packages. Run yarn
to install dependencies after cloning the repo and
use the following scripts for various development tasks:
yarn build
- build all packagesyarn build:watch
- build and watch all packages in parallelyarn clean
- clean up build and coverage outputyarn lint
- lint all packagesyarn readme
- generate cli commands readme usageyarn test
- run all tests, one package after anotheryarn test:coverage
- run all tests with coverage, one package after anotheryarn global:link
- links all packages being developed as global.
yarn build
to be run before consuming.yarn link @percy/[core|cli..]
yarn global:unlink
- unlinks all packages globallyIndividual package scripts can be invoked using yarn's workspace command. For example:
1$ yarn workspace @percy/core test
check in Core Package's readme here.
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
Found 15/16 approved changesets -- score normalized to 9
Reason
SAST tool is not run on all commits -- score normalized to 5
Details
Reason
7 existing vulnerabilities detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
security policy file not detected
Details
Reason
license file not detected
Details
Reason
project is not fuzzed
Details
Reason
Project has not signed or included provenance with any releases.
Details
Score
Last Scanned on 2024-11-18
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