reg-cli 0.17.3 → 0.17.6

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,9 +43,9 @@ $ 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.
-  * `-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`.
-  * `-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`.
+  * `-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.
   * `-A`, `--enableAntialias` Enable antialias. If omitted false.
   * `-X`, `--additionalDetection`. Enable additional difference detection(highly experimental). Select "none" or "client" (default: "none").

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) {
@@ -115,10 +117,10 @@ var observer = (0, _2.default)({
   report: report,
   json: json,
   urlPrefix: urlPrefix,
-  matchingThreshold: Number(cli.flags.matchingThreshold),
+  matchingThreshold: Number(cli.flags.matchingThreshold || 0),
   thresholdRate: Number(cli.flags.thresholdRate),
   thresholdPixel: Number(cli.flags.thresholdPixel),
-  concurrency: Number(cli.flags.concurrency) || 4,
+  concurrency: Number(cli.flags.concurrency || 4),
   enableAntialias: !!cli.flags.enableAntialias,
   enableClientAdditionalDetection: enableClientAdditionalDetection
 });
@@ -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

@@ -118,12 +118,19 @@ var compareImages = function compareImages(emitter, _ref2) {
 
 var cleanupExpectedDir = function cleanupExpectedDir(expectedDir, changedFiles) {
   var paths = changedFiles.map(function (image) {
-    return _path2.default.join(expectedDir, image);
+    var _path$posix;
+
+    var directories = expectedDir.split("\\");
+    return escapeGlob((_path$posix = _path2.default.posix).join.apply(_path$posix, _toConsumableArray(directories).concat([image])));
   });
   // force: true needed to allow deleting outside working directory
   return (0, _del2.default)(paths, { force: true });
 };
 
+var escapeGlob = function escapeGlob(fileName) {
+  return fileName.replace(/(\*)/g, '[$1]').replace(/(\*)/g, '[$1]').replace(/(\?)/g, '[$1]').replace(/(\[)/g, '[$1]').replace(/(\])/g, '[$1]').replace(/(\{)/g, '[$1]').replace(/(\})/g, '[$1]').replace(/(\))/g, '[$1]').replace(/(\()/g, '[$1]').replace(/(\!)/g, '[$1]');
+};
+
 var aggregate = function aggregate(result) {
   var passed = result.filter(function (r) {
     return r.passed;
@@ -165,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.3",
+  "version": "0.17.6",
   "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.0",
+    "**/set-value": "4.1.0",
+    "**/tar": "^4.4.18",
+    "**/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": {
@@ -51,7 +56,7 @@
     "cli-spinner": "0.2.10",
     "cross-spawn": "7.0.3",
     "del": "6.0.0",
-    "glob": "7.1.7",
+    "glob": "7.2.0",
     "img-diff-js": "0.5.2",
     "jpeg-js": "^0.4.0",
     "lodash": "4.17.21",
@@ -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.3",
     "babel-plugin-transform-es2015-block-scoping": "6.26.0",
     "babel-plugin-transform-flow-strip-types": "6.22.0",
     "babel-preset-es2015": "6.24.1",
@@ -77,13 +82,9 @@
     "finalhandler": "1.1.2",
     "flow-bin": "0.77.0",
     "flow-typed": "3.2.1",
-    "husky": "4.3.0",
-    "puppeteer": "1.20.0",
+    "puppeteer": "13.4.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",

package/CHANGELOG.md

@@ -1,29 +0,0 @@
-# Changelog
-
-<!-- 
-## [[Unreleased]](https://github.com/reg-viz/reg-cli/compare/v5.0.0-beta.0...master)
-<details>
-  <summary>
-    Changes that have landed in master but are not yet released.
-    Click to see more.
-  </summary>
-</details> -->
-
-<!--
-### :rocket: New Feature
-
-### :bug: Bug Fix
-
-### :nail_care: Enhancement
-  
-### :memo: Documentation
-  
-### :house: Internal
--->
-
-## [0.15.13 (2019-11-30)](https://github.com/reg-viz/reg-cli/compare/v0.15.12...v0.15.13)
-
-### :bug: Bug Fix
-
-- Fixed a Marker style (reg-viz/reg-cli-report-ui#25)
-- Fixed a bug where the diff items path was inconsistent when using jpg files (reg-viz/reg-cli-report-ui#26)

package/report/ui/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 reg-viz.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

package/report/ui/README.md

@@ -1,85 +0,0 @@
-# reg-cli-report-ui
-
-[![GitHub Actions Status](https://github.com/reg-viz/reg-cli-report-ui/workflows/Continuous%20Integration/badge.svg)](https://github.com/reg-viz/reg-cli-report-ui/actions)
-
-> :gem: New face of reg-cli report UI.
-
-This repository is the Report UI of [reg-viz/reg-cli][reg-cli]
-
-## Screenshots
-
-![open](./docs/images/open.png)
-![close](./docs/images/close.png)
-![viewer](./docs/images/viewer.png)
-
-## Available scripts
-
-The following list is scripts used during development.
-
-### `yarn start`
-
-```bash
-$ yarn start
-```
-
-Launch the Report UI with the mock data.
-
-### `yarn build`
-
-```bash
-$ yarn build
-```
-
-Generate the JavaScript file required to embed Report UI. This is usually called in [reg-viz/reg-cli][reg-cli].
-
-### `yarn typecheck`
-
-```bash
-$ yarn typecheck
-```
-
-Run static type checking using TypeScript.
-
-### `yarn lint`
-
-```bash
-$ yarn lint
-```
-
-Run Lint with ESLint.
-
-### `yarn format`
-
-```bash
-$ yarn format
-```
-
-Format the source code using Prettier and ESLint.
-
-### `yarn storybook`
-
-```bash
-$ yarn storybook
-```
-
-Launch the component catalog with Storybook.
-
-### `yarn scaffold`
-
-```bash
-$ yarn scaffold
-```
-
-Generate a component template.
-
-## Contribute
-
-PRs welcome.
-
-## License
-
-[MIT License @ reg-viz](./LICENSE)
-
-![reg-viz](https://raw.githubusercontent.com/reg-viz/artwork/master/repository/footer.png)
-
-[reg-cli]: https://github.com/reg-viz/reg-cli

package/report/ui/package.json

@@ -1,109 +0,0 @@
-{
-  "name": "reg-suit-report-ui",
-  "version": "0.2.1",
-  "private": true,
-  "license": "MIT",
-  "scripts": {
-    "build": "cross-env NODE_ENV=\"production\" run-s -s clean build:source",
-    "build:source": "webpack",
-    "clean": "rimraf dist",
-    "format": "run-s format:prettier format:script",
-    "format:prettier": "prettier --write .",
-    "format:script": "yarn lint:script --fix",
-    "lint": "run-p lint:*",
-    "lint:prettier": "prettier --check .",
-    "lint:script": "eslint . --ext \".js,.jsx,.ts,.tsx\"",
-    "scaffold": "yarn scaffdog generate",
-    "start": "webpack serve",
-    "start:huge": "webpack serve --env ENABLED_HUGE",
-    "storybook": "start-storybook -p 6006",
-    "storybook:build": "build-storybook",
-    "test": "jest",
-    "test:watch": "yarn test --watch",
-    "typecheck": "tsc"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx,css,md,yml,json}": [
-      "prettier --write"
-    ]
-  },
-  "browserslist": "> 1%, not dead, not IE <= 11, not OperaMini all",
-  "dependencies": {
-    "body-scroll-lock": "^3.1.5",
-    "clipboard-polyfill": "^3.0.2",
-    "debounce": "^1.2.0",
-    "focus-trap": "^6.2.3",
-    "fuse.js": "^6.4.6",
-    "history": "^5.0.0",
-    "keycode": "^2.2.0",
-    "mousetrap": "^1.6.5",
-    "preact": "^10.5.10",
-    "query-string": "^7.0.1",
-    "rc-slider": "^9.7.1",
-    "re-resizable": "^6.9.0",
-    "react": "17.0.1",
-    "react-dom": "17.0.1",
-    "react-md-spinner": "^1.0.0",
-    "react-transition-group": "^4.4.1",
-    "styled-components": "5.2.1",
-    "unstated-next": "^1.1.0",
-    "use-intersection": "^0.2.1",
-    "x-img-diff-js": "^0.3.5"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/plugin-proposal-class-properties": "^7.12.1",
-    "@babel/plugin-proposal-object-rest-spread": "^7.12.1",
-    "@babel/preset-env": "^7.12.11",
-    "@babel/preset-react": "^7.12.10",
-    "@babel/preset-typescript": "^7.12.7",
-    "@storybook/addon-actions": "^6.1.14",
-    "@storybook/addons": "^6.1.14",
-    "@storybook/react": "^6.1.14",
-    "@types/body-scroll-lock": "^2.6.1",
-    "@types/debounce": "^1.2.0",
-    "@types/fuzzy-search": "^2.1.0",
-    "@types/imagesloaded": "^4.1.2",
-    "@types/jest": "^26.0.20",
-    "@types/mousetrap": "^1.6.5",
-    "@types/node": "^14.14.21",
-    "@types/react": "^17.0.0",
-    "@types/react-dom": "^17.0.0",
-    "@types/react-measure": "^2.0.6",
-    "@types/react-transition-group": "^4.4.0",
-    "@types/styled-components": "5.1.7",
-    "@typescript-eslint/eslint-plugin": "^4.13.0",
-    "@typescript-eslint/parser": "^4.13.0",
-    "babel-loader": "^8.2.2",
-    "babel-plugin-styled-components": "^1.12.0",
-    "copy-webpack-plugin": "^7.0.0",
-    "cross-env": "^7.0.3",
-    "eslint": "^7.18.0",
-    "eslint-config-prettier": "^7.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.1.3",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-react": "^7.22.0",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "html-webpack-plugin": "^5.0.0-beta.5",
-    "husky": "^4.3.8",
-    "jest": "^26.6.3",
-    "lint-staged": "^10.5.3",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^2.2.1",
-    "prettier-plugin-packagejson": "^2.2.9",
-    "react-hot-loader": "^4.13.0",
-    "rimraf": "^3.0.2",
-    "scaffdog": "^1.0.0",
-    "typescript": "^4.1.3",
-    "typescript-eslint-language-service": "^4.1.3",
-    "webpack": "^5.15.0",
-    "webpack-cli": "^4.3.1",
-    "webpack-dev-server": "^3.11.2"
-  }
-}