@openinvest/eslint-config

@openinvest/eslint-config

OpenInvest ESLint config.

Usage

NOTE: For Node projects, you may want to disable no-console when extending this config, since console logging might be of use to you.

Install (macOS, Linux)

yarn add --dev @typescript-eslint/eslint-plugin \
               @typescript-eslint/parser \
               babel-eslint \
               eslint \
               prettier \
               eslint-config-prettier \
               eslint-plugin-prettier \
               eslint-plugin-react \
               eslint-plugin-react-native \
               typescript \
               @openinvest/eslint-config

Install (Windows)

yarn add --dev @typescript-eslint/eslint-plugin ^
               @typescript-eslint/parser ^
               babel-eslint ^
               eslint ^
               prettier ^
               eslint-config-prettier ^
               eslint-plugin-prettier ^
               eslint-plugin-react ^
               eslint-plugin-react-native ^
               typescript ^
               @openinvest/eslint-config

Update your .eslintrc.json

{
  // ...
  "extends": "@openinvest/eslint-config"
}

Set of rules

• accessor-pairs
• constructor-super
• curly
• dot-location
• eqeqeq
• handle-callback-err
• new-cap
• no-array-constructor
• no-caller
• no-class-assign
• no-compare-neg-zero
• no-cond-assign
• no-console
• no-const-assign
• no-constant-condition
• no-control-regex
• no-debugger
• no-delete-var
• no-dupe-args
• no-dupe-class-members
• no-dupe-keys
• no-duplicate-case
• no-else-return
• no-empty-character-class
• no-empty-pattern
• no-eval
• no-ex-assign
• no-extend-native
• no-extra-bind
• no-extra-boolean-cast
• no-extra-parens
• no-fallthrough
• no-floating-decimal
• no-func-assign
• no-global-assign
• no-implied-eval
• no-inner-declarations
• no-invalid-regexp
• no-iterator
• no-label-var
• no-labels
• no-lone-blocks
• no-lonely-if
• no-multi-str
• no-negated-in-lhs
• no-new-func
• no-new-object
• no-new-require
• no-new-symbol
• no-new-wrappers
• no-new
• no-obj-calls
• no-octal-escape
• no-octal
• no-path-concat
• no-proto
• no-redeclare
• no-return-assign
• no-return-await
• no-self-assign
• no-self-compare
• no-sequences
• no-shadow-restricted-names
• no-sparse-arrays
• no-this-before-super
• no-throw-literal
• no-undef-init
• no-undef
• no-unmodified-loop-condition
• no-unneeded-ternary
• no-unreachable
• no-unsafe-finally
• no-unsafe-negation
• no-useless-call
• no-useless-computed-key
• no-useless-constructor
• no-useless-escape
• no-useless-rename
• no-useless-return
• no-var
• no-with
• object-property-newline
• one-var
• prefer-arrow-callback
• prefer-promise-reject-errors
• prefer-template
• sort-vars
• strict
• symbol-description
• unicode-bom
• use-isnan
• valid-typeof
• wrap-iife
• yoda