@percy/cli-upload 1.0.0-beta.9 → 1.0.2

package/README.md

@@ -4,29 +4,36 @@ Percy CLI command to uploade a directory of static images to Percy for diffing.
 
 ## Commands
 <!-- commands -->
-* [`percy upload DIRNAME`](#percy-upload-dirname)
+* [`percy upload`](#percy-upload)
 
-## `percy upload DIRNAME`
+### `percy upload`
 
 Upload a directory of images to Percy
 
 ```
-USAGE
-  $ percy upload DIRNAME
-
-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
-
-EXAMPLE
+Usage:
+  $ percy upload [options] <dirname>
+
+Arguments:
+  dirname                 Directory of images to upload
+
+Options:
+  -f, --files [pattern]   One or more globs matching image file paths to upload (default:
+                          "**/*.{png,jpg,jpeg}")
+  -i, --ignore <pattern>  One or more globs matching image file paths to ignore
+  -e, --strip-extensions  Strips file extensions from snapshot names
+
+Percy options:
+  -c, --config <file>     Config file path
+  -d, --dry-run           Print snapshot names only
+
+Global options:
+  -v, --verbose           Log everything
+  -q, --quiet             Log errors only
+  -s, --silent            Log nothing
+  -h, --help              Display command help
+
+Examples:
   $ percy upload ./images
 ```
 <!-- commandsstop -->
@@ -39,6 +46,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/config.js

@@ -1,10 +1,4 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.schema = void 0;
-const schema = {
+export const schema = {
   upload: {
     type: 'object',
     additionalProperties: false,
@@ -30,8 +24,27 @@ const schema = {
           }
         }],
         default: ''
+      },
+      stripExtensions: {
+        type: 'boolean',
+        default: false
+      },
+      concurrency: {
+        type: 'number',
+        minimum: 1
       }
     }
   }
 };
-exports.schema = schema;
+export 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/index.js

@@ -1,8 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {};
-exports.default = _default;
+export { default, upload } from './upload.js';

package/dist/resources.js

@@ -1,22 +1,11 @@
-"use strict";
+import path from 'path';
+import { sha256hash } from '@percy/client/utils'; // Returns a root resource object with a sha and mimetype.
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = createImageResources;
-
-var _path = _interopRequireDefault(require("path"));
-
-var _utils = require("@percy/client/dist/utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Returns a root resource object with a sha and mimetype.
 function createRootResource(url, content) {
   return {
     url,
     content,
-    sha: (0, _utils.sha256hash)(content),
+    sha: sha256hash(content),
     mimetype: 'text/html',
     root: true
   };
@@ -27,7 +16,7 @@ function createImageResource(url, content, mimetype) {
   return {
     url,
     content,
-    sha: (0, _utils.sha256hash)(content),
+    sha: sha256hash(content),
     mimetype
   };
 } // Returns root resource and image resource objects based on an image's
@@ -35,15 +24,16 @@ function createImageResource(url, content, mimetype) {
 // designed to display an image at it's native size without margins or padding.
 
 
-function createImageResources(filename, content, width, height) {
+export function createImageResources(filename, content, size) {
   let {
+    dir,
     name,
     ext
-  } = _path.default.parse(filename);
-
-  let url = `/${encodeURIComponent(filename)}`;
+  } = path.parse(filename);
+  let rootUrl = `/${encodeURIComponent(path.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 +46,9 @@ function createImageResources(filename, content, width, height) {
           </style>
         </head>
         <body>
-          <img src="${url}" width="${width}px" height="${height}px"/>
+          <img src="${imageUrl}" width="${size.width}px" height="${size.height}px"/>
         </body>
       </html>
-    `), createImageResource(url, content, mimetype)];
-}
+    `), createImageResource(imageUrl, content, mimetype)];
+}
+export default createImageResources;

package/dist/upload.js

@@ -0,0 +1,125 @@
+import fs from 'fs';
+import path from 'path';
+import command from '@percy/cli-command';
+import * as UploadConfig from './config.js';
+const ALLOWED_FILE_TYPES = /\.(png|jpg|jpeg)$/i;
+export const upload = command('upload', {
+  description: 'Upload a directory of images to Percy',
+  args: [{
+    name: 'dirname',
+    description: 'Directory of images to upload',
+    required: true,
+    validate: dir => {
+      if (!fs.existsSync(dir)) {
+        throw new Error(`Not found: ${dir}`);
+      } else if (!fs.lstatSync(dir).isDirectory()) {
+        throw new Error(`Not a directory: ${dir}`);
+      }
+    }
+  }],
+  flags: [{
+    name: 'files',
+    description: 'One or more globs matching image file paths to upload',
+    default: UploadConfig.schema.upload.properties.files.default,
+    percyrc: 'upload.files',
+    type: 'pattern',
+    multiple: true,
+    short: 'f'
+  }, {
+    name: 'ignore',
+    description: 'One or more globs matching image file paths to ignore',
+    percyrc: 'upload.ignore',
+    type: 'pattern',
+    multiple: true,
+    short: 'i'
+  }, {
+    name: 'strip-extensions',
+    description: 'Strips file extensions from snapshot names',
+    percyrc: 'upload.stripExtensions',
+    short: 'e'
+  }],
+  examples: ['$0 ./images'],
+  percy: {
+    discoveryFlags: false,
+    deferUploads: true
+  },
+  config: {
+    schemas: [UploadConfig.schema],
+    migrations: [UploadConfig.migration]
+  }
+}, async function* ({
+  flags,
+  args,
+  percy,
+  log,
+  exit
+}) {
+  if (!percy) exit(0, 'Percy is disabled');
+  let config = percy.config.upload;
+  let {
+    default: glob
+  } = await import('fast-glob');
+  let pathnames = yield glob(config.files, {
+    ignore: [].concat(config.ignore || []),
+    cwd: args.dirname,
+    fs
+  });
+
+  if (!pathnames.length) {
+    exit(1, `No matching files found in '${args.dirname}'`);
+  }
+
+  let {
+    default: imageSize
+  } = await import('image-size');
+  let {
+    createImageResources
+  } = await import('./resources.js'); // the internal upload queue shares a concurrency with the snapshot queue
+
+  percy.setConfig({
+    discovery: {
+      concurrency: config.concurrency
+    }
+  }); // do not launch a browser when starting
+
+  yield* percy.yield.start({
+    browser: false
+  });
+
+  for (let filename of pathnames) {
+    let file = path.parse(filename);
+    let name = config.stripExtensions ? path.join(file.dir, file.name) : filename;
+
+    if (!ALLOWED_FILE_TYPES.test(filename)) {
+      log.info(`Skipping unsupported file type: ${filename}`);
+    } else {
+      if (percy.dryRun) log.info(`Snapshot found: ${name}`);
+
+      percy._scheduleUpload(filename, async () => {
+        let filepath = path.resolve(args.dirname, filename);
+        let buffer = fs.readFileSync(filepath); // width and height is clamped to API min and max
+
+        let size = imageSize(filepath);
+        let widths = [Math.max(10, Math.min(size.width, 2000))];
+        let minHeight = Math.max(10, Math.min(size.height, 2000));
+        let resources = createImageResources(filename, buffer, size);
+        return {
+          name,
+          widths,
+          minHeight,
+          resources
+        };
+      }).then(() => {
+        log.info(`Snapshot uploaded: ${name}`);
+      });
+    }
+  }
+
+  try {
+    yield* percy.yield.stop();
+  } catch (error) {
+    await percy.stop(true);
+    throw error;
+  }
+});
+export default upload;

package/package.json

@@ -1,40 +1,40 @@
 {
   "name": "@percy/cli-upload",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.2",
   "license": "MIT",
-  "main": "dist/index.js",
-  "files": [
-    "dist",
-    "oclif.manifest.json"
-  ],
-  "scripts": {
-    "build": "babel --root-mode upward src --out-dir dist",
-    "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"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/cli-upload"
   },
   "publishConfig": {
     "access": "public"
   },
-  "mocha": {
-    "require": "../../scripts/babel-register"
+  "engines": {
+    "node": ">=14"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "scripts": {
+    "build": "node ../../scripts/build",
+    "lint": "eslint --ignore-path ../../.gitignore .",
+    "readme": "percy-cli-readme",
+    "test": "node ../../scripts/test",
+    "test:coverage": "yarn test --coverage"
   },
-  "oclif": {
-    "bin": "percy",
-    "commands": "./dist/commands",
-    "hooks": {
-      "init": "./dist/hooks/init"
-    }
+  "@percy/cli": {
+    "commands": [
+      "./dist/upload.js"
+    ]
   },
   "dependencies": {
-    "@percy/cli-command": "^1.0.0-beta.9",
-    "@percy/client": "^1.0.0-beta.9",
-    "@percy/config": "^1.0.0-beta.9",
-    "@percy/logger": "^1.0.0-beta.9",
-    "globby": "^11.0.0",
-    "image-size": "^0.8.3"
+    "@percy/cli-command": "1.0.2",
+    "fast-glob": "^3.2.11",
+    "image-size": "^1.0.0"
   },
-  "gitHead": "57a2eeb90c7f5cdf8827c78be1e5c12df581f4b5"
+  "gitHead": "7288764b8088e444e853d5d78756959e46516dc7"
 }

package/dist/commands/upload.js

@@ -1,169 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Upload = void 0;
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _cliCommand = _interopRequireWildcard(require("@percy/cli-command"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _globby = _interopRequireDefault(require("globby"));
-
-var _imageSize = _interopRequireDefault(require("image-size"));
-
-var _client = _interopRequireDefault(require("@percy/client"));
-
-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 _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 _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;
-
-class Upload extends _cliCommand.default {
-  async run() {
-    if (!this.isPercyEnabled()) {
-      _logger.default.info('Percy is disabled. Skipping upload');
-
-      return;
-    }
-
-    let {
-      dirname
-    } = this.args;
-
-    if (!_fs.default.existsSync(dirname)) {
-      return this.error(`Not found: ${dirname}`);
-    } else if (!_fs.default.lstatSync(dirname).isDirectory()) {
-      return this.error(`Not a directory: ${dirname}`);
-    }
-
-    let {
-      upload: {
-        files,
-        ignore
-      }
-    } = this.percyrc();
-    ignore = [].concat(ignore).filter(Boolean);
-    let paths = await (0, _globby.default)(files, {
-      cwd: dirname,
-      ignore
-    });
-    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}`
-    });
-    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 (!name.match(ALLOWED_IMAGE_TYPES)) {
-        _logger.default.info(`Skipping unsupported image type: ${name}`);
-
-        continue;
-      }
-
-      let filepath = _path.default.resolve(dirname, name);
-
-      let buffer = _fs.default.readFileSync(filepath);
-
-      let {
-        width,
-        height
-      } = (0, _imageSize.default)(filepath);
-      await this.client.sendSnapshot({
-        // width and height is clamped to API min and max
-        widths: [Math.max(10, Math.min(width, 2000))],
-        minHeight: Math.max(10, Math.min(height, 2000)),
-        resources: (0, _resources.default)(name, buffer, width, height),
-        name
-      });
-
-      _logger.default.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;
-
-      await ((_this$client2 = this.client) === null || _this$client2 === void 0 ? void 0 : _this$client2.finalizeBuild());
-
-      _logger.default.info(`Finalized build #${build.number}: ${build.url}`);
-    }
-  }
-
-}
-
-exports.Upload = Upload;
-
-_defineProperty(Upload, "description", 'Upload a directory of images to Percy');
-
-_defineProperty(Upload, "args", [{
-  name: 'dirname',
-  description: 'directory of images to upload',
-  required: true
-}]);
-
-_defineProperty(Upload, "flags", { ..._cliCommand.flags.logging,
-  ..._cliCommand.flags.config,
-  files: _cliCommand.flags.string({
-    char: 'f',
-    multiple: true,
-    description: 'one or more globs matching image file paths to upload',
-    default: _config.schema.upload.properties.files.default,
-    percyrc: 'upload.files'
-  }),
-  ignore: _cliCommand.flags.string({
-    char: 'i',
-    multiple: true,
-    description: 'one or more globs matching image file paths to ignore',
-    percyrc: 'upload.ignore'
-  }),
-  'dry-run': _cliCommand.flags.boolean({
-    char: 'd',
-    description: 'prints a list of matching images to upload without uploading'
-  })
-});
-
-_defineProperty(Upload, "examples", ['$ percy upload ./images']);

package/dist/hooks/init.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = _default;
-
-var _config = _interopRequireDefault(require("@percy/config"));
-
-var _config2 = require("../config");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _default() {
-  _config.default.addSchema(_config2.schema);
-}

package/oclif.manifest.json

@@ -1 +0,0 @@
-{"version":"1.0.0-beta.9","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}]}}}