Merge pull request #1 from moderntribe/features/eslint-config

Initial eslint config

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+lib/
+react/

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.DS_Store

README.md

@@ -1 +1,36 @@
-# products-eslint-config
+# Products Eslint Config
+
+Custom config that extends [wpcalypso](https://github.com/Automattic/eslint-config-wpcalypso).
+
+## Dependencies
+
+* `eslint 3.19.0+`
+
+## Installation
+
+```sh
+npm install --save-dev github:moderntribe/eslint-config-products
+
+# Target branch or release:
+# npm install --save-dev github:moderntribe/eslint-config-products#branch-name
+```
+
+### Add .eslintrc file
+
+In the root directory, add in an `.eslintrc` file.
+
+```js
+{
+    extends: 'products'
+}
+```
+
+## Using React eslint config
+
+Update `.eslintrc` to:
+
+```js
+{
+    extends: 'products/react'
+}
+```

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/defaults.js');

lib/defaults.js

@@ -0,0 +1,7 @@
+module.exports = {
+    extends: [
+        'eslint:recommended',
+        'wpcalypso'
+    ],
+    rules: require('./rules')
+};

lib/rules/index.js

@@ -0,0 +1,196 @@
+// From: https://gist.github.com/cletusw/e01a85e399ab563b1236
+
+module.exports = {
+    ////////// Possible Errors //////////
+
+    // 'no-comma-dangle': 0,         // disallow trailing commas in object literals
+    // 'no-cond-assign': 0,          // disallow assignment in conditional expressions
+    'no-console': 1,              // disallow use of console (off by default in the node environment)
+    // 'no-constant-condition': 0,   // disallow use of constant expressions in conditions
+    // 'no-control-regex': 0,        // disallow control characters in regular expressions
+    'no-debugger': 2,             // disallow use of debugger
+    // 'no-dupe-keys': 0,            // disallow duplicate keys when creating object literals
+    // 'no-empty': 0,                // disallow empty statements
+    'no-empty-character-class': 2,// disallow the use of empty character classes in regular expressions
+    // 'no-ex-assign': 0,            // disallow assigning to the exception in a catch block
+    // 'no-extra-boolean-cast': 0,   // disallow double-negation boolean casts in a boolean context
+    // 'no-extra-parens': 0,         // disallow unnecessary parentheses (off by default)
+    'no-extra-semi': 2,           // disallow unnecessary semicolons
+    'no-func-assign': 2,          // disallow overwriting functions written as function declarations
+    // 'no-inner-declarations': 0,   // disallow function or variable declarations in nested blocks
+    'no-invalid-regexp': 2,       // disallow invalid regular expression strings in the RegExp constructor
+    // 'no-irregular-whitespace': 0, // disallow irregular whitespace outside of strings and comments
+    // 'no-negated-in-lhs': 0,       // disallow negation of the left operand of an in expression
+    // 'no-obj-calls': 0,            // disallow the use of object properties of the global object (Math and JSON) as functions
+    // 'no-regex-spaces': 0,         // disallow multiple spaces in a regular expression literal
+    // 'no-reserved-keys': 0,        // disallow reserved words being used as object literal keys (off by default)
+    'no-sparse-arrays': 2,        // disallow sparse arrays
+    // 'no-unreachable': 0,          // disallow unreachable statements after a return, throw, continue, or break statement
+    // 'use-isnan': 0,               // disallow comparisons with the value NaN
+    // 'valid-jsdoc': 0,             // Ensure JSDoc comments are valid (off by default)
+    // 'valid-typeof': 0,            // Ensure that the results of typeof are compared against a valid string
+
+    ////////// Best Practices //////////
+
+    'block-scoped-var': 2,      // treat var statements as if they were block scoped (off by default)
+    // complexity: 0,              // specify the maximum cyclomatic complexity allowed in a program (off by default)
+    // 'consistent-return': 0,     // require return statements to either always or never specify values
+    // curly: 0,                   // specify curly brace conventions for all control statements
+    // 'default-case': 0,          // require default case in switch statements (off by default)
+    // 'dot-notation': 0,          // encourages use of dot notation whenever possible
+    eqeqeq: [2, 'allow-null'],  // require the use of === and !==
+    // 'guard-for-in': 0,          // make sure for-in loops have an if statement (off by default)
+    'no-alert': 1,              // disallow the use of alert, confirm, and prompt
+    // 'no-caller': 0,             // disallow use of arguments.caller or arguments.callee
+    // 'no-div-regex': 0,          // disallow division operators explicitly at beginning of regular expression (off by default)
+    'no-else-return': 2,        // disallow else after a return in an if (off by default)
+    // 'no-empty-label': 0,        // disallow use of labels for anything other then loops and switches
+    // 'no-eq-null': 0,            // disallow comparisons to null without a type-checking operator (off by default)
+    // 'no-eval': 0,               // disallow use of eval()
+    // 'no-extend-native': 0,      // disallow adding to native types
+    // 'no-extra-bind': 0,         // disallow unnecessary function binding
+    // 'no-fallthrough': 0,        // disallow fallthrough of case statements
+    // 'no-floating-decimal': 0,   // disallow the use of leading or trailing decimal points in numeric literals (off by default)
+    // 'no-implied-eval': 0,       // disallow use of eval()-like methods
+    // 'no-iterator': 0,           // disallow usage of __iterator__ property
+    // 'no-labels': 0,             // disallow use of labeled statements
+    // 'no-lone-blocks': 0,        // disallow unnecessary nested blocks
+    // 'no-loop-func': 0,          // disallow creation of functions within loops
+    'no-multi-spaces': [
+        2,
+        {"exceptions":
+            {"VariableDeclarator": true}
+        }
+    ],                          // disallow use of multiple spaces
+    // 'no-multi-str': 0,          // disallow use of multiline strings
+    // 'no-native-reassign': 0,    // disallow reassignments of native objects
+    // 'no-new': 0,                // disallow use of new operator when not part of the assignment or comparison
+    // 'no-new-func': 0,           // disallow use of new operator for Function object
+    // 'no-new-wrappers': 0,       // disallows creating new instances of String, Number, and Boolean
+    // 'no-octal': 0,              // disallow use of octal literals
+    // 'no-octal-escape': 0,       // disallow use of octal escape sequences in string literals, such as var foo = "Copyright \251";
+    'no-param-reassign': [
+        2,
+        {"props": false}
+    ],                          // disallow Reassignment of Function Parameters
+    // 'no-process-env': 0,        // disallow use of process.env (off by default)
+    // 'no-proto': 0,              // disallow usage of __proto__ property
+    // 'no-redeclare': 0,          // disallow declaring the same variable more then once
+    // 'no-return-assign': 0,      // disallow use of assignment in return statement
+    // 'no-script-url': 0,         // disallow use of javascript: urls.
+    // 'no-self-compare': 0,       // disallow comparisons where both sides are exactly the same (off by default)
+    // 'no-sequences': 0,          // disallow use of comma operator
+    // 'no-unused-expressions': 0, // disallow usage of expressions in statement position
+    'no-useless-escape': 2,     // disallow unnecessary escape usage
+    // 'no-void': 0,               // disallow use of void operator (off by default)
+    // 'no-warning-comments': 0,   // disallow usage of configurable warning terms in comments, e.g. TODO or FIXME (off by default)
+    // 'no-with': 0,               // disallow use of the with statement
+    // radix: 0,                   // require use of the second argument for parseInt() (off by default)
+    // 'vars-on-top': 0,           // requires to declare all vars on top of their containing scope (off by default)
+    // 'wrap-iife': 0,             // require immediate function invocation to be wrapped in parentheses (off by default)
+    // yoda: [ 2, 'never' ],       // require or disallow Yoda conditions
+
+    ////////// Strict Mode //////////
+
+    // 'global-strict': 0,   // (deprecated) require or disallow the "use strict" pragma in the global scope (off by default in the node environment)
+    // 'no-extra-strict': 0, // (deprecated) disallow unnecessary use of "use strict"; when already in strict mode
+    // strict: [ 1, 'global' ], // controls location of Use Strict Directives
+
+    ////////// Variables //////////
+
+    // 'no-catch-shadow': 0,            // disallow the catch clause parameter name being the same as a variable in the outer scope (off by default in the node environment)
+    // 'no-delete-var': 0,              // disallow deletion of variables
+    // 'no-label-var': 0,               // disallow labels that share a name with a variable
+    'no-shadow': 2,                  // disallow declaration of variables already declared in the outer scope
+    // 'no-shadow-restricted-names': 0, // disallow shadowing of names such as arguments
+    // 'no-undef': 0,                   // disallow use of undeclared variables unless mentioned in a /*global */ block
+    // 'no-undef-init': 0,              // disallow use of undefined when initializing variables
+    // 'no-undefined': 0,               // disallow use of undefined variable (off by default)
+    'no-unused-vars': 2,             // disallow declaration of variables that are not used in the code
+    'no-use-before-define': [
+        2, 'nofunc'
+    ],                               // disallow use of variables before they are defined
+
+    ////////// Node.js //////////
+
+    // 'handle-callback-err': 0,   // enforces error handling in callbacks (off by default) (on by default in the node environment)
+    // 'no-mixed-requires': 1,     // disallow mixing regular variable and require declarations (off by default) (on by default in the node environment)
+    // 'no-new-require': 0,        // disallow use of new operator with the require function (off by default) (on by default in the node environment)
+    // 'no-path-concat': 0,        // disallow string concatenation with __dirname and __filename (off by default) (on by default in the node environment)
+    // 'no-process-exit': 0,       // disallow process.exit() (on by default in the node environment)
+    // 'no-restricted-modules': 0, // restrict usage of specified node modules (off by default)
+    // 'no-sync': 0,               // disallow use of synchronous methods (off by default)
+
+    ////////// Stylistic Issues //////////
+
+    // 'brace-style': 0,               // enforce one true brace style (off by default)
+    camelcase: 2,                   // require camel case names
+    // 'comma-spacing': 0,             // enforce spacing before and after comma
+    // 'comma-style': 0,               // enforce one true comma style (off by default)
+    // 'consistent-this': 0,           // enforces consistent naming when capturing the current execution context (off by default)
+    // 'eol-last': 0,                  // enforce newline at the end of file, with no multiple empty lines
+    // 'func-names': 0,                // require function expressions to have a name (off by default)
+    // 'func-style': 0,                // enforces use of function declarations or expressions (off by default)
+    // 'key-spacing': 0,               // enforces spacing between keys and values in object literal properties
+    'linebreak-style': [2, 'unix'],  // enforce consistent linebreak style
+    // 'max-nested-callbacks': 0,      // specify the maximum depth callbacks can be nested (off by default)
+    // 'new-cap': 0,                   // require a capital letter for constructors
+    // 'new-parens': 0,                // disallow the omission of parentheses when invoking a constructor with no arguments
+    // 'no-array-constructor': 0,      // disallow use of the Array constructor
+    // 'no-inline-comments': 0,        // disallow comments inline after code (off by default)
+    // 'no-lonely-if': 0,              // disallow if as the only statement in an else block (off by default)
+    // 'no-mixed-spaces-and-tabs': 0,  // disallow mixed spaces and tabs for indentation
+    // 'no-multiple-empty-lines': 0,   // disallow multiple empty lines (off by default)
+    // 'no-nested-ternary': 0,         // disallow nested ternary expressions (off by default)
+    // 'no-new-object': 0,             // disallow use of the Object constructor
+    // 'no-spaced-func': 0,            // disallow space between function identifier and application
+    // 'no-ternary': 0,                // disallow the use of ternary operators (off by default)
+    // 'no-trailing-spaces': 0,        // disallow trailing whitespace at the end of lines
+    // 'no-underscore-dangle': 0,      // disallow dangling underscores in identifiers
+    // 'no-wrap-func': 0,              // disallow wrapping of non-IIFE statements in parens
+    // 'one-var': 0,                   // allow just one var statement per function (off by default)
+    // 'operator-assignment': 0,       // require assignment operator shorthand where possible or prohibit it entirely (off by default)
+    // 'padded-blocks': 0,             // enforce padding within blocks (off by default)
+    'quote-props': [
+        2,
+        'consistent-as-needed'
+    ],                              // require quotes around object literal property names (off by default)
+    quotes: [
+        2,
+        'single', {
+            allowTemplateLiterals: true
+        }
+    ],                              // specify whether double or single quotes should be used
+    semi: [
+        2, 'always'
+    ],                              // require or disallow use of semicolons instead of ASI
+    // 'semi-spacing': 0,              // Enforce spacing before and after semicolons
+    // 'sort-vars': 0,                 // sort variables within the same declaration block (off by default)
+    'space-before-blocks': [2, 'always'],       // enforce consistent spacing before blocks
+    'space-before-function-paren': [2, 'never'], // enforce consistent spacing before function definition opening parenthesis
+    'space-in-parens': [2, 'always'],           // enforce consistent spacing inside parentheses
+    'space-infix-ops': 2,           // require spacing around infix operators
+    'space-unary-ops': [
+        2,
+        {
+            words: true,
+            nonwords: false
+        }
+    ],                              // enforce consistent spacing before or after unary operators
+    // 'spaced-comment': 0,            // enforce consistent spacing after the // or /* in a comment
+    // 'wrap-regex': 0,                // require regex literals to be wrapped in parentheses (off by default)
+
+    ////////// ECMAScript 6 //////////
+
+    // 'no-var': 0,         // require let or const instead of var (off by default)
+    // 'generator-star': 0, // enforce the position of the * in generator functions (off by default)
+
+    ////////// Legacy //////////
+
+    // 'max-depth': 0,      // specify the maximum depth that blocks can be nested (off by default)
+    // 'max-len': 0,        // specify the maximum length of a line in your program (off by default)
+    // 'max-params': 0,     // limits the number of parameters that can be used in the function declaration. (off by default)
+    // 'max-statements': 0, // specify the maximum number of statement allowed in a function (off by default)
+    // 'no-bitwise': 0,     // disallow use of bitwise operators (off by default)
+    // 'no-plusplus': 0,    // disallow use of unary operators, ++ and -- (off by default)
+};

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "eslint-config-products",
+  "version": "0.0.1",
+  "description": "Products eslint config",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moderntribe/eslint-config-products.git"
+  },
+  "author": "",
+  "license": "GPL-2.0",
+  "bugs": {
+    "url": "https://github.com/moderntribe/eslint-config-products/issues"
+  },
+  "homepage": "https://github.com/moderntribe/eslint-config-products#readme",
+  "dependencies": {
+    "eslint-config-wpcalypso": "^0.8.0",
+    "eslint-plugin-wpcalypso": "^3.2.0"
+  },
+  "optionalDependencies": {
+    "eslint-plugin-jsx-a11y": "^5.0.3",
+    "eslint-plugin-react": "^7.0.1"
+  },
+  "peerDependencies": {
+    "eslint": "^3.19.0"
+  }
+}

react/index.js

@@ -0,0 +1,28 @@
+module.exports = {
+    env: {
+        node: true,
+        browser: true
+    },
+    extends: [
+        'wpcalypso/react-a11y',
+        '../index.js'
+    ],
+    rules: {
+        'react/jsx-filename-extension': 0,
+        'react/jsx-indent-props': [2, 'tab'],
+        'react/jsx-indent': [2, 'tab'],
+        'react/jsx-uses-vars': 1,
+        'react/prop-types': 1,
+        'react/react-in-jsx-scope': 1,
+
+        'jsx-a11y/alt-text': 2,
+        'jsx-a11y/no-static-element-interactions': 2,
+        'jsx-a11y/no-noninteractive-element-interactions': 2,
+        'jsx-a11y/interactive-supports-focus': 2,
+
+        // Removed in v5
+        'jsx-a11y/img-has-alt': 0,
+        'jsx-a11y/onclick-has-focus': 0,
+        'jsx-a11y/onclick-has-role': 0
+    }
+};