Create gulp tasks for linting and building

.jshintrc

@@ -0,0 +1,92 @@
+{
+  "maxerr"        : 100,       // {int} Maximum error before stopping
+
+  // Enforcing
+  "bitwise"       : true,     // true: Prohibit bitwise operators (&, |, ^, etc.)
+  "camelcase"     : false,    // true: Identifiers must be in camelCase
+  "curly"         : false,    // true: Require {} for every new block or scope
+  "eqeqeq"        : true,     // true: Require triple equals (===) for comparison
+  "forin"         : false,    // true: Require filtering for..in loops with obj.hasOwnProperty()
+  "immed"         : false,    // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
+  "indent"        : 2,        // {int} Number of spaces to use for indentation
+  "latedef"       : false,    // true: Require variables/functions to be defined before being used
+  "newcap"        : false,    // true: Require capitalization of all constructor functions e.g. `new F()`
+  "noarg"         : false,    // true: Prohibit use of `arguments.caller` and `arguments.callee`
+  "noempty"       : true,     // true: Prohibit use of empty blocks
+  "nonew"         : false,    // true: Prohibit use of constructors for side-effects (without assignment)
+  "plusplus"      : false,    // true: Prohibit use of `++` & `--`
+  "quotmark"      : "single", // Quotation mark consistency:
+                              //   false    : do nothing (default)
+                              //   true     : ensure whatever is used is consistent
+                              //   "single" : require single quotes
+                              //   "double" : require double quotes
+  "undef"         : true,     // true: Require all non-global variables to be declared (prevents global leaks)
+  "unused"        : false,    // true: Require all defined variables be used
+  "strict"        : false,    // true: Requires all functions run in ES5 Strict Mode
+  "maxparams"     : false,    // {int} Max number of formal params allowed per function
+  "maxdepth"      : false,    // {int} Max depth of nested blocks (within functions)
+  "maxstatements" : false,    // {int} Max number statements per function
+  "maxcomplexity" : false,    // {int} Max cyclomatic complexity per function
+  "maxlen"        : false,    // {int} Max number of characters per line
+
+  // Relaxing
+  "asi"           : false,     // true: Tolerate Automatic Semicolon Insertion (no semicolons)
+  "boss"          : false,     // true: Tolerate assignments where comparisons would be expected
+  "debug"         : false,     // true: Allow debugger statements e.g. browser breakpoints.
+  "eqnull"        : false,     // true: Tolerate use of `== null`
+  "es5"           : false,     // true: Allow ES5 syntax (ex: getters and setters)
+  "esnext"        : false,     // true: Allow ES.next (ES6) syntax (ex: `const`)
+  "moz"           : false,     // true: Allow Mozilla specific syntax (extends and overrides esnext features)
+                               // (ex: `for each`, multiple try/catch, function expression…)
+  "evil"          : true,      // true: Tolerate use of `eval` and `new Function()`
+  "expr"          : true,      // true: Tolerate `ExpressionStatement` as Programs
+  "funcscope"     : false,     // true: Tolerate defining variables inside control statements"
+  "globalstrict"  : false,     // true: Allow global "use strict" (also enables 'strict')
+  "iterator"      : false,     // true: Tolerate using the `__iterator__` property
+  "lastsemic"     : false,     // true: Tolerate omitting a semicolon for the last statement of a 1-line block
+  "laxbreak"      : false,     // true: Tolerate possibly unsafe line breakings
+  "laxcomma"      : false,     // true: Tolerate comma-first style coding
+  "loopfunc"      : false,     // true: Tolerate functions being defined in loops
+  "multistr"      : false,     // true: Tolerate multi-line strings
+  "proto"         : false,     // true: Tolerate using the `__proto__` property
+  "scripturl"     : false,     // true: Tolerate script-targeted URLs
+  "shadow"        : false,     // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
+  "sub"           : false,     // true: Tolerate using `[]` notation when it can still be expressed in dot notation
+  "supernew"      : false,     // true: Tolerate `new function () { ... };` and `new Object;`
+  "validthis"     : false,     // true: Tolerate using this in a non-constructor function
+
+  // Environments
+  "browser"       : false,    // Web Browser (window, document, etc)
+  "couch"         : false,    // CouchDB
+  "devel"         : true,     // Development/debugging (alert, confirm, etc)
+  "dojo"          : false,    // Dojo Toolkit
+  "jquery"        : false,    // jQuery
+  "mootools"      : false,    // MooTools
+  "node"          : true,     // Node.js
+  "nonstandard"   : false,    // Widely adopted globals (escape, unescape, etc)
+  "prototypejs"   : false,    // Prototype and Scriptaculous
+  "rhino"         : false,    // Rhino
+  "worker"        : false,    // Web Workers
+  "wsh"           : false,    // Windows Scripting Host
+  "yui"           : false,    // Yahoo User Interface
+
+  // Custom Globals
+  "globals": {
+    "after": true,
+    "afterEach": true,
+    "before": true,
+    "beforeEach": true,
+    "describe": true,
+    "expect": true,
+    "it": true,
+    "runs": true,
+    "spyOn": true,
+    "unescape": true,
+    "waits": true,
+    "waitsFor": true,
+    "require": true,
+    "define": true,
+    "module": true,
+    "describe": true
+  }
+}

client.jshintrc

@@ -0,0 +1,91 @@
+{
+  "maxerr"        : 100,       // {int} Maximum error before stopping
+
+  // Enforcing
+  "bitwise"       : true,     // true: Prohibit bitwise operators (&, |, ^, etc.)
+  "camelcase"     : false,    // true: Identifiers must be in camelCase
+  "curly"         : true,     // true: Require {} for every new block or scope
+  "eqeqeq"        : true,     // true: Require triple equals (===) for comparison
+  "forin"         : true,     // true: Require filtering for..in loops with obj.hasOwnProperty()
+  "immed"         : false,    // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
+  "indent"        : 2,        // {int} Number of spaces to use for indentation
+  "latedef"       : false,    // true: Require variables/functions to be defined before being used
+  "newcap"        : false,    // true: Require capitalization of all constructor functions e.g. `new F()`
+  "noarg"         : true,     // true: Prohibit use of `arguments.caller` and `arguments.callee`
+  "noempty"       : true,     // true: Prohibit use of empty blocks
+  "nonew"         : false,    // true: Prohibit use of constructors for side-effects (without assignment)
+  "plusplus"      : false,    // true: Prohibit use of `++` & `--`
+  "quotmark"      : "single", // Quotation mark consistency:
+                              //   false    : do nothing (default)
+                              //   true     : ensure whatever is used is consistent
+                              //   "single" : require single quotes
+                              //   "double" : require double quotes
+  "undef"         : true,     // true: Require all non-global variables to be declared (prevents global leaks)
+  "unused"        : true,     // true: Require all defined variables be used
+  "strict"        : true,     // true: Requires all functions run in ES5 Strict Mode
+  "maxparams"     : false,    // {int} Max number of formal params allowed per function
+  "maxdepth"      : false,    // {int} Max depth of nested blocks (within functions)
+  "maxstatements" : false,    // {int} Max number statements per function
+  "maxcomplexity" : false,    // {int} Max cyclomatic complexity per function
+  "maxlen"        : false,    // {int} Max number of characters per line
+
+  // Relaxing
+  "asi"           : false,     // true: Tolerate Automatic Semicolon Insertion (no semicolons)
+  "boss"          : false,     // true: Tolerate assignments where comparisons would be expected
+  "debug"         : false,     // true: Allow debugger statements e.g. browser breakpoints.
+  "eqnull"        : false,     // true: Tolerate use of `== null`
+  "es5"           : false,     // true: Allow ES5 syntax (ex: getters and setters)
+  "esnext"        : false,     // true: Allow ES.next (ES6) syntax (ex: `const`)
+  "moz"           : false,     // true: Allow Mozilla specific syntax (extends and overrides esnext features)
+  // (ex: `for each`, multiple try/catch, function expression…)
+  "evil"          : true,      // true: Tolerate use of `eval` and `new Function()`
+  "expr"          : true,      // true: Tolerate `ExpressionStatement` as Programs
+  "funcscope"     : false,     // true: Tolerate defining variables inside control statements"
+  "globalstrict"  : false,     // true: Allow global "use strict" (also enables 'strict')
+  "iterator"      : false,     // true: Tolerate using the `__iterator__` property
+  "lastsemic"     : false,     // true: Tolerate omitting a semicolon for the last statement of a 1-line block
+  "laxbreak"      : false,     // true: Tolerate possibly unsafe line breakings
+  "laxcomma"      : false,     // true: Tolerate comma-first style coding
+  "loopfunc"      : false,     // true: Tolerate functions being defined in loops
+  "multistr"      : false,     // true: Tolerate multi-line strings
+  "proto"         : false,     // true: Tolerate using the `__proto__` property
+  "scripturl"     : false,     // true: Tolerate script-targeted URLs
+  "shadow"        : false,     // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
+  "sub"           : false,     // true: Tolerate using `[]` notation when it can still be expressed in dot notation
+  "supernew"      : false,     // true: Tolerate `new function () { ... };` and `new Object;`
+  "validthis"     : false,     // true: Tolerate using this in a non-constructor function
+
+  // Environments
+  "browser"       : true,     // Web Browser (window, document, etc)
+  "couch"         : false,    // CouchDB
+  "devel"         : true,     // Development/debugging (alert, confirm, etc)
+  "dojo"          : false,    // Dojo Toolkit
+  "jquery"        : true,    // jQuery
+  "mootools"      : false,    // MooTools
+  "node"          : false,    // Node.js
+  "nonstandard"   : false,    // Widely adopted globals (escape, unescape, etc)
+  "prototypejs"   : false,    // Prototype and Scriptaculous
+  "rhino"         : false,    // Rhino
+  "worker"        : false,    // Web Workers
+  "wsh"           : false,    // Windows Scripting Host
+  "yui"           : false,    // Yahoo User Interface
+
+  // Custom Globals
+  "globals": {
+    "after": true,
+    "afterEach": true,
+    "before": true,
+    "beforeEach": true,
+    "describe": true,
+    "define": true,
+    "expect": true,
+    "it": true,
+    "runs": true,
+    "spyOn": true,
+    "unescape": true,
+    "waits": true,
+    "waitsFor": true,    
+    "require": true,
+    "DJ": true
+  }
+}

gulpfile.js

@@ -1,19 +1,148 @@
-//TODO: feeding in configs, logins, selenium servers, browsers.. tests should do this so they can run in isolation but that's a lot more maintenance...
-var gulp = require('gulp');
-var mocha = require('gulp-spawn-mocha');
-var options = {reporter: 'mochawesome', timeout: 30000, slow: 1, "no-exit": true};
+var gulp        = require('gulp'),
+    gutil       = require('gulp-util'),
+    path        = require('path'),
+    plumber     = require('gulp-plumber'),
+    less        = require('gulp-less'),
+    uglify      = require('gulp-uglify'),
+    jshint      = require('gulp-jshint'),
+    concat      = require('gulp-concat'),
+    merge       = require('merge-stream'),
+    handlebars  = require('gulp-handlebars'),
+    wrap        = require('gulp-wrap'),
+    declare     = require('gulp-declare'),
+    watch       = require('gulp-watch'),
+    mocha       = require('gulp-spawn-mocha'),
+    options     = {reporter: 'mochawesome', timeout: 30000, slow: 1, "no-exit": true},
+    config      = require('./lib/config');
 
+var watchFiles = [
+  path.join(config.srcLessDir, '*.less'),
+  path.join(config.srcJsDir, '*.js'),
+  path.join('!', config.srcJsDir, 'hbsHelpers.js'),
+  path.join(config.srcHbsDir, '*.mu')
+];
 
+var lintPaths =  {
+  server: './.jshintrc',
+  client: './client.jshintrc',
+  lint: [
+    './lib/*.js',
+    '!./lib/templates.js'
+  ],
+  felint: [
+    path.join(config.srcJsDir, '*.js')
+  ]
+};
+
+function onWatchFileChanged(file) {
+  var ext = file.relative.slice(file.relative.indexOf('.') + 1);
+  gutil.log('Change detected in ' + file.relative);
+  if (ext === 'less') {
+    gulp.start('styles');
+  }
+  if (ext === 'js') {
+    gulp.start('scripts');
+  }
+  if (ext === 'mu') {
+    gulp.start('templates');
+  }
+}
+
+// Build Tasks
+gulp.task('fonts', function () {
+  return gulp.src(path.join(config.bsFontsDir, '*'))
+    .pipe(gulp.dest(config.buildFontsDir));
+});
+
+gulp.task('styles', function () {
+  return gulp.src(path.join(config.srcLessDir, '[^_]*.less'))
+    .pipe(plumber({errorHandler: gutil.log}))
+    .pipe(less({
+      paths: [config.srcLessDir, config.bsLessDir],
+      compress: true
+    }))
+    .pipe(gulp.dest(config.buildCssDir));
+});
+
+gulp.task('scripts', function () {
+  return gulp.src(config.clientJsFiles)
+    .pipe(concat('mochawesome.js'))
+    .pipe(uglify())
+    .pipe(gulp.dest(config.buildJsDir));
+});
+
+gulp.task('templates', function () {
+  var partials = gulp.src(path.join(config.srcHbsDir, '_*.mu'))
+    .pipe(handlebars())
+    .pipe(wrap('Handlebars.registerPartial(<%= processPartialName(file.relative) %>, Handlebars.template(<%= contents %>));', {}, {
+      imports: {
+        processPartialName: function(fileName) {
+          // Strip the extension
+          // Escape the output with JSON.stringify
+          return JSON.stringify(path.basename(fileName, '.js'));
+        }
+      }
+    }));
+
+  var templates = gulp.src(path.join(config.srcHbsDir, '[^_]*.mu'))
+    .pipe(handlebars())
+    .pipe(wrap('Handlebars.template(<%= contents %>)'))
+    .pipe(declare({
+      root: 'exports',
+      noRedeclare: true, // Avoid duplicate declarations
+      processName: function(filePath) {
+        return declare.processNameByPath(filePath.replace('src/templates/', ''));
+      }
+    }));
+
+  var helpers = gulp.src(path.join(config.srcJsDir, 'hbsHelpers.js'));
+
+  return merge(partials, templates, helpers)
+    .pipe(concat('templates.js'))
+    .pipe(wrap('var Handlebars = require("handlebars");\n <%= contents %>'))
+    .pipe(gulp.dest(config.libDir));
+});
+
+// Test Tasks
 gulp.task('fiveby', function () {
   return gulp.src('test/**/*.js', '!test/test.js')
     .pipe(mocha(options))
-    .on("error", console.warn.bind(console));
+    .on('error', console.warn.bind(console));
 });
 
 gulp.task('test', function () {
   return gulp.src('test/test.js')
     .pipe(mocha(options))
-    .on("error", console.warn.bind(console));
+    .on('error', console.warn.bind(console));
+});
+
+// Linting
+gulp.task('svrlint', function () {
+  return gulp.src(lintPaths.lint)
+    .pipe(jshint(lintPaths.server))
+    .pipe(jshint.reporter('jshint-stylish'))
+    .pipe(jshint.reporter('fail'));
 });
 
+gulp.task('felint', function () {
+  return gulp.src(lintPaths.felint)
+    .pipe(jshint(lintPaths.client))
+    .pipe(jshint.reporter('jshint-stylish'))
+    .pipe(jshint.reporter('fail'));
+});
+
+// Watch Tasks
+gulp.task('watch', function () {
+  watch(watchFiles, onWatchFileChanged);
+});
+
+// Default/Combo Tasks
+gulp.task('build', ['lint'], function () {
+  return gulp.start('assemble');
+});
+
+gulp.task('lint', ['svrlint', 'felint']);
+
+gulp.task('assemble', ['fonts', 'styles', 'scripts', 'templates']);
+
 gulp.task('default', ['test']);

package.json

@@ -16,13 +16,25 @@
     "mocha": "",
     "moment": "^2.7.0",
     "ncp": "^1.0.1",
-    "node-uuid": "^1.4.1",
-    "uglify-js": "^2.4.15"
+    "node-uuid": "^1.4.1"
   },
   "devDependencies": {
     "fiveby": "git+https://github.dowjones.net/institutional/fiveby.git",
     "gulp": "^3.8.1",
-    "gulp-spawn-mocha": "^0.1.5",
+    "gulp-concat": "^2.4.3",
+    "gulp-declare": "^0.3.0",
+    "gulp-handlebars": "^3.0.1",
+    "gulp-jshint": "^1.9.0",
+    "gulp-less": "^2.0.1",
+    "gulp-plumber": "^0.6.6",
+    "gulp-spawn-mocha": "^0.5.2",
+    "gulp-uglify": "^1.1.0",
+    "gulp-util": "^3.0.2",
+    "gulp-watch": "^4.1.0",
+    "gulp-wrap": "^0.10.1",
+    "istanbul": "^0.3.5",
+    "jshint-stylish": "^1.0.0",
+    "merge-stream": "^0.1.7",
     "should": "^3.3.2"
   },
   "scripts": {
@@ -36,4 +48,4 @@
     "handlebars"
   ],
   "license": "ISC"
-}
+}