Merge pull request #30 from bguiz/task-yargs-rev-merge

Task yargs rev merge, ongoing testing testing will be done on master before the next release, thanks @bguiz

Author: impaler

bin/cli.js

@@ -11,13 +11,14 @@ var path        = require('path'),
     wordwrap    = require('wordwrap'),
     runSequence = require('run-sequence'),
     chalk       = require('chalk'),
-    prettyTime  = require('pretty-hrtime');
+    prettyTime  = require('pretty-hrtime'),
+    yargs       = require('yargs');
 
-var yargs = require('./../lib/util/yargs');
+var taskYargs     = require('../lib/util/task-yargs'),
+    taskYargsRun  = require('../lib/util/task-yargs-run');
 
 // TODO @bholloway menus
 // var mainMenu = require('../lib/cli/mainMenu');
-require('../index');
 
 // we need to duplicate some event handlers from the gulp cli since we have bypassed it
 gulp.on('task_start', function (e) {
@@ -32,43 +33,77 @@ gulp.on('task_stop', function (e) {
   );
 });
 
-// describe the top level arguments
-yargs.getInstance()
+var packageJson = require(path.join(__dirname, '..', 'package.json'));
+var helpOption = {
+  key: 'help',
+  value: {
+    describe: 'This help message, or help on a specific task',
+    alias: ['h', '?'],
+    boolean: true
+  }
+};
+var defaultYargsInstance = yargs
   .usage(wordwrap(2, 80)([
-    'Angularity is an opinionated build tool for AngularJS projects.',
+    packageJson.description,
     '',
-    'Tasks include:',
-    yargs.listTasks().join(', ')
+    'Tasks include:'
+    //TODO add task list here
   ].join('\n')))
-  .example('angularity', 'Interactive menu')
+  // .example('angularity', 'Interactive menu') //TODO reinstate when interactive menu is reinstated
   .example('angularity -v', 'Display the version of angularity')
-  .example('angularity -h \<task name\>', 'Get help on a particular task')
+  .example('angularity \<task name\> -h', 'Get help on a particular task')
   .example('angularity \<task name\>', 'Run the given task')
-  .describe('h', 'This help message, or help on a specific task').alias('h', '?').alias('h', 'help')
-  .describe('version', 'Display the version of angularity').alias('version', 'v').boolean('version')
-  .wrap(80);
+  .option('version', {
+    describe: 'Display the curent version',
+    alias: ['v'],
+    boolean: true
+  })
+  .option(helpOption.key, helpOption.value);
 
-// find the yargs instance that is most appropriate for the given command line parameters
-var cliArgs = yargs.resolveArgv();
+taskYargsRun.taskYargs.register('help', {
+  description: (wordwrap(2, 80)('Displays context-specific help messages')),
+  prerequisiteTasks: [],
+  options: [
+    {
+      key: 'help',
+      value: {
+        describe: 'This help message, or help on a specific task',
+        alias: ['h', '?'],
+        boolean: true
+      }
+    }
+  ],
+  checks: []
+});
 
-// show help
-if (cliArgs.help) {
-  yargs
-    .getInstance(cliArgs.taskName || cliArgs.help)
-    .showHelp();
-}
-// run a task
-else if (cliArgs.taskName) {
-  runSequence(cliArgs.taskName);
+require('../index');
+
+//TODO move these to ../index.js
+require('../tasks/html')(taskYargsRun);
+require('../tasks/css')(taskYargsRun);
+require('../tasks/javascript')(taskYargsRun);
+require('../tasks/test')(taskYargsRun);
+require('../tasks/build')(taskYargsRun);
+require('../tasks/release')(taskYargsRun);
+require('../tasks/server')(taskYargsRun);
+require('../tasks/watch')(taskYargsRun);
+require('../tasks/init')(taskYargsRun);
+require('../tasks/webstorm')(taskYargsRun);
+
+var cliArgs;
+var taskName = taskYargsRun.taskYargs.getCurrentName();
+if (taskName) {
+  taskYargsRun.current();
 }
-// show the version string
-else if (cliArgs.version) {
-  var packagePath = path.join(__dirname, '..', 'package.json');
-  var version     = require(packagePath).version;
-  console.log('angularity:', version);
+else {
+  cliArgs = defaultYargsInstance.argv;
+  if (cliArgs.version) {
+    console.log('angularity:', packageJson.version);
+  }
+  else {
+    if (!cliArgs.help) {
+      console.log('Task specified is not recognised');
+    }
+    defaultYargsInstance.showHelp();
+  }
 }
-// interactive menu
-// TODO @bholloway reimplement after yargs refactor regression
-// else {
-//   mainMenu.prompt();
-// }

index.js

@@ -1 +1 @@
-require('require-dir')('./tasks');
+'use strict';

lib/test/karma.js

@@ -12,6 +12,7 @@ var yargs    = require('../util/yargs'),
     streams  = require('../config/streams'),
     platform = require('../config/platform');
 
+//TODO @bguiz get this from config
 var defaultReporterName = 'karma-angularity-reporter';
 
 var basePathRegex               = /['"]?\s*\/\*+\s*ANGULARITY_BASE_PATH\s*\*+\/\s*['"]?/ ;
@@ -37,14 +38,21 @@ function getKarmaReporterPluginPath(reporterName) {
     throw 'Reporter name is unspecified';
   }
 
-  //Default reporter is a dependency of angularity
-  var reporterPath = (reporterName === defaultReporterName) ?
-    path.resolve(__dirname, '../../node_modules', defaultReporterName) :
-    reporterName;
+  var reporterPath;
+
+  // Default reporter is a dependency of angularity
+  if (reporterName === defaultReporterName) {
+    reporterPath = path.resolve(__dirname, '../../node_modules', defaultReporterName);
+  }
+  else {
+    reporterPath = reporterName;
+  }
+
   //Specific reporters are expected to be dependencies of the local project
-  reporterPath = (path.dirname(reporterPath) === '.') ?
-    path.resolve('node_modules', 'karma-' + reporterName + '-reporter') :
-    reporterPath;
+  if (path.dirname(reporterPath) === '.') { //not an absolute path
+    reporterPath = path.resolve('node_modules', 'karma-' +
+      getKarmaReporterName(reporterName) + '-reporter');
+  }
 
   //Either way, the absolute path of the reporter is `require`d
   //Only to determine if it is indeed `require`able,
@@ -55,8 +63,8 @@ function getKarmaReporterPluginPath(reporterName) {
   catch (ex) {
     throw 'Attempt to require reporter from path ' + reporterPath + ' with no success.';
   }
-  reporterPath = path.normalize(reporterPath);
 
+  reporterPath = path.normalize(reporterPath);
   if (platform.isWindows()) {
     //Sanitise path for Windows
     //Replace any single backslash characters in file paths with
@@ -74,7 +82,7 @@ function getKarmaReporterPluginPath(reporterName) {
  */
 function getKarmaReporterName(reporterName) {
   if (typeof reporterName !== 'string') {
-    throw 'Get Karma Reporter Name: Reporter name is unspecified';
+    throw 'Reporter name is unspecified';
   }
 
   var name = (path.dirname(reporterName) === '.') ?
@@ -172,54 +180,27 @@ function karmaRun() {
     var appPath = path.join(__dirname, 'karma-background.js');
     var data    = querystring.escape(JSON.stringify(options));
 
-    childProcess.spawn('node', [appPath, data], {
-      cwd  : process.cwd(),
-      stdio: 'inherit',
-      env  : lodashMerge(process.env, {
-        //NOTE this workaround is necessary, see issue:
-        //https://github.com/sindresorhus/supports-color/issues/13
-        //TODO @bguiz remove workaround when issue has been resolved
-        SUPPORTS_COLOR: true
+    childProcess
+      .spawn('node', [appPath, data], {
+        cwd  : process.cwd(),
+        stdio: 'inherit',
+        env  : lodashMerge(process.env, {
+          //NOTE this workaround is necessary, see issue:
+          //https://github.com/sindresorhus/supports-color/issues/13
+          //TODO @bguiz remove workaround when issue has been resolved
+          SUPPORTS_COLOR: true
+        })
       })
-    })
       .on('close', function() {
         done();
       });
   }
   return through.obj(transformFn, flushFn);
 }
 
-var yargsOptionDefinition = {
-  key  : 'karma-reporter',
-  value: {
-    describe: 'Specify a custom Karma reporter to use. Either a locally npm installed module, or an asolute path to ' +
-    'one.',
-    alias   : ['k'],
-    default : defaultReporterName,
-    string  : true
-  }
-};
-var checkKarmaReporter = yargs.createCheck()
-  .withGate(function (argv) {
-    return !argv.help;
-  })
-  .withTest({
-    'karma-reporter': function(value) {
-      if (typeof value !== 'undefined') {
-        try {
-          getKarmaReporterPluginPath(value);
-        }
-        catch (ex) {
-          return 'Illegal value for "karma-reporter": ' + ex;
-        }
-      }
-    }
-  })
-  .commit();
-
 module.exports = {
-  createConfig: karmaCreateConfig,
-  run         : karmaRun,
-  yargsCheck  : checkKarmaReporter,
-  yargsOption : yargsOptionDefinition
+  createConfig       : karmaCreateConfig,
+  run                : karmaRun,
+  defaultReporterName: defaultReporterName,
+  getPluginPath      : getKarmaReporterPluginPath
 };

lib/util/jshint-reporter.js

@@ -1,10 +1,12 @@
 'use strict';
 
-var path       = require('path'),
-    gulpJshint = require('gulp-jshint');
+var path       = require('path');
 
-var yargs = require('./yargs');
+var gulpJshint = require('gulp-jshint');
 
+var yargs      = require('./yargs');
+
+//TODO @bguiz get this from config
 var defaultReporterName = 'angularity-jshint-reporter';
 
 /**
@@ -76,38 +78,7 @@ function getJsHintReporter(reporterName) {
   }
 }
 
-var yargsOptionDefiniton = {
-  key: 'jshint-reporter',
-  value: {
-    describe: 'Specify a custom JsHint reporter to use. Either a locally npm installed module, or the absolute path ' +
-      'to one.',
-    alias   : ['j'],
-    default : defaultReporterName,
-    string  : true
-  }
-};
-var checkJsHintReporter = yargs.createCheck()
-  .withGate(function (argv) {
-    return !argv.help;
-  })
-  .withTest({
-    'jshint-reporter': function(value) {
-      if (typeof value === 'undefined') {
-        return;
-      }
-      try {
-        getJsHintReporter(value);
-      }
-      catch (ex) {
-        return 'Illegal value for "jshint-reporter": ' + ex;
-      }
-    }
-  })
-  .commit();
-
 module.exports = {
   get                : getJsHintReporter,
-  yargsCheck         : checkJsHintReporter,
-  yargsOption        : yargsOptionDefiniton,
   defaultReporterName: defaultReporterName
 };

lib/util/task-yargs-run.js

@@ -0,0 +1,64 @@
+'use strict';
+
+var taskYargsRun = require('task-yargs/run');
+var tyRunInstance = taskYargsRun();
+
+//NOTE This file is to maintain a single task yargs run instance,
+// as we wish to use the same one across multiple gulp tasks.
+// In addition, we may augment or proxy some methods within it.
+
+function checkFlagMissing(opt, key, value) {
+  if ((!!opt.value.isOptional) &&
+    (typeof value === 'undefined')) {
+    // all other options must be specified, or have default defined
+    return true;
+  }
+  if ((typeof value === 'undefined') ||
+    ((typeof value === 'string') && (value.length < 1) && (key !== 'description'))) {
+    throw new Error('Required option "' + key + '" is not specified');
+  }
+}
+
+function checkFlagType(opt, ket, value) {
+  var valueType = (typeof value);
+  var typeIsOk = false;
+  var validTypes = ['string', 'boolean', 'number']
+    .filter(function(selType) {
+      return !!(opt.value[selType]);
+    });
+  if (!opt.value.isMultiple) {
+    validTypes.forEach(function(validType) {
+      if (valueType === validType) {
+        typeIsOk = true;
+      }
+    });
+  }
+  else {
+    value = [].concat(value);
+    if (value.length === 0) {
+      typeIsOk = true;
+    }
+    else {
+      value.forEach(function (subValue) {
+        validTypes.forEach(function(validType) {
+          if (typeof subValue === validType) {
+            typeIsOk = true;
+          }
+        });
+      });
+    }
+  }
+  if (!typeIsOk) {
+    var expectedType = JSON.stringify(validTypes);
+    if (opt.value.isMultiple) {
+      expectedType = 'Array<' + expectedType + '>'
+    }
+    throw new Error('' + key + ' is expected to be of types ' +
+      expectedType + ' but a ' + (typeof value) + ' was provided instead.');
+  }
+}
+
+tyRunInstance.checkFlagType = checkFlagType;
+tyRunInstance.checkFlagMissing = checkFlagMissing;
+
+module.exports = tyRunInstance;