reg-cli 0.17.7 → 0.18.0

package/README.md

@@ -107,3 +107,4 @@ The above copyright notice and this permission notice shall be included in all c
 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.
 
 ![reg-viz](https://raw.githubusercontent.com/reg-viz/artwork/master/repository/footer.png)
+

package/dist/cli.js

@@ -1,76 +1,120 @@
 #!/usr/bin/env node
-'use strict';
-
-var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
-
-// import notifier from './notifier';
-
-
-var _cliSpinner = require('cli-spinner');
-
-var _meow = require('meow');
-
-var _meow2 = _interopRequireDefault(_meow);
-
-var _path = require('path');
-
-var _path2 = _interopRequireDefault(_path);
-
-var _ = require('./');
-
-var _2 = _interopRequireDefault(_);
-
-var _log = require('./log');
-
-var _log2 = _interopRequireDefault(_log);
-
-var _fs = require('fs');
-
-var _fs2 = _interopRequireDefault(_fs);
-
-var _icon = require('./icon');
-
-var _report = require('./report');
-
-var _report2 = _interopRequireDefault(_report);
-
+"use strict";
+
+var _cliSpinner = require("cli-spinner");
+var _meow = _interopRequireDefault(require("meow"));
+var _path = _interopRequireDefault(require("path"));
+var _ = _interopRequireDefault(require("./"));
+var _log = _interopRequireDefault(require("./log"));
+var _fs = _interopRequireDefault(require("fs"));
+var _icon = require("./icon");
+var _report = _interopRequireDefault(require("./report"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+// import notifier from './notifier';
 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    -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',
-    I: 'ignoreChange',
-    E: 'extendedErrors',
-    R: 'report',
-    P: 'urlPrefix',
-    M: 'matchingThreshold',
-    T: 'thresholdRate',
-    S: 'thresholdPixel',
-    C: 'concurrency',
-    A: 'enableAntialias',
-    X: 'additionalDetection',
-    F: 'from',
-    D: 'customDiffMessage'
+var cli = (0, _meow.default)(`
+  Usage
+    $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir
+  Options
+    -U, --update Update expected images.(Copy \`actual images\` to \`expected images\`).
+    -J, --json Specified json report path. If omitted ./reg.json.
+    -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. If omitted false.
+    -R, --report Output html report to specified directory.
+    --junit Output junit report to specified file.
+    -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.
+    -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\`.
+    -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").
+    -F, --from Generate report from json. Please specify json file. If set, only report will be output without comparing images.
+    -D, --customDiffMessage Pass custom massage that will logged to the terminal when there is a diff.
+  Examples
+    $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir -U -D ./reg.json
+`, {
+  flags: {
+    update: {
+      type: 'boolean',
+      alias: 'U'
+    },
+    json: {
+      type: 'string',
+      alias: 'J',
+      default: './reg.json'
+    },
+    ignoreChange: {
+      type: 'boolean',
+      alias: 'I'
+    },
+    extendedErrors: {
+      type: 'boolean',
+      alias: 'E',
+      default: false
+    },
+    report: {
+      type: 'string',
+      alias: 'R'
+    },
+    junit: {
+      type: 'string'
+    },
+    urlPrefix: {
+      type: 'string',
+      alias: 'P'
+    },
+    matchingThreshold: {
+      type: 'number',
+      alias: 'M',
+      default: 0
+    },
+    thresholdRate: {
+      type: 'number',
+      alias: 'T'
+    },
+    thresholdPixel: {
+      type: 'number',
+      alias: 'S'
+    },
+    concurrency: {
+      type: 'number',
+      alias: 'C',
+      default: 4
+    },
+    enableAntialias: {
+      type: 'boolean',
+      alias: 'A',
+      default: false
+    },
+    additionalDetection: {
+      type: 'string',
+      alias: 'X',
+      default: 'none'
+    },
+    from: {
+      type: 'string',
+      alias: 'F'
+    },
+    customDiffMessage: {
+      type: 'string',
+      alias: 'D'
+    }
   }
 });
 if (!cli.flags.from) {
   if (!process.argv[2] || !process.argv[3] || !process.argv[4]) {
-    _log2.default.fail('please specify actual, expected and diff images directory.');
-    _log2.default.fail('e.g.: $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir');
+    _log.default.fail('please specify actual, expected and diff images directory.');
+    _log.default.fail('e.g.: $ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir');
     process.exit(1);
   }
 }
-
 var json = cli.flags.json ? cli.flags.json.toString() : './reg.json'; // default output path
 
 var urlPrefix = typeof cli.flags.urlPrefix === 'string' ? cli.flags.urlPrefix : './';
-
 var report = typeof cli.flags.report === 'string' ? cli.flags.report : !!cli.flags.report ? './report.html' : '';
-
+var junitReport = typeof cli.flags.junit === 'string' ? cli.flags.junit : !!cli.flags.junit ? './junit.xml' : '';
 var actualDir = process.argv[2];
 var expectedDir = process.argv[3];
 var diffDir = process.argv[4];
@@ -79,96 +123,92 @@ 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. ');
+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) {
   var _json = '';
   try {
-    _json = _fs2.default.readFileSync(from, { encoding: 'utf8' });
+    _json = _fs.default.readFileSync(from, {
+      encoding: 'utf8'
+    });
   } catch (e) {
-    _log2.default.fail('Failed to read specify json.');
-    _log2.default.fail(e);
+    _log.default.fail('Failed to read specify json.');
+    _log.default.fail(e);
     process.exit(1);
   }
-
   try {
     var params = JSON.parse(_json);
-    (0, _report2.default)(_extends({}, params, {
+    (0, _report.default)({
+      ...params,
       json: _json || './reg.json',
       report: report || './report.html',
+      junitReport: junitReport || '',
+      extendedErrors,
       urlPrefix: urlPrefix || '',
-      enableClientAdditionalDetection: enableClientAdditionalDetection,
+      enableClientAdditionalDetection,
       fromJSON: true
-    }));
+    });
     process.exit(0);
   } catch (e) {
-    _log2.default.fail('Failed to parse json. Please specify valid json.');
-    _log2.default.fail(e);
+    _log.default.fail('Failed to parse json. Please specify valid json.');
+    _log.default.fail(e);
     process.exit(1);
   }
 }
-
-var observer = (0, _2.default)({
-  actualDir: actualDir,
-  expectedDir: expectedDir,
-  diffDir: diffDir,
-  update: update,
-  report: report,
-  json: json,
-  urlPrefix: urlPrefix,
+var observer = (0, _.default)({
+  actualDir,
+  expectedDir,
+  diffDir,
+  update,
+  report,
+  junitReport,
+  extendedErrors,
+  json,
+  urlPrefix,
   matchingThreshold: Number(cli.flags.matchingThreshold || 0),
   thresholdRate: Number(cli.flags.thresholdRate),
   thresholdPixel: Number(cli.flags.thresholdPixel),
   concurrency: Number(cli.flags.concurrency || 4),
   enableAntialias: !!cli.flags.enableAntialias,
-  enableClientAdditionalDetection: enableClientAdditionalDetection
+  enableClientAdditionalDetection
 });
-
-observer.once('start', function () {
-  return spinner.start();
-});
-
-observer.on('compare', function (params) {
+observer.once('start', () => spinner.start());
+observer.on('compare', params => {
   spinner.stop(true);
-  var file = _path2.default.join('' + actualDir, '' + params.path);
+  var file = _path.default.join(`${actualDir}`, `${params.path}`);
   switch (params.type) {
     case 'delete':
-      return _log2.default.warn(_icon.MINUS + ' delete  ' + file);
+      return _log.default.warn(`${_icon.MINUS} delete  ${file}`);
     case 'new':
-      return _log2.default.info(_icon.GREEK_CROSS + ' append  ' + file);
+      return _log.default.info(`${_icon.GREEK_CROSS} append  ${file}`);
     case 'pass':
-      return _log2.default.success(_icon.CHECK_MARK + ' pass    ' + file);
+      return _log.default.success(`${_icon.CHECK_MARK} pass    ${file}`);
     case 'fail':
-      return _log2.default.fail(_icon.BALLOT_X + ' change  ' + file);
+      return _log.default.fail(`${_icon.BALLOT_X} change  ${file}`);
   }
   spinner.start();
 });
-
-observer.once('update', function () {
-  return _log2.default.success('\u2728 your expected images are updated \u2728');
-});
-
-observer.once('complete', function (_ref) {
-  var failedItems = _ref.failedItems,
-      deletedItems = _ref.deletedItems,
-      newItems = _ref.newItems,
-      passedItems = _ref.passedItems;
-
+observer.once('update', () => _log.default.success(`✨ your expected images are updated ✨`));
+observer.once('complete', ({
+  failedItems,
+  deletedItems,
+  newItems,
+  passedItems
+}) => {
   spinner.stop(true);
-  _log2.default.info('\n');
-  if (failedItems.length) _log2.default.fail(_icon.BALLOT_X + ' ' + failedItems.length + ' file(s) changed.');
-  if (deletedItems.length) _log2.default.warn(_icon.MINUS + ' ' + deletedItems.length + ' file(s) deleted.');
-  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.');
+  _log.default.info('\n');
+  if (failedItems.length) _log.default.fail(`${_icon.BALLOT_X} ${failedItems.length} file(s) changed.`);
+  if (deletedItems.length) _log.default.warn(`${_icon.MINUS} ${deletedItems.length} file(s) deleted.`);
+  if (newItems.length) _log.default.info(`${_icon.GREEK_CROSS} ${newItems.length} file(s) appended.`);
+  if (passedItems.length) _log.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(customDiffMessage);
+    _log.default.fail(customDiffMessage);
     if (!ignoreChange) process.exit(1);
   }
   return process.exit(0);
 });
-
-observer.once('error', function (error) {
-  _log2.default.fail(error);
+observer.once('error', error => {
+  _log.default.fail(error);
   process.exit(1);
 });

package/dist/diff.js

@@ -1,37 +1,24 @@
-'use strict';
-
-var _slicedToArray = function () { function sliceIterator(arr, i) { var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"]) _i["return"](); } finally { if (_d) throw _e; } } return _arr; } return function (arr, i) { if (Array.isArray(arr)) { return arr; } else if (Symbol.iterator in Object(arr)) { return sliceIterator(arr, i); } else { throw new TypeError("Invalid attempt to destructure non-iterable instance"); } }; }(); // $FlowIgnore
-// $FlowIgnore
-
-
-var _imgDiffJs = require('img-diff-js');
-
-var _md5File = require('md5-file');
-
-var _md5File2 = _interopRequireDefault(_md5File);
-
-var _path = require('path');
-
-var _path2 = _interopRequireDefault(_path);
+"use strict";
 
+var _imgDiffJs = require("img-diff-js");
+var _md5File = _interopRequireDefault(require("md5-file"));
+var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var getMD5 = function getMD5(file) {
-  return new Promise(function (resolve, reject) {
-    (0, _md5File2.default)(file, function (err, hash) {
-      if (err) reject(err);
-      resolve(hash);
-    });
+// $FlowIgnore
+// $FlowIgnore
+var getMD5 = file => new Promise((resolve, reject) => {
+  (0, _md5File.default)(file, (err, hash) => {
+    if (err) reject(err);
+    resolve(hash);
   });
-};
-
-var isPassed = function isPassed(_ref) {
-  var width = _ref.width,
-      height = _ref.height,
-      diffCount = _ref.diffCount,
-      thresholdPixel = _ref.thresholdPixel,
-      thresholdRate = _ref.thresholdRate;
-
+});
+var isPassed = ({
+  width,
+  height,
+  diffCount,
+  thresholdPixel,
+  thresholdRate
+}) => {
   if (typeof thresholdPixel === "number") {
     return diffCount <= thresholdPixel;
   } else if (typeof thresholdRate === "number") {
@@ -41,47 +28,53 @@ var isPassed = function isPassed(_ref) {
   }
   return diffCount === 0;
 };
-
-var createDiff = function createDiff(_ref2) {
-  var actualDir = _ref2.actualDir,
-      expectedDir = _ref2.expectedDir,
-      diffDir = _ref2.diffDir,
-      image = _ref2.image,
-      matchingThreshold = _ref2.matchingThreshold,
-      thresholdRate = _ref2.thresholdRate,
-      thresholdPixel = _ref2.thresholdPixel,
-      enableAntialias = _ref2.enableAntialias;
-
-  return Promise.all([getMD5(_path2.default.join(actualDir, image)), getMD5(_path2.default.join(expectedDir, image))]).then(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
-        actualHash = _ref4[0],
-        expectedHash = _ref4[1];
-
+var createDiff = ({
+  actualDir,
+  expectedDir,
+  diffDir,
+  image,
+  matchingThreshold,
+  thresholdRate,
+  thresholdPixel,
+  enableAntialias
+}) => {
+  return Promise.all([getMD5(_path.default.join(actualDir, image)), getMD5(_path.default.join(expectedDir, image))]).then(([actualHash, expectedHash]) => {
     if (actualHash === expectedHash) {
       if (!process || !process.send) return;
-      return process.send({ passed: true, image: image });
+      return process.send({
+        passed: true,
+        image
+      });
     }
     var diffImage = image.replace(/\.[^\.]+$/, ".png");
     return (0, _imgDiffJs.imgDiff)({
-      actualFilename: _path2.default.join(actualDir, image),
-      expectedFilename: _path2.default.join(expectedDir, image),
-      diffFilename: _path2.default.join(diffDir, diffImage),
+      actualFilename: _path.default.join(actualDir, image),
+      expectedFilename: _path.default.join(expectedDir, image),
+      diffFilename: _path.default.join(diffDir, diffImage),
       options: {
         threshold: matchingThreshold,
         includeAA: !enableAntialias
       }
-    }).then(function (_ref5) {
-      var width = _ref5.width,
-          height = _ref5.height,
-          diffCount = _ref5.diffCount;
-
-      var passed = isPassed({ width: width, height: height, diffCount: diffCount, thresholdPixel: thresholdPixel, thresholdRate: thresholdRate });
+    }).then(({
+      width,
+      height,
+      diffCount
+    }) => {
+      var passed = isPassed({
+        width,
+        height,
+        diffCount,
+        thresholdPixel,
+        thresholdRate
+      });
       if (!process || !process.send) return;
-      process.send({ passed: passed, image: image });
+      process.send({
+        passed,
+        image
+      });
     });
   });
 };
-
-process.on('message', function (data) {
+process.on('message', data => {
   createDiff(data);
 });

package/dist/icon.js

@@ -1,8 +1,9 @@
-'use strict';
+"use strict";
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.TEARDROP = exports.MULTIPLICATION_X = exports.MINUS = exports.GREEK_CROSS = exports.CHECK_MARK = exports.BALLOT_X = void 0;
 var BALLOT_X = exports.BALLOT_X = '\u2718';
 var CHECK_MARK = exports.CHECK_MARK = '\u2714';
 var TEARDROP = exports.TEARDROP = '\u274B';

package/dist/image-finder.js

@@ -1,46 +1,25 @@
-'use strict';
+"use strict";
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.findImages = undefined;
-
-var _glob = require('glob');
-
-var _glob2 = _interopRequireDefault(_glob);
-
-var _path = require('path');
-
-var _path2 = _interopRequireDefault(_path);
-
+exports.findImages = void 0;
+var _glob = _interopRequireDefault(require("glob"));
+var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var difference = function difference(arrA, arrB) {
-  return arrA.filter(function (a) {
-    return !arrB.includes(a);
-  });
-}; // $FlowIgnore
-
-
+// $FlowIgnore
+var difference = (arrA, arrB) => arrA.filter(a => !arrB.includes(a));
 var IMAGE_FILES = '/**/*.+(tiff|jpeg|jpg|gif|png|bmp)';
-
-var findImages = exports.findImages = function findImages(expectedDir, actualDir) {
-  var expectedImages = _glob2.default.sync('' + expectedDir + IMAGE_FILES).map(function (p) {
-    return _path2.default.relative(expectedDir, p);
-  }).map(function (p) {
-    return p[0] === _path2.default.sep ? p.slice(1) : p;
-  });
-  var actualImages = _glob2.default.sync('' + actualDir + IMAGE_FILES).map(function (p) {
-    return _path2.default.relative(actualDir, p);
-  }).map(function (p) {
-    return p[0] === _path2.default.sep ? p.slice(1) : p;
-  });
+var findImages = (expectedDir, actualDir) => {
+  var expectedImages = _glob.default.sync(`${expectedDir}${IMAGE_FILES}`).map(p => _path.default.relative(expectedDir, p)).map(p => p[0] === _path.default.sep ? p.slice(1) : p);
+  var actualImages = _glob.default.sync(`${actualDir}${IMAGE_FILES}`).map(p => _path.default.relative(actualDir, p)).map(p => p[0] === _path.default.sep ? p.slice(1) : p);
   var deletedImages = difference(expectedImages, actualImages);
   var newImages = difference(actualImages, expectedImages);
   return {
-    expectedImages: expectedImages,
-    actualImages: actualImages,
-    deletedImages: deletedImages,
-    newImages: newImages
+    expectedImages,
+    actualImages,
+    deletedImages,
+    newImages
   };
-};
+};
+exports.findImages = findImages;