@percy/cli
Advanced tools
@percy/cli - npm Package Compare versions
Comparing version 1.0.0-beta.39 to 1.0.0-beta.40
| { | ||
| "name": "@percy/cli", | ||
| "version": "1.0.0-beta.39", | ||
| "version": "1.0.0-beta.40", | ||
| "license": "MIT", | ||
@@ -19,4 +19,4 @@ "main": "index.js", | ||
| "lint": "eslint --ignore-path ../../.gitignore .", | ||
| "test": "cross-env NODE_ENV=test mocha", | ||
| "test:coverage": "nyc yarn test" | ||
| "test": "node ../../scripts/test", | ||
| "test:coverage": "yarn test --coverage" | ||
| }, | ||
@@ -26,5 +26,2 @@ "publishConfig": { | ||
| }, | ||
| "mocha": { | ||
| "require": "../../scripts/babel-register" | ||
| }, | ||
| "oclif": { | ||
@@ -43,9 +40,9 @@ "bin": "percy", | ||
| "@oclif/plugin-help": "^3.2.0", | ||
| "@percy/cli-build": "^1.0.0-beta.39", | ||
| "@percy/cli-config": "^1.0.0-beta.39", | ||
| "@percy/cli-exec": "^1.0.0-beta.39", | ||
| "@percy/cli-snapshot": "^1.0.0-beta.39", | ||
| "@percy/cli-upload": "^1.0.0-beta.39" | ||
| "@percy/cli-build": "^1.0.0-beta.40", | ||
| "@percy/cli-config": "^1.0.0-beta.40", | ||
| "@percy/cli-exec": "^1.0.0-beta.40", | ||
| "@percy/cli-snapshot": "^1.0.0-beta.40", | ||
| "@percy/cli-upload": "^1.0.0-beta.40" | ||
| }, | ||
| "gitHead": "bd5cea12ca0d21ca167ce9100df2ead274428b7e" | ||
| "gitHead": "1607ab0f5dbe5ab8ef3c9f7b6c2a89f66533348c" | ||
| } |
| # Percy CLI | ||
|  | ||
| [](https://github.com/percy/cli/actions) | ||
| The Percy CLI is used to capture and upload snapshots to [percy.io](https://percy.io) from the | ||
| command line. | ||
| The Percy CLI is used to interact with, and upload snapshots to, [percy.io](https://percy.io) via | ||
| the command line. | ||
| - [Installation](#installation) | ||
| - [Command Topics](#command-topics) | ||
| - [Advanced](#advanced) | ||
| - [Issues](#issues) | ||
| - [Developing](#developing) | ||
| ## Installation | ||
| Using yarn: | ||
| ```sh-session | ||
| $ yarn add @percy/cli --dev | ||
| $ npm install --save-dev @percy/cli | ||
| ``` | ||
| Using npm: | ||
| ```sh-session | ||
| $ npm install @percy/cli --save-dev | ||
| ``` | ||
| ## Command Topics | ||
@@ -33,10 +31,11 @@ | ||
| In addition to the CLI packages, this repo contains core libraries responsible for Percy's CI/CD | ||
| integrations, Percy API communication, DOM snapshotting, and asset discovery. | ||
| integrations, Percy API communication, DOM serialization, asset discovery, etc. | ||
| - [`@percy/core`](./packages/core#readme) - performs snapshot asset discovery and uploading | ||
| - [`@percy/config`](./packages/config#readme) - loads Percy configuration files | ||
| - [`@percy/client`](./packages/client#readme) - handles communicating with the Percy API | ||
| - [`@percy/dom`](./packages/dom#readme) - serializes DOM snapshots | ||
| - [`@percy/env`](./packages/env#readme) - captures CI build environment variables | ||
| - [`@percy/client`](./packages/client#readme) - handles communicating with the Percy API | ||
| - [`@percy/config`](./packages/config#readme) - loads Percy configuration files | ||
| - [`@percy/logger`](./packages/logger#readme) - common logger used throughout the CLI | ||
| - [`@percy/sdk-utils`](./packages/sdk-utils#readme) - shared helpers for JavaScript SDKs | ||
@@ -48,3 +47,4 @@ ## Issues | ||
| For other issues, [open a support request](https://percy.io). | ||
| For other issues, [open a support | ||
| request](https://www.browserstack.com/contact?ref=percy#technical-support). | ||
@@ -54,4 +54,4 @@ ## Developing | ||
| This project is built with [lerna](https://lerna.js.org/). The core libaries and CLI plugins are | ||
| located in [./packages](./packages). Run `yarn` to install dependencies after cloning the repo and use | ||
| the following scripts for various development tasks: | ||
| located in [./packages](./packages). Run `yarn` to install dependencies after cloning the repo and | ||
| use the following scripts for various development tasks: | ||
@@ -72,9 +72,1 @@ - `yarn build` - build all packages | ||
| ``` | ||
| ### Releasing | ||
| 1. Run `yarn bump-version` and choose an appropriate version. | ||
| 2. Commit the updated version with a matching commit (e.g. `🔖v1.0.0`). | ||
| 3. Push the commit to GitHub and wait for CI to pass. | ||
| 4. Edit and publish the GitHub release draft from the releases page. | ||
| 5. The GitHub release will trigger an [automated NPM release](https://github.com/percy/cli/actions?query=workflow%3ARelease). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-2.8%
7333
- Number of lines in readme file
- decreased by-10.39%
69