Replace commander with minimist (closes #305) (#307)

vweevers · web-flow · commit bc2c8935c045 · 2021-03-07T12:39:11.000+01:00
diff --git a/README.md b/README.md
@@ -259,20 +259,21 @@ Should work in theory :)
 Usage: `airtap [options] <files>`. Supports multiple `files`. They can be paths relative to the working directory or glob patterns (e.g. `airtap test/*.js`). Options:
 
 ```
-  -v, --version            print version
-  -l, --list-browsers      list (effective or --all) browsers
-  -a, --all                test or list all available browsers
-  -c, --concurrency <n>    number of browsers to test concurrently, default 5
-  -r, --retries <retries>  number of retries when running a browser, default 6
-  -t, --timeout <timeout>  how long to wait for test results, default 5m
-  --coverage               enable code coverage analysis
-  --live                   keep browsers open to allow repeated test runs
-  -p, --preset <preset>    select a configuration preset
-  -s, --server <script>    path to script that runs a support server
-  --loopback <hostname>    custom hostname that equals or resolves to 127.0.0.1
-  --verbose                enable airtap debug output
-  --silly                  enable all debug output
-  -h, --help               display help for command
+-v --version          Print version and exit
+-l --list-browsers    List (effective or --all) browsers
+-a --all              Test or list all available browsers
+   --coverage         Enable code coverage analysis
+   --live             Keep browsers open to allow repeated test runs
+-c --concurrency <n>  Number of browsers to test concurrently, default 5
+-r --retries <n>      Number of retries when running a browser, default 6
+-t --timeout <n>      How long to wait for test results, default 5m. Can
+                      be a number in milliseconds or a string with unit.
+-p --preset <preset>  Select a configuration preset
+-s --server <script>  Path to script that runs a support server
+   --loopback <host>  Custom hostname that equals or resolves to 127.0.0.1
+   --verbose          Enable airtap debug output
+   --silly            Enable all debug output
+-h --help             Print help and exit.
 ```
 
 <details><summary>Examples (click to expand)</summary>
diff --git a/bin/airtap.js b/bin/airtap.js
@@ -8,52 +8,67 @@ if (process.version.match(/^v(\d+)\./)[1] < 10) {
 
 require('make-promises-safe')
 
-const program = require('commander')
 const nearest = require('find-nearest-file')
 const yaml = require('js-yaml')
 const os = require('os')
 const fs = require('fs')
 const path = require('path')
 const Airtap = require('../lib/airtap')
-const version = require('../package.json').version
 const hasOwnProperty = Object.prototype.hasOwnProperty
+const argv = require('minimist')(process.argv.slice(2), {
+  string: [
+    'concurrency',
+    'retries',
+    'timeout',
+    'preset',
+    'server',
+    'loopback'
+  ],
+  boolean: [
+    'version',
+    'help',
+    'list-browsers',
+    'all',
+    'coverage',
+    'live',
+    'verbose',
+    'silly',
+
+    // Legacy options (handled below)
+    'local',
+    'open',
+    'electron'
+  ],
+  alias: {
+    v: 'version',
+    h: 'help',
+    l: 'list-browsers',
+    a: 'all',
+    c: 'concurrency',
+    r: 'retries',
+    t: 'timeout',
+    p: 'preset',
+    s: 'server'
+  }
+})
 
-program
-  .version(version, '-v, --version', 'print version')
-  .usage('[options] <files>')
-  .option('-l, --list-browsers', 'list (effective or --all) browsers')
-  .option('-a, --all', 'test or list all available browsers')
-  .option('-c, --concurrency <n>', 'number of browsers to test concurrently, default 5')
-  .option('-r, --retries <retries>', 'number of retries when running a browser, default 6')
-  .option('-t, --timeout <timeout>', 'how long to wait for test results, default 5m')
-  .option('--coverage', 'enable code coverage analysis')
-  .option('--live', 'keep browsers open to allow repeated test runs')
-  .option('-p, --preset <preset>', 'select a configuration preset')
-  .option('-s, --server <script>', 'path to script that runs a support server')
-  .option('--loopback <hostname>', 'custom hostname that equals or resolves to 127.0.0.1')
-  .option('--verbose', 'enable airtap debug output')
-  .option('--silly', 'enable all debug output')
-
-  // Can we hide these in help?
-  .option('--local', 'n/a')
-  .option('--open', 'n/a')
-  .option('--electron', 'n/a')
-
-  .on('--help', function () {
-    console.log()
-    console.log(read('examples.txt'))
-  })
-  .parse(process.argv)
+if (argv.help) {
+  console.log(read('help.txt'))
+  process.exit()
+} else if (argv.version) {
+  console.log(require('../package.json').version)
+  process.exit()
+}
 
 const config = {
   watchify: !process.env.CI,
   ...readYAML(nearest('.airtaprc') || path.join(os.homedir(), '.airtaprc')),
   ...readYAML('.airtap.yml'),
-  ...wash(program.opts())
+  ...wash(argv)
 }
 
-if (program.preset) {
-  usePreset(config, program.preset)
+if (argv.preset) {
+  usePreset(config, argv.preset)
 }
 
 if (config.silly) {
@@ -77,14 +92,14 @@ setCredentials(config, process.env)
 
 const airtap = new Airtap()
 const wanted = config.all ? null : config.browsers || []
-const files = program.args.length ? program.args : config.files || []
+const files = argv._.length ? argv._ : config.files || []
 
 if (!config.providers) {
   config.providers = ['airtap-default']
   if (wanted) wanted.splice(0, wanted.length, { name: 'default' })
 }
 
-if (!files.length && !program.listBrowsers) {
+if (!files.length && !argv['list-browsers']) {
   fail('At least one file must be specified.', true)
 } else if (!config.providers.length) {
   fail(read('no-input.txt'), true)
@@ -99,7 +114,7 @@ airtap.provider(config.providers)
 airtap.manifests(wanted, function (err, manifests) {
   if (err) return fail(err)
 
-  if (program.listBrowsers) {
+  if (argv['list-browsers']) {
     manifests.forEach(simplifyManifest)
     console.log(toYAML(manifests))
     return
@@ -157,8 +172,8 @@ function wash (opts) {
   const copy = {}
 
   for (const k in opts) {
-    if (!hasOwnProperty.call(opts, k)) continue
-    if (opts[k] != null) copy[k] = opts[k]
+    if (k.startsWith('_') || !hasOwnProperty.call(opts, k)) continue
+    if (opts[k] != null && opts[k] !== '') copy[k] = opts[k]
   }
 
   return copy
diff --git a/bin/examples.txt b/bin/examples.txt
diff --git a/bin/help.txt b/bin/help.txt
@@ -0,0 +1,30 @@
+Usage: airtap [options] <files>
+
+Options:
+  -v --version          Print version and exit
+  -l --list-browsers    List (effective or --all) browsers
+  -a --all              Test or list all available browsers
+     --coverage         Enable code coverage analysis
+     --live             Keep browsers open to allow repeated test runs
+  -c --concurrency <n>  Number of browsers to test concurrently, default 5
+  -r --retries <n>      Number of retries when running a browser, default 6
+  -t --timeout <n>      How long to wait for test results, default 5m. Can
+                        be a number in milliseconds or a string with unit.
+  -p --preset <preset>  Select a configuration preset
+  -s --server <script>  Path to script that runs a support server
+     --loopback <host>  Custom hostname that equals or resolves to 127.0.0.1
+     --verbose          Enable airtap debug output
+     --silly            Enable all debug output
+  -h --help             Print help and exit.
+
+List all available browsers:
+  $ airtap -la
+
+Test browsers specified in .airtap.yml:
+  $ airtap test.js
+
+Test all available browsers (careful):
+  $ airtap -a test.js
+
+Test multiple files:
+  $ airtap "test/*.js"
diff --git a/package.json b/package.json
@@ -29,7 +29,6 @@
     "browserify": "^16.5.2",
     "browserify-istanbul": "^3.0.1",
     "bruce-millis-option": "^1.0.0",
-    "commander": "^6.0.0",
     "compression": "^1.7.1",
     "debug": "^4.1.0",
     "engine.io": "^3.4.2",
@@ -43,6 +42,7 @@
     "load-script": "^1.0.0",
     "make-promises-safe": "^5.1.0",
     "maybe-combine-errors": "^1.0.0",
+    "minimist": "^1.2.5",
     "nanoresource": "^1.3.0",
     "nanoresource-collection": "^1.0.0",
     "on-stream-close": "^1.0.0",
diff --git a/test/integration/fixtures/tap/out b/test/integration/fixtures/tap/out
@@ -15,7 +15,7 @@ ok 6 (unnamed assert)
 ok 7 true is true AWESOME
 # failed plan
 ok 8 one assert
-not ok 9 test timed out after 200ms
+not ok 9 failed plan timed out after 200ms
 # error
 not ok 10 Error: test
 
