New: Support configuration with .gulp.* files (closes #69) (#90)

Includes implementation for description configuration (closes #70)

README.md

@@ -83,6 +83,18 @@ You can find a list of supported languages at https://github.com/js-cli/js-inter
 
 The CLI adds process.env.INIT_CWD which is the original cwd it was launched from.
 
+## Configuration
+
+Configuration is supported through the use of a `.gulp.*` file (e.g. `.gulp.json`, `.gulp.yml`). You can find a list of supported languages at https://github.com/js-cli/js-interpret.
+
+Configuration from the home directory (`~`) and current working directory (`cwd`) are merged with `cwd` taking precedence.
+
+Supported configurations properties:
+
+| Property | Description |
+|-------------|-------------|
+| description | Top-level description of the project/gulpfile (Replaces "Tasks for ~/path/of/gulpfile.js") |
+
 ## Flags
 
 gulp has very few flags to know about. All other flags are for tasks to use if needed.

index.js

@@ -9,6 +9,8 @@ var Liftoff = require('liftoff');
 var tildify = require('tildify');
 var interpret = require('interpret');
 var v8flags = require('v8flags');
+var merge = require('lodash.merge');
+var isString = require('lodash.isstring');
 var findRange = require('semver-greatest-satisfied-range');
 var exit = require('./lib/shared/exit');
 var cliOptions = require('./lib/shared/cliOptions');
@@ -34,6 +36,18 @@ var cli = new Liftoff({
  completions: completion,
  extensions: interpret.jsVariants,
  v8flags: v8flags,
+ configFiles: {
+ '.gulp': {
+ home: {
+ path: '~',
+ extensions: interpret.extensions,
+ },
+ cwd: {
+ path: '.',
+ extensions: interpret.extensions,
+ },
+ },
+ },
 });
 
 var usage =
@@ -82,6 +96,15 @@ module.exports = run;
 
 // The actual logic
 function handleArguments(env) {
+
+ // Map an array of keys to preserve order
+ var configFilePaths = ['home', 'cwd'].map(function(key) {
+ return env.configFiles['.gulp'][key];
+ });
+ configFilePaths.filter(isString).forEach(function(filePath) {
+ merge(opts, require(filePath));
+ });
+
  if (opts.help) {
  console.log(parser.help());
  exit(0);

lib/versioned/^3.7.0/index.js

@@ -4,6 +4,7 @@ var chalk = require('chalk');
 var log = require('gulplog');
 var stdout = require('mute-stdout');
 var tildify = require('tildify');
+var isString = require('lodash.isstring');
 
 var taskTree = require('./taskTree');
 var logTasks = require('../../shared/log/tasks');
@@ -38,7 +39,11 @@ function execute(opts, env) {
  }
  if (opts.tasks) {
  var tree = taskTree(gulpInst.tasks);
- tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ if (opts.description && isString(opts.description)) {
+ tree.label = opts.description;
+ } else {
+ tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ }
  return logTasks(tree, opts.depth, function(task) {
  return gulpInst.tasks[task].fn;
  });

lib/versioned/^4.0.0-alpha.1/index.js

@@ -6,6 +6,7 @@ var log = require('gulplog');
 var chalk = require('chalk');
 var stdout = require('mute-stdout');
 var tildify = require('tildify');
+var isString = require('lodash.isstring');
 
 var exit = require('../../shared/exit');
 
@@ -42,10 +43,13 @@ function execute(opts, env) {
  return logTasksSimple(gulpInst.tree());
  }
  if (opts.tasks) {
- var tree = {
- label: 'Tasks for ' + chalk.magenta(tildify(env.configPath)),
- nodes: gulpInst.tree({ deep: true }),
- };
+ var tree = {};
+ if (opts.description && isString(opts.description)) {
+ tree.label = opts.description;
+ } else {
+ tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ }
+ tree.nodes = gulpInst.tree({ deep: true });
  return logTasks(tree, opts.depth, function(taskname) {
  return gulpInst.task(taskname);
  });

lib/versioned/^4.0.0-alpha.2/index.js

@@ -6,6 +6,7 @@ var log = require('gulplog');
 var chalk = require('chalk');
 var stdout = require('mute-stdout');
 var tildify = require('tildify');
+var isString = require('lodash.isstring');
 
 var exit = require('../../shared/exit');
 
@@ -48,13 +49,21 @@ function execute(opts, env) {
  }
  if (opts.tasks) {
  tree = gulpInst.tree({ deep: true });
- tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ if (opts.description && isString(opts.description)) {
+ tree.label = opts.description;
+ } else {
+ tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ }
 
  return logTasks(tree, opts.depth, getTask(gulpInst));
  }
  if (opts.tasksJson) {
  tree = gulpInst.tree({ deep: true });
- tree.label = 'Tasks for ' + tildify(env.configPath);
+ if (opts.description && isString(opts.description)) {
+ tree.label = opts.description;
+ } else {
+ tree.label = 'Tasks for ' + tildify(env.configPath);
+ }
 
  var output = JSON.stringify(tree);
 

lib/versioned/^4.0.0/index.js

@@ -6,6 +6,7 @@ var log = require('gulplog');
 var chalk = require('chalk');
 var stdout = require('mute-stdout');
 var tildify = require('tildify');
+var isString = require('lodash.isstring');
 
 var exit = require('../../shared/exit');
 
@@ -48,13 +49,21 @@ function execute(opts, env) {
  }
  if (opts.tasks) {
  tree = gulpInst.tree({ deep: true });
- tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ if (opts.description && isString(opts.description)) {
+ tree.label = opts.description;
+ } else {
+ tree.label = 'Tasks for ' + chalk.magenta(tildify(env.configPath));
+ }
 
  return logTasks(tree, opts.depth, getTask(gulpInst));
  }
  if (opts.tasksJson) {
  tree = gulpInst.tree({ deep: true });
- tree.label = 'Tasks for ' + tildify(env.configPath);
+ if (opts.description && isString(opts.description)) {
+ tree.label = opts.description;
+ } else {
+ tree.label = 'Tasks for ' + tildify(env.configPath);
+ }
 
  var output = JSON.stringify(tree);
 

package.json

@@ -36,10 +36,11 @@
  "fancy-log": "^1.1.0",
  "gulplog": "^1.0.0",
  "interpret": "^1.0.0",
- "liftoff": "^2.1.0",
+ "liftoff": "^2.3.0",
  "lodash.isfunction": "^3.0.8",
  "lodash.isplainobject": "^4.0.4",
  "lodash.isstring": "^4.0.1",
+ "lodash.merge": "^4.5.1",
  "lodash.sortby": "^4.5.0",
  "matchdep": "^1.0.0",
  "mute-stdout": "^1.0.0",

test/config.js

@@ -0,0 +1,67 @@
+'use strict';
+
+var lab = exports.lab = require('lab').script();
+var expect = require('code').expect;
+var path = require('path');
+var fs = require('fs');
+
+var skipLines = require('./tools/skip-lines');
+var eraseTime = require('./tools/erase-time');
+var runner = require('./tools/run-gulp');
+
+var fixturesDir = path.join(__dirname, 'fixtures', 'config');
+var expectedDir = path.join(__dirname, 'expected', 'config');
+
+lab.experiment('gulp configuration', function() {
+
+ lab.test('Should configure with a .gulp.* file in cwd',
+ function(done) {
+ runner({ verbose: false })
+ .basedir(fixturesDir)
+ .chdir('foo/bar')
+ .gulp('--tasks')
+ .run(cb);
+
+ function cb(err, stdout) {
+ var expected = fs.readFileSync(path.join(expectedDir, 'output0.txt'),
+ 'utf-8');
+ stdout = eraseTime(stdout);
+ expect(stdout).to.equal(expected);
+ done(err);
+ }
+ });
+
+ lab.test('Should configure with a .gulp.* file in cwd found up',
+ function(done) {
+ runner({ verbose: false })
+ .basedir(fixturesDir)
+ .chdir('foo/bar/baz')
+ .gulp('--tasks')
+ .run(cb);
+
+ function cb(err, stdout) {
+ var expected = fs.readFileSync(path.join(expectedDir, 'output0.txt'),
+ 'utf-8');
+ stdout = eraseTime(skipLines(stdout, 1));
+ expect(stdout).to.equal(expected);
+ done(err);
+ }
+ });
+
+ lab.test('Should configure with a .gulp.* file in cwd by --cwd',
+ function(done) {
+ runner({ verbose: false })
+ .basedir(fixturesDir)
+ .chdir('qux')
+ .gulp('--tasks', '--gulpfile ../foo/bar/gulpfile.js', '--cwd .')
+ .run(cb);
+
+ function cb(err, stdout) {
+ var expected = fs.readFileSync(path.join(expectedDir, 'output1.txt'),
+ 'utf-8');
+ stdout = eraseTime(stdout);
+ expect(stdout).to.equal(expected);
+ done(err);
+ }
+ });
+});

test/expected/flags-tasks/by-unwrap-and-not-by-unwrap.txt → test/expected/by-unwrap-and-not-by-unwrap.txt

@@ -1,4 +1,4 @@
-gulp-cli/test
+gulp-cli/test/fixtures
 ├─┬ default
 │ └─┬ <series>
 │ ├── task1

test/expected/config/output0.txt

@@ -0,0 +1,2 @@
+Description by .gulp.json in directory foo/bar
+└── default

test/expected/config/output1.txt

@@ -0,0 +1,2 @@
+description by .gulp.js in directory qux
+└── default

test/expected/flags-tasks-json.json

@@ -1 +1 @@
-{"label":"Tasks for {{path}}","nodes":[{"label":"test1","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"noop","type":"function","nodes":[]}]}]},{"label":"test2","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"test1","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"noop","type":"function","nodes":[]}]}]},{"label":"noop","type":"function","nodes":[]}]}]},{"label":"test3","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"described","type":"function","nodes":[]}]}]},{"label":"test4","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"errorFunction","type":"function","nodes":[]},{"label":"anon","type":"function","nodes":[]}]}]},{"label":"default","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"test1","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"noop","type":"function","nodes":[]}]}]},{"label":"test3","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"described","type":"function","nodes":[]}]}]},{"label":"noop","type":"function","nodes":[]}]}]}]}
+{"label":"gulp-cli/test/fixtures/gulpfiles","nodes":[{"label":"test1","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"noop","type":"function","nodes":[]}]}]},{"label":"test2","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"test1","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"noop","type":"function","nodes":[]}]}]},{"label":"noop","type":"function","nodes":[]}]}]},{"label":"test3","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"described","type":"function","nodes":[]}]}]},{"label":"test4","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"errorFunction","type":"function","nodes":[]},{"label":"anon","type":"function","nodes":[]}]}]},{"label":"default","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"test1","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"noop","type":"function","nodes":[]}]}]},{"label":"test3","type":"task","nodes":[{"label":"<series>","type":"function","branch":true,"nodes":[{"label":"described","type":"function","nodes":[]}]}]},{"label":"noop","type":"function","nodes":[]}]}]}]}

test/expected/flags-tasks.txt

@@ -1,4 +1,4 @@
-gulp-cli/test
+gulp-cli/test/fixtures/gulpfiles
 ├─┬ default
 │ └─┬ <series>
 │ ├─┬ test1

test/expected/tasks-as-exports.txt

@@ -1,4 +1,4 @@
-gulp-cli/test
+gulp-cli/test/fixtures/gulpfiles
 ├── build
 ├── clean
 └─┬ dist

test/expected/flags-tasks/with-desc-and-flags.txt → test/expected/with-desc-and-flags.txt

@@ -1,4 +1,4 @@
-gulp-cli/test
+gulp-cli/test/fixtures
 ├─┬ build Build all the things!
 │ │ --dev …un-minified
 │ │ --production …compressed into single bundle

test/exports-as-tasks.js

@@ -1,26 +1,31 @@
 'use strict';
 
 var lab = exports.lab = require('lab').script();
-var code = require('code');
+var expect = require('code').expect;
 var fs = require('fs');
-var child = require('child_process');
+var path = require('path');
+var skipLines = require('./tools/skip-lines');
+var eraseTime = require('./tools/erase-time');
+var runner = require('./tools/run-gulp');
 
-var output = fs.readFileSync(__dirname + '/expected/tasks-as-exports.txt', 'utf8').replace(/(\r\n|\n|\r)/gm,'\n');
+var expectedDir = path.join(__dirname, 'expected');
 
 // Long timeout is required because parse time is slow
 lab.experiment('exports as tasks', { timeout: 0 }, function() {
 
  lab.test('prints the task list', function(done) {
+ runner({ verbose: false })
+ .gulp('--tasks',
+ '--gulpfile ./fixtures/gulpfiles/gulpfile-exports.babel.js')
+ .run(cb);
 
- child.exec('node ' + __dirname + '/../bin/gulp.js --tasks --gulpfile "./test/fixtures/gulpfile-exports.babel.js"', function(err, stdout) {
- code.expect(stdout).to.contain('Tasks for');
- stdout = stdout.replace(/\\/g, '/').split('Tasks for')[1].split('\n');
- var outputArray = output.split('\n');
- for (var i = 0; i < stdout.length; i++) {
- code.expect(stdout[i]).to.contain(outputArray[i]);
- }
- done(err);
- });
+ function cb(err, stdout) {
+ var filepath = path.join(expectedDir, 'tasks-as-exports.txt');
+ var expected = fs.readFileSync(filepath, 'utf-8');
+ stdout = eraseTime(skipLines(stdout, 2));
+ expect(stdout).to.equal(expected);
+ done();
+ }
  });
 
 });

test/fixtures/.gulp.json

@@ -0,0 +1,3 @@
+{
+ "description" : "gulp-cli/test/fixtures"
+}

test/fixtures/config/foo/bar/.gulp.json

@@ -0,0 +1,3 @@
+{
+ "description": "Description by .gulp.json in directory foo/bar"
+}

test/fixtures/config/foo/bar/baz/.gulp.babel.js

@@ -0,0 +1,3 @@
+// jscs:disable
+
+exports.description = 'DESCRIPTION BY .gulp.babel.js in directory foo/bar/baz'

test/fixtures/config/foo/bar/gulpfile.js

@@ -0,0 +1,7 @@
+'use strict';
+
+var gulp = require('gulp');
+
+gulp.task('default', function(done) {
+ done();
+});

test/fixtures/config/qux/.gulp.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+ description: 'description by .gulp.js in directory qux',
+};

test/fixtures/gulpfiles/.gulp.json

@@ -0,0 +1,3 @@
+{
+ "description" : "gulp-cli/test/fixtures/gulpfiles"
+}

test/flags-continue.js

@@ -8,7 +8,7 @@ var child = require('child_process');
 lab.experiment('flag: --continue', function() {
 
  lab.test('continues execution when flag is set', function(done) {
- child.exec('node ' + __dirname + '/../bin/gulp.js test4 --continue --cwd ./test/fixtures', function(err, stdout, stderr) {
+ child.exec('node ' + __dirname + '/../bin/gulp.js test4 --continue --cwd ./test/fixtures/gulpfiles', function(err, stdout, stderr) {
  code.expect(stdout).to.contain('Starting \'errorFunction\'');
  code.expect(stderr).to.contain('\'errorFunction\' errored after');
  stdout = stdout.replace(/\\/g, '/').split('\n');
@@ -19,7 +19,7 @@ lab.experiment('flag: --continue', function() {
  });
 
  lab.test('stops execution when flag is not set', function(done) {
- child.exec('node ' + __dirname + '/../bin/gulp.js test4 --cwd ./test/fixtures', function(err, stdout, stderr) {
+ child.exec('node ' + __dirname + '/../bin/gulp.js test4 --cwd ./test/fixtures/gulpfiles', function(err, stdout, stderr) {
  code.expect(stdout).to.contain('Starting \'errorFunction\'');
  code.expect(stderr).to.contain('\'errorFunction\' errored after');
  code.expect(stdout[4]).to.not.contain('Starting \'anon\'');

test/flags-gulpfile.js

@@ -8,9 +8,9 @@ var child = require('child_process');
 lab.experiment('flag: --gulpfile', function() {
 
  lab.test('Manually set path of gulpfile', function(done) {
- child.exec('node ' + __dirname + '/../bin/gulp.js --gulpfile "./test/fixtures/gulpfile-2.js"', function(err, stdout) {
+ child.exec('node ' + __dirname + '/../bin/gulp.js --gulpfile "./test/fixtures/gulpfiles/gulpfile-2.js"', function(err, stdout) {
  stdout = stdout.replace(/\\/g, '/').split('\n');
- code.expect(stdout[1]).to.contain('test/fixtures/gulpfile-2.js');
+ code.expect(stdout[1]).to.contain('test/fixtures/gulpfiles/gulpfile-2.js');
  code.expect(stdout[5]).to.contain('Finished \'default\'');
  done(err);
  });