@percy/sdk-utils
Advanced tools
@percy/sdk-utils - npm Package Compare versions
Comparing version 1.0.0-beta.39 to 1.0.0-beta.40
| { | ||
| "name": "@percy/sdk-utils", | ||
| "version": "1.0.0-beta.39", | ||
| "version": "1.0.0-beta.40", | ||
| "license": "MIT", | ||
@@ -15,4 +15,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" | ||
| }, | ||
@@ -22,9 +22,6 @@ "publishConfig": { | ||
| }, | ||
| "mocha": { | ||
| "require": "../../scripts/babel-register" | ||
| }, | ||
| "dependencies": { | ||
| "@percy/logger": "^1.0.0-beta.39" | ||
| "@percy/logger": "^1.0.0-beta.40" | ||
| }, | ||
| "gitHead": "bd5cea12ca0d21ca167ce9100df2ead274428b7e" | ||
| "gitHead": "1607ab0f5dbe5ab8ef3c9f7b6c2a89f66533348c" | ||
| } |
@@ -5,35 +5,18 @@ # @percy/sdk-utils | ||
| - [Usage](#usage) | ||
| - [`logger()`](#loggerdebug) | ||
| - [`getInfo()`](#getinfo) | ||
| - [`isPercyEnabled()`](#ispercyenabled) | ||
| - [`postSnapshot()`](#postsnapshot) | ||
| ## Usage | ||
| ### `log(level, message)` | ||
| ### `logger([debug])` | ||
| Logs colored output and stack traces based on the loglevel defined by the `PERCY_LOGLEVEL` | ||
| environment variable. | ||
| This function is a direct export of [`@percy/logger`](./packages/logger). | ||
| ``` js | ||
| const { log } = require('@percy/sdk-utils'); | ||
| // logs unless loglevel is quiet or silent | ||
| log('info', 'foobar'); | ||
| // [percy] foobar | ||
| // logs a red error message unless the loglevel is silent | ||
| log('error', 'bad'); | ||
| // [percy] bad | ||
| // logs the stack trace when loglevel is debug | ||
| log('error', new Error('some error')); | ||
| // [percy] Error: some error | ||
| // at example (/path/to/example.js:2:10) | ||
| // at ... | ||
| // only logs when the loglevel is debug | ||
| log('debug', 'debug message'); | ||
| // [percy] debug message | ||
| ``` | ||
| ### `getInfo()` | ||
| Returns information about any running Percy CLI server. Some information is only available after | ||
| [`isPercyEnabled`](#isPercyEnabled) has been called. | ||
| [`isPercyEnabled`](#ispercyenabled) has been called. | ||
@@ -43,16 +26,15 @@ ``` js | ||
| let info = getInfo(); | ||
| const { cliApi, loglevel, version, config } = getInfo(); | ||
| ``` | ||
| // CLI API address | ||
| info.cliApi === (process.env.PERCY_CLI_API || 'http://localhost:5338') | ||
| #### Returned properties | ||
| // CLI loglevel | ||
| info.loglevel === (process.env.PERCY_LOGLEVEL || 'info') | ||
| - `cliApi` — CLI API address (`process.env.PERCY_CLI_API || 'http://localhost:5338'`) | ||
| - `loglevel` — CLI log level (`process.env.PERCY_LOGLEVEL || 'info'`) | ||
| // CLI version parts (requires isPercyEnabled call) | ||
| info.version === (['1', '0', '0'] || undefined) | ||
| The following properties are only populated after [`isPercyEnabled`](#ispercyenabled) has been | ||
| called. | ||
| // CLI config options (requires isPercyEnabled call) | ||
| info.config === {} | ||
| ``` | ||
| - `version` — CLI version parts (e.g. `['1', '0', '0']`) | ||
| - `config` — CLI config options | ||
@@ -59,0 +41,0 @@ ### `isPercyEnabled()` |
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-3.98%
9046
- Number of lines in readme file
- decreased by-15.25%
100
Dependency changes
Updated@percy/logger@^1.0.0-beta.40