@percy/cli-snapshot 1.0.0-beta.9 → 1.0.0

package/README.md

@@ -4,160 +4,145 @@ Snapshot a list or static directory of web pages.
 
 ## Commands
 <!-- commands -->
-* [`percy snapshot PATHNAME`](#percy-snapshot-pathname)
+* [`percy snapshot`](#percy-snapshot)
 
-## `percy snapshot PATHNAME`
+### `percy snapshot`
 
-Snapshot a list of pages from a file or directory
+Snapshot a static directory, snapshots file, or sitemap URL
 
 ```
-USAGE
-  $ percy snapshot PATHNAME
-
-ARGUMENTS
-  PATHNAME  path to a directory or file containing a list of pages
-
-OPTIONS
-  -b, --base-url=base-url                          [default: /] the url path to serve the static directory from
-  -c, --config=config                              configuration file path
-  -d, --dry-run                                    prints a list of pages to snapshot without snapshotting
-
-  -f, --files=files                                [default: **/*.{html,htm}] one or more globs matching static file
-                                                   paths to snapshot
-
-  -h, --allowed-hostname=allowed-hostname          allowed hostnames
-
-  -i, --ignore=ignore                              one or more globs matching static file paths to ignore
-
-  -q, --quiet                                      log errors only
-
-  -t, --network-idle-timeout=network-idle-timeout  asset discovery idle timeout
-
-  -v, --verbose                                    log everything
-
-  --disable-asset-cache                            disable asset discovery caches
-
-  --silent                                         log nothing
-
-EXAMPLES
+Usage:
+  $ percy snapshot [options] <dir|file|sitemap>
+
+Arguments:
+  dir|file|sitemap                   Static directory, snapshots file, or sitemap url
+
+Options:
+  -b, --base-url <string>            The base url pages are hosted at when snapshotting
+  --include <pattern>                One or more globs/patterns matching snapshots to include
+  --exclude <pattern>                One or more globs/patterns matching snapshots to exclude
+
+Static options:
+  --clean-urls                       Rewrite static index and filepath URLs to be clean
+
+Percy options:
+  -c, --config <file>                Config file path
+  -d, --dry-run                      Print snapshot names only
+  -h, --allowed-hostname <hostname>  Allowed hostnames to capture in asset discovery
+  --disallowed-hostname <hostname>   Disallowed hostnames to abort in asset discovery
+  -t, --network-idle-timeout <ms>    Asset discovery network idle timeout
+  --disable-cache                    Disable asset discovery caches
+  --debug                            Debug asset discovery and do not upload snapshots
+
+Global options:
+  -v, --verbose                      Log everything
+  -q, --quiet                        Log errors only
+  -s, --silent                       Log nothing
+  --help                             Display command help
+
+Examples:
   $ percy snapshot ./public
-  $ percy snapshot pages.yml
+  $ percy snapshot snapshots.yml
+  $ percy snapshot https://percy.io/sitemap.xml
 ```
 <!-- commandsstop -->
 
 ## Usage
 
-### Static Directory
-
-When snapshotting a static directory, the directory will be served locally and each matching page
-will be navigated to and snapshotted.
-
-```sh-session
-$ percy snapshot ./public
-[percy] Percy has started!
-[percy] Created build #1: https://percy.io/org/project/123
-[percy] Snapshot taken: /index.html
-[percy] Snapshot taken: /about.html
-[percy] Snapshot taken: /contact.html
-[percy] Stopping percy...
-[percy] Finalized build #1: https://percy.io/org/project/123
-[percy] Done!
-```
-
-### Page Listing
-
-When snapshotting a file containing a list of pages to snapshot, the page URLs must all be
-accessible by a browser. The file must be YAML, JSON, or a JS file exporting a list of pages. Each
-page must contain a snapshot `name` and `url`, with an optional `waitFor` option to wait for a selector
-or timeout before snapshotting the page.
+### Snapshot Lists
 
-#### YAML
+When providing a file containing a list of snapshots, the file must be YAML, JSON, or a JS file
+exporting a list of pages. Each snapshot must contain at least a `url` that can be navigated to
+using a browser.
 
-`pages.yml`:
+`snapshots.yml`:
 
 ```yaml
-- name: Snapshot one
-  url: http://localhost:8080
-
-- name: Snapshot two
-  url: http://localhost:8080/two
-  # wait for an element or timeout before snapshotting
-  waitFor: .some-element
+- http://localhost:8080
+- http://localhost:8080/two
 ```
 
-Snapshotting `pages.yml`:
+Snapshotting `snapshots.yml`:
 
 ```sh-session
-$ percy snapshot pages.yml
+$ percy snapshot snapshots.yml
 [percy] Percy has started!
-[percy] Created build #1: https://percy.io/org/project/123
-[percy] Snapshot taken: Snapshot one
-[percy] Snapshot taken: Snapshot two
-[percy] Stopping percy...
+[percy] Snapshot taken: /
+[percy] Snapshot taken: /two
 [percy] Finalized build #1: https://percy.io/org/project/123
-[percy] Done!
 ```
 
-#### JSON
+#### Snapshot Options
+
+A `name` can be provided which will override the default snapshot name generated from the url
+path. The options `waitForTimeout` and `waitForSelector` can also be provided to wait for a timeout
+or selector respectively before taking the snapshot.
 
-`pages.json`:
+`snapshots.json`:
 
 ```json
 [{
   "name": "Snapshot one",
-  "url": "http://localhost:8080"
+  "url": "http://localhost:8080",
+  "waitForTimeout": 1000
 }, {
   "name": "Snapshot two",
   "url": "http://localhost:8080/two",
-  "waitFor": ".some-element"
+  "waitForSelector": ".some-element"
 }]
 ```
 
-Snapshotting `pages.json`:
+Snapshotting `snapshots.json`:
 
 ```sh-session
-$ percy snapshot pages.json
+$ percy snapshot snapshots.json
 [percy] Percy has started!
-[percy] Created build #1: https://percy.io/org/project/123
 [percy] Snapshot taken: Snapshot one
 [percy] Snapshot taken: Snapshot two
-[percy] Stopping percy...
 [percy] Finalized build #1: https://percy.io/org/project/123
-[percy] Done!
 ```
 
-#### JavaScript
+For more advanced use cases, an `execute` function and `additionalSnapshots` may be specified for
+each snapshot to execute JavaScript within the page execution context before subsequent snapshots
+are taken.
 
-For JavaScript exports, an `execute` function and additional `snapshots` may be specified for each
-page to interact with the underlying Puppeteer Page object before snapshots are taken.
+> Note: All options are also accepted by other file formats. For `execute` however, a string
+> containing a function body can be provided when the file format prevents normal functions.
 
-`pages.js`:
+`snapshots.js`:
 
 ```js
 module.exports = [{
-  name: 'Snapshot one',
-  url: 'http://localhost:8080',
-  async execute(page) {
-    await page.click('.button')
-  }
-}, {
-  name: 'Snapshot two',
-  url: 'http://localhost:8080/two',
-  waitFor: '.some-element',
-  snapshots: [{
-    name: 'Snapshot two - after click',
-    async execute(page) {
-      await page.click('.button')
+  name: 'My form',
+  url: 'http://localhost:8080/form',
+  waitForSelector: '.form-loaded',
+  execute() {
+    document.querySelector('.name').value = 'Name Namerson';
+    document.querySelector('.email').value = 'email@domain.com';
+  },
+  additionalSnapshots: [{
+    suffix: ' - submitting',
+    execute() {
+      document.querySelector('.submit').click();
     }
   }, {
-    name: 'Snapshot two - after double click',
-    async execute(page) {
-      await page.click('.button', { clickCount: 2 })
-    }
+    suffix: ' - after submit',
+    waitForSelector: '.form-submitted'
   }]
 }]
 ```
 
+Snapshotting `snapshots.js`:
+
+```sh-session
+$ percy snapshot snapshots.js
+[percy] Percy has started!
+[percy] Snapshot taken: My form
+[percy] Snapshot taken: My form - submitting
+[percy] Snapshot taken: My form - after submit
+[percy] Finalized build #1: https://percy.io/org/project/123
+```
+
 JavaScript files may also export sync or async functions that return a list of pages to snapshot.
 
 ``` js
@@ -167,17 +152,164 @@ module.exports = async () => {
 }
 ```
 
-Snapshotting `pages.js`:
+#### Advanced List Options
+
+Instead of an array of snapshots, list files can also contain an object that defines additional
+top-level options along with a `snapshots` option containing the array of snapshots. This allows
+dynamically filtering lists with `include`/`exclude` options, and enables utilizing features such as
+YAML anchors and references.
+
+<details>
+  <summary>Example <code>snapshots.yml</code></summary><br>
+
+``` yaml
+base-url: https://example.com
+exclude:
+  - /page/(\d+)
+
+references:
+  dismiss-cookie-banner: &dismiss-cookie-banner |
+    document.querySelector('.cookie-banner .dismiss').click();
+
+snapshots:
+  - url: /foo
+    execute: *dismiss-cookie-banner
+  - url: /foo
+    name: "/foo - with cookie banner"
+  - url: /bar
+    execute: *dismiss-cookie-banner
+```
+</details>
+
+### Static Directory
+
+When providing a static directory, it will be served locally and pages matching the `files` argument
+(and excluding the `ignore` argument) will be navigated to and snapshotted.
 
 ```sh-session
-$ percy snapshot pages.js
+$ percy snapshot ./public
 [percy] Percy has started!
-[percy] Created build #1: https://percy.io/org/project/123
-[percy] Snapshot taken: Snapshot one
-[percy] Snapshot taken: Snapshot two
-[percy] Snapshot taken: Snapshot two - after click
-[percy] Snapshot taken: Snapshot two - after double click
-[percy] Stopping percy...
+[percy] Snapshot taken: /index.html
+[percy] Snapshot taken: /about.html
+[percy] Snapshot taken: /contact.html
 [percy] Finalized build #1: https://percy.io/org/project/123
-[percy] Done!
 ```
+
+#### Static Options
+
+For snapshotting static directories, the following Percy config file options are also accepted:
+
+``` yaml
+# .percy.yml
+version: 2
+static:
+  base-url: /
+  clean-urls: false
+  include: **/*.html
+  exclude: []
+  rewrites: {}
+  overrides: []
+```
+
+- **base-url** - The base URL path the static site should be served under.
+- **clean-urls** - When true, rewrite index and filepath URLs to be clean.
+
+<span/>
+
+- **include/exclude** - A predicate or an array of predicates matching snapshots to include/exclude.
+
+  A predicate can be a string glob or pattern, a regular expression, or a function that accepts a
+  snapshot object and returns `true` or `false` if the snapshot is considered matching or not.
+
+  ``` javascript
+  // .percy.js
+  module.exports = {
+    version: 2,
+    static: {
+      include: [
+        'blog/**/*.html',          // glob
+        'pages/page-(?!10).html$', // pattern
+        /about-(.+)\.html/i        // regexp
+      ],
+      exclude: [
+        // function that returns true when matching
+        ({ name }) => DISALLOWED.includes(name)
+      ]
+    }
+  };
+  ```
+
+- **rewrites** - An object containing source-destination pairs for rewriting URLs.
+
+  Paths for resources can sometimes be expected to be in a certain format that may not be covered by
+  the `clean-urls` option. For such paths, rewrites can map a short, clean, or pretty path to a
+  specific resource. Paths are matched using [path-to-regexp](https://github.com/pillarjs/path-to-regexp).
+
+  ``` yaml
+  # .percy.yml
+  version: 2
+  static:
+    base-url: /blog
+    rewrites:
+      /:year/:month/:title: /posts/:year-:month--:title.html
+      /:year/:month: /posts/index-:year-:month.html
+      /:year: /posts/index-:year.html
+  ```
+
+- **overrides** - An array of per-snapshot option overrides.
+
+  Just like [page listing options](#page-options), static snapshots may also contain
+  per-snapshot configuration options. However, since pages are matched against the `files`
+  option, so are per-snapshot configuration options via an array of `overrides`. If multiple
+  overrides match a snapshot, they will be merged with previously matched overrides.
+
+  ``` yaml
+  # .percy.yml
+  version: 2
+  static:
+    overrides:
+    - files: /foo-bar.html
+      waitForSelector: .is-ready
+      execute: |
+        document.querySelector('.button').click()
+  ```
+
+### Sitemap URL
+
+When providing a sitemap URL, the document must be an XML document. For sitemap URLs the `--include` and
+`--exclude` flags can be used to filter snapshots. With a Percy config file, the `overrides` option
+is also accepted.
+
+> Tip: Sitemaps can contain **a lot** of URLs, so its best to always start with the `--dry-run` flag
+> while fine tuning the `include` and `exclude` options.
+
+``` sh-session
+$ percy snapshot https://percy.io/sitemap.xml --dry-run
+[percy] Found 10 snapshots
+[percy] Snapshot found: /
+[percy] Snapshot found: /changelog
+[percy] Snapshot found: /customers
+[percy] Snapshot found: /enterprise
+[percy] Snapshot found: /features
+[percy] Snapshot found: /how-it-works
+[percy] Snapshot found: /integrations
+[percy] Snapshot found: /pricing
+[percy] Snapshot found: /security
+[percy] Snapshot found: /visual-testing
+```
+
+#### Sitemap Options
+
+For snapshotting sitemaps, the following Percy config file options are accepted:
+
+``` yaml
+# .percy.yml
+version: 2
+static:
+  include: **/*.html
+  exclude: []
+  overrides: []
+```
+
+See [the corresponding static options](#static-options) for details on `includes`, `excludes`, and
+`overrides` options.

package/package.json

@@ -1,45 +1,39 @@
 {
   "name": "@percy/cli-snapshot",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.0",
   "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",
-    "pretest": "node ../../scripts/install-browser",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:coverage": "nyc yarn test"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/cli-snapshot"
   },
   "publishConfig": {
     "access": "public"
   },
-  "mocha": {
-    "require": "../../scripts/babel-register",
-    "timeout": 10000
+  "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/snapshot.js"
+    ]
   },
   "dependencies": {
-    "@percy/cli-command": "^1.0.0-beta.9",
-    "@percy/config": "^1.0.0-beta.9",
-    "@percy/core": "^1.0.0-beta.9",
-    "@percy/dom": "^1.0.0-beta.9",
-    "@percy/logger": "^1.0.0-beta.9",
-    "cors": "^2.8.5",
-    "express": "^4.17.1",
-    "globby": "^11.0.0",
-    "yaml": "^1.8.0"
+    "@percy/cli-command": "1.0.0",
+    "yaml": "^1.10.0"
   },
-  "gitHead": "57a2eeb90c7f5cdf8827c78be1e5c12df581f4b5"
+  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
 }

package/dist/commands/snapshot.js

@@ -1,194 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Snapshot = void 0;
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _cliCommand = _interopRequireWildcard(require("@percy/cli-command"));
-
-var _core = _interopRequireDefault(require("@percy/core"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _globby = _interopRequireDefault(require("globby"));
-
-var _yaml = _interopRequireDefault(require("yaml"));
-
-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; }
-
-class Snapshot extends _cliCommand.default {
-  async run() {
-    if (!this.isPercyEnabled()) {
-      _logger.default.info('Percy is disabled. Skipping snapshots');
-
-      return;
-    }
-
-    let config = this.percyrc();
-    let {
-      pathname
-    } = this.args;
-
-    if (!_fs.default.existsSync(pathname)) {
-      return this.error(`Not found: ${pathname}`);
-    } else if (config.static.baseUrl[0] !== '/') {
-      return this.error('The base-url flag must begin with a forward slash (/)');
-    }
-
-    let pages = _fs.default.lstatSync(pathname).isDirectory() ? await this.loadStaticPages(pathname, config.static) : await this.loadPagesFile(pathname);
-
-    if (!pages.length) {
-      return this.error('No snapshots found');
-    }
-
-    if (this.flags['dry-run']) {
-      let l = pages.length;
-
-      _logger.default.info(`Found ${l} snapshot${l === 1 ? '' : 's'}:`);
-
-      return pages.forEach(({
-        name,
-        snapshots = []
-      }) => {
-        (name ? [{
-          name
-        }].concat(snapshots) : snapshots).forEach(({
-          name
-        }) => console.log(name));
-      });
-    }
-
-    this.percy = await _core.default.start({
-      clientInfo: `${_package.default.name}/${_package.default.version}`,
-      server: false,
-      config: false,
-      ...config
-    });
-    await Promise.all(pages.map(page => this.percy.capture(page)));
-  } // Called on error, interupt, or after running
-
-
-  async finally() {
-    var _this$percy, _this$server;
-
-    await ((_this$percy = this.percy) === null || _this$percy === void 0 ? void 0 : _this$percy.stop());
-    (_this$server = this.server) === null || _this$server === void 0 ? void 0 : _this$server.close();
-  } // Serves a static directory at a base-url and resolves when listening.
-
-
-  async serve(staticDir, baseUrl) {
-    let express = require('express');
-
-    let app = express();
-    app.use(require('cors')());
-    app.use(baseUrl, express.static(staticDir));
-    return new Promise(resolve => {
-      this.server = app.listen(() => {
-        let {
-          port
-        } = this.server.address();
-        resolve(`http://localhost:${port}`);
-      });
-    });
-  } // Starts a static server and returns a list of pages to snapshot.
-
-
-  async loadStaticPages(pathname, {
-    baseUrl,
-    files,
-    ignore
-  }) {
-    ignore = [].concat(ignore).filter(Boolean);
-    let paths = await (0, _globby.default)(files, {
-      cwd: pathname,
-      ignore
-    });
-    let addr = '';
-
-    if (!this.flags['dry-run']) {
-      addr = await this.serve(pathname, baseUrl);
-    }
-
-    return paths.sort().map(path => ({
-      url: `${addr}${baseUrl}${path}`,
-      name: `${baseUrl}${path}`
-    }));
-  } // Loads pages to snapshot from a js, json, or yaml file.
-
-
-  async loadPagesFile(pathname) {
-    let ext = _path.default.extname(pathname);
-
-    if (ext === '.js') {
-      let pages = require(_path.default.resolve(pathname));
-
-      return typeof pages === 'function' ? await pages() : pages;
-    } else if (ext === '.json') {
-      return JSON.parse(_fs.default.readFileSync(pathname, {
-        encoding: 'utf-8'
-      }));
-    } else if (ext.match(/\.ya?ml$/)) {
-      return _yaml.default.parse(_fs.default.readFileSync(pathname, {
-        encoding: 'utf-8'
-      }));
-    } else {
-      return this.error(`Unsupported filetype: ${pathname}`);
-    }
-  }
-
-}
-
-exports.Snapshot = Snapshot;
-
-_defineProperty(Snapshot, "description", 'Snapshot a list of pages from a file or directory');
-
-_defineProperty(Snapshot, "args", [{
-  name: 'pathname',
-  description: 'path to a directory or file containing a list of pages',
-  required: true
-}]);
-
-_defineProperty(Snapshot, "flags", { ..._cliCommand.flags.logging,
-  ..._cliCommand.flags.discovery,
-  ..._cliCommand.flags.config,
-  'base-url': _cliCommand.flags.string({
-    char: 'b',
-    description: 'the url path to serve the static directory from',
-    default: _config.schema.static.properties.baseUrl.default,
-    percyrc: 'static.baseUrl'
-  }),
-  files: _cliCommand.flags.string({
-    char: 'f',
-    multiple: true,
-    description: 'one or more globs matching static file paths to snapshot',
-    default: _config.schema.static.properties.files.default,
-    percyrc: 'static.files'
-  }),
-  ignore: _cliCommand.flags.string({
-    char: 'i',
-    multiple: true,
-    description: 'one or more globs matching static file paths to ignore',
-    percyrc: 'static.ignore'
-  }),
-  'dry-run': _cliCommand.flags.boolean({
-    char: 'd',
-    description: 'prints a list of pages to snapshot without snapshotting'
-  })
-});
-
-_defineProperty(Snapshot, "examples", ['$ percy snapshot ./public', '$ percy snapshot pages.yml']);

package/dist/config.js

@@ -1,41 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.schema = void 0;
-const schema = {
-  static: {
-    type: 'object',
-    additionalProperties: false,
-    properties: {
-      baseUrl: {
-        type: 'string',
-        default: '/'
-      },
-      files: {
-        anyOf: [{
-          type: 'string'
-        }, {
-          type: 'array',
-          items: {
-            type: 'string'
-          }
-        }],
-        default: '**/*.{html,htm}'
-      },
-      ignore: {
-        anyOf: [{
-          type: 'string'
-        }, {
-          type: 'array',
-          items: {
-            type: 'string'
-          }
-        }],
-        default: ''
-      }
-    }
-  }
-};
-exports.schema = schema;

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/dist/index.js

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

package/oclif.manifest.json

@@ -1 +0,0 @@
-{"version":"1.0.0-beta.9","commands":{"snapshot":{"id":"snapshot","description":"Snapshot a list of pages from a file or directory","pluginName":"@percy/cli-snapshot","pluginType":"core","aliases":[],"examples":["$ percy snapshot ./public","$ percy snapshot pages.yml"],"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},"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"allowed hostnames"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"asset discovery idle timeout"},"disable-asset-cache":{"name":"disable-asset-cache","type":"boolean","description":"disable asset discovery caches","allowNo":false},"config":{"name":"config","type":"option","char":"c","description":"configuration file path"},"base-url":{"name":"base-url","type":"option","char":"b","description":"the url path to serve the static directory from","default":"/"},"files":{"name":"files","type":"option","char":"f","description":"one or more globs matching static file paths to snapshot","default":"**/*.{html,htm}"},"ignore":{"name":"ignore","type":"option","char":"i","description":"one or more globs matching static file paths to ignore"},"dry-run":{"name":"dry-run","type":"boolean","char":"d","description":"prints a list of pages to snapshot without snapshotting","allowNo":false}},"args":[{"name":"pathname","description":"path to a directory or file containing a list of pages","required":true}]}}}