Create default linting rules

Ian VanSchooten · Ian VanSchooten · commit 680c04339142 · 2015-11-09T15:39:56.000-05:00
This extracts the current set of rules from the Nutshell web app, allowing reuse across different repos. Rules are split into modules based on their categorization on the [ESLint rules page](http://eslint.org/docs/rules/). Currently only a default config is being exported, but it is possible in the future to export different sets of rules tailored to target apps or environments.
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,20 @@
+---
+
+    extends: nutshell
+
+    ecmaFeatures:
+        modules: false
+
+    env:
+        node: true
+
+    rules:
+        key-spacing:
+            - 2
+            - align: colon
+        quote-props:
+            - 2
+            - always
+        strict:
+            - 2
+            - global
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,16 @@
+node_modules/*
+!node_modules/eslint-config-nutshell
+
+# Ignore configuration and automatically generated cruft
+*.log
+
+# Operating system files
+.Spotlight-V100
+.Trashes
+.DS_Store
+.DS_Store?
+ehthumbs.db
+Thumbs.db
+
+# Text Editors
+*.sublime-workspace
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
 # eslint-config-nutshell
-ESLint shareable config for the Nutshell JavaScript style guide
+ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for the Nutshell JavaScript style guide
+
+
+## Install
+
+```
+$ npm install --save-dev eslint eslint-config-nutshell
+```
+
+## Usage
+
+Read up on how to use [sharable configs](http://eslint.org/docs/developer-guide/shareable-configs) at the ESLint website.  Essentially, add the following to the project's `.eslintrc` file:
+
+```json
+{
+    "extends": "nutshell"
+}
+```
diff --git a/default.js b/default.js
@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports = {
+    'extends': [
+        'eslint:recommended',
+        'eslint-config-nutshell/rules/babel',
+        'eslint-config-nutshell/rules/best-practices',
+        'eslint-config-nutshell/rules/errors',
+        'eslint-config-nutshell/rules/es6',
+        'eslint-config-nutshell/rules/react',
+        'eslint-config-nutshell/rules/strict',
+        'eslint-config-nutshell/rules/style',
+    ],
+};
diff --git a/index.js b/index.js
@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./default');
diff --git a/node_modules/eslint-config-nutshell b/node_modules/eslint-config-nutshell
diff --git a/package.json b/package.json
@@ -0,0 +1,37 @@
+{
+  "name": "eslint-config-nutshell",
+  "version": "1.0.0",
+  "description": "ESLint sharable config for Nutshell Javascript style guide",
+  "main": "index.js",
+  "scripts": {
+    "test": "npm run lint -s",
+    "lint": "eslint ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nutshellcrm/eslint-config-nutshell.git"
+  },
+  "keywords": [
+    "nutshell",
+    "eslint",
+    "config",
+    "eslintconfig"
+  ],
+  "author": "Nutshell",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/nutshellcrm/eslint-config-nutshell/issues"
+  },
+  "homepage": "https://github.com/nutshellcrm/eslint-config-nutshell#readme",
+  "peerDependencies": {
+    "eslint": "^1.6.0",
+    "eslint-plugin-babel": "^2.1.1",
+    "eslint-plugin-react": "^3.8.0"
+  },
+  "devDependencies": {
+    "babel-eslint": "^4.1.4",
+    "eslint": ">=1.6.0",
+    "eslint-plugin-babel": "^2.1.1",
+    "eslint-plugin-react": "^3.8.0"
+  }
+}
diff --git a/rules/babel.js b/rules/babel.js
@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = {
+    'parser' : 'babel-eslint',
+    'plugins': ['babel'],
+    'rules'  : {
+        // Use babel/new-cap instead of new-cap for decorator support
+        'babel/new-cap': [2],
+    },
+};
diff --git a/rules/best-practices.js b/rules/best-practices.js
@@ -0,0 +1,16 @@
+'use strict';
+
+module.exports = {
+    'rules': {
+        // Specify curly brace conventions for all control statements
+        'curly'            : [2, 'multi-line'],
+        // Disallow use of multiple spaces
+        'no-multi-spaces'  : [2],
+        // Disallow reassignment of function parameters
+        'no-param-reassign': [2],
+        // Disallow comparisons where both sides are exactly the same
+        'no-self-compare'  : [2],
+        // Disallow usage of expressions in statement position
+        'no-throw-literal' : [2],
+    },
+};
diff --git a/rules/errors.js b/rules/errors.js
@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = {
+    'rules': {
+        // Enforce trailing commas in multiline object literals
+        'comma-dangle': [2, 'always-multiline'],
+    },
+};
diff --git a/rules/es6.js b/rules/es6.js
@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports = {
+    'env': {
+        'es6': true,
+    },
+    'ecmaFeatures': {
+        'modules': true,
+    },
+    'rules': {
+        // Require let or const instead of var
+        'no-var': [2],
+    },
+};
diff --git a/rules/react.js b/rules/react.js
@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports = {
+    'ecmaFeatures': {
+        'jsx': true,
+    },
+    'plugins': [
+        'react',
+    ],
+    'rules': {
+        // Prevent variables used in JSX to be incorrectly marked as unused
+        'react/jsx-uses-vars': [2],
+    },
+};
diff --git a/rules/strict.js b/rules/strict.js
@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = {
+    'rules': {
+        // Prohibit use strict directive, because it is unnecessary in modules.
+        'strict': [2, 'never'],
+    },
+};
diff --git a/rules/style.js b/rules/style.js
@@ -0,0 +1,56 @@
+'use strict';
+
+module.exports = {
+    'rules': {
+        // Enforce spaces inside of single line blocks
+        'block-spacing'              : [2, 'always'],
+        // Enforce one true brace style
+        'brace-style'                : [2, '1tbs', {'allowSingleLine': true }],
+        // Enforce spacing after comma
+        'comma-spacing'              : [2, {'before': false, 'after': true}],
+        // Enforce consistent naming when capturing the current execution context
+        'consistent-this'            : [2, 'self'],
+        // Enforce newline at the end of file, with no multiple empty lines
+        'eol-last'                   : [2],
+        // Enforce four space indent width for your code
+        'indent'                     : [2, 4],
+        // Enforce spacing between keys and values in object literal properties
+        'key-spacing'                : [2, {'beforeColon': false, 'afterColon': true}],
+        // Disallow mixed 'LF' and 'CRLF' as linebreaks
+        'linebreak-style'            : [2, 'unix'],
+        // Disallow use of the continue statement
+        'no-continue'                : [2],
+        // Disallow if as the only statement in an else block
+        'no-lonely-if'               : [2],
+        // disallow multiple empty lines
+        'no-multiple-empty-lines'    : [2],
+        // Disallow nested ternary expressions
+        'no-nested-ternary'          : [2],
+        // Disallow space between function identifier and application
+        'no-spaced-func'             : [2],
+        // Disallow the use of Boolean literals in conditional expressions
+        'no-unneeded-ternary'        : [2],
+        // Enforce padding within blocks
+        'padded-blocks'              : [2, 'never'],
+        // Require quotes around object literal property names
+        'quote-props'                : [2, 'as-needed', {'keywords': true}],
+        // Specify use of single quotes
+        'quotes'                     : [2, 'single'],
+        // Enforce spacing after semicolons
+        'semi-spacing'               : [2, {'before': false, 'after': true}],
+        // Require use of semicolons instead of ASI
+        'semi'                       : [2, 'always'],
+        // Require a space after certain keywords
+        'space-after-keywords'       : [2],
+        // Require space before blocks
+        'space-before-blocks'        : [2],
+        // Disallow space before function opening parenthesis
+        'space-before-function-paren': [2, 'never'],
+        // Require spaces around infix operators
+        'space-infix-ops'            : [2],
+        // Require a space after return, throw, and case
+        'space-return-throw-case'    : [2],
+        // Disallow spaces before/after unary operators
+        'space-unary-ops'            : [2],
+    },
+};

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+'use strict';`
	`2`	`+`
	`3`	`+module.exports = require('./default');`