Use commander for cli parsing

closes #434
resolves #433

Author: charlierudolph

README.md

@@ -427,75 +427,83 @@ var myAfterHooks = function () {
 module.exports = myAfterHooks;
 ```
 
-### Transpilers
+### CLI
 
-Step definitions and support files can be written in other languages that transpile to javascript. This done with the CLI option `--compiler <file_extension>:<module_name>`.
-
-#### CoffeeScript
-
-Install the [coffee-script](https://www.npmjs.com/package/coffee-script) NPM package and invoke Cucumber with `--compiler coffee:coffee-script/register`.
-
-#### TypeScript
+Cucumber.js includes a binary file to execute the features.
 
-Install the [typescript-node](https://www.npmjs.com/package/typescript-node) NPM package and invoke Cucumber with `--compiler ts:typescript-node/register`.
+If you installed cucumber.js globally, you may run it with:
 
-As usual, all your step definition and support files must export a function to be run by Cucumber. This is how it is done in TS:
+``` shell
+$ cucumber.js
+```
 
+If you installed Cucumber locally, you may need to specify the path to the binary:
 
-```typescript
-declare var module: any;
-module.exports = function () {
-  this.Given(/.*/, function () {
-    // ...
-  })
-}
+``` shell
+$ ./node_modules/.bin/cucumber.js
 ```
 
-#### PogoScript
+**Note to Windows users:** invoke Cucumber.js with `cucumber-js` instead of `cucumber.js`. The latter is causing the operating system to invoke JScript instead of Node.js, because of the so-called file extension.
 
-Install the [pogo](https://www.npmjs.com/package/pogo) NPM package and invoke Cucumber with `--compiler pogo:pogo`.
+#### Running specific features
 
-### Custom Snippet Syntax
+* Specify a feature file
+  * `$ cucumber.js features/my_feature.feature`
+* Specify a scenario by its line number
+  * `$ cucumber.js features/my_feature.feature:3`
+* Use [Tags](#tags)
 
-Undefined steps snippets are printed in javascript by default.
-Custom snippet snytaxes can be used with `--snippet-syntax <FILE>`.
-See [here](/features/step_definition_snippets_custom_syntax.feature) for an example.
+#### Requiring support files
 
-##### Building a custom snippet syntax
+Use `--require <FILE|DIR>` to require files before executing the features.
+If not used, all "*.js" files (and other extensions specifed by `--compiler`) that are siblings
+or below the features will be loaded automatically. Automatic
+loading is disabled when this option is specified, and all loading becomes explicit.
+Files under directories named "support" are always loaded first
 
-* See the [JavaScript syntax](/lib/cucumber/support_code/step_definition_snippet_builder/javascript_syntax.js) for an example. Please open an issue if you need more information.
-* Please add the keywords `cucumber` and `snippets` to your package,
-so it can easily be found by searching [npm](https://www.npmjs.com/search?q=cucumber+snippets).
+#### Formatters
 
-### Run cucumber
+Use `--format <TYPE[:PATH]>` to specify the format of the output.
+If PATH is not supplied, the formatter prints to stdout.
+If PATH is supplied, it prints to the given file.
+If multiple formats are specified with the same output, only the last is used.
 
-Cucumber.js includes a binary file to execute the features.
+Built-in formatters
+* pretty - prints the feature as is (default)
+* progress - prints one character per scenario
+* json - prints the feature as JSON
+* summary - prints a summary only, after all scenarios were executed
 
-If you installed cucumber.js globally, you may run it with:
+#### Tags
 
-``` shell
-$ cucumber.js
-```
+Use `--tags <EXPRESSION>` to run specific features or scenarios.
 
-You may specify the features to run:
+* `--tag @dev`: tagged with @dev
+* `--tag ~@dev`: NOT tagged with `@dev`
+* `--tags @foo,@bar`: tagged with `@foo` OR `bar`
+* `--tags @foo --tags @bar`: tagged with `@foo` AND `bar`
 
-``` shell
-$ cucumber.js features/my_feature.feature
-```
+#### Transpilers
 
-And require specific step definitions and support code files with the --require option:
+Step definitions and support files can be written in other languages that transpile to javascript.
+This done with the CLI option `--compiler <file_extension>:<module_name>`.
+Below are some examples
 
-``` shell
-$ cucumber.js features/my_feature.feature --require features/step_definitions/my_step_definitions.js
-```
+* [CoffeeScript](https://www.npmjs.com/package/coffee-script): `--compiler coffee:coffee-script/register`
+* [TypeScript](https://www.npmjs.com/package/ts-node): `--compiler ts:ts-node/register`
+* [Pogo](https://www.npmjs.com/package/pogo): `--compiler pogo:pogo`
 
-If you installed Cucumber locally or with `npm install --save-dev`, you'll need to specify the path to the binary:
+### Custom Snippet Syntax
 
-``` shell
-$ ./node_modules/.bin/cucumber.js
-```
+Undefined steps snippets are printed in javascript by default.
+Custom snippet snytaxes can be used with `--snippet-syntax <FILE>`.
+See [here](/features/step_definition_snippets_custom_syntax.feature) for an example.
 
-**Note to Windows users:** invoke Cucumber.js with `cucumber-js` instead of `cucumber.js`. The latter is causing the operating system to invoke JScript instead of Node.js, because of the so-called file extension.
+##### Building a custom snippet syntax
+
+* See the [JavaScript syntax](/lib/cucumber/support_code/step_definition_snippet_builder/javascript_syntax.js) for an example. Please open an issue if you need more information.
+* Please add the keywords `cucumber` and `snippets` to your package,
+so it can easily be found by searching [npm](https://www.npmjs.com/search?q=cucumber+snippets).
 
 ### Examples
 

lib/cucumber/ast/filter/scenario_at_line_rule.js

@@ -5,7 +5,7 @@ function ScenarioAtLineRule(suppliedPaths) {
 
   var mapping = {};
   suppliedPaths.forEach(function(path){
-    var matches = Cucumber.Cli.ArgumentParser.FEATURE_FILENAME_AND_LINENUM_REGEXP.exec(path);
+    var matches = Cucumber.Cli.Configuration.FEATURE_FILENAME_AND_LINENUM_REGEXP.exec(path);
     var specifiedLineNums = matches && matches[2];
     if (specifiedLineNums) {
       var realPath = fs.realpathSync(matches[1]);

lib/cucumber/cli.js

@@ -1,116 +1,70 @@
 function Cli(argv) {
   var Cucumber = require('../cucumber');
+  var Command = require('commander').Command;
+  var path = require('path');
+
+  function collect(val, memo) {
+    memo.push(val);
+    return memo;
+  }
+
+  function getConfiguration() {
+    var program = getProgram();
+    program.parse(argv);
+    var profileArgs = Cucumber.Cli.ProfilesLoader.getArgs(program.profile);
+    argv.splice.apply(argv, [2, 0].concat(profileArgs));
+    program.parse(argv);
+    var configuration = Cucumber.Cli.Configuration(program.opts(), program.args);
+    return configuration;
+  }
+
+  function getProgram () {
+    var program = new Command(path.basename(argv[1]));
+
+    program
+      .usage('[options] [<DIR|FILE[:LINE]>...]')
+      .version(Cucumber.VERSION, '-v, --version')
+      .option('-b, --backtrace', 'show full backtrace for errors')
+      .option('--compiler <EXTENSION:MODULE>', 'require files with the given EXTENSION after requiring MODULE (repeatable)', collect, [])
+      .option('-d, --dry-run', 'invoke formatters without executing steps')
+      .option('--fail-fast', 'abort the run on first failure')
+      .option('-f, --format <TYPE[:PATH]>', 'specify the output format, optionally supply PATH to redirect formatter output (repeatable)', collect, ['pretty'])
+      .option('--no-colors', 'disable colors in formatter output')
+      .option('--no-snippets', 'hide step definition snippets for pending steps')
+      .option('--no-source', 'hide source uris')
+      .option('-p, --profile <NAME>', 'specify the profile to use (repeatable)', collect, [])
+      .option('-r, --require <FILE|DIR>', 'require files before executing features (repeatable)', collect, [])
+      .option('--snippet-syntax <FILE>', 'specify a custom snippet syntax')
+      .option('-S, --strict', 'fail if there are any undefined or pending steps')
+      .option('-t, --tags <EXPRESSION>', 'only execute the features or scenarios with tags matching the expression (repeatable)', collect, []);
+
+    program.on('--help', function(){
+      console.log('  For more details please visit https://github.com/cucumber/cucumber-js#cli\n');
+    });
+
+    return program;
+  }
 
   var self = {
     run: function run(callback) {
-      var configuration = Cli.Configuration(argv);
-      if (configuration.isHelpRequested())
-        self.displayHelp(callback);
-      else if (configuration.isVersionRequested())
-        self.displayVersion(callback);
-      else
-        self.runSuiteWithConfiguration(configuration, callback);
-    },
-
-    runSuiteWithConfiguration: function runSuiteWithConfiguration(configuration, callback) {
+      var configuration = getConfiguration();
       var runtime    = Cucumber.Runtime(configuration);
       var formatters = configuration.getFormatters();
       formatters.forEach(function (formatter) {
         runtime.attachListener(formatter);
       });
       runtime.start(callback);
-    },
-
-    displayHelp: function displayHelp(callback) {
-      /* jshint -W109 */
-      process.stdout.write("Usage: cucumber.js [options] [[FILE|DIR][:LINE]]+\n\
-\n\
--r, --require LIBRARY|DIR     Require files before executing the features. If\n\
-                              this option is not specified, all *.js and\n\
-                              *.coffee files that are siblings or below the\n\
-                              features will be loaded automatically. Automatic\n\
-                              loading is disabled when this option is specified,\n\
-                              and all loading becomes explicit.\n\
-\n\
-                              Files under directories named \"support\" are\n\
-                              always loaded first.\n\
-\n\
--t, --tags TAG_EXPRESSION     Only execute the features or scenarios with tags\n\
-                              matching TAG_EXPRESSION. Scenarios inherit tags\n\
-                              declared on the Feature level. The simplest\n\
-                              TAG_EXPRESSION is simply a tag. Example:\n\
-                                --tags @dev\n\
-\n\
-                              When a tag in a tag expression starts with a ~,\n\
-                              this represents boolean NOT. Example:\n\
-                                --tags ~@dev\n\
-\n\
-                              A tag expression can have several tags separated\n\
-                              by a comma, which represents logical OR. Example:\n\
-                                --tags @dev,@wip\n\
-\n\
-                              The --tags option can be specified several times,\n\
-                              and this represents logical AND. Example:\n\
-                                --tags @foo,~@bar --tags @zap.\n\
-\n\
-                              This represents the following boolean expression:\n\
-                              (@foo || !@bar) && @zap.\n\
-\n\
-                              Beware that if you want to use several negative\n\
-                              tags to exclude several tags you have to use\n\
-                              logical AND: --tags ~@fixme --tags ~@buggy.\n\
-\n\
--f, --format FORMAT[:PATH]    How to format features (default: progress).\n\
-                              Supply PATH to redirect that formatters output.\n\
-                              Available formats:\n\
-                                pretty  : prints the feature as is\n\
-                                progress: prints one character per scenario\n\
-                                json    : prints the feature as JSON\n\
-                                summary : prints a summary only, after all\n\
-                                          scenarios were executed\n\
-\n\
--p, --profile PROFILE         Pull command line arguments from cucumber.js.\n\
-                              When a 'default' profile is defined and no profile\n\
-                              is specified it is always used.\n\
-\n\
---compiler SUFFIX:MODULE      Include step definitions and support files with the\n\
-                              given file suffix and require the given module to\n\
-                              load those files.\n\
-\n\
--i, --no-snippets             Don't print snippets for pending steps.\n\
-\n\
---snippet-syntax FILE         Specify a custom snippet syntax.\n\
-\n\
--b, --backtrace               Show full backtrace for all errors.\n\
-\n\
--S, --strict                  Fail if there are any undefined or pending steps.\n\
-\n\
--d, --dry-run                 Invokes formatters without executing the steps.\n\
-\n\
---no-source                   Don't print the source uris.\n\
-\n\
---[no-]colors                 Enable/disable colors in output.\n\
-\n\
---fail-fast                   Abort the run on first failure.\n\
-\n\
--v, --version                 Display Cucumber.js's version.\n\
-\n\
--h, --help                    You're looking at it.\n");
-      /* jshint +W109 */
-      callback(true);
-    },
-
-    displayVersion: function displayVersion(callback) {
-      process.stdout.write(Cucumber.VERSION + '\n');
-      callback(true);
     }
   };
   return self;
 }
 
-Cli.ArgumentParser      = require('./cli/argument_parser');
-Cli.Configuration       = require('./cli/configuration');
+Cli.Configuration = require('./cli/configuration');
+Cli.FeaturePathExpander = require('./cli/feature_path_expander');
 Cli.FeatureSourceLoader = require('./cli/feature_source_loader');
-Cli.SupportCodeLoader   = require('./cli/support_code_loader');
+Cli.PathExpander = require('./cli/path_expander');
+Cli.ProfilesLoader = require('./cli/profiles_loader');
+Cli.SupportCodeLoader = require('./cli/support_code_loader');
+Cli.SupportCodePathExpander = require('./cli/support_code_path_expander');
 
 module.exports = Cli;