From 948f4bb87cb8099c4542997c3d63f25fb9a843e1 Mon Sep 17 00:00:00 2001 From: Melanie Beck Date: Fri, 30 Sep 2022 14:58:52 -0500 Subject: [PATCH] run npm audit fix --- node_modules/ansi-regex/index.js | 2 +- node_modules/ansi-regex/package.json | 128 +- node_modules/chokidar/package.json | 124 +- node_modules/commander/CHANGELOG.md | 779 ++- node_modules/commander/Readme.md | 809 ++- node_modules/commander/index.js | 3064 +++++++----- node_modules/commander/package.json | 160 +- node_modules/commander/typings/index.d.ts | 565 ++- node_modules/dot-prop/index.js | 18 + node_modules/dot-prop/package.json | 110 +- node_modules/dot-prop/readme.md | 2 + node_modules/glob-parent/package.json | 109 +- node_modules/got/package.json | 139 +- node_modules/ini/ini.js | 86 +- node_modules/ini/package.json | 105 +- node_modules/is-wsl/index.js | 8 +- node_modules/is-wsl/package.json | 144 +- node_modules/kind-of/CHANGELOG.md | 7 +- node_modules/kind-of/README.md | 38 +- node_modules/kind-of/index.js | 2 +- node_modules/kind-of/package.json | 179 +- node_modules/latest-version/package.json | 99 +- node_modules/markdown-it/package.json | 100 +- node_modules/minimist/example/parse.js | 2 +- node_modules/minimist/index.js | 19 +- node_modules/minimist/package.json | 111 +- node_modules/minimist/readme.markdown | 35 +- node_modules/minimist/test/bool.js | 12 + node_modules/nodemon/package.json | 131 +- node_modules/open/index.d.ts | 134 +- node_modules/open/index.js | 284 +- node_modules/open/license | 2 +- node_modules/open/package.json | 174 +- node_modules/open/readme.md | 128 +- node_modules/open/xdg-open | 2 +- node_modules/package-json/package.json | 109 +- node_modules/querystringify/README.md | 9 +- node_modules/querystringify/index.js | 6 +- node_modules/querystringify/package.json | 125 +- node_modules/reload/CHANGELOG.md | 312 -- node_modules/reload/README.md | 7 +- node_modules/reload/bin/reload | 30 +- node_modules/reload/index.js | 2 +- node_modules/reload/lib/reload-client.js | 18 +- node_modules/reload/lib/reload-server.js | 57 +- node_modules/reload/lib/reload.js | 12 +- node_modules/reload/package.json | 141 +- node_modules/requires-port/package.json | 119 +- node_modules/undefsafe/.npmignore | 2 - node_modules/undefsafe/example.js | 2 +- node_modules/undefsafe/lib/undefsafe.js | 24 +- .../node_modules/debug/.coveralls.yml | 1 - .../undefsafe/node_modules/debug/.eslintrc | 11 - .../undefsafe/node_modules/debug/.npmignore | 9 - .../undefsafe/node_modules/debug/.travis.yml | 14 - .../undefsafe/node_modules/debug/CHANGELOG.md | 362 -- .../undefsafe/node_modules/debug/LICENSE | 19 - .../undefsafe/node_modules/debug/Makefile | 50 - .../undefsafe/node_modules/debug/README.md | 312 -- .../node_modules/debug/component.json | 19 - .../node_modules/debug/karma.conf.js | 70 - .../undefsafe/node_modules/debug/node.js | 1 - .../undefsafe/node_modules/debug/package.json | 128 - .../node_modules/debug/src/browser.js | 185 - .../undefsafe/node_modules/debug/src/debug.js | 202 - .../undefsafe/node_modules/debug/src/index.js | 10 - .../node_modules/debug/src/inspector-log.js | 15 - .../undefsafe/node_modules/debug/src/node.js | 248 - node_modules/undefsafe/package.json | 103 +- node_modules/update-notifier/package.json | 154 +- node_modules/url-parse/README.md | 12 +- node_modules/url-parse/dist/url-parse.js | 256 +- node_modules/url-parse/dist/url-parse.min.js | 2 +- .../url-parse/dist/url-parse.min.js.map | 2 +- node_modules/url-parse/index.js | 193 +- node_modules/url-parse/package.json | 139 +- node_modules/ws/README.md | 129 +- node_modules/ws/index.js | 1 - node_modules/ws/lib/buffer-util.js | 14 +- node_modules/ws/lib/event-target.js | 2 +- node_modules/ws/lib/extension.js | 41 +- node_modules/ws/lib/permessage-deflate.js | 34 +- node_modules/ws/lib/receiver.js | 11 +- node_modules/ws/lib/sender.js | 18 +- node_modules/ws/lib/stream.js | 149 - node_modules/ws/lib/websocket-server.js | 95 +- node_modules/ws/lib/websocket.js | 241 +- node_modules/ws/package.json | 137 +- out/index.html | 4 +- package-lock.json | 4331 ++++++++++++++++- 90 files changed, 9535 insertions(+), 6975 deletions(-) delete mode 100644 node_modules/reload/CHANGELOG.md delete mode 100644 node_modules/undefsafe/.npmignore delete mode 100644 node_modules/undefsafe/node_modules/debug/.coveralls.yml delete mode 100644 node_modules/undefsafe/node_modules/debug/.eslintrc delete mode 100644 node_modules/undefsafe/node_modules/debug/.npmignore delete mode 100644 node_modules/undefsafe/node_modules/debug/.travis.yml delete mode 100644 node_modules/undefsafe/node_modules/debug/CHANGELOG.md delete mode 100644 node_modules/undefsafe/node_modules/debug/LICENSE delete mode 100644 node_modules/undefsafe/node_modules/debug/Makefile delete mode 100644 node_modules/undefsafe/node_modules/debug/README.md delete mode 100644 node_modules/undefsafe/node_modules/debug/component.json delete mode 100644 node_modules/undefsafe/node_modules/debug/karma.conf.js delete mode 100644 node_modules/undefsafe/node_modules/debug/node.js delete mode 100644 node_modules/undefsafe/node_modules/debug/package.json delete mode 100644 node_modules/undefsafe/node_modules/debug/src/browser.js delete mode 100644 node_modules/undefsafe/node_modules/debug/src/debug.js delete mode 100644 node_modules/undefsafe/node_modules/debug/src/index.js delete mode 100644 node_modules/undefsafe/node_modules/debug/src/inspector-log.js delete mode 100644 node_modules/undefsafe/node_modules/debug/src/node.js delete mode 100644 node_modules/ws/lib/stream.js diff --git a/node_modules/ansi-regex/index.js b/node_modules/ansi-regex/index.js index c4aaecf..93f162c 100644 --- a/node_modules/ansi-regex/index.js +++ b/node_modules/ansi-regex/index.js @@ -2,7 +2,7 @@ module.exports = () => { const pattern = [ - '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\\u0007)', + '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[a-zA-Z\\d]*)*)?\\u0007)', '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))' ].join('|'); diff --git a/node_modules/ansi-regex/package.json b/node_modules/ansi-regex/package.json index d41b66f..0548619 100644 --- a/node_modules/ansi-regex/package.json +++ b/node_modules/ansi-regex/package.json @@ -1,121 +1,53 @@ { - "_args": [ - [ - "ansi-regex@^3.0.0", - "/home/grant/Sites/mdffreport12/node_modules/strip-ansi" - ] - ], - "_from": "ansi-regex@>=3.0.0 <4.0.0", - "_id": "ansi-regex@3.0.0", - "_inCache": true, - "_installable": true, - "_location": "/ansi-regex", - "_nodeVersion": "4.8.3", - "_npmOperationalInternal": { - "host": "s3://npm-registry-packages", - "tmp": "tmp/ansi-regex-3.0.0.tgz_1497985412590_0.5700640194118023" - }, - "_npmUser": { - "email": "sindresorhus@gmail.com", - "name": "sindresorhus" - }, - "_npmVersion": "2.15.11", - "_phantomChildren": {}, - "_requested": { - "name": "ansi-regex", - "raw": "ansi-regex@^3.0.0", - "rawSpec": "^3.0.0", - "scope": null, - "spec": ">=3.0.0 <4.0.0", - "type": "range" - }, - "_requiredBy": [ - "/strip-ansi" - ], - "_resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "_shasum": "ed0317c322064f79466c02966bddb605ab37d998", - "_shrinkwrap": null, - "_spec": "ansi-regex@^3.0.0", - "_where": "/home/grant/Sites/mdffreport12/node_modules/strip-ansi", + "name": "ansi-regex", + "version": "3.0.1", + "description": "Regular expression for matching ANSI escape codes", + "license": "MIT", + "repository": "chalk/ansi-regex", "author": { - "email": "sindresorhus@gmail.com", "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", "url": "sindresorhus.com" }, - "bugs": { - "url": "https://github.com/chalk/ansi-regex/issues" - }, - "dependencies": {}, - "description": "Regular expression for matching ANSI escape codes", - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "directories": {}, - "dist": { - "shasum": "ed0317c322064f79466c02966bddb605ab37d998", - "tarball": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz" - }, "engines": { "node": ">=4" }, + "scripts": { + "test": "xo && ava", + "view-supported": "node fixtures/view-codes.js" + }, "files": [ "index.js" ], - "gitHead": "0a8cc19946c03c38520fe8c086b8adb66f9cce0b", - "homepage": "https://github.com/chalk/ansi-regex#readme", "keywords": [ - "256", "ansi", - "cli", + "styles", "color", - "colors", "colour", - "command-line", + "colors", + "terminal", "console", + "cli", + "string", + "tty", "escape", - "find", "formatting", - "match", - "pattern", - "re", - "regex", - "regexp", "rgb", + "256", "shell", - "string", - "styles", - "terminal", - "test", + "xterm", + "command-line", "text", - "tty", - "xterm" - ], - "license": "MIT", - "maintainers": [ - { - "name": "dthree", - "email": "threedeecee@gmail.com" - }, - { - "name": "qix", - "email": "i.am.qix@gmail.com" - }, - { - "name": "sindresorhus", - "email": "sindresorhus@gmail.com" - } + "regex", + "regexp", + "re", + "match", + "test", + "find", + "pattern" ], - "name": "ansi-regex", - "optionalDependencies": {}, - "readme": "ERROR: No README data found!", - "repository": { - "type": "git", - "url": "git+https://github.com/chalk/ansi-regex.git" - }, - "scripts": { - "test": "xo && ava", - "view-supported": "node fixtures/view-codes.js" - }, - "version": "3.0.0" + "devDependencies": { + "ava": "*", + "xo": "*" + } } diff --git a/node_modules/chokidar/package.json b/node_modules/chokidar/package.json index 2e98bd0..566311a 100644 --- a/node_modules/chokidar/package.json +++ b/node_modules/chokidar/package.json @@ -1,55 +1,41 @@ { - "_args": [ - [ - "chokidar@^2.1.8", - "/home/grant/Sites/mdffreport12/node_modules/nodemon" - ] - ], - "_from": "chokidar@>=2.1.8 <3.0.0", - "_hasShrinkwrap": false, - "_id": "chokidar@2.1.8", - "_inCache": true, - "_installable": true, - "_location": "/chokidar", - "_nodeVersion": "12.8.1", - "_npmOperationalInternal": { - "host": "s3://npm-registry-packages", - "tmp": "tmp/chokidar_2.1.8_1566409705431_0.31447568058522024" - }, - "_npmUser": { - "email": "paul@paulmillr.com", - "name": "paulmillr" - }, - "_npmVersion": "6.10.3", - "_phantomChildren": {}, - "_requested": { - "name": "chokidar", - "raw": "chokidar@^2.1.8", - "rawSpec": "^2.1.8", - "scope": null, - "spec": ">=2.1.8 <3.0.0", - "type": "range" - }, - "_requiredBy": [ - "/nodemon" + "name": "chokidar", + "description": "A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.", + "version": "2.1.8", + "keywords": [ + "fs", + "watch", + "watchFile", + "watcher", + "watching", + "file", + "fsevents" ], - "_resolved": "https://registry.npmjs.org/chokidar/-/chokidar-2.1.8.tgz", - "_shasum": "804b3a7b6a99358c3c5c61e71d8728f041cff917", - "_shrinkwrap": null, - "_spec": "chokidar@^2.1.8", - "_where": "/home/grant/Sites/mdffreport12/node_modules/nodemon", - "author": { - "name": "Paul Miller", - "url": "https://paulmillr.com" + "types": "./types/index.d.ts", + "homepage": "https://github.com/paulmillr/chokidar", + "author": "Paul Miller (https://paulmillr.com), Elan Shanker", + "repository": { + "type": "git", + "url": "https://github.com/paulmillr/chokidar.git" }, "bugs": { "url": "https://github.com/paulmillr/chokidar/issues" }, + "license": "MIT", + "scripts": { + "test": "nyc mocha --exit", + "coveralls": "nyc report --reporter=text-lcov | coveralls", + "dtslint": "dtslint types" + }, + "files": [ + "index.js", + "lib/", + "types/index.d.ts" + ], "dependencies": { "anymatch": "^2.0.0", "async-each": "^1.0.1", "braces": "^2.3.2", - "fsevents": "^1.2.7", "glob-parent": "^3.1.0", "inherits": "^2.0.3", "is-binary-path": "^1.0.0", @@ -59,7 +45,9 @@ "readdirp": "^2.2.1", "upath": "^1.1.1" }, - "description": "A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.", + "optionalDependencies": { + "fsevents": "^1.2.7" + }, "devDependencies": { "@types/node": "^11.9.4", "chai": "^3.2.0", @@ -71,53 +59,5 @@ "rimraf": "^2.4.3", "sinon": "^1.10.3", "sinon-chai": "^2.6.0" - }, - "directories": {}, - "dist": { - "fileCount": 7, - "integrity": "sha512-ZmZUazfOzf0Nve7duiCKD23PFSCs4JPoYyccjUFF3aQkQadqBhfzhjkwBH2mNOG9cTBwhamM37EIsIkZw3nRgg==", - "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdXYPqCRA9TVsSAnZWagAAD3wP/irJQlf2kbB6XF6wRa9I\no6DIDY/XukhWwlXuvQfxnmCmosflH3bq+aXMZK5HPFpfDWHayJ8P1YV2ypiE\nP8cfG3iDCnE0S8TpO73etXxaiUT2NuLBvAhypBWjZS9S4kZ1jp+oFxCs+yG5\nU+ALkILneYpHVCjEmRZkGEKnyYrQYwfDugd89u3Ue3DdqmSlPlm2TQUGi7pz\nfyK4By1+f1Are7SIabOmKruyoyN11Qj3avwzKXjYyWj5knaRm03s7siSZG0p\nFqgrzZwXymIO5qS5nQaEP/F7sbgRG9rzr2s2aKZf1NtOSfmWQn2OiHRBM2aN\nh6IWj5/UfVR3sViLqXwTf52BueJSonGsNhEHeLAxsDDgj62VRqj/tUWFR5Os\naeCf8aNb+HLz/PqLRxtfCGmU0z8ar6i6CWpxUzlZyZqNMDl1gFeR5d7x5Evn\nf2xSQ6/091jx+65XDoapQML26KuGlbt5s9IQLeP+oG4MtYbwcFnsmfaN1t6S\nKt0cL+R0HIGOT3+YiZxUkZIk76I0FVdW0vxgerNdaASubF7Epq1ftNNYio+5\nEsr0OWprSiXlzHH+3Y3L9JAldf3GfW9KPDpTgJorhbrzw0JEuV6z/R5I9Ces\n5naB6w5EPPnhSvhL6J+7Tm6+ge1f5f+U1/+A5QGv8paQYkRH0rvZP2735q3R\nNyeK\r\n=wtk7\r\n-----END PGP SIGNATURE-----\r\n", - "shasum": "804b3a7b6a99358c3c5c61e71d8728f041cff917", - "tarball": "https://registry.npmjs.org/chokidar/-/chokidar-2.1.8.tgz", - "unpackedSize": 87828 - }, - "gitHead": "a60961966746b143c1cdab13b37a90b97c4fae05", - "homepage": "https://github.com/paulmillr/chokidar", - "keywords": [ - "file", - "fs", - "fsevents", - "watch", - "watchFile", - "watcher", - "watching" - ], - "license": "MIT", - "maintainers": [ - { - "name": "es128", - "email": "elan.shanker+npm@gmail.com" - }, - { - "name": "paulmillr", - "email": "paul@paulmillr.com" - } - ], - "name": "chokidar", - "optionalDependencies": { - "fsevents": "^1.2.7" - }, - "readme": "# Chokidar [![Weekly downloads](https://img.shields.io/npm/dw/chokidar.svg)](https://github.com/paulmillr/chokidar) [![Yearly downloads](https://img.shields.io/npm/dy/chokidar.svg)](https://github.com/paulmillr/chokidar) [![Mac/Linux Build Status](https://img.shields.io/travis/paulmillr/chokidar/master.svg?label=Mac%20OSX%20%26%20Linux)](https://travis-ci.org/paulmillr/chokidar) [![Windows Build status](https://img.shields.io/appveyor/ci/paulmillr/chokidar/master.svg?label=Windows)](https://ci.appveyor.com/project/paulmillr/chokidar/branch/master) [![Coverage Status](https://coveralls.io/repos/paulmillr/chokidar/badge.svg)](https://coveralls.io/r/paulmillr/chokidar)\n\n> A neat wrapper around node.js fs.watch / fs.watchFile / FSEvents.\n\n[![NPM](https://nodei.co/npm/chokidar.png)](https://www.npmjs.com/package/chokidar)\n\n## Why?\nNode.js `fs.watch`:\n\n* Doesn't report filenames on MacOS.\n* Doesn't report events at all when using editors like Sublime on MacOS.\n* Often reports events twice.\n* Emits most changes as `rename`.\n* Has [a lot of other issues](https://github.com/nodejs/node/search?q=fs.watch&type=Issues)\n* Does not provide an easy way to recursively watch file trees.\n\nNode.js `fs.watchFile`:\n\n* Almost as bad at event handling.\n* Also does not provide any recursive watching.\n* Results in high CPU utilization.\n\nChokidar resolves these problems.\n\nInitially made for **[Brunch](http://brunch.io)** (an ultra-swift web app build tool), it is now used in\n[gulp](https://github.com/gulpjs/gulp/),\n[karma](http://karma-runner.github.io),\n[PM2](https://github.com/Unitech/PM2),\n[browserify](http://browserify.org/),\n[webpack](http://webpack.github.io/),\n[BrowserSync](http://www.browsersync.io/),\n[Microsoft's Visual Studio Code](https://github.com/microsoft/vscode),\nand [many others](https://www.npmjs.org/browse/depended/chokidar/).\nIt has proven itself in production environments.\n\n## How?\nChokidar does still rely on the Node.js core `fs` module, but when using\n`fs.watch` and `fs.watchFile` for watching, it normalizes the events it\nreceives, often checking for truth by getting file stats and/or dir contents.\n\nOn MacOS, chokidar by default uses a native extension exposing the Darwin\n`FSEvents` API. This provides very efficient recursive watching compared with\nimplementations like `kqueue` available on most \\*nix platforms. Chokidar still\ndoes have to do some work to normalize the events received that way as well.\n\nOn other platforms, the `fs.watch`-based implementation is the default, which\navoids polling and keeps CPU usage down. Be advised that chokidar will initiate\nwatchers recursively for everything within scope of the paths that have been\nspecified, so be judicious about not wasting system resources by watching much\nmore than needed.\n\n## Getting started\nInstall with npm:\n\n```sh\nnpm install chokidar\n```\n\nThen `require` and use it in your code:\n\n```javascript\nvar chokidar = require('chokidar');\n\n// One-liner for current directory, ignores .dotfiles\nchokidar.watch('.', {ignored: /(^|[\\/\\\\])\\../}).on('all', (event, path) => {\n console.log(event, path);\n});\n```\n\n```javascript\n// Example of a more typical implementation structure:\n\n// Initialize watcher.\nvar watcher = chokidar.watch('file, dir, glob, or array', {\n ignored: /(^|[\\/\\\\])\\../,\n persistent: true\n});\n\n// Something to use when events are received.\nvar log = console.log.bind(console);\n// Add event listeners.\nwatcher\n .on('add', path => log(`File ${path} has been added`))\n .on('change', path => log(`File ${path} has been changed`))\n .on('unlink', path => log(`File ${path} has been removed`));\n\n// More possible events.\nwatcher\n .on('addDir', path => log(`Directory ${path} has been added`))\n .on('unlinkDir', path => log(`Directory ${path} has been removed`))\n .on('error', error => log(`Watcher error: ${error}`))\n .on('ready', () => log('Initial scan complete. Ready for changes'))\n .on('raw', (event, path, details) => {\n log('Raw event info:', event, path, details);\n });\n\n// 'add', 'addDir' and 'change' events also receive stat() results as second\n// argument when available: http://nodejs.org/api/fs.html#fs_class_fs_stats\nwatcher.on('change', (path, stats) => {\n if (stats) console.log(`File ${path} changed size to ${stats.size}`);\n});\n\n// Watch new files.\nwatcher.add('new-file');\nwatcher.add(['new-file-2', 'new-file-3', '**/other-file*']);\n\n// Get list of actual paths being watched on the filesystem\nvar watchedPaths = watcher.getWatched();\n\n// Un-watch some files.\nwatcher.unwatch('new-file*');\n\n// Stop watching.\nwatcher.close();\n\n// Full list of options. See below for descriptions. (do not use this example)\nchokidar.watch('file', {\n persistent: true,\n\n ignored: '*.txt',\n ignoreInitial: false,\n followSymlinks: true,\n cwd: '.',\n disableGlobbing: false,\n\n usePolling: true,\n interval: 100,\n binaryInterval: 300,\n alwaysStat: false,\n depth: 99,\n awaitWriteFinish: {\n stabilityThreshold: 2000,\n pollInterval: 100\n },\n\n ignorePermissionErrors: false,\n atomic: true // or a custom 'atomicity delay', in milliseconds (default 100)\n});\n\n```\n\n## API\n\n`chokidar.watch(paths, [options])`\n\n* `paths` (string or array of strings). Paths to files, dirs to be watched\nrecursively, or glob patterns.\n* `options` (object) Options object as defined below:\n\n#### Persistence\n\n* `persistent` (default: `true`). Indicates whether the process\nshould continue to run as long as files are being watched. If set to\n`false` when using `fsevents` to watch, no more events will be emitted\nafter `ready`, even if the process continues to run.\n\n#### Path filtering\n\n* `ignored` ([anymatch](https://github.com/es128/anymatch)-compatible definition)\nDefines files/paths to be ignored. The whole relative or absolute path is\ntested, not just filename. If a function with two arguments is provided, it\ngets called twice per path - once with a single argument (the path), second\ntime with two arguments (the path and the\n[`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats)\nobject of that path).\n* `ignoreInitial` (default: `false`). If set to `false` then `add`/`addDir` events are also emitted for matching paths while\ninstantiating the watching as chokidar discovers these file paths (before the `ready` event).\n* `followSymlinks` (default: `true`). When `false`, only the\nsymlinks themselves will be watched for changes instead of following\nthe link references and bubbling events through the link's path.\n* `cwd` (no default). The base directory from which watch `paths` are to be\nderived. Paths emitted with events will be relative to this.\n* `disableGlobbing` (default: `false`). If set to `true` then the strings passed to `.watch()` and `.add()` are treated as\nliteral path names, even if they look like globs.\n\n#### Performance\n\n* `usePolling` (default: `false`).\nWhether to use fs.watchFile (backed by polling), or fs.watch. If polling\nleads to high CPU utilization, consider setting this to `false`. It is\ntypically necessary to **set this to `true` to successfully watch files over\na network**, and it may be necessary to successfully watch files in other\nnon-standard situations. Setting to `true` explicitly on MacOS overrides the\n`useFsEvents` default. You may also set the CHOKIDAR_USEPOLLING env variable\nto true (1) or false (0) in order to override this option.\n* _Polling-specific settings_ (effective when `usePolling: true`)\n * `interval` (default: `100`). Interval of file system polling. You may also\n set the CHOKIDAR_INTERVAL env variable to override this option.\n * `binaryInterval` (default: `300`). Interval of file system\n polling for binary files.\n ([see list of binary extensions](https://github.com/sindresorhus/binary-extensions/blob/master/binary-extensions.json))\n* `useFsEvents` (default: `true` on MacOS). Whether to use the\n`fsevents` watching interface if available. When set to `true` explicitly\nand `fsevents` is available this supercedes the `usePolling` setting. When\nset to `false` on MacOS, `usePolling: true` becomes the default.\n* `alwaysStat` (default: `false`). If relying upon the\n[`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats)\nobject that may get passed with `add`, `addDir`, and `change` events, set\nthis to `true` to ensure it is provided even in cases where it wasn't\nalready available from the underlying watch events.\n* `depth` (default: `undefined`). If set, limits how many levels of\nsubdirectories will be traversed.\n* `awaitWriteFinish` (default: `false`).\nBy default, the `add` event will fire when a file first appears on disk, before\nthe entire file has been written. Furthermore, in some cases some `change`\nevents will be emitted while the file is being written. In some cases,\nespecially when watching for large files there will be a need to wait for the\nwrite operation to finish before responding to a file creation or modification.\nSetting `awaitWriteFinish` to `true` (or a truthy value) will poll file size,\nholding its `add` and `change` events until the size does not change for a\nconfigurable amount of time. The appropriate duration setting is heavily\ndependent on the OS and hardware. For accurate detection this parameter should\nbe relatively high, making file watching much less responsive.\nUse with caution.\n * *`options.awaitWriteFinish` can be set to an object in order to adjust\n timing params:*\n * `awaitWriteFinish.stabilityThreshold` (default: 2000). Amount of time in\n milliseconds for a file size to remain constant before emitting its event.\n * `awaitWriteFinish.pollInterval` (default: 100). File size polling interval.\n\n#### Errors\n* `ignorePermissionErrors` (default: `false`). Indicates whether to watch files\nthat don't have read permissions if possible. If watching fails due to `EPERM`\nor `EACCES` with this set to `true`, the errors will be suppressed silently.\n* `atomic` (default: `true` if `useFsEvents` and `usePolling` are `false`).\nAutomatically filters out artifacts that occur when using editors that use\n\"atomic writes\" instead of writing directly to the source file. If a file is\nre-added within 100 ms of being deleted, Chokidar emits a `change` event\nrather than `unlink` then `add`. If the default of 100 ms does not work well\nfor you, you can override it by setting `atomic` to a custom value, in\nmilliseconds.\n\n### Methods & Events\n\n`chokidar.watch()` produces an instance of `FSWatcher`. Methods of `FSWatcher`:\n\n* `.add(path / paths)`: Add files, directories, or glob patterns for tracking.\nTakes an array of strings or just one string.\n* `.on(event, callback)`: Listen for an FS event.\nAvailable events: `add`, `addDir`, `change`, `unlink`, `unlinkDir`, `ready`,\n`raw`, `error`.\nAdditionally `all` is available which gets emitted with the underlying event\nname and path for every event other than `ready`, `raw`, and `error`.\n* `.unwatch(path / paths)`: Stop watching files, directories, or glob patterns.\nTakes an array of strings or just one string.\n* `.close()`: Removes all listeners from watched files.\n* `.getWatched()`: Returns an object representing all the paths on the file\nsystem being watched by this `FSWatcher` instance. The object's keys are all the\ndirectories (using absolute paths unless the `cwd` option was used), and the\nvalues are arrays of the names of the items contained in each directory.\n\n## CLI\n\nIf you need a CLI interface for your file watching, check out\n[chokidar-cli](https://github.com/kimmobrunfeldt/chokidar-cli), allowing you to\nexecute a command on each change, or get a stdio stream of change events.\n\n## Install Troubleshooting\n\n* `npm WARN optional dep failed, continuing fsevents@n.n.n`\n * This message is normal part of how `npm` handles optional dependencies and is\n not indicative of a problem. Even if accompanied by other related error messages,\n Chokidar should function properly.\n\n* `ERR! stack Error: Python executable \"python\" is v3.4.1, which is not supported by gyp.`\n * You should be able to resolve this by installing python 2.7 and running:\n `npm config set python python2.7`\n\n* `gyp ERR! stack Error: not found: make`\n * On Mac, install the XCode command-line tools\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2012-2019 Paul Miller (https://paulmillr.com) & Elan Shanker\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the “Software”), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n", - "readmeFilename": "README.md", - "repository": { - "type": "git", - "url": "git+https://github.com/paulmillr/chokidar.git" - }, - "scripts": { - "coveralls": "nyc report --reporter=text-lcov | coveralls", - "dtslint": "dtslint types", - "test": "nyc mocha --exit" - }, - "types": "./types/index.d.ts", - "version": "2.1.8" + } } diff --git a/node_modules/commander/CHANGELOG.md b/node_modules/commander/CHANGELOG.md index 2d81159..0b55881 100644 --- a/node_modules/commander/CHANGELOG.md +++ b/node_modules/commander/CHANGELOG.md @@ -5,511 +5,436 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). (Format adopted after v3.0.0.) -## [3.0.2] (2019-09-27) + + -### Fixed - -* Improve tracking of executable subcommands. - -### Changed - -* update development dependencies - -## [3.0.1] (2019-08-30) +## [7.2.0] (2021-03-26) ### Added -* .name and .usage to README ([#1010]) -* Table of Contents to README ([#1010]) -* TypeScript definition for `executableFile` in CommandOptions ([#1028]) +- TypeScript typing for `parent` property on `Command` ([#1475]) +- TypeScript typing for `.attributeName()` on `Option` ([#1483]) +- support information in package ([#1477]) ### Changed -* consistently use `const` rather than `var` in README ([#1026]) - -### Fixed - -* help for sub commands with custom executableFile ([#1018]) - -3.0.0 / 2019-08-08 -================= - - * Add option to specify executable file name ([#999]) - * e.g. `.command('clone', 'clone description', { executableFile: 'myClone' })` - * Change docs for `.command` to contrast action handler vs git-style executable. ([#938] [#990]) - * **Breaking** Change TypeScript to use overloaded function for `.command`. ([#938] [#990]) - * Change to use straight quotes around strings in error messages (like 'this' instead of `this') ([#915]) - * Add TypeScript "reference types" for node ([#974]) - * Add support for hyphen as an option argument in subcommands ([#697]) - * Add support for a short option flag and its value to be concatenated for action handler subcommands ([#599]) - * e.g. `-p 80` can also be supplied as `-p80` - * Add executable arguments to spawn in win32, for git-style executables ([#611]) - * e.g. `node --harmony myCommand.js clone` - * Add parent command as prefix of subcommand in help ([#980]) - * Add optional custom description to `.version` ([#963]) - * e.g. `program.version('0.0.1', '-v, --vers', 'output the current version')` - * Add `.helpOption(flags, description)` routine to customise help flags and description ([#963]) - * e.g. `.helpOption('-e, --HELP', 'read more information')` - * Fix behavior of --no-* options ([#795]) - * can now define both `--foo` and `--no-foo` - * **Breaking** custom event listeners: `--no-foo` on cli now emits `option:no-foo` (previously `option:foo`) - * **Breaking** default value: defining `--no-foo` after defining `--foo` leaves the default value unchanged (previously set it to false) - * allow boolean default value, such as from environment ([#987]) - * Increment inspector port for spawned subcommands ([#991]) - * e.g. `node --inspect myCommand.js clone` - -Example Breaking Changes ------------------------- - -The custom event for a negated option like `--no-foo` is `option:no-foo` (previously `option:foo`). - -```js -program - .option('--no-foo') - .on('option:no-foo', () => { - console.log('removing foo'); - }); -``` - -When using TypeScript, adding a command does not allow an explicit `undefined` for an unwanted executable description (e.g -for a command with an action handler). - -```js -program - .command('action1', undefined, { noHelp: true }) // No longer valid - .command('action2', { noHelp: true }) // Correct -``` - -3.0.0-0 Prerelease / 2019-07-28 -============================== - -(Released as 3.0.0) - -2.20.0 / 2019-04-02 -================== - - * fix: resolve symbolic links completely when hunting for subcommands (#935) - * Update index.d.ts (#930) - * Update Readme.md (#924) - * Remove --save option as it isn't required anymore (#918) - * Add link to the license file (#900) - * Added example of receiving args from options (#858) - * Added missing semicolon (#882) - * Add extension to .eslintrc (#876) - -2.19.0 / 2018-10-02 -================== - - * Removed newline after Options and Commands headers (#864) - * Bugfix - Error output (#862) - * Fix to change default value to string (#856) - -2.18.0 / 2018-09-07 -================== - - * Standardize help output (#853) - * chmod 644 travis.yml (#851) - * add support for execute typescript subcommand via ts-node (#849) - -2.17.1 / 2018-08-07 -================== - - * Fix bug in command emit (#844) - -2.17.0 / 2018-08-03 -================== - - * fixed newline output after help information (#833) - * Fix to emit the action even without command (#778) - * npm update (#823) - -2.16.0 / 2018-06-29 -================== - - * Remove Makefile and `test/run` (#821) - * Make 'npm test' run on Windows (#820) - * Add badge to display install size (#807) - * chore: cache node_modules (#814) - * chore: remove Node.js 4 (EOL), add Node.js 10 (#813) - * fixed typo in readme (#812) - * Fix types (#804) - * Update eslint to resolve vulnerabilities in lodash (#799) - * updated readme with custom event listeners. (#791) - * fix tests (#794) - -2.15.0 / 2018-03-07 -================== - - * Update downloads badge to point to graph of downloads over time instead of duplicating link to npm - * Arguments description - -2.14.1 / 2018-02-07 -================== - - * Fix typing of help function - -2.14.0 / 2018-02-05 -================== - - * only register the option:version event once - * Fixes issue #727: Passing empty string for option on command is set to undefined - * enable eqeqeq rule - * resolves #754 add linter configuration to project - * resolves #560 respect custom name for version option - * document how to override the version flag - * document using options per command - -2.13.0 / 2018-01-09 -================== - - * Do not print default for --no- - * remove trailing spaces in command help - * Update CI's Node.js to LTS and latest version - * typedefs: Command and Option types added to commander namespace - -2.12.2 / 2017-11-28 -================== - - * fix: typings are not shipped - -2.12.1 / 2017-11-23 -================== - - * Move @types/node to dev dependency - -2.12.0 / 2017-11-22 -================== - - * add attributeName() method to Option objects - * Documentation updated for options with --no prefix - * typings: `outputHelp` takes a string as the first parameter - * typings: use overloads - * feat(typings): update to match js api - * Print default value in option help - * Fix translation error - * Fail when using same command and alias (#491) - * feat(typings): add help callback - * fix bug when description is add after command with options (#662) - * Format js code - * Rename History.md to CHANGELOG.md (#668) - * feat(typings): add typings to support TypeScript (#646) - * use current node - -2.11.0 / 2017-07-03 -================== - - * Fix help section order and padding (#652) - * feature: support for signals to subcommands (#632) - * Fixed #37, --help should not display first (#447) - * Fix translation errors. (#570) - * Add package-lock.json - * Remove engines - * Upgrade package version - * Prefix events to prevent conflicts between commands and options (#494) - * Removing dependency on graceful-readlink - * Support setting name in #name function and make it chainable - * Add .vscode directory to .gitignore (Visual Studio Code metadata) - * Updated link to ruby commander in readme files - -2.10.0 / 2017-06-19 -================== - - * Update .travis.yml. drop support for older node.js versions. - * Fix require arguments in README.md - * On SemVer you do not start from 0.0.1 - * Add missing semi colon in readme - * Add save param to npm install - * node v6 travis test - * Update Readme_zh-CN.md - * Allow literal '--' to be passed-through as an argument - * Test subcommand alias help - * link build badge to master branch - * Support the alias of Git style sub-command - * added keyword commander for better search result on npm - * Fix Sub-Subcommands - * test node.js stable - * Fixes TypeError when a command has an option called `--description` - * Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets. - * Add chinese Readme file - -2.9.0 / 2015-10-13 -================== - - * Add option `isDefault` to set default subcommand #415 @Qix- - * Add callback to allow filtering or post-processing of help text #434 @djulien - * Fix `undefined` text in help information close #414 #416 @zhiyelee - -2.8.1 / 2015-04-22 -================== - - * Back out `support multiline description` Close #396 #397 - -2.8.0 / 2015-04-07 -================== - - * Add `process.execArg` support, execution args like `--harmony` will be passed to sub-commands #387 @DigitalIO @zhiyelee - * Fix bug in Git-style sub-commands #372 @zhiyelee - * Allow commands to be hidden from help #383 @tonylukasavage - * When git-style sub-commands are in use, yet none are called, display help #382 @claylo - * Add ability to specify arguments syntax for top-level command #258 @rrthomas - * Support multiline descriptions #208 @zxqfox - -2.7.1 / 2015-03-11 -================== - - * Revert #347 (fix collisions when option and first arg have same name) which causes a bug in #367. - -2.7.0 / 2015-03-09 -================== - - * Fix git-style bug when installed globally. Close #335 #349 @zhiyelee - * Fix collisions when option and first arg have same name. Close #346 #347 @tonylukasavage - * Add support for camelCase on `opts()`. Close #353 @nkzawa - * Add node.js 0.12 and io.js to travis.yml - * Allow RegEx options. #337 @palanik - * Fixes exit code when sub-command failing. Close #260 #332 @pirelenito - * git-style `bin` files in $PATH make sense. Close #196 #327 @zhiyelee - -2.6.0 / 2014-12-30 -================== - - * added `Command#allowUnknownOption` method. Close #138 #318 @doozr @zhiyelee - * Add application description to the help msg. Close #112 @dalssoft - -2.5.1 / 2014-12-15 -================== - - * fixed two bugs incurred by variadic arguments. Close #291 @Quentin01 #302 @zhiyelee - -2.5.0 / 2014-10-24 -================== - - * add support for variadic arguments. Closes #277 @whitlockjc +- improvements to error messages, README, and tests +- update dependencies -2.4.0 / 2014-10-17 -================== +## [7.1.0] (2021-02-15) - * fixed a bug on executing the coercion function of subcommands option. Closes #270 - * added `Command.prototype.name` to retrieve command name. Closes #264 #266 @tonylukasavage - * added `Command.prototype.opts` to retrieve all the options as a simple object of key-value pairs. Closes #262 @tonylukasavage - * fixed a bug on subcommand name. Closes #248 @jonathandelgado - * fixed function normalize doesn’t honor option terminator. Closes #216 @abbr - -2.3.0 / 2014-07-16 -================== - - * add command alias'. Closes PR #210 - * fix: Typos. Closes #99 - * fix: Unused fs module. Closes #217 - -2.2.0 / 2014-03-29 -================== +### Added - * add passing of previous option value - * fix: support subcommands on windows. Closes #142 - * Now the defaultValue passed as the second argument of the coercion function. +- support for named imports from ECMAScript modules ([#1440]) +- add `.cjs` to list of expected script file extensions ([#1449]) +- allow using option choices and variadic together ([#1454]) -2.1.0 / 2013-11-21 -================== +### Fixed - * add: allow cflag style option params, unit test, fixes #174 +- replace use of deprecated `process.mainModule` ([#1448]) +- regression for legacy `command('*')` and call when command line includes options ([#1464]) +- regression for `on('command:*', ...)` and call when command line includes unknown options ([#1464]) +- display best error for combination of unknown command and unknown option (i.e. unknown command) ([#1464]) -2.0.0 / 2013-07-18 -================== +### Changed - * remove input methods (.prompt, .confirm, etc) +- make TypeScript typings tests stricter ([#1453]) +- improvements to README and tests -1.3.2 / 2013-07-18 -================== +## [7.0.0] (2021-01-15) - * add support for sub-commands to co-exist with the original command +### Added -1.3.1 / 2013-07-18 -================== +- `.enablePositionalOptions()` to let program and subcommand reuse same option ([#1427]) +- `.passThroughOptions()` to pass options through to other programs without needing `--` ([#1427]) +- `.allowExcessArguments(false)` to show an error message if there are too many command-arguments on command line for the action handler ([#1409]) +- `.configureOutput()` to modify use of stdout and stderr or customise display of errors ([#1387]) +- use `.addHelpText()` to add text before or after the built-in help, for just current command or also for all subcommands ([#1296]) +- enhance Option class ([#1331]) + - allow hiding options from help + - allow restricting option arguments to a list of choices + - allow setting how default value is shown in help +- `.createOption()` to support subclassing of automatically created options (like `.createCommand()`) ([#1380]) +- refactor the code generating the help into a separate public Help class ([#1365]) + - support sorting subcommands and options in help + - support specifying wrap width (columns) + - allow subclassing Help class + - allow configuring Help class without subclassing - * add quick .runningCommand hack so you can opt-out of other logic when running a sub command +### Changed -1.3.0 / 2013-07-09 -================== +- *Breaking:* options are stored safely by default, not as properties on the command ([#1409]) + - this especially affects accessing options on program, use `program.opts()` + - revert behaviour with `.storeOptionsAsProperties()` +- *Breaking:* action handlers are passed options and command separately ([#1409]) +- deprecated callback parameter to `.help()` and `.outputHelp()` (removed from README) ([#1296]) +- *Breaking:* errors now displayed using `process.stderr.write()` instead of `console.error()` +- deprecate `.on('--help')` (removed from README) ([#1296]) +- initialise the command description to empty string (previously undefined) ([#1365]) +- document and annotate deprecated routines ([#1349]) - * add EACCES error handling - * fix sub-command --help +### Fixed -1.2.0 / 2013-06-13 -================== +- wrapping bugs in help ([#1365]) + - first line of command description was wrapping two characters early + - pad width calculation was not including help option and help command + - pad width calculation was including hidden options and commands +- improve backwards compatibility for custom command event listeners ([#1403]) + +### Deleted - * allow "-" hyphen as an option argument - * support for RegExp coercion +- *Breaking:* `.passCommandToAction()` ([#1409]) + - no longer needed as action handler is passed options and command +- *Breaking:* "extra arguments" parameter to action handler ([#1409]) + - if being used to detect excess arguments, there is now an error available by setting `.allowExcessArguments(false)` -1.1.1 / 2012-11-20 -================== +### Migration Tips - * add more sub-command padding - * fix .usage() when args are present. Closes #106 +The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately. -1.1.0 / 2012-11-16 -================== +If you wish to restore the old behaviour and get running quickly you can call `.storeOptionsAsProperties()`. +To allow you to move to the new code patterns incrementally, the action handler will be passed the command _twice_, +to match the new "options" and "command" parameters (see below). - * add git-style executable subcommand support. Closes #94 +**program options** -1.0.5 / 2012-10-09 -================== +Use the `.opts()` method to access the options. This is available on any command but is used most with the program. - * fix `--name` clobbering. Closes #92 - * fix examples/help. Closes #89 +```js +program.option('-d, --debug'); +program.parse(); +// Old code before Commander 7 +if (program.debug) console.log(`Program name is ${program.name()}`); +``` -1.0.4 / 2012-09-03 -================== +```js +// New code +const options = program.opts(); +if (options.debug) console.log(`Program name is ${program.name()}`); +``` - * add `outputHelp()` method. +**action handler** -1.0.3 / 2012-08-30 -================== +The action handler gets passed a parameter for each command-argument you declared. Previously by default the next parameter was the command object with the options as properties. Now the next two parameters are instead the options and the command. If you +only accessed the options there may be no code changes required. - * remove invalid .version() defaulting +```js +program + .command('compress ') + .option('-t, --trace') + // Old code before Commander 7 + .action((filename, cmd)) => { + if (cmd.trace) console.log(`Command name is ${cmd.name()}`); + }); +``` -1.0.2 / 2012-08-24 -================== +```js + // New code + .action((filename, options, command)) => { + if (options.trace) console.log(`Command name is ${command.name()}`); + }); +``` - * add `--foo=bar` support [arv] - * fix password on node 0.8.8. Make backward compatible with 0.6 [focusaurus] +If you already set `.storeOptionsAsProperties(false)` you may still need to adjust your code. -1.0.1 / 2012-08-03 -================== +```js +program + .command('compress ') + .storeOptionsAsProperties(false) + .option('-t, --trace') + // Old code before Commander 7 + .action((filename, command)) => { + if (command.opts().trace) console.log(`Command name is ${command.name()}`); + }); +``` - * fix issue #56 - * fix tty.setRawMode(mode) was moved to tty.ReadStream#setRawMode() (i.e. process.stdin.setRawMode()) +```js + // New code + .action((filename, options, command)) => { + if (command.opts().trace) console.log(`Command name is ${command.name()}`); + }); +``` -1.0.0 / 2012-07-05 -================== +## [7.0.0-2] (2020-12-14) - * add support for optional option descriptions - * add defaulting of `.version()` to package.json's version +(Released in 7.0.0) -0.6.1 / 2012-06-01 -================== +## [7.0.0-1] (2020-11-21) - * Added: append (yes or no) on confirmation - * Added: allow node.js v0.7.x +(Released in 7.0.0) -0.6.0 / 2012-04-10 -================== +## [7.0.0-0] (2020-10-25) - * Added `.prompt(obj, callback)` support. Closes #49 - * Added default support to .choose(). Closes #41 - * Fixed the choice example +(Released in 7.0.0) -0.5.1 / 2011-12-20 -================== +## [6.2.1] (2020-12-13) - * Fixed `password()` for recent nodes. Closes #36 +### Fixed -0.5.0 / 2011-12-04 -================== +- some tests failed if directory path included a space ([1390]) - * Added sub-command option support [itay] +## [6.2.0] (2020-10-25) -0.4.3 / 2011-12-04 -================== +### Added - * Fixed custom help ordering. Closes #32 +- added 'tsx' file extension for stand-alone executable subcommands ([#1368]) +- documented second parameter to `.description()` to describe command arguments ([#1353]) +- documentation of special cases with options taking varying numbers of option-arguments ([#1332]) +- documentation for terminology ([#1361]) + +### Fixed -0.4.2 / 2011-11-24 -================== +- add missing TypeScript definition for `.addHelpCommand()' ([#1375]) +- removed blank line after "Arguments:" in help, to match "Options:" and "Commands:" ([#1360]) - * Added travis support - * Fixed: line-buffered input automatically trimmed. Closes #31 +### Changed -0.4.1 / 2011-11-18 -================== +- update dependencies - * Removed listening for "close" on --help +## [6.1.0] (2020-08-28) -0.4.0 / 2011-11-15 -================== +### Added - * Added support for `--`. Closes #24 +- include URL to relevant section of README for error for potential conflict between Command properties and option values ([#1306]) +- `.combineFlagAndOptionalValue(false)` to ease upgrade path from older versions of Commander ([#1326]) +- allow disabling the built-in help option using `.helpOption(false)` ([#1325]) +- allow just some arguments in `argumentDescription` to `.description()` ([#1323]) -0.3.3 / 2011-11-14 -================== +### Changed - * Fixed: wait for close event when writing help info [Jerry Hamlet] +- tidy async test and remove lint override ([#1312]) -0.3.2 / 2011-11-01 -================== +### Fixed - * Fixed long flag definitions with values [felixge] +- executable subcommand launching when script path not known ([#1322]) -0.3.1 / 2011-10-31 -================== +## [6.0.0] (2020-07-21) - * Changed `--version` short flag to `-V` from `-v` - * Changed `.version()` so it's configurable [felixge] +### Added -0.3.0 / 2011-10-31 -================== +- add support for variadic options ([#1250]) +- allow options to be added with just a short flag ([#1256]) + - *Breaking* the option property has same case as flag. e.g. flag `-n` accessed as `opts().n` (previously uppercase) +- *Breaking* throw an error if there might be a clash between option name and a Command property, with advice on how to resolve ([#1275]) - * Added support for long flags only. Closes #18 +### Fixed -0.2.1 / 2011-10-24 -================== +- Options which contain -no- in the middle of the option flag should not be treated as negatable. ([#1301]) - * "node": ">= 0.4.x < 0.7.0". Closes #20 +## [6.0.0-0] (2020-06-20) -0.2.0 / 2011-09-26 -================== +(Released in 6.0.0) - * Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs] +## [5.1.0] (2020-04-25) -0.1.0 / 2011-08-24 -================== +### Added - * Added support for custom `--help` output +- support for multiple command aliases, the first of which is shown in the auto-generated help ([#531], [#1236]) +- configuration support in `addCommand()` for `hidden` and `isDefault` ([#1232]) -0.0.5 / 2011-08-18 -================== +### Fixed - * Changed: when the user enters nothing prompt for password again - * Fixed issue with passwords beginning with numbers [NuckChorris] +- omit masked help flags from the displayed help ([#645], [#1247]) +- remove old short help flag when change help flags using `helpOption` ([#1248]) -0.0.4 / 2011-08-15 -================== +### Changed - * Fixed `Commander#args` +- remove use of `arguments` to improve auto-generated help in editors ([#1235]) +- rename `.command()` configuration `noHelp` to `hidden` (but not remove old support) ([#1232]) +- improvements to documentation +- update dependencies +- update tested versions of node +- eliminate lint errors in TypeScript ([#1208]) -0.0.3 / 2011-08-15 -================== +## [5.0.0] (2020-03-14) - * Added default option value support +### Added -0.0.2 / 2011-08-15 -================== +* support for nested commands with action-handlers ([#1] [#764] [#1149]) +* `.addCommand()` for adding a separately configured command ([#764] [#1149]) +* allow a non-executable to be set as the default command ([#742] [#1149]) +* implicit help command when there are subcommands (previously only if executables) ([#1149]) +* customise implicit help command with `.addHelpCommand()` ([#1149]) +* display error message for unknown subcommand, by default ([#432] [#1088] [#1149]) +* display help for missing subcommand, by default ([#1088] [#1149]) +* combined short options as single argument may include boolean flags and value flag and value (e.g. `-a -b -p 80` can be written as `-abp80`) ([#1145]) +* `.parseOption()` includes short flag and long flag expansions ([#1145]) +* `.helpInformation()` returns help text as a string, previously a private routine ([#1169]) +* `.parse()` implicitly uses `process.argv` if arguments not specified ([#1172]) +* optionally specify where `.parse()` arguments "from", if not following node conventions ([#512] [#1172]) +* suggest help option along with unknown command error ([#1179]) +* TypeScript definition for `commands` property of `Command` ([#1184]) +* export `program` property ([#1195]) +* `createCommand` factory method to simplify subclassing ([#1191]) - * Added mask support to `Command#password(str[, mask], fn)` - * Added `Command#password(str, fn)` +### Fixed -0.0.1 / 2010-01-03 -================== +* preserve argument order in subcommands ([#508] [#962] [#1138]) +* do not emit `command:*` for executable subcommands ([#809] [#1149]) +* action handler called whether or not there are non-option arguments ([#1062] [#1149]) +* combining option short flag and value in single argument now works for subcommands ([#1145]) +* only add implicit help command when it will not conflict with other uses of argument ([#1153] [#1149]) +* implicit help command works with command aliases ([#948] [#1149]) +* options are validated whether or not there is an action handler ([#1149]) - * Initial release +### Changed -[#599]: https://github.com/tj/commander.js/issues/599 -[#611]: https://github.com/tj/commander.js/issues/611 -[#697]: https://github.com/tj/commander.js/issues/697 -[#795]: https://github.com/tj/commander.js/issues/795 -[#915]: https://github.com/tj/commander.js/issues/915 -[#938]: https://github.com/tj/commander.js/issues/938 -[#963]: https://github.com/tj/commander.js/issues/963 -[#974]: https://github.com/tj/commander.js/issues/974 -[#980]: https://github.com/tj/commander.js/issues/980 -[#987]: https://github.com/tj/commander.js/issues/987 -[#990]: https://github.com/tj/commander.js/issues/990 -[#991]: https://github.com/tj/commander.js/issues/991 -[#999]: https://github.com/tj/commander.js/issues/999 -[#1010]: https://github.com/tj/commander.js/pull/1010 -[#1018]: https://github.com/tj/commander.js/pull/1018 -[#1026]: https://github.com/tj/commander.js/pull/1026 -[#1028]: https://github.com/tj/commander.js/pull/1028 +* *Breaking* `.args` contains command arguments with just recognised options removed ([#1032] [#1138]) +* *Breaking* display error if required argument for command is missing ([#995] [#1149]) +* tighten TypeScript definition of custom option processing function passed to `.option()` ([#1119]) +* *Breaking* `.allowUnknownOption()` ([#802] [#1138]) + * unknown options included in arguments passed to command action handler + * unknown options included in `.args` +* only recognised option short flags and long flags are expanded (e.g. `-ab` or `--foo=bar`) ([#1145]) +* *Breaking* `.parseOptions()` ([#1138]) + * `args` in returned result renamed `operands` and does not include anything after first unknown option + * `unknown` in returned result has arguments after first unknown option including operands, not just options and values +* *Breaking* `.on('command:*', callback)` and other command events passed (changed) results from `.parseOptions`, i.e. operands and unknown ([#1138]) +* refactor Option from prototype to class ([#1133]) +* refactor Command from prototype to class ([#1159]) +* changes to error handling ([#1165]) + * throw for author error, not just display message + * preflight for variadic error + * add tips to missing subcommand executable +* TypeScript fluent return types changed to be more subclass friendly, return `this` rather than `Command` ([#1180]) +* `.parseAsync` returns `Promise` to be consistent with `.parse()` ([#1180]) +* update dependencies + +### Removed + +* removed EventEmitter from TypeScript definition for Command, eliminating implicit peer dependency on `@types/node` ([#1146]) +* removed private function `normalize` (the functionality has been integrated into `parseOptions`) ([#1145]) +* `parseExpectedArgs` is now private ([#1149]) + +### Migration Tips + +If you use `.on('command:*')` or more complicated tests to detect an unrecognised subcommand, you may be able to delete the code and rely on the default behaviour. + +If you use `program.args` or more complicated tests to detect a missing subcommand, you may be able to delete the code and rely on the default behaviour. + +If you use `.command('*')` to add a default command, you may be be able to switch to `isDefault:true` with a named command. + +If you want to continue combining short options with optional values as though they were boolean flags, set `combineFlagAndOptionalValue(false)` +to expand `-fb` to `-f -b` rather than `-f b`. + +## [5.0.0-4] (2020-03-03) + +(Released in 5.0.0) + +## [5.0.0-3] (2020-02-20) + +(Released in 5.0.0) + +## [5.0.0-2] (2020-02-10) + +(Released in 5.0.0) + +## [5.0.0-1] (2020-02-08) + +(Released in 5.0.0) + +## [5.0.0-0] (2020-02-02) + +(Released in 5.0.0) + +## Older versions + +* [4.x](./changelogs/CHANGELOG-4.md) +* [3.x](./changelogs/CHANGELOG-3.md) +* [2.x](./changelogs/CHANGELOG-2.md) +* [1.x](./changelogs/CHANGELOG-1.md) +* [0.x](./changelogs/CHANGELOG-0.md) + +[#1]: https://github.com/tj/commander.js/issues/1 +[#432]: https://github.com/tj/commander.js/issues/432 +[#508]: https://github.com/tj/commander.js/issues/508 +[#512]: https://github.com/tj/commander.js/issues/512 +[#531]: https://github.com/tj/commander.js/issues/531 +[#645]: https://github.com/tj/commander.js/issues/645 +[#742]: https://github.com/tj/commander.js/issues/742 +[#764]: https://github.com/tj/commander.js/issues/764 +[#802]: https://github.com/tj/commander.js/issues/802 +[#809]: https://github.com/tj/commander.js/issues/809 +[#948]: https://github.com/tj/commander.js/issues/948 +[#962]: https://github.com/tj/commander.js/issues/962 +[#995]: https://github.com/tj/commander.js/issues/995 +[#1032]: https://github.com/tj/commander.js/issues/1032 +[#1062]: https://github.com/tj/commander.js/pull/1062 +[#1088]: https://github.com/tj/commander.js/issues/1088 +[#1119]: https://github.com/tj/commander.js/pull/1119 +[#1133]: https://github.com/tj/commander.js/pull/1133 +[#1138]: https://github.com/tj/commander.js/pull/1138 +[#1145]: https://github.com/tj/commander.js/pull/1145 +[#1146]: https://github.com/tj/commander.js/pull/1146 +[#1149]: https://github.com/tj/commander.js/pull/1149 +[#1153]: https://github.com/tj/commander.js/issues/1153 +[#1159]: https://github.com/tj/commander.js/pull/1159 +[#1165]: https://github.com/tj/commander.js/pull/1165 +[#1169]: https://github.com/tj/commander.js/pull/1169 +[#1172]: https://github.com/tj/commander.js/pull/1172 +[#1179]: https://github.com/tj/commander.js/pull/1179 +[#1180]: https://github.com/tj/commander.js/pull/1180 +[#1184]: https://github.com/tj/commander.js/pull/1184 +[#1191]: https://github.com/tj/commander.js/pull/1191 +[#1195]: https://github.com/tj/commander.js/pull/1195 +[#1208]: https://github.com/tj/commander.js/pull/1208 +[#1232]: https://github.com/tj/commander.js/pull/1232 +[#1235]: https://github.com/tj/commander.js/pull/1235 +[#1236]: https://github.com/tj/commander.js/pull/1236 +[#1247]: https://github.com/tj/commander.js/pull/1247 +[#1248]: https://github.com/tj/commander.js/pull/1248 +[#1250]: https://github.com/tj/commander.js/pull/1250 +[#1256]: https://github.com/tj/commander.js/pull/1256 +[#1275]: https://github.com/tj/commander.js/pull/1275 +[#1296]: https://github.com/tj/commander.js/pull/1296 +[#1301]: https://github.com/tj/commander.js/issues/1301 +[#1306]: https://github.com/tj/commander.js/pull/1306 +[#1312]: https://github.com/tj/commander.js/pull/1312 +[#1322]: https://github.com/tj/commander.js/pull/1322 +[#1323]: https://github.com/tj/commander.js/pull/1323 +[#1325]: https://github.com/tj/commander.js/pull/1325 +[#1326]: https://github.com/tj/commander.js/pull/1326 +[#1331]: https://github.com/tj/commander.js/pull/1331 +[#1332]: https://github.com/tj/commander.js/pull/1332 +[#1349]: https://github.com/tj/commander.js/pull/1349 +[#1353]: https://github.com/tj/commander.js/pull/1353 +[#1360]: https://github.com/tj/commander.js/pull/1360 +[#1361]: https://github.com/tj/commander.js/pull/1361 +[#1365]: https://github.com/tj/commander.js/pull/1365 +[#1368]: https://github.com/tj/commander.js/pull/1368 +[#1375]: https://github.com/tj/commander.js/pull/1375 +[#1380]: https://github.com/tj/commander.js/pull/1380 +[#1387]: https://github.com/tj/commander.js/pull/1387 +[#1390]: https://github.com/tj/commander.js/pull/1390 +[#1403]: https://github.com/tj/commander.js/pull/1403 +[#1409]: https://github.com/tj/commander.js/pull/1409 +[#1427]: https://github.com/tj/commander.js/pull/1427 +[#1440]: https://github.com/tj/commander.js/pull/1440 +[#1448]: https://github.com/tj/commander.js/pull/1448 +[#1449]: https://github.com/tj/commander.js/pull/1449 +[#1453]: https://github.com/tj/commander.js/pull/1453 +[#1454]: https://github.com/tj/commander.js/pull/1454 +[#1464]: https://github.com/tj/commander.js/pull/1464 +[#1475]: https://github.com/tj/commander.js/pull/1475 +[#1477]: https://github.com/tj/commander.js/pull/1477 +[#1483]: https://github.com/tj/commander.js/pull/1483 [Unreleased]: https://github.com/tj/commander.js/compare/master...develop -[3.0.1]: https://github.com/tj/commander.js/compare/v3.0.0...v3.0.1 +[7.2.0]: https://github.com/tj/commander.js/compare/v7.1.0...v7.2.0 +[7.1.0]: https://github.com/tj/commander.js/compare/v7.0.0...v7.1.0 +[7.0.0]: https://github.com/tj/commander.js/compare/v6.2.1...v7.0.0 +[7.0.0-2]: https://github.com/tj/commander.js/compare/v7.0.0-1...v7.0.0-2 +[7.0.0-1]: https://github.com/tj/commander.js/compare/v7.0.0-0...v7.0.0-1 +[7.0.0-0]: https://github.com/tj/commander.js/compare/v6.2.0...v7.0.0-0 +[6.2.1]: https://github.com/tj/commander.js/compare/v6.2.0..v6.2.1 +[6.2.0]: https://github.com/tj/commander.js/compare/v6.1.0..v6.2.0 +[6.1.0]: https://github.com/tj/commander.js/compare/v6.0.0..v6.1.0 +[6.0.0]: https://github.com/tj/commander.js/compare/v5.1.0..v6.0.0 +[6.0.0-0]: https://github.com/tj/commander.js/compare/v5.1.0..v6.0.0-0 +[5.1.0]: https://github.com/tj/commander.js/compare/v5.0.0..v5.1.0 +[5.0.0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0 +[5.0.0-4]: https://github.com/tj/commander.js/compare/v5.0.0-3..v5.0.0-4 +[5.0.0-3]: https://github.com/tj/commander.js/compare/v5.0.0-2..v5.0.0-3 +[5.0.0-2]: https://github.com/tj/commander.js/compare/v5.0.0-1..v5.0.0-2 +[5.0.0-1]: https://github.com/tj/commander.js/compare/v5.0.0-0..v5.0.0-1 +[5.0.0-0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0-0 diff --git a/node_modules/commander/Readme.md b/node_modules/commander/Readme.md index 9663a16..d2a88a7 100644 --- a/node_modules/commander/Readme.md +++ b/node_modules/commander/Readme.md @@ -1,11 +1,13 @@ # Commander.js -[![Build Status](https://api.travis-ci.org/tj/commander.js.svg?branch=master)](http://travis-ci.org/tj/commander.js) +[![Build Status](https://github.com/tj/commander.js/workflows/build/badge.svg)](https://github.com/tj/commander.js/actions?query=workflow%3A%22build%22) [![NPM Version](http://img.shields.io/npm/v/commander.svg?style=flat)](https://www.npmjs.org/package/commander) [![NPM Downloads](https://img.shields.io/npm/dm/commander.svg?style=flat)](https://npmcharts.com/compare/commander?minimal=true) [![Install Size](https://packagephobia.now.sh/badge?p=commander)](https://packagephobia.now.sh/result?p=commander) -The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/commander-rb/commander). +The complete solution for [node.js](http://nodejs.org) command-line interfaces. + +Read this in other languages: English | [简体中文](./Readme_zh-CN.md) - [Commander.js](#commanderjs) - [Installation](#installation) @@ -13,27 +15,39 @@ The complete solution for [node.js](http://nodejs.org) command-line interfaces, - [Options](#options) - [Common option types, boolean and value](#common-option-types-boolean-and-value) - [Default option value](#default-option-value) - - [Other option types, negatable boolean and flag|value](#other-option-types-negatable-boolean-and-flagvalue) - - [Custom option processing](#custom-option-processing) + - [Other option types, negatable boolean and boolean|value](#other-option-types-negatable-boolean-and-booleanvalue) + - [Required option](#required-option) + - [Variadic option](#variadic-option) - [Version option](#version-option) + - [More configuration](#more-configuration) + - [Custom option processing](#custom-option-processing) - [Commands](#commands) - [Specify the argument syntax](#specify-the-argument-syntax) - - [Action handler (sub)commands](#action-handler-subcommands) - - [Git-style executable (sub)commands](#git-style-executable-subcommands) - - [Automated --help](#automated---help) + - [Action handler](#action-handler) + - [Stand-alone executable (sub)commands](#stand-alone-executable-subcommands) + - [Automated help](#automated-help) - [Custom help](#custom-help) + - [Display help from code](#display-help-from-code) - [.usage and .name](#usage-and-name) - - [.outputHelp(cb)](#outputhelpcb) - [.helpOption(flags, description)](#helpoptionflags-description) - - [.help(cb)](#helpcb) + - [.addHelpCommand()](#addhelpcommand) + - [More configuration](#more-configuration-1) - [Custom event listeners](#custom-event-listeners) - [Bits and pieces](#bits-and-pieces) + - [.parse() and .parseAsync()](#parse-and-parseasync) + - [Parsing Configuration](#parsing-configuration) + - [Legacy options as properties](#legacy-options-as-properties) - [TypeScript](#typescript) + - [createCommand()](#createcommand) - [Node options such as `--harmony`](#node-options-such-as---harmony) - - [Node debugging](#node-debugging) + - [Debugging stand-alone executable subcommands](#debugging-stand-alone-executable-subcommands) + - [Override exit and output handling](#override-exit-and-output-handling) + - [Additional documentation](#additional-documentation) - [Examples](#examples) - - [License](#license) - [Support](#support) + - [Commander for enterprise](#commander-for-enterprise) + +For information about terms used in this document see: [terminology](./docs/terminology.md) ## Installation @@ -47,31 +61,56 @@ Commander exports a global object which is convenient for quick programs. This is used in the examples in this README for brevity. ```js -const program = require('commander'); +const { program } = require('commander'); program.version('0.0.1'); ``` For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local Command object to use. - ```js - const commander = require('commander'); - const program = new commander.Command(); - program.version('0.0.1'); - ``` +```js +const { Command } = require('commander'); +const program = new Command(); +program.version('0.0.1'); +``` + +For named imports in ECMAScript modules, import from `commander/esm.mjs`. + +```js +// index.mjs +import { Command } from 'commander/esm.mjs'; +const program = new Command(); +``` + +And in TypeScript: + +```ts +// index.ts +import { Command } from 'commander'; +const program = new Command(); +``` + ## Options -Options are defined with the `.option()` method, also serving as documentation for the options. Each option can have a short flag (single character) and a long name, separated by a comma or space. +Options are defined with the `.option()` method, also serving as documentation for the options. Each option can have a short flag (single character) and a long name, separated by a comma or space or vertical bar ('|'). + +The parsed options can be accessed by calling `.opts()` on a `Command` object, and are passed to the action handler. Multi-word options such as "--template-engine" are camel-cased, becoming `program.opts().templateEngine` etc. + +Multiple short flags may optionally be combined in a single argument following the dash: boolean flags, followed by a single option taking a value (possibly followed by the value). +For example `-a -b -p 80` may be written as `-ab -p80` or even `-abp80`. -The options can be accessed as properties on the Command object. Multi-word options such as "--template-engine" are camel-cased, becoming `program.templateEngine` etc. Multiple short flags may be combined as a single arg, for example `-abc` is equivalent to `-a -b -c`. +You can use `--` to indicate the end of the options, and any remaining arguments will be used without being interpreted. + +By default options on the command line are not positional, and can be specified before or after other arguments. ### Common option types, boolean and value -The two most used option types are a boolean flag, and an option which takes a value (declared using angle brackets). Both are `undefined` unless specified on command line. +The two most used option types are a boolean option, and an option which takes its value +from the following argument (declared with angle brackets like `--expect `). Both are `undefined` unless specified on command line. -```js -const program = require('commander'); +Example file: [options-common.js](./examples/options-common.js) +```js program .option('-d, --debug', 'output extra debugging') .option('-s, --small', 'small pizza size') @@ -79,10 +118,11 @@ program program.parse(process.argv); -if (program.debug) console.log(program.opts()); +const options = program.opts(); +if (options.debug) console.log(options); console.log('pizza details:'); -if (program.small) console.log('- small pizza size'); -if (program.pizzaType) console.log(`- ${program.pizzaType}`); +if (options.small) console.log('- small pizza size'); +if (options.pizzaType) console.log(`- ${options.pizzaType}`); ``` ```bash @@ -101,21 +141,21 @@ pizza details: - cheese ``` -`program.parse(arguments)` processes the arguments, leaving any args not consumed by the options as the `program.args` array. +`program.parse(arguments)` processes the arguments, leaving any args not consumed by the program options in the `program.args` array. The parameter is optional and defaults to `process.argv`. ### Default option value You can specify a default value for an option which takes a value. -```js -const program = require('commander'); +Example file: [options-defaults.js](./examples/options-defaults.js) +```js program .option('-c, --cheese ', 'add the specified type of cheese', 'blue'); -program.parse(process.argv); +program.parse(); -console.log(`cheese: ${program.cheese}`); +console.log(`cheese: ${program.opts().cheese}`); ``` ```bash @@ -125,25 +165,26 @@ $ pizza-options --cheese stilton cheese: stilton ``` -### Other option types, negatable boolean and flag|value +### Other option types, negatable boolean and boolean|value -You can specify a boolean option long name with a leading `no-` to set the option value to false when used. +You can define a boolean option long name with a leading `no-` to set the option value to false when used. Defined alone this also makes the option true by default. If you define `--foo` first, adding `--no-foo` does not change the default value from what it would -otherwise be. You can specify a default boolean value for a boolean flag and it can be overridden on command line. +otherwise be. You can specify a default boolean value for a boolean option and it can be overridden on command line. -```js -const program = require('commander'); +Example file: [options-negatable.js](./examples/options-negatable.js) +```js program .option('--no-sauce', 'Remove sauce') .option('--cheese ', 'cheese flavour', 'mozzarella') .option('--no-cheese', 'plain with no cheese') - .parse(process.argv); + .parse(); -const sauceStr = program.sauce ? 'sauce' : 'no sauce'; -const cheeseStr = (program.cheese === false) ? 'no cheese' : `${program.cheese} cheese`; +const options = program.opts(); +const sauceStr = options.sauce ? 'sauce' : 'no sauce'; +const cheeseStr = (options.cheese === false) ? 'no cheese' : `${options.cheese} cheese`; console.log(`You ordered a pizza with ${sauceStr} and ${cheeseStr}`); ``` @@ -158,19 +199,21 @@ $ pizza-options --no-sauce --no-cheese You ordered a pizza with no sauce and no cheese ``` -You can specify an option which functions as a flag but may also take a value (declared using square brackets). +You can specify an option which may be used as a boolean option but may optionally take an option-argument +(declared with square brackets like `--optional [value]`). -```js -const program = require('commander'); +Example file: [options-boolean-or-value.js](./examples/options-boolean-or-value.js) +```js program .option('-c, --cheese [type]', 'Add cheese with optional type'); program.parse(process.argv); -if (program.cheese === undefined) console.log('no cheese'); -else if (program.cheese === true) console.log('add cheese'); -else console.log(`add cheese type ${program.cheese}`); +const options = program.opts(); +if (options.cheese === undefined) console.log('no cheese'); +else if (options.cheese === true) console.log('add cheese'); +else console.log(`add cheese type ${options.cheese}`); ``` ```bash @@ -182,21 +225,126 @@ $ pizza-options --cheese mozzarella add cheese type mozzarella ``` -### Custom option processing +For information about possible ambiguous cases, see [options taking varying arguments](./docs/options-taking-varying-arguments.md). + +### Required option + +You may specify a required (mandatory) option using `.requiredOption`. The option must have a value after parsing, usually specified on the command line, or perhaps from a default value (say from environment). The method is otherwise the same as `.option` in format, taking flags and description, and optional default value or custom processing. + +Example file: [options-required.js](./examples/options-required.js) + +```js +program + .requiredOption('-c, --cheese ', 'pizza must have cheese'); + +program.parse(); +``` + +```bash +$ pizza +error: required option '-c, --cheese ' not specified +``` + +### Variadic option + +You may make an option variadic by appending `...` to the value placeholder when declaring the option. On the command line you +can then specify multiple option-arguments, and the parsed option value will be an array. The extra arguments +are read until the first argument starting with a dash. The special argument `--` stops option processing entirely. If a value +is specified in the same argument as the option then no further values are read. + +Example file: [options-variadic.js](./examples/options-variadic.js) + +```js +program + .option('-n, --number ', 'specify numbers') + .option('-l, --letter [letters...]', 'specify letters'); + +program.parse(); + +console.log('Options: ', program.opts()); +console.log('Remaining arguments: ', program.args); +``` + +```bash +$ collect -n 1 2 3 --letter a b c +Options: { number: [ '1', '2', '3' ], letter: [ 'a', 'b', 'c' ] } +Remaining arguments: [] +$ collect --letter=A -n80 operand +Options: { number: [ '80' ], letter: [ 'A' ] } +Remaining arguments: [ 'operand' ] +$ collect --letter -n 1 -n 2 3 -- operand +Options: { number: [ '1', '2', '3' ], letter: true } +Remaining arguments: [ 'operand' ] +``` + +For information about possible ambiguous cases, see [options taking varying arguments](./docs/options-taking-varying-arguments.md). + +### Version option + +The optional `version` method adds handling for displaying the command version. The default option flags are `-V` and `--version`, and when present the command prints the version number and exits. + +```js +program.version('0.0.1'); +``` + +```bash +$ ./examples/pizza -V +0.0.1 +``` -You may specify a function to do custom processing of option values. The callback function receives two parameters, the user specified value and the -previous value for the option. It returns the new value for the option. +You may change the flags and description by passing additional parameters to the `version` method, using +the same syntax for flags as the `option` method. + +```js +program.version('0.0.1', '-v, --vers', 'output the current version'); +``` -This allows you to coerce the option value to the desired type, or accumulate values, or do entirely custom processing. +### More configuration -You can optionally specify the default/starting value for the option after the function. +You can add most options using the `.option()` method, but there are some additional features available +by constructing an `Option` explicitly for less common cases. + +Example file: [options-extra.js](./examples/options-extra.js) ```js -const program = require('commander'); +program + .addOption(new Option('-s, --secret').hideHelp()) + .addOption(new Option('-t, --timeout ', 'timeout in seconds').default(60, 'one minute')) + .addOption(new Option('-d, --drink ', 'drink size').choices(['small', 'medium', 'large'])); +``` + +```bash +$ extra --help +Usage: help [options] + +Options: + -t, --timeout timeout in seconds (default: one minute) + -d, --drink drink cup size (choices: "small", "medium", "large") + -h, --help display help for command + +$ extra --drink huge +error: option '-d, --drink ' argument 'huge' is invalid. Allowed choices are small, medium, large. +``` + +### Custom option processing + +You may specify a function to do custom processing of option-arguments. The callback function receives two parameters, +the user specified option-argument and the previous value for the option. It returns the new value for the option. +This allows you to coerce the option-argument to the desired type, or accumulate values, or do entirely custom processing. + +You can optionally specify the default/starting value for the option after the function parameter. + +Example file: [options-custom-processing.js](./examples/options-custom-processing.js) + +```js function myParseInt(value, dummyPrevious) { - // parseInt takes a string and an optional radix - return parseInt(value); + // parseInt takes a string and a radix + const parsedValue = parseInt(value, 10); + if (isNaN(parsedValue)) { + throw new commander.InvalidOptionArgumentError('Not a number.'); + } + return parsedValue; } function increaseVerbosity(dummyValue, previous) { @@ -219,13 +367,14 @@ program .option('-l, --list ', 'comma separated list', commaSeparatedList) ; -program.parse(process.argv); +program.parse(); -if (program.float !== undefined) console.log(`float: ${program.float}`); -if (program.integer !== undefined) console.log(`integer: ${program.integer}`); -if (program.verbose > 0) console.log(`verbosity: ${program.verbose}`); -if (program.collect.length > 0) console.log(program.collect); -if (program.list !== undefined) console.log(program.list); +const options = program.opts(); +if (options.float !== undefined) console.log(`float: ${options.float}`); +if (options.integer !== undefined) console.log(`integer: ${options.integer}`); +if (options.verbose > 0) console.log(`verbosity: ${options.verbose}`); +if (options.collect.length > 0) console.log(options.collect); +if (options.list !== undefined) console.log(options.list); ``` ```bash @@ -241,29 +390,13 @@ $ custom --list x,y,z [ 'x', 'y', 'z' ] ``` -### Version option - -The optional `version` method adds handling for displaying the command version. The default option flags are `-V` and `--version`, and when present the command prints the version number and exits. - -```js -program.version('0.0.1'); -``` - -```bash -$ ./examples/pizza -V -0.0.1 -``` - -You may change the flags and description by passing additional parameters to the `version` method, using -the same syntax for flags as the `option` method. The version flags can be named anything, but a long name is required. +## Commands -```js -program.version('0.0.1', '-v, --vers', 'output the current version'); -``` +You can specify (sub)commands using `.command()` or `.addCommand()`. There are two ways these can be implemented: using an action handler attached to the command, or as a stand-alone executable file (described in more detail later). The subcommands may be nested ([example](./examples/nestedCommands.js)). -## Commands +In the first parameter to `.command()` you specify the command name and any command-arguments. The arguments may be `` or `[optional]`, and the last argument may also be `variadic...`. -You can specify (sub)commands for your top-level command using `.command`. There are two ways these can be implemented: using an action handler attached to the command, or as a separate executable file (described in more detail later). In the first parameter to `.command` you specify the command name and any command arguments. The arguments may be `` or `[optional]`, and the last argument may also be `variadic...`. +You can use `.addCommand()` to add an already configured subcommand to the program. For example: @@ -277,182 +410,203 @@ program console.log('clone command called'); }); -// Command implemented using separate executable file (description is second parameter to `.command`) -// Returns top-level command for adding more commands. +// Command implemented using stand-alone executable file (description is second parameter to `.command`) +// Returns `this` for adding more commands. program .command('start ', 'start named service') .command('stop [service]', 'stop named service, or all if no name supplied'); + +// Command prepared separately. +// Returns `this` for adding more commands. +program + .addCommand(build.makeBuildCommand()); ``` +Configuration options can be passed with the call to `.command()` and `.addCommand()`. Specifying `hidden: true` will +remove the command from the generated help output. Specifying `isDefault: true` will run the subcommand if no other +subcommand is specified ([example](./examples/defaultCommand.js)). + ### Specify the argument syntax -You use `.arguments` to specify the arguments for the top-level command, and for subcommands they are included in the `.command` call. Angled brackets (e.g. ``) indicate required input. Square brackets (e.g. `[optional]`) indicate optional input. +You use `.arguments` to specify the expected command-arguments for the top-level command, and for subcommands they are usually +included in the `.command` call. Angled brackets (e.g. ``) indicate required command-arguments. +Square brackets (e.g. `[optional]`) indicate optional command-arguments. +You can optionally describe the arguments in the help by supplying a hash as second parameter to `.description()`. -```js -const program = require('commander'); +Example file: [arguments.js](./examples/arguments.js) +```js program .version('0.1.0') - .arguments(' [env]') - .action(function (cmd, env) { - cmdValue = cmd; - envValue = env; + .arguments(' [password]') + .description('test command', { + username: 'user to login', + password: 'password for user, if required' + }) + .action((username, password) => { + console.log('username:', username); + console.log('environment:', password || 'no password given'); }); - -program.parse(process.argv); - -if (typeof cmdValue === 'undefined') { - console.error('no command given!'); - process.exit(1); -} -console.log('command:', cmdValue); -console.log('environment:', envValue || "no environment given"); ``` The last argument of a command can be variadic, and only the last argument. To make an argument variadic you append `...` to the argument name. For example: ```js -const program = require('commander'); - program .version('0.1.0') - .command('rmdir [otherDirs...]') - .action(function (dir, otherDirs) { - console.log('rmdir %s', dir); - if (otherDirs) { - otherDirs.forEach(function (oDir) { - console.log('rmdir %s', oDir); - }); - } + .command('rmdir ') + .action(function (dirs) { + dirs.forEach((dir) => { + console.log('rmdir %s', dir); + }); }); - -program.parse(process.argv); ``` -The variadic argument is passed to the action handler as an array. (And this also applies to `program.args`.) +The variadic argument is passed to the action handler as an array. -### Action handler (sub)commands +### Action handler -You can add options to a command that uses an action handler. -The action handler gets passed a parameter for each argument you declared, and one additional argument which is the -command object itself. This command argument has the values for the command-specific options added as properties. +The action handler gets passed a parameter for each command-argument you declared, and two additional parameters +which are the parsed options and the command object itself. -```js -const program = require('commander'); +Example file: [thank.js](./examples/thank.js) +```js program - .command('rm ') - .option('-r, --recursive', 'Remove recursively') - .action(function (dir, cmdObj) { - console.log('remove ' + dir + (cmdObj.recursive ? ' recursively' : '')) - }) - -program.parse(process.argv) + .arguments('') + .option('-t, --title ', 'title to use before name') + .option('-d, --debug', 'display some debugging') + .action((name, options, command) => { + if (options.debug) { + console.error('Called %s with options %o', command.name(), options); + } + const title = options.title ? `${options.title} ` : ''; + console.log(`Thank-you ${title}${name}`); + }); ``` -A command's options on the command line are validated when the command is used. Any unknown options will be reported as an error. However, if an action-based command does not define an action, then the options are not validated. +You may supply an `async` action handler, in which case you call `.parseAsync` rather than `.parse`. -Configuration options can be passed with the call to `.command()`. Specifying `true` for `opts.noHelp` will remove the command from the generated help output. +```js +async function run() { /* code goes here */ } + +async function main() { + program + .command('run') + .action(run); + await program.parseAsync(process.argv); +} +``` -### Git-style executable (sub)commands +A command's options and arguments on the command line are validated when the command is used. Any unknown options or missing arguments will be reported as an error. You can suppress the unknown option checks with `.allowUnknownOption()`. By default it is not an error to +pass more arguments than declared, but you can make this an error with `.allowExcessArguments(false)`. -When `.command()` is invoked with a description argument, this tells commander that you're going to use separate executables for sub-commands, much like `git(1)` and other popular tools. +### Stand-alone executable (sub)commands + +When `.command()` is invoked with a description argument, this tells Commander that you're going to use stand-alone executables for subcommands. Commander will search the executables in the directory of the entry script (like `./examples/pm`) with the name `program-subcommand`, like `pm-install`, `pm-search`. You can specify a custom name with the `executableFile` configuration option. You handle the options for an executable (sub)command in the executable, and don't declare them at the top-level. -```js -// file: ./examples/pm -const program = require('commander'); +Example file: [pm](./examples/pm) +```js program .version('0.1.0') .command('install [name]', 'install one or more packages') .command('search [query]', 'search with optional query') - .command('update', 'update installed packages', {executableFile: 'myUpdateSubCommand'}) - .command('list', 'list packages installed', {isDefault: true}) - .parse(process.argv); -``` + .command('update', 'update installed packages', { executableFile: 'myUpdateSubCommand' }) + .command('list', 'list packages installed', { isDefault: true }); -Configuration options can be passed with the call to `.command()`. Specifying `true` for `opts.noHelp` will remove the command from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified. -Specifying a name with `executableFile` will override the default constructed name. +program.parse(process.argv); +``` If the program is designed to be installed globally, make sure the executables have proper modes, like `755`. -## Automated --help +## Automated help + +The help information is auto-generated based on the information commander already knows about your program. The default +help option is `-h,--help`. - The help information is auto-generated based on the information commander already knows about your program, so the following `--help` info is for free: +Example file: [pizza](./examples/pizza) ```bash -$ ./examples/pizza --help +$ node ./examples/pizza --help Usage: pizza [options] -An application for pizzas ordering +An application for pizza ordering Options: - -V, --version output the version number -p, --peppers Add peppers - -P, --pineapple Add pineapple - -b, --bbq Add bbq sauce -c, --cheese Add the specified type of cheese (default: "marble") -C, --no-cheese You do not want any cheese - -h, --help output usage information + -h, --help display help for command ``` -### Custom help +A `help` command is added by default if your command has subcommands. It can be used alone, or with a subcommand name to show +further help for the subcommand. These are effectively the same if the `shell` program has implicit help: - You can display arbitrary `-h, --help` information - by listening for "--help". Commander will automatically - exit once you are done so that the remainder of your program - does not execute causing undesired behaviors, for example - in the following executable "stuff" will not output when - `--help` is used. +```bash +shell help +shell --help -```js -#!/usr/bin/env node +shell help spawn +shell spawn --help +``` + +### Custom help -const program = require('commander'); +You can add extra text to be displayed along with the built-in help. +Example file: [custom-help](./examples/custom-help) + +```js program - .version('0.1.0') - .option('-f, --foo', 'enable some foo') - .option('-b, --bar', 'enable some bar') - .option('-B, --baz', 'enable some baz'); - -// must be before .parse() since -// node's emit() is immediate - -program.on('--help', function(){ - console.log('') - console.log('Examples:'); - console.log(' $ custom-help --help'); - console.log(' $ custom-help -h'); -}); + .option('-f, --foo', 'enable some foo'); -program.parse(process.argv); +program.addHelpText('after', ` -console.log('stuff'); +Example call: + $ custom-help --help`); ``` -Yields the following help output when `node script-name.js -h` or `node script-name.js --help` are run: +Yields the following help output: ```Text Usage: custom-help [options] Options: - -h, --help output usage information - -V, --version output the version number - -f, --foo enable some foo - -b, --bar enable some bar - -B, --baz enable some baz + -f, --foo enable some foo + -h, --help display help for command -Examples: +Example call: $ custom-help --help - $ custom-help -h ``` +The positions in order displayed are: + +- `beforeAll`: add to the program for a global banner or header +- `before`: display extra information before built-in help +- `after`: display extra information after built-in help +- `afterAll`: add to the program for a global footer (epilog) + +The positions "beforeAll" and "afterAll" apply to the command and all its subcommands. + +The second parameter can be a string, or a function returning a string. The function is passed a context object for your convenience. The properties are: + +- error: a boolean for whether the help is being displayed due to a usage error +- command: the Command which is displaying the help + +### Display help from code + +`.help()`: display help information and exit immediately. You can optionally pass `{ error: true }` to display on stderr and exit with an error status. + +`.outputHelp()`: output help information without exiting. You can optionally pass `{ error: true }` to display on stderr. + +`.helpInformation()`: get the built-in command help information as a string for processing or displaying yourself. + ### .usage and .name These allow you to customise the usage description in the first line of the help. The name is otherwise @@ -470,143 +624,294 @@ The help will start with: Usage: my-command [global options] command ``` -### .outputHelp(cb) - -Output help information without exiting. -Optional callback cb allows post-processing of help text before it is displayed. +### .helpOption(flags, description) -If you want to display help by default (e.g. if no command was provided), you can use something like: +By default every command has a help option. Override the default help flags and description. Pass false to disable the built-in help option. ```js -const program = require('commander'); -const colors = require('colors'); - program - .version('0.1.0') - .command('getstream [url]', 'get stream URL') - .parse(process.argv); - -if (!process.argv.slice(2).length) { - program.outputHelp(make_red); -} - -function make_red(txt) { - return colors.red(txt); //display the help text in red on the console -} + .helpOption('-e, --HELP', 'read more information'); ``` -### .helpOption(flags, description) +### .addHelpCommand() + +A help command is added by default if your command has subcommands. You can explicitly turn on or off the implicit help command with `.addHelpCommand()` and `.addHelpCommand(false)`. - Override the default help flags and description. +You can both turn on and customise the help command by supplying the name and description: ```js -program - .helpOption('-e, --HELP', 'read more information'); +program.addHelpCommand('assist [command]', 'show assistance'); ``` -### .help(cb) +### More configuration - Output help information and exit immediately. - Optional callback cb allows post-processing of help text before it is displayed. +The built-in help is formatted using the Help class. +You can configure the Help behaviour by modifying data properties and methods using `.configureHelp()`, or by subclassing using `.createHelp()` if you prefer. + +The data properties are: + +- `helpWidth`: specify the wrap width, useful for unit tests +- `sortSubcommands`: sort the subcommands alphabetically +- `sortOptions`: sort the options alphabetically + +There are methods getting the visible lists of arguments, options, and subcommands. There are methods for formatting the items in the lists, with each item having a _term_ and _description_. Take a look at `.formatHelp()` to see how they are used. + +Example file: [configure-help.js](./examples/configure-help.js) + +``` +program.configureHelp({ + sortSubcommands: true, + subcommandTerm: (cmd) => cmd.name() // Just show the name, instead of short usage. +}); +``` ## Custom event listeners - You can execute custom actions by listening to command and option events. +You can execute custom actions by listening to command and option events. ```js program.on('option:verbose', function () { - process.env.VERBOSE = this.verbose; + process.env.VERBOSE = this.opts().verbose; }); -// error on unknown commands -program.on('command:*', function () { - console.error('Invalid command: %s\nSee --help for a list of available commands.', program.args.join(' ')); - process.exit(1); +program.on('command:*', function (operands) { + console.error(`error: unknown command '${operands[0]}'`); + const availableCommands = program.commands.map(cmd => cmd.name()); + mySuggestBestMatch(operands[0], availableCommands); + process.exitCode = 1; }); ``` ## Bits and pieces -### TypeScript +### .parse() and .parseAsync() -The Commander package includes its TypeScript Definition file, but also requires the node types which you need to install yourself. e.g. +The first argument to `.parse` is the array of strings to parse. You may omit the parameter to implicitly use `process.argv`. -```bash -npm install commander -npm install --save-dev @types/node +If the arguments follow different conventions than node you can pass a `from` option in the second parameter: + +- 'node': default, `argv[0]` is the application and `argv[1]` is the script being run, with user parameters after that +- 'electron': `argv[1]` varies depending on whether the electron application is packaged +- 'user': all of the arguments from the user + +For example: + +```js +program.parse(process.argv); // Explicit, node conventions +program.parse(); // Implicit, and auto-detect electron +program.parse(['-f', 'filename'], { from: 'user' }); ``` -If you use `ts-node` and git-style sub-commands written as `.ts` files, you need to call your program through node to get the sub-commands called correctly. e.g. +### Parsing Configuration + +If the default parsing does not suit your needs, there are some behaviours to support other usage patterns. + +By default program options are recognised before and after subcommands. To only look for program options before subcommands, use `.enablePositionalOptions()`. This lets you use +an option for a different purpose in subcommands. + +Example file: [positional-options.js](./examples/positional-options.js) + +With positional options, the `-b` is a program option in the first line and a subcommand option in the second line: + +```sh +program -b subcommand +program subcommand -b +``` + +By default options are recognised before and after command-arguments. To only process options that come +before the command-arguments, use `.passThroughOptions()`. This lets you pass the arguments and following options through to another program +without needing to use `--` to end the option processing. +To use pass through options in a subcommand, the program needs to enable positional options. + +Example file: [pass-through-options.js](./examples/pass-through-options.js) + +With pass through options, the `--port=80` is a program option in the first line and passed through as a command-argument in the second line: + +```sh +program --port=80 arg +program arg --port=80 +``` + +By default the option processing shows an error for an unknown option. To have an unknown option treated as an ordinary command-argument and continue looking for options, use `.allowUnknownOption()`. This lets you mix known and unknown options. + +By default the argument processing does not display an error for more command-arguments than expected. +To display an error for excess arguments, use`.allowExcessArguments(false)`. + +### Legacy options as properties + +Before Commander 7, the option values were stored as properties on the command. +This was convenient to code but the downside was possible clashes with +existing properties of `Command`. You can revert to the old behaviour to run unmodified legacy code by using `.storeOptionsAsProperties()`. + +```js +program + .storeOptionsAsProperties() + .option('-d, --debug') + .action((commandAndOptions) => { + if (commandAndOptions.debug) { + console.error(`Called ${commandAndOptions.name()}`); + } + }); +``` + +### TypeScript + +If you use `ts-node` and stand-alone executable subcommands written as `.ts` files, you need to call your program through node to get the subcommands called correctly. e.g. ```bash node -r ts-node/register pm.ts ``` +### createCommand() + +This factory function creates a new command. It is exported and may be used instead of using `new`, like: + +```js +const { createCommand } = require('commander'); +const program = createCommand(); +``` + +`createCommand` is also a method of the Command object, and creates a new command rather than a subcommand. This gets used internally +when creating subcommands using `.command()`, and you may override it to +customise the new subcommand (example file [custom-command-class.js](./examples/custom-command-class.js)). + ### Node options such as `--harmony` You can enable `--harmony` option in two ways: -- Use `#! /usr/bin/env node --harmony` in the sub-commands scripts. (Note Windows does not support this pattern.) -- Use the `--harmony` option when call the command, like `node --harmony examples/pm publish`. The `--harmony` option will be preserved when spawning sub-command process. +- Use `#! /usr/bin/env node --harmony` in the subcommands scripts. (Note Windows does not support this pattern.) +- Use the `--harmony` option when call the command, like `node --harmony examples/pm publish`. The `--harmony` option will be preserved when spawning subcommand process. -### Node debugging +### Debugging stand-alone executable subcommands -If you are using the node inspector for [debugging](https://nodejs.org/en/docs/guides/debugging-getting-started/) git-style executable (sub)commands using `node -inspect` et al, +An executable subcommand is launched as a separate child process. + +If you are using the node inspector for [debugging](https://nodejs.org/en/docs/guides/debugging-getting-started/) executable subcommands using `node --inspect` et al, the inspector port is incremented by 1 for the spawned subcommand. +If you are using VSCode to debug executable subcommands you need to set the `"autoAttachChildProcesses": true` flag in your launch.json configuration. + +### Override exit and output handling + +By default Commander calls `process.exit` when it detects errors, or after displaying the help or version. You can override +this behaviour and optionally supply a callback. The default override throws a `CommanderError`. + +The override callback is passed a `CommanderError` with properties `exitCode` number, `code` string, and `message`. The default override behaviour is to throw the error, except for async handling of executable subcommand completion which carries on. The normal display of error messages or version or help +is not affected by the override which is called after the display. + +```js +program.exitOverride(); + +try { + program.parse(process.argv); +} catch (err) { + // custom processing... +} +``` + +By default Commander is configured for a command-line application and writes to stdout and stderr. +You can modify this behaviour for custom applications. In addition, you can modify the display of error messages. + +Example file: [configure-output.js](./examples/configure-output.js) + + +```js +function errorColor(str) { + // Add ANSI escape codes to display text in red. + return `\x1b[31m${str}\x1b[0m`; +} + +program + .configureOutput({ + // Visibly override write routines as example! + writeOut: (str) => process.stdout.write(`[OUT] ${str}`), + writeErr: (str) => process.stdout.write(`[ERR] ${str}`), + // Highlight errors in color. + outputError: (str, write) => write(errorColor(str)) + }); +``` + +### Additional documentation + +There is more information available about: + +- [deprecated](./docs/deprecated.md) features still supported for backwards compatibility +- [options taking varying arguments](./docs/options-taking-varying-arguments.md) + ## Examples +In a single command program, you might not need an action handler. + +Example file: [pizza](./examples/pizza) + ```js -const program = require('commander'); +const { program } = require('commander'); program - .version('0.1.0') - .option('-C, --chdir ', 'change the working directory') - .option('-c, --config ', 'set config path. defaults to ./deploy.conf') - .option('-T, --no-tests', 'ignore test hook'); + .description('An application for pizza ordering') + .option('-p, --peppers', 'Add peppers') + .option('-c, --cheese ', 'Add the specified type of cheese', 'marble') + .option('-C, --no-cheese', 'You do not want any cheese'); + +program.parse(); + +const options = program.opts(); +console.log('you ordered a pizza with:'); +if (options.peppers) console.log(' - peppers'); +const cheese = !options.cheese ? 'no' : options.cheese; +console.log(' - %s cheese', cheese); +``` + +In a multi-command program, you will have action handlers for each command (or stand-alone executables for the commands). + +Example file: [deploy](./examples/deploy) + +```js +const { Command } = require('commander'); +const program = new Command(); + +program + .version('0.0.1') + .option('-c, --config ', 'set config path', './deploy.conf'); program .command('setup [env]') .description('run setup commands for all envs') - .option("-s, --setup_mode [mode]", "Which setup mode to use") - .action(function(env, options){ - const mode = options.setup_mode || "normal"; + .option('-s, --setup_mode ', 'Which setup mode to use', 'normal') + .action((env, options) => { env = env || 'all'; - console.log('setup for %s env(s) with %s mode', env, mode); + console.log('read config from %s', program.opts().config); + console.log('setup for %s env(s) with %s mode', env, options.setup_mode); }); program - .command('exec ') + .command('exec