Merge remote-tracking branch 'remotes/origin/master' into test-standards-bundled

Author: benholloway

README.md

@@ -1,14 +1,42 @@
-# angularity
+# Angularity
+
 ![Angularity Logo](http://angularity.github.io/assets/logo.png)
 
-[![Build Status](https://travis-ci.org/angularity/node-angularity.svg?branch=master)](https://travis-ci.org/angularity/node-angularity) [![Build status](https://ci.appveyor.com/api/projects/status/6b1xir7y1j0wm64a/branch/master?svg=true)](https://ci.appveyor.com/project/impaler/node-angularity/branch/master)
+[![NPM](https://nodei.co/npm/angularity.png)](http://angularity.github.io)
+
+[![Build Status](https://travis-ci.org/angularity/node-angularity.svg?branch=master)](https://travis-ci.org/angularity/node-angularity)
+[![Build status](https://ci.appveyor.com/api/projects/status/6b1xir7y1j0wm64a/branch/master?svg=true)](https://ci.appveyor.com/project/impaler/node-angularity/branch/master)
+
+Build projects, not build systems.
+
+- Hand picked and industry proven front end technologies.
+- A complete and scalable single page application workflow.
+
+![AngularJs, Browserify, BabelJs, NodeJs](angularity-library-logos.png)
+
+## Features
+
+A complete frontend development solution for:
+modules, minification, source maps, linting, testing, live reloading, release and workflow tooling
+
+- No complicated build files per project
+- Kickstart your workflow with IDE integration and command line interface
+- Write with the latest ES6 Javascript features
+- Use CommonJs/NodeJs syntax
+- In-built support for Karma tests
+- Build with minification and source-map safe bundles
+- Use both Bower and NPM for your vendor dependencies
+- Convenient CI integration with custom reporters
+- Plugin system to create your own tasks
+
+## Documentation
 
-An opinionated node.js build system for ECMAScript 6 AngularJS projects
+[angularity.github.io](http://angularity.github.io)
 
-Angularity is a philosophy of development.
+## Maintained by
 
-Our focus is maintaining uniformity of development across groups of developers with varying experience levels.
+Ben Holloway, Chris Decoster, Brendan Graetz
 
-Our contributors hold a collective vision of best-practice AngularJS development and have condensed this into a set of tools and resources known as Angularity.
+## Licence
 
-Documentation: [http://angularity.github.io](http://angularity.github.io)
+MIT

angularity-library-logos.png

@@ -49,17 +49,15 @@ pluginRegistry
   .add(defaultTaskPlugins)
   .add(configTaskPlugins);
 
-var taskPlugins = pluginRegistry
+pluginRegistry
   .get('angularity')
-  .getAllOfCategory('task');
-
-taskPlugins
-  .forEach(function eachTaskPlugin(pluginDefinition) {
-    var plugin = require(pluginDefinition.requirePath);
+  .getAllOfCategory('task')
+  .forEach(function eachTaskPlugin(definition) {
+    var plugin = definition.plugin;
 
     // Task plugins are expected to export a function which should be called with an instance of taskYargsRun
     if (typeof plugin !== 'function') {
-      throw new Error('Plugin named ' + pluginDefinition.name + ' does not export a function');
+      throw new Error('Plugin named ' + definition.name + ' does not export a function');
     }
 
     var taskDefinition = plugin({

index.js

@@ -1,7 +1,7 @@
 {
   "name": "angularity",
   "description": "An opinionated NodeJs build system for ECMAScript 6 AngularJs projects",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "tags": [
     "build",
     "system",

npm-shrinkwrap.json

@@ -34,10 +34,10 @@ function setUpInitTask(context) {
     {
       key: 'defaults',
       value: {
-        describe: 'Set defaults',
-        alias   : 'z',
-        boolean : true,
-        isOptional: true
+        describe  : 'Set defaults',
+        alias     : 'z',
+        isOptional: true,
+        default   : false
       }
     },
     {
@@ -151,7 +151,7 @@ function setUpInitTask(context) {
         if (tyRun.checkFlagMissing(opt, key, value)) {
           return;
         }
-        if (key !== 'port') {
+        if ((key !== 'port') && (key !== 'defaults')) {
           // skip the valid types test for port, as will be done later
           // ensure options correspond to the types that they were defined as belonging to
           tyRun.checkFlagType(opt, key, value);
@@ -174,6 +174,11 @@ function setUpInitTask(context) {
             throw new Error('Port must be an integer, or "random"');
           }
         }
+        else if (key === 'defaults') {
+          if (!(/^(true|false|reset)$/.test(String(argv.defaults)))) {
+            throw new Error('Unrecognised value for defaults flag, expected true|false|reset.');
+          }
+        }
       });
       return true;
     }
@@ -226,8 +231,8 @@ function setUpInitTask(context) {
           template    = require('lodash.template'),
           merge       = require('lodash.merge');
 
-      var hr              = require('../lib/util/hr'),
-          streams         = require('../lib/config/streams');
+      var hr          = require('../lib/util/hr'),
+          streams     = require('../lib/config/streams');
 
       var TEMPLATE_PATH = path.join(__dirname, '..', 'templates', 'angularity');
 

package.json

@@ -8,11 +8,11 @@ function setUpWebStormTask(context) {
     throw new Error('Context must specify run-sequence instance');
   }
 
-  var fs              = require('fs'),
-      path            = require('path'),
-      ideTemplate     = require('ide-template'),
-      defaults        = require('../lib/config/defaults'),
-      platform        = require('../lib/config/platform');
+  var fs          = require('fs'),
+      path        = require('path'),
+      ideTemplate = require('ide-template'),
+      defaults    = require('../lib/config/defaults'),
+      platform    = require('../lib/config/platform');
 
   var config = defaults
     .getInstance('webstorm')
@@ -30,20 +30,20 @@ function setUpWebStormTask(context) {
     {
       key: 'defaults',
       value: {
-        describe: 'Set defaults',
-        alias   : 'z',
-        boolean : true,
-        isOptional: true
+        describe  : 'Set defaults',
+        alias     : 'z',
+        isOptional: true,
+        default   : false
       }
     },
     {
       key: 'subdir',
       value: {
-        describe: 'Navigate to the sub-directory specified',
-        alias   : 's',
-        string  : true,
+        describe  : 'Navigate to the sub-directory specified',
+        alias     : 's',
+        string    : true,
         isOptional: true,
-        default : config.get('subdir')
+        default   : config.get('subdir')
       }
     },
     {
@@ -87,10 +87,9 @@ function setUpWebStormTask(context) {
       value: {
         describe: 'Launch the IDE following setup',
         alias   : 'l',
-        boolean : true,
         default : config.get('launch')
       }
-    },
+    }
   ];
 
   function checkWebstormFlags(argv) {
@@ -108,7 +107,9 @@ function setUpWebStormTask(context) {
         }
 
         // ensure options correspond to the types that they were defined as belonging to
-        tyRun.checkFlagType(opt, key, value);
+        if ((key !== 'defaults') && (key !== 'launch')) {
+          tyRun.checkFlagType(opt, key, value);
+        }
 
         if (key === 'subdir') {
           var subdir  = path.resolve(value);
@@ -117,6 +118,29 @@ function setUpWebStormTask(context) {
             throw new Error('The specified subdirectory does not exist.');
           }
         }
+        else if (key === 'defaults') {
+          if (!(/^(true|false|reset)$/.test(String(argv.defaults)))) {
+            throw new Error('Unrecognised value for defaults flag, expected true|false|reset.');
+          }
+        }
+        else if (key === 'launch') {
+          switch (String(argv.launch)) {
+            case 'false':
+              break;
+            case 'true':
+              if (!ideTemplate.webStorm.validateExecutable()) {
+                throw new Error('Cannot find Webstorm executable, you will have to specify it explicitly.');
+              }
+              break;
+            default:
+              var customPath = path.normalize(argv.launch);
+              if (fs.existsSync(customPath)) {
+                ideTemplate.webStorm.customExecutable = customPath;
+              } else {
+                throw new Error('Launch path is not valid or does not exist.');
+              }
+          }
+        }
       });
       if (!argv.defaults) {
         // when defaults are not present, check whether angularity project is present
@@ -129,33 +153,6 @@ function setUpWebStormTask(context) {
     return true;
   }
 
-  /**
-   * yargs check for a valid --launch parameter
-   * Additionally parses true|false strings to boolean literals
-   * @param argv
-   */
-  function validateLaunchPath(argv) {
-    switch (argv.launch) {
-      case false:
-      case 'false':
-        argv.launch = false;
-        break;
-      case true:
-      case 'true':
-        if (ideTemplate.webStorm.validateExecutable()) {
-          argv.launch = true;
-        } else {
-          return 'Cannot find Webstorm executable, you will have to specify it explicitly.';
-        }
-        break;
-      default:
-        if (!fs.existsSync(path.normalize(argv.launch))) {
-          return 'Launch path is not valid or does not exist.';
-        }
-    }
-    return argv;
-  }
-
   var taskDefinition = {
     name: 'webstorm',
     description: [
@@ -180,7 +177,7 @@ function setUpWebStormTask(context) {
       'angularity webstorm --defaults reset             Reset defaults'
     ].join('\n'),
     prerequisiteTasks: ['help'],
-    checks: [validateLaunchPath, checkWebstormFlags],
+    checks: [checkWebstormFlags],
     options: webstormOptionDefinitions,
     onInit: function onInitWebstormTask(yargsInstance) {
       var gulp            = context.gulp,
@@ -198,6 +195,9 @@ function setUpWebStormTask(context) {
         .wrap(80);
       cliArgs = yargsInstance.argv;
 
+      // launch parameter should be boolean for consistency with defaults
+      cliArgs.launch = (cliArgs.launch === 'true') ? true : (cliArgs.launch === 'false') ? false : cliArgs.launch;
+
       gulp.task('webstorm', function (done) {
         console.log(hr('-', 80, 'webstorm'));