rework and docs on eslintrc rules files

Author: rpl

.eslintrc

@@ -1,38 +1,23 @@
 {
-  "plugins": [
-    "no-tabs",
-    "react"
-  ],
   "rules": {
+    "indent": [2, 2], // check 2 space indentation
     "no-mixed-spaces-and-tabs": [2],
     "quotes": [2, "double"],
     "semi": [1, "always"],
 
-    "no-tabs/at-all": [2],
+    // disabled rule which enforce unix or windows line breaks
+    "linebreak-style": [0],
 
-    "react/display-name": 2,
-    "react/prop-types": 0,
+    // disabled comma-dangle is safe for our use case
+    "comma-dangle": [0],
 
-    "indent": [0, 2],
-    "linebreak-style": [0],
+    // disabled eqeqeq and no-use-before-define are safe if you use them correctly
     "eqeqeq": [0],
-    "new-cap": [0],
-    "no-new": [0],
-    "comma-dangle": [0],
-    "no-use-before-define": [0]
+    "no-use-before-define": [0],
   },
   "env": {
-    "es6": true,
-    "browser": true,
-    "amd": true
+    "es6": true
   },
   "globals": {
-    "define": true,
-    "require": true,
-    "requirejs": true,
-
-    "Str": true,
-    "Locale": true,
-    "Options": true
   }
 }

data/.eslintrc

@@ -0,0 +1,35 @@
+// extends common eslintrc config with "javascript running in a content context" specific configs
+{
+    "extends": "../.eslintrc",
+		"plugins": [
+			// prevents tab whitespace when 'indent' rule is disabled
+	    "no-tabs",
+	    "react"
+	  ],
+		"env": {
+      // enable browser & amd conventions
+      "browser": true,
+			"amd": true
+    },
+    "rules": {
+			// disabled due to conflicts with special indentation in requirejs modules
+			"indent": 0,
+			// prevents any usage of tab whitespaces
+			"no-tabs/at-all": [2],
+
+			// force definition of displayName on React components
+			"react/display-name": 2,
+
+			// TODO: force propTypes on React Components
+	    "react/prop-types": 0,
+
+			// disabled due to conflicts with capitalized React components names
+			"new-cap": [0],
+    },
+    "globals": {
+      // firebug.sdk globals
+			"Str": true,
+			"Locale": true,
+			"Options": true
+    }
+}

data/inspector/config.js

@@ -1,5 +1,7 @@
 /* See license.txt for terms of usage */
 
+/* globals requirejs */
+
 // RequireJS configuration
 require.config({
   baseUrl: ".",

data/inspector/main.js

@@ -156,9 +156,12 @@ theApp = React.render(MainTabbedArea({
 
 // Helper modules for handling application events.
 packetsStore = new PacketsStore(window, theApp);
+
+/* eslint-disable no-new */
 new ActorsStore(window, theApp);
 new Resizer(window, theApp);
 new Search(window, theApp);
+/* eslint-enable */
 
 // Send notification about initialization being done.
 postChromeMessage("initialized");

karma-tests/.eslintrc

@@ -0,0 +1,7 @@
+// extends data eslintrc config with karma tests specific configs
+{
+    "extends": "../data/.eslintrc",
+    "env": {},
+    "rules": {},
+    "globals": {}
+}

lib/inspector-service.js

@@ -105,14 +105,14 @@ const InspectorService =
       then(({registrar, front}) => {
         this.globalRegistrar = registrar;
         return front;
-    });
+      });
 
     // Register as tab actor.
     let tab = Rdp.registerTabActor(client, config).
       then(({registrar, front}) => {
         this.tabRegistrar = registrar;
         return front;
-    });
+      });
 
     // Wait till both registrations are done.
     all([global, tab]).then(results => {

package.json

@@ -27,7 +27,7 @@
     "jpm-tests": "jpm test",
     "travis-ci": "npm run karma-coverage && npm run lint",
     "lint-content": "eslint data/inspector && eslint karma-tests/",
-    "lint-addon": "eslint --env node lib",
+    "lint-addon": "eslint lib",
     "lint": "npm run lint-content && npm run lint-addon"
   },
   "engines": {