@innovixx/eslint-config 1.0.0

package/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+max_line_length = null

package/.eslintrc

@@ -0,0 +1,6 @@
+{
+  // "extends": "./"
+  "extends": "./configs/base"
+  // "extends": "./configs/jest",
+  // "extends": "./configs/react",
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Innovixx Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,62 @@
+# JavaScript Style Guide
+
+## Highlights
+
+## Quick Start
+
+### Installation
+
+```bash
+$ npm i --save-dev @innovixx/eslint-config
+$ npm info @innovixx/eslint-config peerDependencies
+$ npm i --save-dev <dependency>@<version> # for each dependency in the above output
+$ # or
+$ yarn add --dev @innovixx/eslint-config
+$ yarn info @innovixx/eslint-config peerDependencies
+$ yarn add --dev <dependency>@<version> # for each dependency in the above output
+```
+
+### Usage
+
+There are a number of configurations for consumption, all of which are packaged together as the default export &mdash; *or they can be selectively extended, which prevents the path names [from being written shorthand](https://eslint.org/docs/developer-guide/shareable-configs#sharing-multiple-configs).*
+
+```javascript
+{
+  "extends": "@innovixx"
+  // or selectively extend any config(s)
+  // "extends": [
+  //   "@innovixx/eslint-config/configs/base",
+  //   "@innovixx/eslint-config/configs/jest",
+  //   "@innovixx/eslint-config/configs/react",
+  // ]
+}
+```
+
+If using Webpack, install and configure `eslint-loader` to have loaded files automatically linted.
+
+```javascript
+{
+  test: /\.js$/,
+  exclude: /node_modules/,
+  loader: 'eslint-loader',
+  options: {
+    fix: true,
+    emitWarning: true,
+  },
+}
+```
+
+For working examples, see the [demo app](./demo/App.demo.js).
+
+## Demo
+
+```bash
+$ git clone git@github.com:Innovixx-Development/eslint-config.git
+$ yarn
+$ yarn demo
+$ open http://localhost:3000
+```
+
+## License
+
+[MIT](https://github.com/Innovixx-Development/eslint-config/blob/master/LICENSE) Copyright (c) Innovixx, Ltd

package/configs/base/index.js

@@ -0,0 +1,17 @@
+module.exports = {
+  plugins: [
+    'node',
+  ],
+  env: {
+    node: true,
+  },
+  extends: [
+    './rules/best-practices',
+    './rules/errors',
+    './rules/es6',
+    './rules/imports',
+    './rules/style',
+    './rules/variables',
+  ].map(require.resolve),
+  rules: {},
+};

package/configs/base/rules/best-practices.js

@@ -0,0 +1,356 @@
+module.exports = {
+  rules: {
+    // enforces getter/setter pairs in objects
+    'accessor-pairs': 'off',
+
+    // enforces return statements in callbacks of array's methods
+    // https://eslint.org/docs/rules/array-callback-return
+    'array-callback-return': ['error', { allowImplicit: true }],
+
+    // treat var statements as if they were block scoped
+    'block-scoped-var': 'error',
+
+    // specify the maximum cyclomatic complexity allowed in a program
+    complexity: ['off', 11],
+
+    // enforce that class methods use "this"
+    // https://eslint.org/docs/rules/class-methods-use-this
+    'class-methods-use-this': ['error', {
+      exceptMethods: [],
+    }],
+
+    // require return statements to either always or never specify values
+    'consistent-return': 'error',
+
+    // specify curly brace conventions for all control statements
+    curly: ['error', 'multi-line'], // multiline
+
+    // require default case in switch statements
+    'default-case': ['error', { commentPattern: '^no default$' }],
+
+    // https://eslint.org/docs/rules/default-param-last
+    // TODO: enable, semver-minor, when eslint v6.4 is required (which is a major)
+    'default-param-last': 'off',
+
+    // encourages use of dot notation whenever possible
+    'dot-notation': ['error', { allowKeywords: true }],
+
+    // enforces consistent newlines before or after dots
+    // https://eslint.org/docs/rules/dot-location
+    'dot-location': ['error', 'property'],
+
+    // require the use of === and !==
+    // https://eslint.org/docs/rules/eqeqeq
+    eqeqeq: ['error', 'always', { null: 'ignore' }],
+
+    // Require grouped accessor pairs in object literals and classes
+    // https://eslint.org/docs/rules/grouped-accessor-pairs
+    // TODO: enable in next major, altho the guide forbids getters/setters anyways
+    'grouped-accessor-pairs': 'off',
+
+    // make sure for-in loops have an if statement
+    'guard-for-in': 'error',
+
+    // enforce a maximum number of classes per file
+    // https://eslint.org/docs/rules/max-classes-per-file
+    'max-classes-per-file': ['error', 1],
+
+    // disallow the use of alert, confirm, and prompt
+    'no-alert': 'warn',
+
+    // disallow use of arguments.caller or arguments.callee
+    'no-caller': 'error',
+
+    // disallow lexical declarations in case/default clauses
+    // https://eslint.org/docs/rules/no-case-declarations.html
+    'no-case-declarations': 'error',
+
+    // Disallow returning value in constructor
+    // https://eslint.org/docs/rules/no-constructor-return
+    // TODO: enable, semver-major
+    'no-constructor-return': 'off',
+
+    // disallow division operators explicitly at beginning of regular expression
+    // https://eslint.org/docs/rules/no-div-regex
+    'no-div-regex': 'off',
+
+    // disallow else after a return in an if
+    // https://eslint.org/docs/rules/no-else-return
+    'no-else-return': ['error', { allowElseIf: false }],
+
+    // disallow empty functions, except for standalone funcs/arrows
+    // https://eslint.org/docs/rules/no-empty-function
+    'no-empty-function': ['error', {
+      allow: [
+        'arrowFunctions',
+        'functions',
+        'methods',
+      ],
+    }],
+
+    // disallow empty destructuring patterns
+    // https://eslint.org/docs/rules/no-empty-pattern
+    'no-empty-pattern': 'error',
+
+    // disallow comparisons to null without a type-checking operator
+    'no-eq-null': 'off',
+
+    // disallow use of eval()
+    'no-eval': 'error',
+
+    // disallow adding to native types
+    'no-extend-native': 'error',
+
+    // disallow unnecessary function binding
+    'no-extra-bind': 'error',
+
+    // disallow Unnecessary Labels
+    // https://eslint.org/docs/rules/no-extra-label
+    'no-extra-label': 'error',
+
+    // disallow fallthrough of case statements
+    'no-fallthrough': 'error',
+
+    // disallow the use of leading or trailing decimal points in numeric literals
+    'no-floating-decimal': 'error',
+
+    // disallow reassignments of native objects or read-only globals
+    // https://eslint.org/docs/rules/no-global-assign
+    'no-global-assign': ['error', { exceptions: [] }],
+    // deprecated in favor of no-global-assign
+    'no-native-reassign': 'off',
+
+    // disallow implicit type conversions
+    // https://eslint.org/docs/rules/no-implicit-coercion
+    'no-implicit-coercion': ['off', {
+      boolean: false,
+      number: true,
+      string: true,
+      allow: [],
+    }],
+
+    // disallow var and named functions in global scope
+    // https://eslint.org/docs/rules/no-implicit-globals
+    'no-implicit-globals': 'off',
+
+    // disallow use of eval()-like methods
+    'no-implied-eval': 'error',
+
+    // disallow this keywords outside of classes or class-like objects
+    'no-invalid-this': 'off',
+
+    // disallow usage of __iterator__ property
+    'no-iterator': 'error',
+
+    // disallow use of labels for anything other then loops and switches
+    'no-labels': ['error', { allowLoop: false, allowSwitch: false }],
+
+    // disallow unnecessary nested blocks
+    'no-lone-blocks': 'error',
+
+    // disallow creation of functions within loops
+    'no-loop-func': 'error',
+
+    // disallow magic numbers
+    // https://eslint.org/docs/rules/no-magic-numbers
+    'no-magic-numbers': ['off', {
+      ignore: [],
+      ignoreArrayIndexes: true,
+      enforceConst: true,
+      detectObjects: false,
+    }],
+
+    // disallow use of multiple spaces
+    'no-multi-spaces': ['error', {
+      ignoreEOLComments: false,
+    }],
+
+    // disallow use of multiline strings
+    'no-multi-str': 'error',
+
+    // disallow use of new operator when not part of the assignment or comparison
+    'no-new': 'error',
+
+    // disallow use of new operator for Function object
+    'no-new-func': 'error',
+
+    // disallows creating new instances of String, Number, and Boolean
+    'no-new-wrappers': 'error',
+
+    // disallow use of (old style) octal literals
+    'no-octal': 'error',
+
+    // disallow use of octal escape sequences in string literals, such as
+    // var foo = 'Copyright \251';
+    'no-octal-escape': 'error',
+
+    // disallow reassignment of function parameters
+    // disallow parameter object manipulation except for specific exclusions
+    // rule: https://eslint.org/docs/rules/no-param-reassign.html
+    'no-param-reassign': ['error', {
+      props: true,
+      ignorePropertyModificationsFor: [
+        'acc', // for reduce accumulators
+        'accumulator', // for reduce accumulators
+        'e', // for e.returnvalue
+        'ctx', // for Koa routing
+        'req', // for Express requests
+        'request', // for Express requests
+        'res', // for Express responses
+        'response', // for Express responses
+        '$scope', // for Angular 1 scopes
+        'staticContext', // for ReactRouter context
+      ],
+    }],
+
+    // disallow usage of __proto__ property
+    'no-proto': 'error',
+
+    // disallow declaring the same variable more then once
+    'no-redeclare': 'error',
+
+    // disallow certain object properties
+    // https://eslint.org/docs/rules/no-restricted-properties
+    'no-restricted-properties': ['error',
+      {
+        object: 'arguments',
+        property: 'callee',
+        message: 'arguments.callee is deprecated',
+      }, {
+        object: 'global',
+        property: 'isFinite',
+        message: 'Please use Number.isFinite instead',
+      }, {
+        object: 'self',
+        property: 'isFinite',
+        message: 'Please use Number.isFinite instead',
+      }, {
+        object: 'window',
+        property: 'isFinite',
+        message: 'Please use Number.isFinite instead',
+      }, {
+        object: 'global',
+        property: 'isNaN',
+        message: 'Please use Number.isNaN instead',
+      }, {
+        object: 'self',
+        property: 'isNaN',
+        message: 'Please use Number.isNaN instead',
+      }, {
+        object: 'window',
+        property: 'isNaN',
+        message: 'Please use Number.isNaN instead',
+      }, {
+        property: '__defineGetter__',
+        message: 'Please use Object.defineProperty instead.',
+      }, {
+        property: '__defineSetter__',
+        message: 'Please use Object.defineProperty instead.',
+      }, {
+        object: 'Math',
+        property: 'pow',
+        message: 'Use the exponentiation operator (**) instead.',
+      }],
+
+    // disallow use of assignment in return statement
+    'no-return-assign': ['error', 'always'],
+
+    // disallow redundant `return await`
+    'no-return-await': 'error',
+
+    // disallow use of `javascript:` urls.
+    'no-script-url': 'error',
+
+    // disallow self assignment
+    // https://eslint.org/docs/rules/no-self-assign
+    'no-self-assign': ['error', {
+      props: true,
+    }],
+
+    // disallow comparisons where both sides are exactly the same
+    'no-self-compare': 'error',
+
+    // disallow use of comma operator
+    'no-sequences': 'error',
+
+    // restrict what can be thrown as an exception
+    'no-throw-literal': 'error',
+
+    // disallow unmodified conditions of loops
+    // https://eslint.org/docs/rules/no-unmodified-loop-condition
+    'no-unmodified-loop-condition': 'off',
+
+    // disallow usage of expressions in statement position
+    'no-unused-expressions': ['error', {
+      allowShortCircuit: false,
+      allowTernary: false,
+      allowTaggedTemplates: false,
+    }],
+
+    // disallow unused labels
+    // https://eslint.org/docs/rules/no-unused-labels
+    'no-unused-labels': 'error',
+
+    // disallow unnecessary .call() and .apply()
+    'no-useless-call': 'off',
+
+    // Disallow unnecessary catch clauses
+    // https://eslint.org/docs/rules/no-useless-catch
+    'no-useless-catch': 'error',
+
+    // disallow useless string concatenation
+    // https://eslint.org/docs/rules/no-useless-concat
+    'no-useless-concat': 'error',
+
+    // disallow unnecessary string escaping
+    // https://eslint.org/docs/rules/no-useless-escape
+    'no-useless-escape': 'error',
+
+    // disallow redundant return; keywords
+    // https://eslint.org/docs/rules/no-useless-return
+    'no-useless-return': 'error',
+
+    // disallow use of void operator
+    // https://eslint.org/docs/rules/no-void
+    'no-void': 'error',
+
+    // disallow usage of configurable warning terms in comments: e.g. todo
+    'no-warning-comments': ['off', { terms: ['todo', 'fixme', 'xxx'], location: 'start' }],
+
+    // disallow use of the with statement
+    'no-with': 'error',
+
+    // require using Error objects as Promise rejection reasons
+    // https://eslint.org/docs/rules/prefer-promise-reject-errors
+    'prefer-promise-reject-errors': ['error', { allowEmptyReject: true }],
+
+    // Suggest using named capture group in regular expression
+    // https://eslint.org/docs/rules/prefer-named-capture-group
+    'prefer-named-capture-group': 'off',
+
+    // https://eslint.org/docs/rules/prefer-regex-literals
+    // TODO; enable, semver-minor, once eslint v6.4 is required (which is a major)
+    'prefer-regex-literals': 'off',
+
+    // require use of the second argument for parseInt()
+    radix: 'error',
+
+    // require `await` in `async function` (note: this is a horrible rule that should never be used)
+    // https://eslint.org/docs/rules/require-await
+    'require-await': 'off',
+
+    // Enforce the use of u flag on RegExp
+    // https://eslint.org/docs/rules/require-unicode-regexp
+    'require-unicode-regexp': 'off',
+
+    // requires to declare all vars on top of their containing scope
+    'vars-on-top': 'error',
+
+    // require immediate function invocation to be wrapped in parentheses
+    // https://eslint.org/docs/rules/wrap-iife.html
+    'wrap-iife': ['error', 'outside', { functionPrototypeMethods: false }],
+
+    // require or disallow Yoda conditions
+    yoda: 'error',
+  },
+};

package/configs/base/rules/errors.js

@@ -0,0 +1,154 @@
+module.exports = {
+  rules: {
+    // Enforce “for” loop update clause moving the counter in the right direction
+    // https://eslint.org/docs/rules/for-direction
+    'for-direction': 'error',
+
+    // Enforces that a return statement is present in property getters
+    // https://eslint.org/docs/rules/getter-return
+    'getter-return': ['error', { allowImplicit: true }],
+
+    // disallow using an async function as a Promise executor
+    // https://eslint.org/docs/rules/no-async-promise-executor
+    'no-async-promise-executor': 'error',
+
+    // Disallow await inside of loops
+    // https://eslint.org/docs/rules/no-await-in-loop
+    'no-await-in-loop': 'error',
+
+    // Disallow comparisons to negative zero
+    // https://eslint.org/docs/rules/no-compare-neg-zero
+    'no-compare-neg-zero': 'error',
+
+    // disallow assignment in conditional expressions
+    'no-cond-assign': ['error', 'always'],
+
+    // disallow use of console
+    'no-console': ['warn', { allow: ['warn', 'error'] }],
+
+    // disallow use of constant expressions in conditions
+    'no-constant-condition': 'warn',
+
+    // disallow control characters in regular expressions
+    'no-control-regex': 'error',
+
+    // disallow use of debugger
+    'no-debugger': 'error',
+
+    // disallow duplicate arguments in functions
+    'no-dupe-args': 'error',
+
+    // Disallow duplicate conditions in if-else-if chains
+    // https://eslint.org/docs/rules/no-dupe-else-if
+    // TODO: enable, semver-major
+    'no-dupe-else-if': 'off',
+
+    // disallow duplicate keys when creating object literals
+    'no-dupe-keys': 'error',
+
+    // disallow a duplicate case label.
+    'no-duplicate-case': 'error',
+
+    // disallow empty statements
+    'no-empty': 'error',
+
+    // disallow the use of empty character classes in regular expressions
+    'no-empty-character-class': 'error',
+
+    // disallow assigning to the exception in a catch block
+    'no-ex-assign': 'error',
+
+    // disallow double-negation boolean casts in a boolean context
+    // https://eslint.org/docs/rules/no-extra-boolean-cast
+    'no-extra-boolean-cast': 'error',
+
+    // disallow unnecessary parentheses
+    // https://eslint.org/docs/rules/no-extra-parens
+    'no-extra-parens': ['off', 'all', {
+      conditionalAssign: true,
+      nestedBinaryExpressions: false,
+      returnAssign: false,
+      ignoreJSX: 'all', // delegate to eslint-plugin-react
+      enforceForArrowConditionals: false,
+    }],
+
+    // disallow unnecessary semicolons
+    'no-extra-semi': 'error',
+
+    // disallow overwriting functions written as function declarations
+    'no-func-assign': 'error',
+
+    // https://eslint.org/docs/rules/no-import-assign
+    // TODO: enable, semver-minor, once eslint v6.4 is required (which is a major)
+    'no-import-assign': 'off',
+
+    // disallow function or variable declarations in nested blocks
+    'no-inner-declarations': 'error',
+
+    // disallow invalid regular expression strings in the RegExp constructor
+    'no-invalid-regexp': 'error',
+
+    // disallow irregular whitespace outside of strings and comments
+    'no-irregular-whitespace': 'error',
+
+    // Disallow characters which are made with multiple code points in character class syntax
+    // https://eslint.org/docs/rules/no-misleading-character-class
+    'no-misleading-character-class': 'error',
+
+    // disallow the use of object properties of the global object (Math and JSON) as functions
+    'no-obj-calls': 'error',
+
+    // disallow use of Object.prototypes builtins directly
+    // https://eslint.org/docs/rules/no-prototype-builtins
+    'no-prototype-builtins': 'error',
+
+    // disallow multiple spaces in a regular expression literal
+    'no-regex-spaces': 'error',
+
+    // Disallow returning values from setters
+    // https://eslint.org/docs/rules/no-setter-return
+    // TODO: enable, semver-major (altho the guide forbids getters/setters already)
+    'no-setter-return': 'off',
+
+    // disallow sparse arrays
+    'no-sparse-arrays': 'error',
+
+    // Disallow template literal placeholder syntax in regular strings
+    // https://eslint.org/docs/rules/no-template-curly-in-string
+    'no-template-curly-in-string': 'error',
+
+    // Avoid code that looks like two expressions but is actually one
+    // https://eslint.org/docs/rules/no-unexpected-multiline
+    'no-unexpected-multiline': 'error',
+
+    // disallow unreachable statements after a return, throw, continue, or break statement
+    'no-unreachable': 'error',
+
+    // disallow return/throw/break/continue inside finally blocks
+    // https://eslint.org/docs/rules/no-unsafe-finally
+    'no-unsafe-finally': 'error',
+
+    // disallow negating the left operand of relational operators
+    // https://eslint.org/docs/rules/no-unsafe-negation
+    'no-unsafe-negation': 'error',
+    // disallow negation of the left operand of an in expression
+    // deprecated in favor of no-unsafe-negation
+    'no-negated-in-lhs': 'off',
+
+    // Disallow assignments that can lead to race conditions due to usage of await or yield
+    // https://eslint.org/docs/rules/require-atomic-updates
+    // TODO: enable, semver-major
+    'require-atomic-updates': 'off',
+
+    // disallow comparisons with the value NaN
+    'use-isnan': 'error',
+
+    // ensure JSDoc comments are valid
+    // https://eslint.org/docs/rules/valid-jsdoc
+    'valid-jsdoc': 'off',
+
+    // ensure that the results of typeof are compared against a valid string
+    // https://eslint.org/docs/rules/valid-typeof
+    'valid-typeof': ['error', { requireStringLiterals: true }],
+  },
+};