Source code formatting

.editorconfig

@@ -0,0 +1,11 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+

.git-hooks/pre-commit

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+if [ "$(git rev-parse --abbrev-ref HEAD)" != "master" ]; then
+  exit 0;
+else
+  gulp jshint &> /dev/null
+  if [ "$?" != "0" ]; then
+    echo "Found some JS errors. Check with 'gulp jshint' before committing."
+    exit 1;
+  fi
+
+  gulp jscs &> /dev/null
+  if [ "$?" != "0" ]; then
+    echo "Unstyled JS. Check with 'gulp jscs' before committing."
+    exit 1;
+  fi
+fi
+

.jscsrc

@@ -0,0 +1,26 @@
+{
+  "requireCurlyBraces": ["for", "while", "do", "try", "catch"],
+  "requireSpaceAfterKeywords": ["if", "else", "for", "while", "do", "switch", "return", "try", "catch"],
+  "requireSpacesInFunctionExpression": {
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowMultipleVarDecl": "exceptUndefined",
+  "requireSpacesInsideObjectBrackets": "allButNested",
+  "disallowSpacesInsideArrayBrackets": true,
+  "disallowSpacesInsideParentheses": true,
+  "disallowSpaceAfterObjectKeys": true,
+  "disallowQuotedKeysInObjects": true,
+  "requireSpaceBeforeBinaryOperators": ["?", "+", "/", "*", "=", "==", "===", "!=", "!==", ">", ">=", "<", "<="],
+  "disallowSpaceAfterBinaryOperators": ["!"],
+  "requireSpaceAfterBinaryOperators": ["?", ",", "+", "/", "*", ":", "=", "==", "===", "!=", "!==", ">", ">=", "<", "<="],
+  "disallowSpaceBeforeBinaryOperators": [","],
+  "disallowSpaceAfterPrefixUnaryOperators": ["++", "--", "+", "-", "~", "!"],
+  "disallowSpaceBeforePostfixUnaryOperators": ["++", "--"],
+  "requireSpaceBeforeBinaryOperators": ["+", "-", "/", "*", "=", "==", "===", "!=", "!==", "%"],
+  "requireSpaceAfterBinaryOperators": ["+", "-", "/", "*", "=", "==", "===", "!=", "!==", "%"],
+  "disallowImplicitTypeConversion": ["numeric", "binary", "string"],
+  "disallowKeywords": ["with", "eval"],
+  "disallowMultipleLineBreaks": true,
+  "requireLineFeedAtFileEnd": true,
+  "validateIndentation": 2
+}

README.md

@@ -7,6 +7,17 @@
 3. `bower install`
 4. `npm install`
 
+If you plan on modifying source code, be a good citizen and:
+
+1. Install [EditorConfig plugin](http://editorconfig.org/#download) for your favourite browser.
+   The plugin should automatically pick up the [.editorconfig](.editorconfig) settings.
+2. Add pre-commit git hook:
+   ```
+   cp .git-hooks/pre-commit .git/hooks && chmod +x .git/hooks/pre-commit
+   ```
+
+   This will check for JS errors and code style before committing to the `master` branch.
+
 ### Running
 
 Start a web server in `app/` or server via App Engine dev server.
@@ -15,4 +26,6 @@ Start a web server in `app/` or server via App Engine dev server.
 
 ### Building
 
-Run `gulp`. Then hit `http://localhost:<PORT>/dist/app/`. The unbuilt version is still viewable at `http://localhost:<PORT>/app/` but will not contain minfied JS or vulcanized HTML Imports. 
+Run `gulp`. Then hit `http://localhost:<PORT>/dist/app/`. The unbuilt version is still viewable at `http://localhost:<PORT>/app/` but will not contain minfied JS or vulcanized HTML Imports.
+
+**Note**: Build won't succeed if either `gulp jshint` or `gulp jscs` reports errors.

gulpfile.js

@@ -151,13 +151,20 @@ gulp.task('vulcanize-elements', ['clean', 'compass'], function() {
 
 // Lint JavaScript
 gulp.task('jshint', function() {
-  return gulp.src(APP_DIR + '/scripts/**/*.js')
+  return gulp.src([APP_DIR + '/scripts/**/*.js', '!**/third_party/**'])
     .pipe(reload({stream: true, once: true}))
     .pipe($.jshint())
     .pipe($.jshint.reporter('jshint-stylish'))
     .pipe($.if(!browserSync.active, $.jshint.reporter('fail')));
 });
 
+// Check JS style
+gulp.task('jscs', function() {
+  return gulp.src([APP_DIR + '/scripts/**/*.js', '!**/third_party/**'])
+    .pipe(reload({stream: true, once: true}))
+    .pipe($.jscs());
+});
+
 // Crush JS
 gulp.task('uglify', function() {
   return gulp.src(APP_DIR + '/scripts/**/*.js')
@@ -210,7 +217,7 @@ gulp.task('serve', ['compass'], function () {
 
 gulp.task('vulcanize', ['vulcanize-elements']);
 
-gulp.task('js', ['jshint', 'uglify']);
+gulp.task('js', ['jshint', 'jscs', 'uglify']);
 
 gulp.task('default', ['clean'], function(cb) {
   runSequence('compass', 'vulcanize', ['js', 'images', 'fonts', 'copy-assets'], cb);

package.json

@@ -41,6 +41,7 @@
     "through2": "0.6.3",
     "vinyl-map": "1.0.1",
     "sprintf-js": "1.0.2",
-    "yargs": "1.3.3"
+    "yargs": "1.3.3",
+    "gulp-jscs": "^1.3.1"
   }
 }