Merge pull request #1 from nutshellcrm/initial-commit

Create default linting rules

Author: andrewsardone

.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

.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

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"
+}
+```

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',
+    ],
+};

index.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./default');

node_modules/eslint-config-nutshell

@@ -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"
+  }
+}

package.json

@@ -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],
+    },
+};

rules/babel.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],
+    },
+};

rules/best-practices.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = {
+    'rules': {
+        // Enforce trailing commas in multiline object literals
+        'comma-dangle': [2, 'always-multiline'],
+    },
+};