New: Support flags.require config option (closes #108, closes #167) (#183)

Author: phated

README.md

@@ -108,6 +108,7 @@ Supported configurations properties:
 | flags.gulpfile     | Set a default gulpfile |
 | flags.silent       | Silence logging by default |
 | flags.series       | Run tasks given on the CLI in series (the default is parallel) |
+| flags.require      | An array of modules to require before running the gulpfile. Any relative paths will be resolved against the `--cwd` directory (if you don't want that behavior, use absolute paths) |
 
 ## Flags
 
@@ -147,7 +148,7 @@ __Some flags only work with gulp 4 and will be ignored when invoked against gulp
     <tr>
       <td>--cwd [path]</td>
       <td></td>
-      <td>Manually set the CWD. The search for the gulpfile, as well as the relativity of all requires will be from here.</td>
+      <td>Manually set the CWD. The search for the gulpfile, as well as the relativity of all requires (including the `--require` flag) will be from here.</td>
     </tr>
     <tr>
       <td>--verify [path (optional)]</td>

lib/shared/config/env-flags.js

@@ -6,6 +6,7 @@ var copyProps = require('copy-props');
 var toFrom = {
   configPath: 'flags.gulpfile',
   configBase: 'flags.gulpfile',
+  require: 'flags.require',
 };
 
 function mergeConfigToEnvFlags(env, config) {
@@ -16,6 +17,9 @@ function convert(configInfo, envInfo) {
   if (envInfo.keyChain === 'configBase') {
     return path.dirname(configInfo.value);
   }
+  if (envInfo.keyChain === 'require') {
+    return [].concat(envInfo.value, configInfo.value);
+  }
   return configInfo.value;
 }
 

test/config-flags-require.js

@@ -0,0 +1,109 @@
+'use strict';
+
+var expect = require('expect');
+
+var path = require('path');
+var fixturesDir = path.join(__dirname, 'fixtures/config');
+
+var headLines = require('gulp-test-tools').headLines;
+var eraseTime = require('gulp-test-tools').eraseTime;
+var runner = require('gulp-test-tools').gulpRunner().basedir(fixturesDir);
+
+describe('config: flags.require', function() {
+
+  it('Should configure with an array in a .gulp.* file', function(done) {
+    runner
+      .chdir('flags/require/array')
+      .gulp()
+      .run(cb);
+
+    function cb(err, stdout, stderr) {
+      expect(err).toEqual(null);
+      expect(stderr).toEqual('');
+
+      var requiring1 = eraseTime(headLines(stdout, 1));
+      expect(requiring1).toEqual('Requiring external module ./preload_one');
+      var requiring2 = eraseTime(headLines(stdout, 1, 1));
+      expect(requiring2).toEqual('Requiring external module ./preload_two');
+      var preload1 = eraseTime(headLines(stdout, 1, 4));
+      expect(preload1).toEqual('preload one!');
+      var preload2 = eraseTime(headLines(stdout, 1, 5));
+      expect(preload2).toEqual('preload two!');
+      done(err);
+    }
+  });
+
+  it('Should configure with a string in a .gulp.* file', function(done) {
+    runner
+      .chdir('flags/require/string')
+      .gulp()
+      .run(cb);
+
+    function cb(err, stdout, stderr) {
+      expect(err).toEqual(null);
+      expect(stderr).toEqual('');
+      var requiring = eraseTime(headLines(stdout, 1));
+      expect(requiring).toEqual('Requiring external module ./preload');
+      var preload1 = eraseTime(headLines(stdout, 1, 3));
+      expect(preload1).toEqual('hello preload!');
+      done(err);
+    }
+  });
+
+  it('Combines --require flag with .gulp.* file flags.require', function(done) {
+    runner
+      .chdir('flags/require/join-flags')
+      .gulp('--require ./preload_one')
+      .run(cb);
+
+    function cb(err, stdout, stderr) {
+      expect(err).toEqual(null);
+      expect(stderr).toEqual('');
+
+      var requiring1 = eraseTime(headLines(stdout, 1));
+      expect(requiring1).toEqual('Requiring external module ./preload_one');
+      var requiring2 = eraseTime(headLines(stdout, 1, 1));
+      expect(requiring2).toEqual('Requiring external module ./preload_two');
+      var preload1 = eraseTime(headLines(stdout, 1, 4));
+      expect(preload1).toEqual('preload one!');
+      var preload2 = eraseTime(headLines(stdout, 1, 5));
+      expect(preload2).toEqual('preload two!');
+      done(err);
+    }
+  });
+
+  it('resolves relative requires against cwd', function(done) {
+    runner
+      .gulp('--cwd flags/require/with-cwd')
+      .run(cb);
+
+    function cb(err, stdout, stderr) {
+      expect(err).toEqual(null);
+      expect(stderr).toEqual('');
+      var requiring = eraseTime(headLines(stdout, 1));
+      expect(requiring).toEqual('Requiring external module ../preload');
+      var preload1 = eraseTime(headLines(stdout, 1, 4));
+      expect(preload1).toEqual('hello preload!');
+      done(err);
+    }
+  });
+
+  it('works with absolute paths, ignoring cwd', function(done) {
+    runner
+      .gulp('--cwd flags/require/with-absolute')
+      .run(cb);
+
+    function cb(err, stdout, stderr) {
+      expect(err).toEqual(null);
+      expect(stderr).toEqual('');
+
+      var absolute = path.join(__dirname, './fixtures/config/flags/require/preload');
+      var requiring = eraseTime(headLines(stdout, 1));
+      expect(requiring).toEqual('Requiring external module ' + absolute);
+      var preload1 = eraseTime(headLines(stdout, 1, 4));
+      expect(preload1).toEqual('hello preload!');
+      done(err);
+    }
+  });
+});
+

test/fixtures/config/flags/require/array/.gulp.json

@@ -0,0 +1,8 @@
+{
+  "flags": {
+    "require": [
+      "./preload_one",
+      "./preload_two"
+    ]
+  }
+}

test/fixtures/config/flags/require/array/gulpfile.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var gulp = require('gulp');
+
+gulp.task('default', function(done) {
+  console.log(global.preload_one);
+  console.log(global.preload_two);
+  done();
+});

test/fixtures/config/flags/require/array/preload_one.js

@@ -0,0 +1 @@
+global.preload_one = 'preload one!';

test/fixtures/config/flags/require/array/preload_two.js

@@ -0,0 +1 @@
+global.preload_two = 'preload two!';

test/fixtures/config/flags/require/join-flags/.gulp.json

@@ -0,0 +1,7 @@
+{
+  "flags": {
+    "require": [
+      "./preload_two"
+    ]
+  }
+}

test/fixtures/config/flags/require/join-flags/gulpfile.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var gulp = require('gulp');
+
+gulp.task('default', function(done) {
+  console.log(global.preload_one);
+  console.log(global.preload_two);
+  done();
+});

test/fixtures/config/flags/require/join-flags/preload_one.js

@@ -0,0 +1 @@
+global.preload_one = 'preload one!';