reg-cli 0.17.4 → 0.17.7

package/README.md

@@ -1,6 +1,5 @@
 ![reg-cli](./docs/reg-cli.jpg)
 
-![[Build Status](https://circleci.com/gh/reg-viz/reg-cli/tree/master)](https://circleci.com/gh/reg-viz/reg-cli/tree/master.svg?style=svg)
 ![[Build Status](https://travis-ci.org/reg-viz/reg-cli)](https://travis-ci.org/reg-viz/reg-cli.svg?branch=master)
 ![[Build Status](https://ci.appveyor.com/project/bokuweb/reg-cli)](https://ci.appveyor.com/api/projects/status/ir907qbc633q9na4?svg=true)
 ![[npm package](https://www.npmjs.com/package/reg-cli)](https://img.shields.io/npm/v/reg-cli.svg)
@@ -44,7 +43,7 @@ $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir -R ./repor
   * `-I`, `--ignoreChange` If true, error will not be thrown when image change detected.
   * `-E`, `--extendedErrors` If true, also added/deleted images will throw an error.
   * `-P`, `--urlPrefix` Add prefix to all image src.
-  * `-M`, `--matchingThreshold` Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0 by default.
+  * `-M`, `--matchingThreshold` Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0 by default. Specifically, you can set how much of a difference in the YIQ difference metric should be considered a different pixel. If there is a difference between pixels, it will be treated as "same pixel" if it is within this threshold.
   * `-T`, `--thresholdRate` Rate threshold for detecting change. When the difference ratio of the image is larger than the set rate detects the change. Applied after `matchingThreshold`. 0 by default.
   * `-S`, `--thresholdPixel` Pixel threshold for detecting change. When the difference pixel of the image is larger than the set pixel detects the change. This value takes precedence over `thresholdRate`. Applied after `matchingThreshold`. 0 by default.
   * `-C`, `--concurrency` How many processes launches in parallel. If omitted 4.

package/dist/cli.js

@@ -39,7 +39,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 var spinner = new _cliSpinner.Spinner();
 spinner.setSpinnerString(18);
 
-var cli = (0, _meow2.default)('\n  Usage\n    $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir\n  Options\n    -U, --update Update expected images.(Copy `actual images` to `expected images`).\n    -J, --json Specified json report path. If omitted ./reg.json.\n    -I, --ignoreChange If true, error will not be thrown when image change detected.\n    -E, --extendedErrors If true, also added/deleted images will throw an error. If omitted false.\n    -R, --report Output html report to specified directory.\n    -P, --urlPrefix Add prefix to all image src.\n    -M, --matchingThreshold Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0 by default.\n    -T, --thresholdRate Rate threshold for detecting change. When the difference ratio of the image is larger than the set rate detects the change.\n    -S, --thresholdPixel Pixel threshold for detecting change. When the difference pixel of the image is larger than the set pixel detects the change. This value takes precedence over `thresholdRate`.\n    -C, --concurrency How many processes launches in parallel. If omitted 4.\n    -A, --enableAntialias. Enable antialias. If omitted false.\n    -X, --additionalDetection. Enable additional difference detection(highly experimental). Select "none" or "client" (default: "none").\n    -F, --from Generate report from json. Please specify json file. If set, only report will be output without comparing images.\n  Examples\n    $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir -U -D ./reg.json\n', {
+var cli = (0, _meow2.default)('\n  Usage\n    $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir\n  Options\n    -U, --update Update expected images.(Copy `actual images` to `expected images`).\n    -J, --json Specified json report path. If omitted ./reg.json.\n    -I, --ignoreChange If true, error will not be thrown when image change detected.\n    -E, --extendedErrors If true, also added/deleted images will throw an error. If omitted false.\n    -R, --report Output html report to specified directory.\n    -P, --urlPrefix Add prefix to all image src.\n    -M, --matchingThreshold Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0 by default.\n    -T, --thresholdRate Rate threshold for detecting change. When the difference ratio of the image is larger than the set rate detects the change.\n    -S, --thresholdPixel Pixel threshold for detecting change. When the difference pixel of the image is larger than the set pixel detects the change. This value takes precedence over `thresholdRate`.\n    -C, --concurrency How many processes launches in parallel. If omitted 4.\n    -A, --enableAntialias. Enable antialias. If omitted false.\n    -X, --additionalDetection. Enable additional difference detection(highly experimental). Select "none" or "client" (default: "none").\n    -F, --from Generate report from json. Please specify json file. If set, only report will be output without comparing images.\n    -D, --customDiffMessage Pass custom massage that will logged to the terminal when there is a diff.\n  Examples\n    $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir -U -D ./reg.json\n', {
   alias: {
     U: 'update',
     J: 'json',
@@ -53,7 +53,8 @@ var cli = (0, _meow2.default)('\n  Usage\n    $ reg-cli /path/to/actual-dir /pat
     C: 'concurrency',
     A: 'enableAntialias',
     X: 'additionalDetection',
-    F: 'from'
+    F: 'from',
+    D: 'customDiffMessage'
   }
 });
 if (!cli.flags.from) {
@@ -78,6 +79,7 @@ var extendedErrors = !!cli.flags.extendedErrors;
 var ignoreChange = !!cli.flags.ignoreChange;
 var enableClientAdditionalDetection = cli.flags.additionalDetection === 'client';
 var from = String(cli.flags.from || '');
+var customDiffMessage = String(cli.flags.customDiffMessage || '\nInspect your code changes, re-run with `-U` to update them. ');
 
 // If from option specified, generate report from json and exit.
 if (from) {
@@ -160,7 +162,7 @@ observer.once('complete', function (_ref) {
   if (newItems.length) _log2.default.info(_icon.GREEK_CROSS + ' ' + newItems.length + ' file(s) appended.');
   if (passedItems.length) _log2.default.success(_icon.CHECK_MARK + ' ' + passedItems.length + ' file(s) passed.');
   if (!update && (failedItems.length > 0 || extendedErrors && (newItems.length > 0 || deletedItems.length > 0))) {
-    _log2.default.fail('\nInspect your code changes, re-run with `-U` to update them. ');
+    _log2.default.fail(customDiffMessage);
     if (!ignoreChange) process.exit(1);
   }
   return process.exit(0);

package/dist/index.js

@@ -172,12 +172,14 @@ module.exports = function (params) {
       expectedDir = params.expectedDir,
       diffDir = params.diffDir,
       json = params.json,
-      concurrency = params.concurrency,
+      _params$concurrency = params.concurrency,
+      concurrency = _params$concurrency === undefined ? 4 : _params$concurrency,
       update = params.update,
       report = params.report,
       urlPrefix = params.urlPrefix,
       threshold = params.threshold,
-      matchingThreshold = params.matchingThreshold,
+      _params$matchingThres = params.matchingThreshold,
+      matchingThreshold = _params$matchingThres === undefined ? 0 : _params$matchingThres,
       thresholdRate = params.thresholdRate,
       thresholdPixel = params.thresholdPixel,
       enableAntialias = params.enableAntialias,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reg-cli",
-  "version": "0.17.4",
+  "version": "0.17.7",
   "description": "",
   "main": "./dist/index.js",
   "start": "node ./dist/cli.js",
@@ -9,7 +9,6 @@
     "build": "npm run build:cli && npm run build:report",
     "build:cli": "babel src -d dist",
     "build:report": "sh ./scripts/build-ui.sh v0.2.1",
-    "dev:report": "npm run copy:ximgdiff && webpack-dev-server --hot --inline --open",
     "flow": "flow",
     "copy:ximgdiff": "copyfiles -u 3 node_modules/x-img-diff-js/build/cv-wasm_browser.* report/assets",
     "prepublishOnly": "npm run build",
@@ -30,19 +29,25 @@
   "author": "bokuweb",
   "license": "MIT",
   "resolutions": {
-    "**/set-value": "4.0.1",
+    "**/set-value": "4.1.0",
+    "**/tar": "^6.0.0",
+    "**/kind-of": "^6.0.3",
     "**/randomatic": "3.1.1",
     "**/deep-extend": "0.6.0",
     "**/cryptiles": "4.1.3",
     "**/lodash": "4.17.21",
-    "**/yargs-parser": "^20.0.0",
+    "**/yargs-parser": "^21.0.0",
     "**/minimist": "^1.2.3",
+    "**/ajv": "^8.0.0",
+    "**/json-schema": "^0.4.0",
     "**/hoek": "6.1.3",
+    "**/ansi-regex": "^5.0.1",
     "**/glob-parent": "^6.0.1",
     "**/dot-prop": "^6.0.1",
-    "**/node-forge": "^0.10.0",
+    "**/node-forge": "^1.0.0",
     "**/serialize-javascript": "^6.0.0",
     "**/y18n": "^5.0.0",
+    "**/braces": "^3.0.0",
     "**/trim-newlines": "^3.0.1"
   },
   "dependencies": {
@@ -60,12 +65,12 @@
     "meow": "3.7.0",
     "mustache": "4.2.0",
     "x-img-diff-js": "0.3.5",
-    "yargs-parser": "^20.2.9"
+    "yargs-parser": "^21.0.1"
   },
   "devDependencies": {
     "ava": "0.25.0",
     "babel-cli": "6.26.0",
-    "babel-loader": "8.2.2",
+    "babel-loader": "8.2.4",
     "babel-plugin-transform-es2015-block-scoping": "6.26.0",
     "babel-plugin-transform-flow-strip-types": "6.22.0",
     "babel-preset-es2015": "6.24.1",
@@ -74,16 +79,12 @@
     "babel-preset-stage-2": "6.24.1",
     "copyfiles": "2.4.1",
     "cross-env": "7.0.3",
-    "finalhandler": "1.1.2",
+    "finalhandler": "1.2.0",
     "flow-bin": "0.77.0",
-    "flow-typed": "3.2.1",
-    "husky": "4.3.0",
-    "puppeteer": "1.20.0",
+    "flow-typed": "3.7.0",
+    "puppeteer": "13.5.1",
     "rimraf": "3.0.2",
-    "serve-static": "1.14.1",
-    "webpack": "4.40.2",
-    "webpack-cli": "3.3.9",
-    "webpack-dev-server": "3.11.2"
+    "serve-static": "1.14.2"
   },
   "files": [
     "dist",