@percy/cli-snapshot 1.0.0 → 1.0.3

package/dist/config.js

@@ -0,0 +1,79 @@
+// Config schema for static directories
+export const configSchema = {
+  static: {
+    type: 'object',
+    $ref: '/snapshot#/$defs/filter',
+    unevaluatedProperties: false,
+    properties: {
+      baseUrl: {
+        $ref: '/snapshot/server#/properties/baseUrl'
+      },
+      cleanUrls: {
+        $ref: '/snapshot/server#/properties/cleanUrls'
+      },
+      rewrites: {
+        $ref: '/snapshot/server#/properties/rewrites'
+      },
+      options: {
+        $ref: '/snapshot#/$defs/options'
+      }
+    }
+  },
+  sitemap: {
+    type: 'object',
+    $ref: '/snapshot#/$defs/filter',
+    unevaluatedProperties: false,
+    properties: {
+      options: {
+        $ref: '/snapshot#/$defs/options'
+      }
+    }
+  }
+};
+export function configMigration(config, util) {
+  /* eslint-disable curly */
+  if (config.version < 2) {
+    // static-snapshots and options were renamed
+    util.map('staticSnapshots.baseUrl', 'static.baseUrl');
+    util.map('staticSnapshots.snapshotFiles', 'static.include');
+    util.map('staticSnapshots.ignoreFiles', 'static.exclude');
+    util.del('staticSnapshots');
+  } else {
+    let notice = {
+      type: 'config',
+      until: '1.0.0'
+    }; // static files and ignore options were renamed
+
+    util.deprecate('static.files', {
+      map: 'static.include',
+      ...notice
+    });
+    util.deprecate('static.ignore', {
+      map: 'static.exclude',
+      ...notice
+    }); // static and sitemap option overrides were renamed
+
+    util.deprecate('static.overrides', {
+      map: 'static.options',
+      ...notice
+    });
+    util.deprecate('sitemap.overrides', {
+      map: 'sitemap.options',
+      ...notice
+    });
+
+    for (let i in ((_config$static = config.static) === null || _config$static === void 0 ? void 0 : _config$static.options) || []) {
+      var _config$static;
+
+      let k = `static.options[${i}]`;
+      util.deprecate(`${k}.files`, {
+        map: `${k}.include`,
+        ...notice
+      });
+      util.deprecate(`${k}.ignore`, {
+        map: `${k}.exclude`,
+        ...notice
+      });
+    }
+  }
+}

package/dist/index.js

@@ -0,0 +1 @@
+export { default, snapshot } from './snapshot.js';

package/dist/snapshot.js

@@ -0,0 +1,167 @@
+import fs from 'fs';
+import path from 'path';
+import command from '@percy/cli-command';
+import * as SnapshotConfig from './config.js';
+export const snapshot = command('snapshot', {
+  description: 'Snapshot a static directory, snapshots file, or sitemap URL',
+  args: [{
+    name: 'dir|file|sitemap',
+    description: 'Static directory, snapshots file, or sitemap url',
+    required: true,
+    attribute: val => {
+      if (/^https?:\/\//.test(val)) return 'sitemap';
+      if (!fs.existsSync(val)) throw new Error(`Not found: ${val}`);
+      return fs.lstatSync(val).isDirectory() ? 'serve' : 'file';
+    }
+  }],
+  flags: [{
+    name: 'base-url',
+    description: 'The base url pages are hosted at when snapshotting',
+    type: 'string',
+    short: 'b'
+  }, {
+    name: 'include',
+    description: 'One or more globs/patterns matching snapshots to include',
+    type: 'pattern',
+    multiple: true
+  }, {
+    name: 'exclude',
+    description: 'One or more globs/patterns matching snapshots to exclude',
+    type: 'pattern',
+    multiple: true
+  }, {
+    // static only
+    name: 'clean-urls',
+    description: 'Rewrite static index and filepath URLs to be clean',
+    percyrc: 'static.cleanUrls',
+    group: 'Static'
+  }, {
+    // deprecated
+    name: 'files',
+    deprecated: ['1.0.0', '--include'],
+    percyrc: 'static.include',
+    type: 'pattern'
+  }, {
+    name: 'ignore',
+    deprecated: ['1.0.0', '--exclude'],
+    percyrc: 'static.exclude',
+    type: 'pattern'
+  }],
+  examples: ['$0 ./public', '$0 snapshots.yml', '$0 https://percy.io/sitemap.xml'],
+  percy: {
+    deferUploads: true
+  },
+  config: {
+    schemas: [SnapshotConfig.configSchema],
+    migrations: [SnapshotConfig.configMigration]
+  }
+}, async function* ({
+  percy,
+  args,
+  flags,
+  log,
+  exit
+}) {
+  let {
+    include,
+    exclude,
+    baseUrl,
+    cleanUrls
+  } = flags;
+  let {
+    file,
+    serve,
+    sitemap
+  } = args; // parse and validate the --base-url flag after args are parsed
+
+  if (file || serve) baseUrl && (baseUrl = parseBaseUrl(baseUrl, !!serve)); // only continue if percy is not disabled
+
+  if (!percy) exit(0, 'Percy is disabled');
+
+  try {
+    let options;
+    /* istanbul ignore else: arg is required and always one of these */
+
+    if (file) {
+      // load snapshots file
+      let snapshots = yield loadSnapshotFile(file); // accept a config object instead of an array of snapshots
+
+      let config = Array.isArray(snapshots) ? {
+        snapshots
+      } : snapshots;
+      options = merge(config, {
+        baseUrl,
+        include,
+        exclude
+      });
+    } else if (serve) {
+      // serve and snapshot a static directory
+      let config = {
+        serve,
+        cleanUrls,
+        baseUrl,
+        include,
+        exclude
+      };
+      options = merge(percy.config.static, config);
+    } else if (sitemap) {
+      // fetch urls to snapshot from a sitemap
+      let config = {
+        sitemap,
+        include,
+        exclude
+      };
+      options = merge(percy.config.sitemap, config);
+    }
+
+    yield* percy.yield.start();
+    yield* percy.yield.snapshot(options);
+    yield* percy.yield.stop();
+  } catch (error) {
+    await percy.stop(true);
+    throw error;
+  }
+}); // Validates the provided `--base-url` flag and returns a `baseUrl` string if valid. The flag is
+// validated and parsed differently for static directories and snapshot files.
+
+function parseBaseUrl(baseUrl, pathOnly) {
+  try {
+    let needsHost = pathOnly && baseUrl.startsWith('/');
+    let url = new URL(baseUrl, needsHost ? 'http://localhost' : undefined);
+    return pathOnly ? url.pathname : url.href;
+  } catch (e) {
+    throw new Error("The '--base-url' flag must " + (pathOnly ? 'start with a forward slash (/) when providing a static directory' : 'include a protocol and hostname when providing a list of snapshots'));
+  }
+} // Small shallow merge util that does not merge null or undefined values.
+
+
+function merge(...objs) {
+  return objs.reduce((target, obj) => {
+    for (let k in obj) target[k] = obj[k] ?? target[k];
+
+    return target;
+  }, {});
+} // Loads snapshot options from a js, json, or yaml file.
+
+
+async function loadSnapshotFile(file) {
+  let ext = path.extname(file);
+
+  if (ext === '.js') {
+    let {
+      default: module
+    } = await import(path.resolve(file));
+    return typeof module === 'function' ? await module() : module;
+  } else if (ext === '.json') {
+    return JSON.parse(fs.readFileSync(file, 'utf-8'));
+  } else if (ext.match(/\.ya?ml$/)) {
+    let {
+      default: YAML
+    } = await import('yaml');
+    return YAML.parse(fs.readFileSync(file, 'utf-8'));
+  } else {
+    throw new Error(`Unsupported filetype: ${file}`);
+  }
+}
+
+export default snapshot;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-snapshot",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -14,7 +14,7 @@
     "node": ">=14"
   },
   "files": [
-    "./dist"
+    "dist"
   ],
   "main": "./dist/index.js",
   "type": "module",
@@ -32,8 +32,8 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.0.0",
+    "@percy/cli-command": "1.0.3",
     "yaml": "^1.10.0"
   },
-  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
+  "gitHead": "a259d5cff0933711bced21a979c577e70765d318"
 }