Merge pull request #1 from shakacode/alex/npm-eslint-config

Add npm eslint config package

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+*.log
+*.log*
+.DS_Store

README.md

@@ -2,22 +2,22 @@ ShakaCode's JavaScript Style Guide (Also see our Ruby one: https://github.com/sh
 
 # ShakaCode JavaScript Style Guide
 
-Our **JavaScript Style Guide** is relatively simpler because we're simply using the [Airbnb JavaScript Style Guide][airbnb-javascript] with it's associated `.eslintrc` and `.jscsrc` files.
+Our **JavaScript Style Guide** is relatively simpler because we're simply using the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) with it's associated `.eslintrc` and `.jscsrc` files.
 
 Here's a few notes on top of that:
 
 1. **Line Length**: We're sticking with the AirBnb Standard of 120, and any strings greater than 100 should be broken up to multiple lines. Airbnb moved to 120, here's [why](https://github.com/airbnb/javascript/pull/458).
 2. Definitely follow the [AirBnb React Guide](https://github.com/airbnb/javascript/blob/master/react/README.md)
 
 
-# Exceptions:
+# Exceptions (React Guide only)
 
 ## Root Components
 [AirBnb on Root components](https://github.com/airbnb/javascript/blob/master/react/README.md#naming)
 
 > However, for root components of a directory, use index.jsx as the filename and use the directory name as the component name.
 
-We have scss + tests files in component directory, so now it looks like this:
+Along with React component we keep styles + tests files side by side in component directory, so it looks like this:
 
 ```
 MyComponent/
@@ -26,7 +26,7 @@ MyComponent/
   |-- MyComponent.spec.jsx
 ```
 
-When we'll apply airbnb rule:
+With AirBnb rule applied, it looks inconsistent:
 
 ```
 MyComponent/
@@ -35,18 +35,15 @@ MyComponent/
   |-- MyComponent.spec.jsx
 ```
 
-Kinda ugly and not consistent.
-
-To solve this we can use this pattern:
-
-```
-MyComponent/
-  |-- index.jsx
-  |-- styles.scss
-  |-- specs.jsx
-```
+So we stick with first pattern for now.
 
 ## Ordering
 [Airbnb on Ordering](https://github.com/airbnb/javascript/blob/master/react/README.md#ordering)
 
-Ordering. I'd put all `static` methods **before** `constructor`, b/c  as we are using `props` in the `constructor`, so `propTypes` should be described first. Also we use statics for transition hooks, so these methods are not related to instance methods, but `constructor` is. One more case when statics may be used is to describe some constants for component, which can also be used in `constructor`. Anyway all of these is not critical I guess.
+Ordering is almost the same, except one change: we keep all `static`s **before** `constructor`.
+
+Here is why:
+
+* As we define `propTypes` as a [`class static properties`](https://github.com/jeffmo/es-class-fields-and-static-properties) and use `props` in the `constructor`, so `propTypes` should be described first.
+* We use `static` methods as router transition hooks (especially `onEnter`), so these methods run first (before any instance is created) and in common they are not related to the instance, but `constructor` is.
+* One more case when `static` may be used is to describe some constants for component, which can also be used in `constructor`.

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "shakacode-style-guide-javascript",
+  "version": "0.0.1",
+  "description": "Shakacode javascript style guide.",
+  "authors": [
+    "Justin Gordon <[email protected]> (https://github.com/justin808)",
+    "Alex Fedoseev <[email protected]> (https://github.com/alexfedoseev)"
+  ],
+  "license": "MIT",
+  "repository": "https://github.com/shakacode/style-guide-javascript",
+  "bugs": {
+    "url": "https://github.com/shakacode/style-guide-javascript/issues"
+  },
+  "engines": {
+    "node": ">=4.2.0"
+  },
+  "scripts": {
+    "release:patch": "cd packages/eslint-config-shakacode && npm run release:patch",
+    "release:minor": "cd packages/eslint-config-shakacode && npm run release:minor",
+    "release:major": "cd packages/eslint-config-shakacode && npm run release:major"
+  }
+}

packages/eslint-config-shakacode/README.md

@@ -0,0 +1,31 @@
+# eslint-config-shakacode
+
+Shakacode `eslint` config.
+
+## Install
+
+```bash
+npm install --save-dev eslint-config-shakacode eslint-config-airbnb eslint
+
+# We need Babel as we use experimental features and flow syntax
+npm install --save-dev babel-eslint
+
+# If it's React project
+npm install --save-dev eslint-plugin-react
+```
+
+## Use
+
+React project:
+
+```yml
+---
+extends: eslint-config-shakacode
+```
+
+Non-React project:
+
+```yml
+---
+extends: eslint-config-shakacode/base
+```

packages/eslint-config-shakacode/base.js

@@ -0,0 +1,7 @@
+module.exports = {
+  'parser': 'babel-eslint',
+  'extends': [
+    'eslint-config-airbnb/base',
+    'eslint-config-shakacode/rules/javascript',
+  ].map(require.resolve),
+};

packages/eslint-config-shakacode/index.js

@@ -0,0 +1,8 @@
+module.exports = {
+  'parser': 'babel-eslint',
+  'extends': [
+    'eslint-config-airbnb',
+    'eslint-config-shakacode/rules/javascript',
+    'eslint-config-shakacode/rules/react',
+  ].map(require.resolve),
+};

packages/eslint-config-shakacode/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "eslint-config-shakacode",
+  "version": "0.0.1",
+  "description": "Shakacode eslint config.",
+  "authors": [
+    "Justin Gordon <[email protected]> (https://github.com/justin808)",
+    "Alex Fedoseev <[email protected]> (https://github.com/alexfedoseev)"
+  ],
+  "license": "MIT",
+  "repository": "https://github.com/shakacode/style-guide-javascript",
+  "bugs": {
+    "url": "https://github.com/shakacode/style-guide-javascript/issues"
+  },
+  "main": "index.js",
+  "engines": {
+    "node": ">=4.2.0"
+  },
+  "scripts": {
+    "release:patch": "scripts/release patch",
+    "release:minor": "scripts/release minor",
+    "release:major": "scripts/release major"
+  },
+  "peerDependencies": {
+    "babel-eslint": "*",
+    "eslint": "*",
+    "eslint-config-airbnb": "*"
+  }
+}

packages/eslint-config-shakacode/rules/javascript.js

@@ -0,0 +1,7 @@
+module.exports = {
+  'extends': (
+    require
+      .resolve('eslint-config-shakacode')
+      .replace('index.js', 'rules/javascript.yml')
+  ),
+};

packages/eslint-config-shakacode/rules/javascript.yml

@@ -0,0 +1,3 @@
+---
+# In case if we'll want to override some airbnb rules
+# rules:

packages/eslint-config-shakacode/rules/react.js

@@ -0,0 +1,7 @@
+module.exports = {
+  'extends': (
+    require
+      .resolve('eslint-config-shakacode')
+      .replace('index.js', 'rules/react.yml')
+  ),
+};

packages/eslint-config-shakacode/rules/react.yml

@@ -0,0 +1,5 @@
+---
+rules:
+  # ES7 static is not supported yet
+  # See https://github.com/yannickcr/eslint-plugin-react/issues/128
+  react/sort-comp: 0

packages/eslint-config-shakacode/scripts/release

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+npm version $1 -m "Bump version to %s"
+git push
+git push --tags
+npm publish