reg-cli 0.18.16 → 0.19.0-rc1

package/package.json

@@ -1,129 +1,95 @@
 {
   "name": "reg-cli",
-  "version": "0.18.16",
-  "description": "",
-  "main": "./dist/index.js",
-  "start": "node ./dist/cli.js",
-  "scripts": {
-    "watch": "babel src --watch -d dist",
-    "build": "npm run build:cli && npm run build:report",
-    "build:cli": "babel src -d dist",
-    "build:report": "sh ./scripts/build-ui.sh v0.5.0",
-    "flow": "flow",
-    "copy:ximgdiff": "copyfiles -u 3 node_modules/x-img-diff-js/build/cv-wasm_browser.* report/assets",
-    "prepublishOnly": "npm run build",
-    "reg": "node dist/cli.js ./sample/actual ./sample/expected ./sample/diff -I -R ./sample/index.html -T 0.01 -X client",
-    "reg:from": "node dist/cli.js -F ./sample/reg.json -R ./sample/index.html",
-    "screenshot": "node test/screenshot.js",
-    "test:cli": "chmod +x dist/cli.js && ava test/cli.test.mjs",
-    "test:screenshot": "npm run build:report && npm run reg && npm run screenshot",
-    "test": "export NODE_OPTIONS=--openssl-legacy-provider && cross-env NODE_ENV=\"debug\" npm run build:report && npm run build && npm run test:cli && npm run test:screenshot"
+  "version": "0.19.0-rc1",
+  "description": "Visual regression testing CLI, Wasm-backed. Drop-in compatible with classic reg-cli's CLI flags, reg.json/junit schema, and `compare()` EventEmitter API (verified against reg-suit's processor.ts).",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist"
+  ],
+  "bin": {
+    "reg-cli": "./dist/cli.mjs"
+  },
+  "scripts": {
+    "build": "tsdown && node ./scripts/stage-assets.mjs",
+    "build:report": "sh ./scripts/build-ui.sh ${REPORT_UI_TAG:-v0.5.0}",
+    "build:wasm": "bash ./scripts/build-wasm.sh",
+    "build:all": "npm run build:report && npm run build:wasm && npm run build",
+    "release:prep": "bash ./scripts/release.sh",
+    "release:pack": "bash ./scripts/release.sh --pack",
+    "test": "node --test test/",
+    "prepublishOnly": "npm run build:all"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/reg-viz/reg-cli/"
   },
-  "ava": {
-    "workerThreads": false
-  },
+  "keywords": [],
   "author": "bokuweb",
   "license": "MIT",
-  "pnpm": {
-    "overrides": {
-      "set-value": "4.1.0",
-      "tar": "^7.5.13",
-      "tar-fs": "3.1.2",
-      "ws": "8.17.1",
-      "kind-of": "^6.0.3",
-      "randomatic": "3.1.1",
-      "deep-extend": "0.6.0",
-      "lodash": "4.18.1",
-      "yargs-parser": "^21.0.0",
-      "minimist": "^1.2.3",
-      "ajv": "^8.0.0",
-      "json-schema": "^0.4.0",
-      "ansi-regex": "^5.0.1",
-      "glob-parent": "^6.0.1",
-      "dot-prop": "^10.0.0",
-      "node-forge": "^1.0.0",
-      "serialize-javascript": "^7.0.0",
-      "y18n": "^5.0.0",
-      "braces": "^3.0.0",
-      "trim-newlines": "3.0.1",
-      "brace-expansion": "5.0.5",
-      "debug": "^4.3.4",
-      "@octokit/request-error@>=1.0.0 <5.1.1": ">=5.1.1",
-      "@octokit/plugin-paginate-rest@>=1.0.0 <9.2.2": ">=9.2.2",
-      "@octokit/request@>=1.0.0 <8.4.1": ">=8.4.1",
-      "minimatch@<3.1.4": "^3.1.4",
-      "minimatch@>=4.0.0 <4.2.5": "^4.2.5",
-      "minimatch@>=5.0.0 <5.1.8": "^5.1.8",
-      "minimatch@>=6.0.0 <6.2.2": "^6.2.2",
-      "minimatch@>=7.0.0 <7.4.8": "^7.4.8",
-      "minimatch@>=8.0.0 <8.0.6": "^8.0.6",
-      "minimatch@>=9.0.0 <9.0.7": "^9.0.7",
-      "minimatch@>=10.0.0 <10.2.3": "^10.2.3",
-      "basic-ftp@<5.2.0": ">=5.2.0",
-      "ajv@>=7.0.0-alpha.0 <8.18.0": ">=8.18.0",
-      "picomatch@<2.3.2": ">=2.3.2",
-      "picomatch@>=4.0.0 <4.0.4": ">=4.0.4",
-      "basic-ftp@<=5.2.1": ">=5.2.2",
-      "simple-git@<3.32.0": ">=3.32.0",
-      "simple-git@>=3.15.0 <3.32.3": ">=3.32.3",
-      "basic-ftp@<=5.2.2": ">=5.3.0"
-    }
-  },
   "dependencies": {
-    "bluebird": "3.7.2",
-    "chalk": "4.1.2",
-    "cli-spinner": "0.2.10",
-    "cross-spawn": "7.0.6",
-    "del": "8.0.1",
-    "glob": "7.2.3",
-    "img-diff-js": "0.5.4",
-    "jpeg-js": "^0.4.4",
-    "lodash": "4.18.1",
-    "make-dir": "3.1.0",
-    "md5-file": "4.0.0",
-    "meow": "^9.0.0",
-    "mustache": "4.2.0",
-    "x-img-diff-js": "0.3.5",
-    "xmlbuilder2": "^4.0.3",
-    "yargs-parser": "^21.0.1"
+    "@tybys/wasm-util": "^0.10.2",
+    "x-img-diff-js": "^0.3.5"
   },
-  "devDependencies": {
-    "@babel/cli": "^7.28.3",
-    "@babel/core": "^7.28.5",
-    "@babel/plugin-transform-block-scoping": "^7.28.5",
-    "@babel/plugin-transform-flow-strip-types": "^7.27.1",
-    "@babel/preset-env": "^7.28.5",
-    "@babel/preset-flow": "^7.27.1",
-    "@babel/preset-stage-2": "^7.8.3",
-    "ava": "8.0.0",
-    "copyfiles": "2.4.1",
-    "cross-env": "10.1.0",
-    "finalhandler": "2.1.1",
-    "flow-bin": "0.77.0",
-    "flow-typed": "4.1.1",
-    "puppeteer": "24.42.0",
-    "rimraf": "3.0.2",
-    "serve-static": "2.2.1"
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.216.0",
+    "@opentelemetry/resources": "^2.7.1",
+    "@opentelemetry/sdk-trace-base": "^2.7.1",
+    "@opentelemetry/sdk-trace-node": "^2.7.1",
+    "@opentelemetry/semantic-conventions": "^1.40.0"
   },
-  "files": [
-    "dist",
-    "template",
-    "report/ui/dist/report.js",
-    "report/ui/dist/worker.js",
-    "report/ui/dist/style.css",
-    "report/assets/favicon_failure.png",
-    "report/assets/favicon_success.png",
-    "report/sample"
-  ],
-  "bin": {
-    "reg-cli": "./dist/cli.js"
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    },
+    "@opentelemetry/exporter-trace-otlp-http": {
+      "optional": true
+    },
+    "@opentelemetry/resources": {
+      "optional": true
+    },
+    "@opentelemetry/sdk-trace-base": {
+      "optional": true
+    },
+    "@opentelemetry/sdk-trace-node": {
+      "optional": true
+    },
+    "@opentelemetry/semantic-conventions": {
+      "optional": true
+    }
   },
-  "packageManager": "pnpm@10.33.2+sha512.a90faf6feeab71ad6c6e57f94e0fe1a12f5dcc22cd754db40ae9593eb6a3e0b6b12e3540218bb37ae083404b1f2ce6db2a4121e979829b4aff94b99f49da1cf8"
+  "devDependencies": {
+    "@types/node": "^22.5.5",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.216.0",
+    "@opentelemetry/resources": "^2.7.1",
+    "@opentelemetry/sdk-trace-base": "^2.7.1",
+    "@opentelemetry/sdk-trace-node": "^2.7.1",
+    "@opentelemetry/semantic-conventions": "^1.40.0",
+    "tsdown": "^0.22.0"
+  },
+  "packageManager": "pnpm@10.33.3+sha512.a19744364a7e248b92657a4ca5973f9354d21caf982579674b1c539f32c7420c47138ad8b1254df07aba9bc782d9b3029e3db34d5dbff974326eb74dac8ff489",
+  "pnpm": {
+    "overrides": {
+      "protobufjs": "^8.6.5"
+    }
+  }
 }

package/dist/cli.js

@@ -1,214 +0,0 @@
-#!/usr/bin/env node
-"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(e) { return e && e.__esModule ? e : { default: e }; }
-// import notifier from './notifier';
-var spinner = new _cliSpinner.Spinner();
-spinner.setSpinnerString(18);
-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]) {
-    _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];
-var update = !!cli.flags.update;
-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) {
-  var _json = '';
-  try {
-    _json = _fs.default.readFileSync(from, {
-      encoding: 'utf8'
-    });
-  } catch (e) {
-    _log.default.fail('Failed to read specify json.');
-    _log.default.fail(e);
-    process.exit(1);
-  }
-  try {
-    var params = JSON.parse(_json);
-    (0, _report.default)({
-      ...params,
-      json: _json || './reg.json',
-      report: report || './report.html',
-      junitReport: junitReport || '',
-      extendedErrors,
-      urlPrefix: urlPrefix || '',
-      enableClientAdditionalDetection,
-      fromJSON: true
-    });
-    process.exit(0);
-  } catch (e) {
-    _log.default.fail('Failed to parse json. Please specify valid json.');
-    _log.default.fail(e);
-    process.exit(1);
-  }
-}
-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
-});
-observer.once('start', () => spinner.start());
-observer.on('compare', params => {
-  spinner.stop(true);
-  var file = _path.default.join(`${actualDir}`, `${params.path}`);
-  switch (params.type) {
-    case 'delete':
-      return _log.default.warn(`${_icon.MINUS} delete  ${file}`);
-    case 'new':
-      return _log.default.info(`${_icon.GREEK_CROSS} append  ${file}`);
-    case 'pass':
-      return _log.default.success(`${_icon.CHECK_MARK} pass    ${file}`);
-    case 'fail':
-      return _log.default.fail(`${_icon.BALLOT_X} change  ${file}`);
-  }
-  spinner.start();
-});
-observer.once('update', () => _log.default.success(`✨ your expected images are updated ✨`));
-observer.once('complete', ({
-  failedItems,
-  deletedItems,
-  newItems,
-  passedItems
-}) => {
-  spinner.stop(true);
-  _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))) {
-    _log.default.fail(customDiffMessage);
-    if (!ignoreChange) process.exit(1);
-  }
-  return process.exit(0);
-});
-observer.once('error', error => {
-  _log.default.fail(error);
-  process.exit(1);
-});

package/dist/diff.js

@@ -1,80 +0,0 @@
-"use strict";
-
-var _imgDiffJs = require("img-diff-js");
-var _md5File = _interopRequireDefault(require("md5-file"));
-var _path = _interopRequireDefault(require("path"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// $FlowIgnore
-// $FlowIgnore
-var getMD5 = file => new Promise((resolve, reject) => {
-  (0, _md5File.default)(file, (err, hash) => {
-    if (err) reject(err);
-    resolve(hash);
-  });
-});
-var isPassed = ({
-  width,
-  height,
-  diffCount,
-  thresholdPixel,
-  thresholdRate
-}) => {
-  if (typeof thresholdPixel === "number") {
-    return diffCount <= thresholdPixel;
-  } else if (typeof thresholdRate === "number") {
-    var totalPixel = width * height;
-    var ratio = diffCount / totalPixel;
-    return ratio <= thresholdRate;
-  }
-  return diffCount === 0;
-};
-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
-      });
-    }
-    var diffImage = image.replace(/\.[^\.]+$/, ".png");
-    return (0, _imgDiffJs.imgDiff)({
-      actualFilename: _path.default.join(actualDir, image),
-      expectedFilename: _path.default.join(expectedDir, image),
-      diffFilename: _path.default.join(diffDir, diffImage),
-      options: {
-        threshold: matchingThreshold,
-        includeAA: !enableAntialias
-      }
-    }).then(({
-      width,
-      height,
-      diffCount
-    }) => {
-      var passed = isPassed({
-        width,
-        height,
-        diffCount,
-        thresholdPixel,
-        thresholdRate
-      });
-      if (!process || !process.send) return;
-      process.send({
-        passed,
-        image
-      });
-    });
-  });
-};
-process.on('message', data => {
-  createDiff(data);
-});

package/dist/icon.js

@@ -1,12 +0,0 @@
-"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';
-var MULTIPLICATION_X = exports.MULTIPLICATION_X = '\u2716';
-var GREEK_CROSS = exports.GREEK_CROSS = '\u271A';
-var MINUS = exports.MINUS = '\u2212';

package/dist/image-finder.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.findImages = void 0;
-var _glob = _interopRequireDefault(require("glob"));
-var _path = _interopRequireDefault(require("path"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// $FlowIgnore
-var difference = (arrA, arrB) => arrA.filter(a => !arrB.includes(a));
-var IMAGE_FILES = '/**/*.+(tiff|jpeg|jpg|gif|png|bmp)';
-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,
-    actualImages,
-    deletedImages,
-    newImages
-  };
-};
-exports.findImages = findImages;