remove compiler option (#1008)

Author: charlierudolph

CHANGELOG.md

@@ -5,6 +5,13 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 #### BREAKING CHANGES
 
 * cucumber now waits for the event loop to drain before exiting. To exit immediately when the tests finish running use `--exit`. Use of this flag is discouraged. See [here](/docs/cli.md#exiting) for more information
+* remove `--compiler` option. See [here](/docs/cli.md#transpilers) for the new way to use transpilers
+
+#### New Features
+
+* can now use glob patterns for selecting what features to run
+* update `--require` to support glob patterns
+* add `--require-module` to require node modules before support code is loaded
 
 #### Deprecations
 

cucumber.js

@@ -1,5 +1,5 @@
 var common = [
-  '--compiler js:babel-register',
+  '--require-module babel-register',
   `--format ${process.env.CI ? 'progress' : 'progress-bar'}`,
   '--format rerun:@rerun.txt',
   '--format usage:usage.txt'

docs/cli.md

@@ -17,6 +17,10 @@ needs to be required in your support files and globally installed modules cannot
 
 ## Running specific features
 
+* Specify a [glob](https://github.com/isaacs/node-glob) pattern
+  * `$ cucumber.js features/**/*.feature`
+* Specify a feature directory
+  * `$ cucumber.js features/dir`
 * Specify a feature file
   * `$ cucumber.js features/my_feature.feature`
 * Specify a scenario by its line number
@@ -28,14 +32,13 @@ needs to be required in your support files and globally installed modules cannot
 
 ## Requiring support files
 
-Use `--require <FILE|DIR>` to require files before executing the features.
+Use `--require <GLOB|DIR|FILE>` to require support files before executing the features. Uses [glob](https://github.com/isaacs/node-glob) patterns.
 If not used, the following files are required:
 * If the features live in a `features` directory (at any level)
-  * all support files in the `features` directory
+  * `features/**/*.js`
 * Otherwise
-  * all support files in the directories of the features
+  * `<DIR>/**/*.js` for each directory containing the selected features
 
-Support files are defined as all `*.js` files and other extensions specified by `--compiler`.
 Automatic loading is disabled when this option is specified, and all loading becomes explicit.
 
 ## Formats
@@ -110,7 +113,7 @@ Use `--tags <EXPRESSION>` to run specific features or scenarios. This option is
 
 ## Transpilers
 
-Step definitions and support files can be written in other languages that transpile to javascript. To do this use the CLI option `--compiler <file_extension>:<module_name>`. Running `require("<module_name>")`, should make it possible to require files with the given extension. As an example, load [CoffeeScript](https://www.npmjs.com/package/coffee-script) support files with `--compiler coffee:coffee-script/register`.
+Step definitions and support files can be written in other languages that transpile to javascript. To do this use the CLI option `--require-module <module_name>`, where `require("<module_name>")` should make it possible to require files for your language. Also use `--require features/**/*.<ext>` if your files end in an extension other than `js`. As an example, load [CoffeeScript](https://www.npmjs.com/package/coffee-script) support files with `--require-module coffee-script/register --require features/**/*.coffee`.
 
 ## World Parameters
 

features/profiles.feature

@@ -18,7 +18,7 @@ Feature: default command line arguments
       """
     And a file named "cucumber.js" with:
       """
-      var common = '--compiler js:babel-register ';
+      var common = '--require-module babel-register ';
 
       module.exports = {
         'default': common + '--format summary',

features/compiler.feature renamed to features/require_module.feature

@@ -18,5 +18,5 @@ Feature: compilers
 
       Given /^a step$/, ->
       """
-    When I run cucumber.js with `--compiler coffee:coffee-script/register`
+    When I run cucumber.js with `--require-module coffee-script/register --require 'features/**/*.coffee'`
     Then the step "a step" has status "passed"

features/support/hooks.js

@@ -24,7 +24,7 @@ Before(function() {
 
   const tmpDirProfilePath = path.join(this.tmpDir, 'cucumber.js')
   const profileContent =
-    'module.exports = {default: "--compiler js:babel-register"}'
+    'module.exports = {default: "--require-module babel-register"}'
   fs.writeFileSync(tmpDirProfilePath, profileContent)
 
   const tmpDirBabelRcPath = path.join(this.tmpDir, '.babelrc')

src/cli/argv_parser.js

@@ -42,15 +42,9 @@ export default class ArgvParser {
     const program = new Command(path.basename(argv[1]))
 
     program
-      .usage('[options] [<DIR|FILE[:LINE]>...]')
+      .usage('[options] [<GLOB|DIR|FILE[:LINE]>...]')
       .version(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)',
-        ArgvParser.collect,
-        []
-      )
       .option('-d, --dry-run', 'invoke formatters without executing steps')
       .option(
         '--exit',
@@ -95,11 +89,17 @@ export default class ArgvParser {
         []
       )
       .option(
-        '-r, --require <FILE|DIR>',
+        '-r, --require <GLOB|DIR|FILE>',
         'require files before executing features (repeatable)',
         ArgvParser.collect,
         []
       )
+      .option(
+        '--require-module <NODE_MODULE>',
+        'require node modules before requiring files (repeatable)',
+        ArgvParser.collect,
+        []
+      )
       .option(
         '-t, --tags <EXPRESSION>',
         'only execute the features or scenarios with tags matching the expression (repeatable)',

src/cli/configuration_builder.js

@@ -2,9 +2,11 @@ import _ from 'lodash'
 import ArgvParser from './argv_parser'
 import fs from 'mz/fs'
 import path from 'path'
-import PathExpander from './path_expander'
 import OptionSplitter from './option_splitter'
-import Promise from 'bluebird'
+import Promise, { promisify } from 'bluebird'
+import glob from 'glob'
+
+const globP = promisify(glob)
 
 export default class ConfigurationBuilder {
   static async build(options) {
@@ -14,7 +16,6 @@ export default class ConfigurationBuilder {
 
   constructor({ argv, cwd }) {
     this.cwd = cwd
-    this.pathExpander = new PathExpander(cwd)
 
     const parsedArgv = ArgvParser.parse(argv)
     this.args = parsedArgv.args
@@ -29,15 +30,16 @@ export default class ConfigurationBuilder {
     let supportCodePaths = []
     if (!listI18nKeywordsFor && !listI18nLanguages) {
       featurePaths = await this.expandFeaturePaths(unexpandedFeaturePaths)
-      const featureDirectoryPaths = this.getFeatureDirectoryPaths(featurePaths)
-      const unexpandedSupportCodePaths =
-        this.options.require.length > 0
-          ? this.options.require
-          : featureDirectoryPaths
-      supportCodePaths = await this.expandSupportCodePaths(
-        unexpandedSupportCodePaths
+      let unexpandedSupportCodePaths = this.options.require
+      if (unexpandedSupportCodePaths.length === 0) {
+        unexpandedSupportCodePaths = this.getFeatureDirectoryPaths(featurePaths)
+      }
+      supportCodePaths = await this.expandPaths(
+        unexpandedSupportCodePaths,
+        '.js'
       )
     }
+    this.options.requireModule.forEach(module => require(module))
     return {
       featureDefaultLanguage: this.options.language,
       featurePaths,
@@ -63,11 +65,28 @@ export default class ConfigurationBuilder {
     }
   }
 
+  async expandPaths(unexpandedPaths, defaultExtension) {
+    const expandedPaths = await Promise.map(
+      unexpandedPaths,
+      async unexpandedPath => {
+        const matches = await globP(unexpandedPath, {
+          absolute: true,
+          cwd: this.cwd
+        })
+        return await Promise.map(matches, async match => {
+          if (path.extname(match) === '') {
+            return await globP(`${match}/**/*${defaultExtension}`)
+          }
+          return match
+        })
+      }
+    )
+    return _.flattenDepth(expandedPaths, 2).map(x => path.normalize(x))
+  }
+
   async expandFeaturePaths(featurePaths) {
     featurePaths = featurePaths.map(p => p.replace(/(:\d+)*$/g, '')) // Strip line numbers
-    return await this.pathExpander.expandPathsWithExtensions(featurePaths, [
-      'feature'
-    ])
+    return await this.expandPaths(featurePaths, '.feature')
   }
 
   getFeatureDirectoryPaths(featurePaths) {
@@ -127,19 +146,6 @@ export default class ConfigurationBuilder {
         return featurePaths
       }
     }
-    return ['features']
-  }
-
-  async expandSupportCodePaths(supportCodePaths) {
-    const extensions = ['js']
-    this.options.compiler.forEach(compiler => {
-      const [extension, module] = OptionSplitter.split(compiler)
-      extensions.push(extension)
-      require(module)
-    })
-    return await this.pathExpander.expandPathsWithExtensions(
-      supportCodePaths,
-      extensions
-    )
+    return ['features/**/*.feature']
   }
 }

src/cli/configuration_builder_spec.js

@@ -34,7 +34,7 @@ describe('Configuration', function() {
         listI18nKeywordsFor: '',
         listI18nLanguages: false,
         pickleFilterOptions: {
-          featurePaths: ['features'],
+          featurePaths: ['features/**/*.feature'],
           names: [],
           tagExpression: ''
         },

src/cli/option_splitter_spec.js

@@ -26,21 +26,6 @@ describe('OptionSplitter', function() {
       description: 'does not split a single absolute windows paths',
       input: 'C:\\custom\\formatter',
       output: ['C:\\custom\\formatter']
-    },
-    {
-      description: 'splits extensions and modules',
-      input: 'ts:typescript',
-      output: ['ts', 'typescript']
-    },
-    {
-      description: 'splits extension and module with an absolute windows path',
-      input: 'ts:C:/typescript',
-      output: ['ts', 'C:/typescript']
-    },
-    {
-      description: 'splits more than 2 parts',
-      input: 'part1:part2:part3',
-      output: ['part1', 'part2', 'part3']
     }
   ]