Merge pull request #44 from mobify/eslint

Removes JSCS/JSHint in favor of ESLint

Author: fractaltheory

README.md

@@ -6,39 +6,28 @@ A repo to document code standards for different languages and provide tools for
 
 ## JavaScript
 
-Typically we lint our javascript files using [Grunt](http://gruntjs.com/). We have two javascript linters with different features. [jshint](https://github.com/gruntjs/grunt-contrib-jshint) and [jscs](https://github.com/gustavohenke/grunt-jscs).
+Typically, we lint our javascript files using [Grunt](http://gruntjs.com/) and [grunt-eslint](https://github.com/sindresorhus/grunt-eslint). grunt-eslint is a Grunt helper for the [ESLint](http://eslint.org/) linter.
 
 To add javascript linting to your project:
 
- 1. Install the NPM `mobify-code-style`, `grunt-contrib-jshint`, and `grunt-contrib-jscs` modules.
+ 1. Install the NPM `mobify-code-style` and `grunt-eslint` modules.
  2. Create a [Gruntfile](http://gruntjs.com/sample-gruntfile) if you don't have one already.
- 3. In the initConfig of your gruntfile, add sections for jshint and/or jscs pointing to the correct linting file.
+ 3. In the initConfig of your gruntfile, add a section for eslint pointing to the correct linting file.
 
-Sample jshint config:
+Sample eslint config:
 
 ```javascript
-jshint:{
+eslint:{
     dev: {
         src: ['src/**/*.js'],
         options: {
-            // The task fails if force is set to false. With true, it shows the
-            // linting errors, but continues
-            force: false,
-            jshintrc: 'node_modules/mobify-code-style/javascript/.jshintrc'
+            // When true, eslint will test _only_ the rules set in the provided
+            // configuration file
+            reset: false,
+            config: 'node_modules/mobify-code-style/javascript/.eslintrc'
         }
     }
 }
 ```
-
-Sample jscs config:
-
-```javascript
-jscs: {
-    options: {
-        config: 'node_modules/mobify-code-style/javascript/.jscsrc'
-    },
-    src: ['src/**/*.js']
-}
-```
 ## CSS
 Our Client Services team's [CSS Style Guide](/css/Readme.md). Written with a lot of tender care by @kpeatt and @jeffkamo.

javascript/.eslintrc

@@ -0,0 +1,114 @@
+{
+    "env": {
+        "node": true,
+        "browser": true,
+        "amd": true,
+        "mocha": true,
+        "jquery": true
+    },
+    "globals": {
+        "Mobify": true,
+        "Zepto": true,
+        "Adaptive": true
+    },
+    "rules": {
+        // Enforce === instead of ==; !== instead of !=
+        "eqeqeq": 2,
+
+        // Enforce if statement within 'for in'
+        "guard-for-in": 2,
+
+        // Disallow overwriting native types like 'Array' or 'Date'
+        "no-extend-native": 2,
+
+        // Enforce wrapping immediate invocations in parentheses
+        "wrap-iife": 2,
+
+        // Disallow usage of a variable before declaration; ignores functions
+        "no-use-before-define": [2, "nofunc"],
+
+        // Enforce capitalization of constructor functions
+        "new-cap": 2,
+
+        // Disallow creation of dense arrays using the Array constructor
+        "no-array-constructor": 2,
+
+        // Disallow use of the Object constructor
+        "no-new-object": 2,
+
+        // Disallow use of argument.caller and argument.callee
+        "no-caller": 2,
+
+        // Disallow empty block statements
+        "no-empty": 2,
+
+        // Disallow use of the with statement
+        "no-with": 2,
+
+        // Disallow mixed spaces and tabs for indentation
+        "no-mixed-spaces-and-tabs": 2,
+
+        // Disallow use of multiline strings
+        "no-multi-str": 2,
+
+        // Warn if variables are not named with camelCase
+        "camelcase": 1,
+
+        // Disallow trailing whitespace at the end of lines
+        "no-trailing-spaces": 2,
+
+        // Disallow spacing before commas; enforce spacing after commas
+        "comma-spacing": [2, { "before": false, "after": true }],
+
+        // Enforce spacing after keywords: if, else, for, while, do, switch, try,
+        // catch, and finally
+        "space-after-keywords": 2,
+
+        // Enforce spacing before opening brace of block statements
+        "space-before-blocks": [2, "always"],
+
+        // Enforce spaceing around infix operators: +, -, :, ?
+        "space-infix-ops": 2,
+
+        // Enforce spacing around word unary operators: new, delete, typeof, void
+        // Disallow spacing around non-word unary operators: -, +, --, ++, !, !!
+        "space-unary-ops": [2, { "words": true, "nonwords": false }],
+
+        // Disallow undeclared variables (unless mentioned in /*global ...*/ comment)
+        "no-undef": 2,
+
+        // Warn if single newline at end of file is missing
+        "eol-last": 1,
+
+        // Enforce single quotes for string literals
+        "quotes": [2, "single"],
+
+        // Disallow unnecessary parentheses
+        "no-extra-parens": 2,
+
+        // Disallow unnecessary semicolons
+        "no-extra-semi": 2,
+
+        // Disallow function or variable declarations in nested blocks
+        "no-inner-declarations": 2,
+
+        // Disallows the nesting of blocks more than 5 deep
+        "max-depth": [2, "5"],
+
+        // Enforces a maximum of 10 parameters in a function declaration
+        "max-params": [2, "10"],
+
+        // Enforces a maximum of 25 statements within a single function
+        "max-statements": [2, "25"],
+
+        // Enforces a maximum of 100 characters in a single line; adjusts tabs
+        // to equal 4 characters
+        "max-len": [2, "300", "4"],
+
+        // Enforces semicolons at the end of statements
+        "semi": 2,
+
+        // Disallow function definitions of the form 'function myFunc() {'
+        "func-style": [2, "expression"]
+    }
+}