feat: support user triggered BAD_ARGS

Also includes small refactors to return rejected promises instead of throwing, and to simplify a few areas of code around aliases.

Author: remy

lib/args.js

@@ -21,7 +21,7 @@ function args(argv, config) {
 
   let aliasShortcuts = abbrev(aliases);
 
-  // fixes up any issue
+  // fixes up any issues
   settings.options.forEach(t => delete settings.alias[t]);
   debug('config', config);
 
@@ -43,6 +43,11 @@ function args(argv, config) {
 
   defaultsDeep(settings.alias, abbrev(all));
 
+  // set abbreviated aliases to have the value of the alias
+  Object.keys(aliasShortcuts).forEach(a => {
+    settings.alias[a] = settings.alias[aliasShortcuts[a]];
+  });
+
   // total hack to capture the yargs help output
   let res = yargslib.reset().options(settings.yargs);
   var help = '';
@@ -76,11 +81,6 @@ function args(argv, config) {
 
   args.$_ = settings.commands[override || args._[0]] || // override or real
             settings.commands[settings.alias[args._[0]]] || // alias
-            settings.commands[ // alias of an alias command
-              settings.alias[args._[0]] &&
-              aliasShortcuts[args._[0]] &&
-              settings.alias[settings.alias[args._[0]]]
-            ] ||
             settings.commands._; // default
 
   // if there's no command config, then try to let the command match the
@@ -97,7 +97,7 @@ function args(argv, config) {
   }
 
   return {
-    help: help,
+    help,
     args,
   };
 }

lib/help.js

@@ -25,7 +25,7 @@ function getHelpItem(args, config) {
       return reject(new Error(`"${args.help}" help can't be found`));
     }
 
-    var error = new Error('no help configured');
+    var error = new Error('No help configured');
     error.code = 'NO_HELP_CONFIGURED';
     reject(error);
   });

lib/index.js

@@ -11,25 +11,20 @@ module.exports = (config, root) => {
       [path.join(root, 'node_modules')] :
       module.parent.parent.paths).slice(0); // copy
   let settings = getSettings(config);
+  let help = '';
 
   return Promise.all([
     parseArgs(process.argv, config),
     read(),
     findRoot(paths).then(res => root = res),
   ]).then(res => {
     let args = res[0].args;
-    let help = res[0].help;
+    help = res[0].help;
     let body = res[1];
     if (!args.$_ && !settings.commands._ && !body) {
-      return loadCommand(root, { $_: ':::./help' }, body, settings).catch(e => {
-        if (e.code === 'NO_HELP_CONFIGURED') {
-          e.message = help.trim();
-        }
-        throw e;
-      }).then(res => {
-        var e = new Error(res);
-        throw e;
-      });
+      var e = new Error('BAD_ARGS');
+      e.code = 'BAD_ARGS';
+      return Promise.reject(e);
     }
 
     return loadCommand(root, args, body, settings);
@@ -42,13 +37,39 @@ module.exports = (config, root) => {
 
     return res;
   }).catch(e => {
-    /* istanbul ignore if */
-    if (!settings.return) {
-      debug(e.stack);
-      console.error(e.message);
-      return process.exit(1);
+    var promise = Promise.reject(e);
+
+    if (e.code === 'BAD_ARGS') {
+      // show either the configured help or the automatically generated help
+      promise = loadCommand(root, {
+        $_: ':::./help', help: true,
+      }, null, settings).then(res => {
+        var error = new Error(res); // based on loaded help
+        error.code = 'BAD_ARGS';
+        return Promise.reject(error);
+      }).catch(error => {
+        if (error.code === 'NO_HELP_CONFIGURED') {
+          error.code = 'BAD_ARGS';
+          error.message = help.trim();
+        }
+
+        if (error.code === 'BAD_ARGS' && e.message !== 'BAD_ARGS') {
+          error.message = `${e.message}\n\n${error.message}`;
+        }
+
+        return Promise.reject(error);
+      });
     }
-    throw e;
+
+    return promise.catch(e => {
+      /* istanbul ignore if */
+      if (!settings.return) {
+        debug(e.stack);
+        console.error(e.message);
+        return process.exit(1);
+      }
+      return Promise.reject(e);
+    });
   });
 };
 
@@ -75,7 +96,7 @@ function loadCommand(root, args, body, settings) {
     resolve(require(filename));
   }).catch(e => {
     e.message = `Fatal: command failed to load "${filename}"`;
-    throw e;
+    return Promise.reject(e);
   }).then(res => res(args, settings, body)).then(res => {
     /* istanbul ignore if */
     if (!settings.return && internal) {

test/fixtures/basic-clite/err.js

@@ -0,0 +1,5 @@
+module.exports = function () {
+  var e = new Error('This did not work');
+  e.code = 'BAD_ARGS';
+  return Promise.reject(e);
+};

test/integration/clite.test.js

@@ -25,7 +25,7 @@ test('throws when no command', function (t) {
   return clite({}, fixtures + '/basic-clite').then(function (res) {
     t.fail('did not want: ' + res);
   }).catch(function (e) {
-    t.equal(e.code, 'NO_HELP_CONFIGURED', 'throws when no command');
+    t.equal(e.code, 'BAD_ARGS', 'throws when no command');
   });
 });
 

test/integration/help.test.js

@@ -16,7 +16,7 @@ var opts = {
 test('errors on help', function (t) {
   process.argv = sampleArgs.concat('--help');
   return clite({}, fixtures + '/basic-clite').catch(function (e) {
-    t.match(e.message, /no help configured/, 'warns on no help');
+    t.match(e.message, /no help configured/i, 'warns on no help');
   });
 });
 
@@ -52,9 +52,42 @@ test('finds specific help', function (t) {
   });
 });
 
-test('erros on unknown help', function (t) {
+test('errors on unknown help', function (t) {
   process.argv = sampleArgs.concat('--help', 'bar');
   return clite(opts, fixtures + '/basic-clite').catch(function (e) {
-    t.match(e.message, /"bar" help/, 'warns on missing help');
+    t.match(e.message, /"bar" help/i, 'warns on missing help');
   });
-});
+});
+
+test('throws with help with no command', function (t) {
+  process.argv = sampleArgs.slice(0);
+  return clite(opts, fixtures + '/basic-clite').then(function (res) {
+    t.fail('did not want: ' + res);
+  }).catch(function (e) {
+    t.equal(e.code, 'BAD_ARGS', 'bad arguments');
+    t.match(e.message, /This is the help/i, 'configured help shown');
+  });
+});
+
+test('throws with generated help with no command', function (t) {
+  process.argv = sampleArgs.slice(0);
+  return clite({}, fixtures + '/basic-clite').then(function (res) {
+    t.fail('did not want: ' + res);
+  }).catch(function (e) {
+    t.equal(e.code, 'BAD_ARGS', 'bad arguments');
+    t.match(e.message, /Options:\s+--version/im, 'generated help shown');
+  });
+});
+
+test('user can trigger usage error', function (t) {
+  process.argv = sampleArgs.slice(0);
+  return clite({
+    commands: { _: './err' },
+    help: opts.help
+  }, fixtures + '/basic-clite').then(function (res) {
+    t.fail('did not want: ' + res);
+  }).catch(function (e) {
+    t.equal(e.code, 'BAD_ARGS', 'bad arguments');
+    t.match(e.message, /This did not work/i, 'user error shown');
+  });
+});

test/unit/args.test.js

@@ -141,4 +141,19 @@ test('options', function (t) {
   // t.equal(res.$_, '.', 'command defaulted');
   t.equal(res.grep, 'sed', 'option captured');
   t.end();
+});
+
+test('aliases options get abbreviated', function (t) {
+  var res = args(sampleArgs.concat('-f', 'foo'), { options: ['grep'], alias: { filter: 'grep' } });
+  t.equal(res.grep, 'foo', 'option captured');
+  t.end();
+});
+
+test('aliases commands get abbreviated', function (t) {
+  var res = args(sampleArgs.concat('f'), {
+    commands: { grep: '.' },
+    alias: { filter: 'grep' }
+  });
+  t.equal(res.$_, '.', 'command captured');
+  t.end();
 });