@percy/cli-upload 1.0.0-beta.7 → 1.0.0-beta.70

package/README.md

@@ -18,13 +18,14 @@ ARGUMENTS
   DIRNAME  directory of images to upload
 
 OPTIONS
-  -c, --config=config  configuration file path
-  -d, --dry-run        prints a list of matching images to upload without uploading
-  -f, --files=files    [default: **/*.{png,jpg,jpeg}] one or more globs matching image file paths to upload
-  -i, --ignore=ignore  one or more globs matching image file paths to ignore
-  -q, --quiet          log errors only
-  -v, --verbose        log everything
-  --silent             log nothing
+  -c, --config=config     configuration file path
+  -d, --dry-run           prints a list of matching images to upload without uploading
+  -e, --strip-extensions  strips file extensions from snapshot names
+  -f, --files=files       [default: **/*.{png,jpg,jpeg}] one or more globs matching image file paths to upload
+  -i, --ignore=ignore     one or more globs matching image file paths to ignore
+  -q, --quiet             log errors only
+  -v, --verbose           log everything
+  --silent                log nothing
 
 EXAMPLE
   $ percy upload ./images
@@ -39,6 +40,11 @@ This CLI plugin adds the following Percy configuration options (defaults shown).
 # defaults
 version: 2
 upload:
+  strip-extensions: false
   files: '**/*.{png,jpg,jpeg}'
   ignore: ''
 ```
+
+- **strip-extensions** - Strips file extensions from snapshot names
+- **files** - A glob or array of globs matching file paths to upload
+- **ignore** - A glob or array of globs matching file paths to ignore

package/dist/commands/upload.js

@@ -19,33 +19,42 @@ var _imageSize = _interopRequireDefault(require("image-size"));
 
 var _client = _interopRequireDefault(require("@percy/client"));
 
+var _queue = _interopRequireDefault(require("@percy/core/dist/queue"));
+
 var _resources = _interopRequireDefault(require("../resources"));
 
 var _config = require("../config");
 
 var _package = _interopRequireDefault(require("../../package.json"));
 
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-const ALLOWED_IMAGE_TYPES = /\.(png|jpg|jpeg)$/i;
+const ALLOWED_FILE_TYPES = /^\.(png|jpg|jpeg)$/i;
 
 class Upload extends _cliCommand.default {
+  constructor(...args) {
+    super(...args);
+
+    _defineProperty(this, "log", (0, _logger.default)('cli:upload'));
+  }
+
   async run() {
     if (!this.isPercyEnabled()) {
-      _logger.default.info('Percy is disabled. Skipping upload');
-
-      return;
+      return this.log.info('Percy is disabled. Skipping upload');
     }
 
     let {
       dirname
     } = this.args;
+    let {
+      'dry-run': dry
+    } = this.flags;
 
     if (!_fs.default.existsSync(dirname)) {
       return this.error(`Not found: ${dirname}`);
@@ -54,83 +63,88 @@ class Upload extends _cliCommand.default {
     }
 
     let {
-      upload: {
-        files,
-        ignore
-      }
+      upload: conf
     } = this.percyrc();
-    ignore = [].concat(ignore).filter(Boolean);
-    let paths = await (0, _globby.default)(files, {
-      cwd: dirname,
-      ignore
+    this.queue = new _queue.default(conf.concurrency);
+    let paths = await (0, _globby.default)(conf.files, {
+      ignore: [].concat(conf.ignore || []),
+      cwd: dirname
     });
+    let l = paths.length;
+    if (!l) this.error(`No matching files found in '${dirname}'`);
     paths.sort();
-
-    if (!paths.length) {
-      return this.error(`No matching files found in '${dirname}'`);
-    } else if (this.flags['dry-run']) {
-      _logger.default.info('Matching files:');
-
-      return paths.forEach(p => console.log(p));
-    } // we already have assets so we don't need asset discovery from @percy/core,
-    // we can use @percy/client directly to send snapshots
-
-
     this.client = new _client.default({
-      clientInfo: `${_package.default.name}/${_package.default.version}`
+      clientInfo: `${_package.default.name}/${_package.default.version}`,
+      environmentInfo: `node/${process.version}`
     });
-    await this.client.createBuild();
-    let {
-      build
-    } = this.client;
-
-    _logger.default.info('Percy has started!');
-
-    _logger.default.info(`Created build #${build.number}: ${build.url}`);
-
-    for (let name of paths) {
-      _logger.default.debug(`Uploading snapshot: ${name}`); // only snapshot supported images
 
+    if (dry) {
+      this.log.info(`Found ${l} snapshot${l !== 1 ? 's' : ''}`);
+    } else {
+      let {
+        data: build
+      } = await this.client.createBuild();
+      let {
+        'build-number': number,
+        'web-url': url
+      } = build.attributes;
+      this.build = {
+        id: build.id,
+        number,
+        url
+      };
+      this.log.info('Percy has started!');
+    }
 
-      if (!name.match(ALLOWED_IMAGE_TYPES)) {
-        _logger.default.info(`Skipping unsupported image type: ${name}`);
+    for (let filename of paths) {
+      let file = _path.default.parse(filename);
 
+      if (!ALLOWED_FILE_TYPES.test(file.ext)) {
+        this.log.info(`Skipping unsupported file type: ${filename}`);
         continue;
       }
 
-      let filepath = _path.default.resolve(dirname, name);
+      let name = conf.stripExtensions ? _path.default.join(file.dir, file.name) : filename;
+      if (dry) this.log.info(`Snapshot found: ${name}`);else this.snapshot(name, filename, dirname);
+    }
+  } // Push a snapshot upload to the queue
+
 
-      let buffer = _fs.default.readFileSync(filepath);
+  snapshot(name, filename, dirname) {
+    this.queue.push(`upload/${name}`, async () => {
+      let filepath = _path.default.resolve(dirname, filename);
 
       let {
         width,
         height
       } = (0, _imageSize.default)(filepath);
-      await this.client.sendSnapshot({
+
+      let buffer = _fs.default.readFileSync(filepath);
+
+      await this.client.sendSnapshot(this.build.id, {
         // width and height is clamped to API min and max
         widths: [Math.max(10, Math.min(width, 2000))],
-        minimumHeight: Math.max(10, Math.min(height, 2000)),
-        resources: (0, _resources.default)(name, buffer, width, height),
+        minHeight: Math.max(10, Math.min(height, 2000)),
+        resources: (0, _resources.default)(filename, buffer, width, height),
         name
       });
-
-      _logger.default.info(`Snapshot uploaded: ${name}`);
-    }
+      this.log.info(`Snapshot uploaded: ${name}`);
+    });
   } // Finalize the build when finished
 
 
-  async finally() {
-    var _this$client;
-
-    let build = (_this$client = this.client) === null || _this$client === void 0 ? void 0 : _this$client.build;
-
-    if (build === null || build === void 0 ? void 0 : build.id) {
-      var _this$client2;
+  async finally(error) {
+    var _this$build;
 
-      await ((_this$client2 = this.client) === null || _this$client2 === void 0 ? void 0 : _this$client2.finalizeBuild());
-
-      _logger.default.info(`Finalized build #${build.number}: ${build.url}`);
-    }
+    if (!((_this$build = this.build) !== null && _this$build !== void 0 && _this$build.id)) return;
+    if (error) this.queue.close(true);
+    if (this.closing) return;
+    this.closing = true;
+    await this.queue.empty(s => {
+      this.log.progress(`Uploading ${s} snapshot${s !== 1 ? 's' : ''}...`, !!s);
+    });
+    await this.client.finalizeBuild(this.build.id);
+    this.log.info(`Finalized build #${this.build.number}: ${this.build.url}`);
   }
 
 }
@@ -160,6 +174,11 @@ _defineProperty(Upload, "flags", { ..._cliCommand.flags.logging,
     description: 'one or more globs matching image file paths to ignore',
     percyrc: 'upload.ignore'
   }),
+  'strip-extensions': _cliCommand.flags.boolean({
+    char: 'e',
+    description: 'strips file extensions from snapshot names',
+    percyrc: 'upload.stripExtensions'
+  }),
   'dry-run': _cliCommand.flags.boolean({
     char: 'd',
     description: 'prints a list of matching images to upload without uploading'

package/dist/config.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.migration = migration;
 exports.schema = void 0;
 const schema = {
   upload: {
@@ -30,8 +31,29 @@ const schema = {
           }
         }],
         default: ''
+      },
+      stripExtensions: {
+        type: 'boolean',
+        default: false
+      },
+      concurrency: {
+        type: 'number',
+        minimum: 1
       }
     }
   }
 };
-exports.schema = schema;
+exports.schema = schema;
+
+function migration(config, {
+  map,
+  del
+}) {
+  /* eslint-disable curly */
+  if (config.version < 2) {
+    // image-snapshots and options were renamed
+    map('imageSnapshots.files', 'upload.files');
+    map('imageSnapshots.ignore', 'upload.ignore');
+    del('imageSnapshots');
+  }
+}

package/dist/hooks/init.js

@@ -7,10 +7,16 @@ exports.default = _default;
 
 var _config = _interopRequireDefault(require("@percy/config"));
 
-var _config2 = require("../config");
+var UploadConfig = _interopRequireWildcard(require("../config"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _default() {
-  _config.default.addSchema(_config2.schema);
+  _config.default.addSchema(UploadConfig.schema);
+
+  _config.default.addMigration(UploadConfig.migration);
 }

package/dist/index.js

@@ -1,8 +1,3 @@
 "use strict";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {};
-exports.default = _default;
+module.exports = require('./commands/upload').Upload;

package/dist/resources.js

@@ -37,13 +37,15 @@ function createImageResource(url, content, mimetype) {
 
 function createImageResources(filename, content, width, height) {
   let {
+    dir,
     name,
     ext
   } = _path.default.parse(filename);
 
-  let url = `/${encodeURIComponent(filename)}`;
+  let rootUrl = `/${encodeURIComponent(_path.default.join(dir, name))}`;
+  let imageUrl = `/${encodeURIComponent(filename)}`;
   let mimetype = ext === '.png' ? 'image/png' : 'image/jpeg';
-  return [createRootResource(encodeURIComponent(name), `
+  return [createRootResource(rootUrl, `
       <!doctype html>
       <html lang="en">
         <head>
@@ -56,8 +58,8 @@ function createImageResources(filename, content, width, height) {
           </style>
         </head>
         <body>
-          <img src="${url}" width="${width}px" height="${height}px"/>
+          <img src="${imageUrl}" width="${width}px" height="${height}px"/>
         </body>
       </html>
-    `), createImageResource(url, content, mimetype)];
+    `), createImageResource(imageUrl, content, mimetype)];
 }

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.0-beta.7","commands":{"upload":{"id":"upload","description":"Upload a directory of images to Percy","pluginName":"@percy/cli-upload","pluginType":"core","aliases":[],"examples":["$ percy upload ./images"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"log everything","allowNo":false},"quiet":{"name":"quiet","type":"boolean","char":"q","description":"log errors only","allowNo":false},"silent":{"name":"silent","type":"boolean","description":"log nothing","allowNo":false},"config":{"name":"config","type":"option","char":"c","description":"configuration file path"},"files":{"name":"files","type":"option","char":"f","description":"one or more globs matching image file paths to upload","default":"**/*.{png,jpg,jpeg}"},"ignore":{"name":"ignore","type":"option","char":"i","description":"one or more globs matching image file paths to ignore"},"dry-run":{"name":"dry-run","type":"boolean","char":"d","description":"prints a list of matching images to upload without uploading","allowNo":false}},"args":[{"name":"dirname","description":"directory of images to upload","required":true}]}}}
+{"version":"1.0.0-beta.70","commands":{"upload":{"id":"upload","description":"Upload a directory of images to Percy","pluginName":"@percy/cli-upload","pluginType":"core","aliases":[],"examples":["$ percy upload ./images"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"log everything","allowNo":false},"quiet":{"name":"quiet","type":"boolean","char":"q","description":"log errors only","allowNo":false},"silent":{"name":"silent","type":"boolean","description":"log nothing","allowNo":false},"config":{"name":"config","type":"option","char":"c","description":"configuration file path"},"files":{"name":"files","type":"option","char":"f","description":"one or more globs matching image file paths to upload","default":"**/*.{png,jpg,jpeg}"},"ignore":{"name":"ignore","type":"option","char":"i","description":"one or more globs matching image file paths to ignore"},"strip-extensions":{"name":"strip-extensions","type":"boolean","char":"e","description":"strips file extensions from snapshot names","allowNo":false},"dry-run":{"name":"dry-run","type":"boolean","char":"d","description":"prints a list of matching images to upload without uploading","allowNo":false}},"args":[{"name":"dirname","description":"directory of images to upload","required":true}]}}}

package/package.json

@@ -1,26 +1,26 @@
 {
   "name": "@percy/cli-upload",
-  "version": "1.0.0-beta.7",
+  "version": "1.0.0-beta.70",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [
     "dist",
     "oclif.manifest.json"
   ],
+  "engines": {
+    "node": ">=12"
+  },
   "scripts": {
-    "build": "babel --root-mode upward src --out-dir dist",
+    "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",
     "postbuild": "oclif-dev manifest",
     "readme": "oclif-dev readme",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:coverage": "nyc yarn test"
+    "test": "node ../../scripts/test",
+    "test:coverage": "yarn test --coverage"
   },
   "publishConfig": {
     "access": "public"
   },
-  "mocha": {
-    "require": "../../scripts/babel-register"
-  },
   "oclif": {
     "bin": "percy",
     "commands": "./dist/commands",
@@ -29,12 +29,17 @@
     }
   },
   "dependencies": {
-    "@percy/cli-command": "^1.0.0-beta.7",
-    "@percy/client": "^1.0.0-beta.7",
-    "@percy/config": "^1.0.0-beta.7",
-    "@percy/logger": "^1.0.0-beta.7",
-    "globby": "^11.0.0",
-    "image-size": "^0.8.3"
+    "@percy/cli-command": "1.0.0-beta.70",
+    "@percy/client": "1.0.0-beta.70",
+    "@percy/config": "1.0.0-beta.70",
+    "@percy/logger": "1.0.0-beta.70",
+    "globby": "^11.0.4",
+    "image-size": "^1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/cli-upload"
   },
-  "gitHead": "5be796ec8f17958e93ada0b634899b945c9b0d60"
+  "gitHead": "34f37a98ff71281cebadd39e53bb55a65b0d3456"
 }