@percy/cli-command 1.9.1 → 1.10.0

package/README.md

@@ -171,9 +171,6 @@ option, if the environment variable `PERCY_ENABLE` is `0`, the callback _will no
 instance (and can act accordingly).
 
 - `percy` — Enables creation of a `@percy/core` instance initialized with provided options.
-  - `discoveryFlags` — When `false` prevents percy discovery flags from being accepted, but will
-    still allow other percy flags such as `--config` and `--dry-run`.
-  - `...` — All other options are passed along to the new percy instance.
 
 #### Config
 

package/dist/command.js

@@ -22,9 +22,14 @@ function withBuiltIns(definition) {
 
 
   if (def.percy && def.percy !== true) {
-    builtInFlags.PERCY.forEach(addDedupedFlag); // maybe include percy discovery flags
+    builtInFlags.PERCY.forEach(addDedupedFlag); // maybe include percy server flags
 
-    if (def.percy.discoveryFlags !== false) {
+    if (def.percy.server === true) {
+      builtInFlags.SERVER.forEach(addDedupedFlag);
+    } // maybe include percy discovery flags
+
+
+    if (def.percy.skipDiscovery !== true) {
       builtInFlags.DISCOVERY.forEach(addDedupedFlag);
     }
   } // always add global built-in flags
@@ -78,12 +83,12 @@ async function runCommandWithContext(parsed) {
   if (def.percy) {
     let {
       Percy
-    } = await import('@percy/core'); // set defaults and prune preconfiguraton options
+    } = await import('@percy/core'); // shallow merge with default options
 
-    let conf = del({
+    let conf = {
       server: false,
       ...def.percy
-    }, 'discoveryFlags');
+    };
     if (pkg) conf.clientInfo || (conf.clientInfo = `${pkg.name}/${pkg.version}`);
     conf.environmentInfo || (conf.environmentInfo = `node/${process.version}`);
     Object.defineProperty(context, 'percy', {

package/dist/flags.js

@@ -40,6 +40,17 @@ export const dryRun = {
   group: 'Percy',
   short: 'd'
 };
+export const port = {
+  name: 'port',
+  description: 'Local CLI server port',
+  env: 'PERCY_SERVER_PORT',
+  percyrc: 'port',
+  type: 'number',
+  parse: Number,
+  default: 5338,
+  group: 'Percy',
+  short: 'P'
+};
 export const allowedHostnames = {
   name: 'allowed-hostname',
   description: 'Allowed hostnames to capture in asset discovery',
@@ -82,4 +93,7 @@ export const debug = {
 
 export const GLOBAL = [verbose, quiet, silent];
 export const PERCY = [config, dryRun];
-export const DISCOVERY = [allowedHostnames, disallowedHostnames, networkIdleTimeout, disableCache, debug];
+export const SERVER = [port];
+export const DISCOVERY = [allowedHostnames, disallowedHostnames, networkIdleTimeout, disableCache, debug]; // export the namespace as the default
+
+export * as default from './flags.js';

package/dist/help.js

@@ -51,13 +51,15 @@ function commandUsage(command) {
 } // Helper to return an array of visible command usage-description pairs.
 
 
-async function visibleCommands(command, help) {
+async function visibleCommands(command, nested) {
   let commands = command.definition.commands ?? [];
   if (typeof commands === 'function') commands = await commands();
   let visible = [];
 
   for (let cmd of commands) {
-    // create parent references and format subcommand names
+    // skip hidden commands entirely
+    if (cmd.definition.hidden) continue; // create parent references and format subcommand names
+
     let name = command.parent ? `${command.name}:${cmd.name}` : cmd.name;
     cmd = { ...cmd,
       name,
@@ -69,16 +71,16 @@ async function visibleCommands(command, help) {
         description
       } = cmd.definition;
       visible.push([commandUsage(cmd), description]);
-    } // include visible subcommands without their implicit help
+    } // include visible subcommands, but not deeply nested subcommands
 
 
-    if (cmd.definition.commands) {
-      visible.push(...(await visibleCommands(cmd, false)));
+    if (!nested && cmd.definition.commands) {
+      visible.push(...(await visibleCommands(cmd, true)));
     }
   } // include implicit help if there are visible commands
 
 
-  if (help !== false && visible.length) {
+  if (!nested && visible.length) {
     visible.push(['help [command]', 'Display command help']);
   }
 

package/dist/parse.js

@@ -45,7 +45,7 @@ async function maybeParseCommand(input, parsed) {
   let command;
 
   for (let name of names) {
-    var _parent$definition$co;
+    var _parent$definition$co, _command;
 
     let parent = command || parsed.command; // find any nested command by name
 
@@ -56,7 +56,11 @@ async function maybeParseCommand(input, parsed) {
     command = await normalizeCommand(command, {
       name,
       parent
-    });
+    }); // some hidden commands should produce warnings when used
+
+    if (typeof ((_command = command) === null || _command === void 0 ? void 0 : _command.definition.hidden) === 'string') {
+      logger('cli').warn(`\nWarning: ${command.definition.hidden}\n`);
+    }
   }
 
   if (command) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-command",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -24,6 +24,7 @@
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
+    "./flags": "./dist/flags.js",
     "./utils": "./dist/utils.js",
     "./test/helpers": "./test/helpers.js"
   },
@@ -34,9 +35,9 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.9.1",
-    "@percy/core": "1.9.1",
-    "@percy/logger": "1.9.1"
+    "@percy/config": "1.10.0",
+    "@percy/core": "1.10.0",
+    "@percy/logger": "1.10.0"
   },
-  "gitHead": "b2ff5100698488c8bf8c681972f4f2b9a1e2055f"
+  "gitHead": "a6934eda4fc3b84845ae606d7f5a901f25e0a56f"
 }