Merge pull request #23 from bholloway/master

init task should create a buildable project

Author: bguiz

lib/util/jshint-reporter.js

@@ -8,6 +8,12 @@ var yargs = require('./yargs');
 
 var defaultReporterName = 'angularity-jshint-reporter';
 
+/**
+ * Cache resolved reporter object or stream
+ * @type {function}
+ */
+var resolvedReporter;
+
 /**
  * Dynamically load a JsHint reporter
  *
@@ -22,46 +28,57 @@ var defaultReporterName = 'angularity-jshint-reporter';
  *   - The absolute path to a node package
  * @return {function} The `required`ed jshint report, ready to be piped a gulp stream
  */
-var jsHintReporter;
 function getJsHintReporter(reporterName) {
-  if (typeof reporterName !== 'string') {
-    throw 'Get JsHint Reporter: Reporter name is unspecified';
-  }
-  if (jsHintReporter) {
-    return jsHintReporter; //cached copy
-  }
 
-  if (reporterName === defaultReporterName) {
-    jsHintReporter = require(defaultReporterName);
-  }
-  else {
-    var reporterPath = (path.dirname(reporterName) === '.') ?
-      path.resolve('node_modules', reporterName) :
-      reporterName;
-    try {
-      jsHintReporter = require(reporterPath);
-      if (typeof jsHintReporter === 'string') {
-        //In JsHint convention, the `index.js` file exports a string which jshint itself should require
-        //e.g. `module.exports = require('path').join(__dirname, 'reporter.js');`
-        jsHintReporter = gulpJshint.reporter(require(jsHintReporter));
-      }
+  // establish a cached copy
+  if (!resolvedReporter) {
+    if (typeof reporterName !== 'string') {
+      throw 'Get JsHint Reporter: Reporter name is unspecified';
     }
-    catch (ex) {
-      throw 'Get JsHint Reporter: Attempt to require reporter from path '+reporterPath+' with no success.';
+    else {
+      // first check angularity installed modules, then check project locally installed modules
+      [ path.resolve('node_modules'), null ].forEach(function (base) {
+          var reporterPath = base ? path.join(base, reporterName) : reporterName;
+          try {
+            // In JsHint convention, the `index.js` file exports a string which jshint itself should require
+            // e.g. `module.exports = require('path').join(__dirname, 'reporter.js');`
+            // this is the indirect case.
+            // However in some cases it may be the reporter itself
+            var indirect = require(reporterPath);
+            resolvedReporter = (typeof indirect === 'string') ? require(indirect) : indirect;
+          } catch (ex) {
+            /* do nothing */
+          }
+        });
+      if (!resolvedReporter) {
+        throw 'Get JsHint Reporter: Attempt to require reporter from path ' + reporterPath + ' with no success.';
+      }
     }
   }
 
-  return jsHintReporter;
+  // return cached copy
+  //  closure that returns a stream
+  if (typeof resolvedReporter === 'function') {
+    return resolvedReporter();
+  }
+  //  jshint plugin object with reporter field
+  else if (!!(resolvedReporter) && (typeof resolvedReporter.reporter === 'function')) {
+    return gulpJshint.reporter(resolvedReporter);
+  }
+  //  unsupported
+  else {
+    throw 'Get JsHint Reporter: Given reporter is badly formed';
+  }
 }
 
 var yargsOptionDefiniton = {
   key: 'reporter',
   value: {
-    describe: 'Specify a custom JsHint reporter to use. '+
-      'Either a locally npm installed module, or an asolute path to one.',
+    describe: 'Specify a custom JsHint reporter to use. Either a locally npm installed module, or the absolute path ' +
+      'to one.',
     alias: ['r'],
     default: defaultReporterName,
-    string: true,
+    string: true
   }
 };
 var checkJsHintReporter = yargs.createCheck()
@@ -77,15 +94,15 @@ var checkJsHintReporter = yargs.createCheck()
         getJsHintReporter(value);
       }
       catch (ex) {
-        return 'Illegal value for "reporter"\n'+ex;
+        return 'Illegal value for "reporter"\n' + ex;
       }
-    },
+    }
   })
   .commit();
 
 module.exports = {
-  get: getJsHintReporter,
-  yargsCheck: checkJsHintReporter,
-  yargsOption: yargsOptionDefiniton,
+  get                : getJsHintReporter,
+  yargsCheck         : checkJsHintReporter,
+  yargsOption        : yargsOptionDefiniton,
   defaultReporterName: defaultReporterName
 };

tasks/javascript.js

@@ -4,7 +4,6 @@ var path            = require('path'),
     fs              = require('fs');
 
 var gulp            = require('gulp'),
-    gulpFilter      = require('gulp-filter'),
     jshint          = require('gulp-jshint'),
     rimraf          = require('gulp-rimraf'),
     runSequence     = require('run-sequence'),

tasks/webstorm.js

@@ -212,31 +212,35 @@ gulp.task('webstorm:project', function () {
 gulp.task('webstorm:templates', function () {
   var srcDirectory  = path.join(TEMPLATE_PATH, 'fileTemplates');
   var destDirectory = path.join(userPreferencesDirectory(), 'fileTemplates');
-  var removed       = [ ];
-  var added         = [ ];
-  fs.readdirSync(destDirectory)
-    .forEach(function eachTemplate(filename) {
-      if (/^angularity/.test(path.basename(filename))) {
-        removed.push(filename);
-        fs.unlinkSync(path.join(destDirectory, filename));
-      }
-    });
-  fs.readdirSync(srcDirectory)
-    .forEach(function eachTemplate(filename) {
-      var srcPath  = path.join(srcDirectory, filename);
-      var destPath = path.join(destDirectory, filename);
-      added.push(filename);
-      fs.writeFileSync(destPath, fs.readFileSync(srcPath))
-    });
-  removed.forEach(function (filename) {
+  var isValid       = fs.existsSync(destDirectory) && fs.statsSync(destDirectory).isDirectory();
+  if (!isValid) {
+    gutil.log('Failed to locate Webstorm templates. Expected directory:')
+    gutil.log('  ' + destDirectory)
+  } else {
+    var removed = [ ];
+    var added   = [ ];
+    fs.readdirSync(destDirectory).forEach(function eachTemplate(filename) {
+        if (/^angularity/.test(path.basename(filename))) {
+          removed.push(filename);
+          fs.unlinkSync(path.join(destDirectory, filename));
+        }
+      });
+    fs.readdirSync(srcDirectory).forEach(function eachTemplate(filename) {
+        var srcPath = path.join(srcDirectory, filename);
+        var destPath = path.join(destDirectory, filename);
+        added.push(filename);
+        fs.writeFileSync(destPath, fs.readFileSync(srcPath))
+      });
+    removed.forEach(function (filename) {
       var isRemove = (added.indexOf(filename) < 0);
       if (isRemove) {
         gutil.log('removed template ' + filename);
       }
     });
-  added.forEach(function (filename) {
+    added.forEach(function (filename) {
       gutil.log('wrote template ' + filename);
     });
+  }
 // TODO review with @impaler
 //  ideTemplate.webStorm.copyFileTemplates(fileTemplatePath);
 });
@@ -276,12 +280,19 @@ gulp.task('webstorm:tools', function () {
         } ]
     };
   }
-  var destPath = path.join(userPreferencesDirectory(), 'tools', 'Angularity.xml');
-  var content  = ideTemplate.webStorm.createExternalTool({
-    name : 'Angularity',
-    tools: ['test', 'watch', 'watch --unminified', 'build', 'build --unminified', 'release'].map(createNode)
-  });
-  fs.writeFileSync(destPath, content);
+  var destDirectory = path.join(userPreferencesDirectory(), 'tools');
+  var isValid       = fs.existsSync(destDirectory) && fs.statsSync(destDirectory).isDirectory();
+  if (!isValid) {
+    gutil.log('Failed to locate Webstorm tools. Expected directory:')
+    gutil.log('  ' + destDirectory)
+  } else {
+    var destPath = path.join(destDirectory, 'Angularity.xml');
+    var content = ideTemplate.webStorm.createExternalTool({
+      name : 'Angularity',
+      tools: ['test', 'watch', 'watch --unminified', 'build', 'build --unminified', 'release'].map(createNode)
+    });
+    fs.writeFileSync(destPath, content);
+  }
 // TODO review with @impaler
 //  ideTemplate.webStorm.writeExternalTool(toolContent, 'Angularity.xml');
 });

templates/angularity/bower.json

@@ -4,6 +4,12 @@
   "description": "<%= description %>",
   "private": true,
   "tags": <%= tags %>,
-  "dependencies": { },
-  "devDependencies": { }
+  "dependencies": {
+    "jQuery": "latest",
+    "angular": "latest",
+    "angular-ui-router": "latest"
+  },
+  "devDependencies": {
+    "angular-mocks": "latest"
+  }
 }

templates/angularity/index.js

@@ -1,3 +1,11 @@
 /* globals angular */
 
-angular.module('<%= name %>', [ ])
+angular.module('<%= name %>', [ 'ui.router' ])
+  .config(function deleteMe($stateProvider, $urlRouterProvider) {
+    $urlRouterProvider.otherwise('/');
+    $stateProvider
+      .state('home', {
+        url:      '/',
+        template: '<span>Hello World</span>'
+      });
+  });