@sumerian/eslint-config

ESLint config by Sumerian for Sumerians

Installation

npm i --D eslint @sumerian/eslint-config

This package only contains rules. It doesn't modify env, parserOptions, etc. We recommend adding the following .eslintrc.json in your project root:

{
  "env": {
    "browser": true,
    "node": true,
    "es2020": true
  },
  "extends": [
    "eslint:recommended",
    "@sumerian"
  ],
  "parserOptions": {
    "ecmaVersion": 11,
    "sourceType": "module"
  }
}

Rules worth reviewing

eslint:recommended rules turned off

• no-prototype-builtins

Ignored rules

The developer who configured our current ESLint version didn't know what this rules mean or didn't have a strong opinion. Ignored rules included in eslint:recommended aren't overwritten, so they're still available.

• no-control-regex
• no-irregular-whitespace
• no-misleading-character-class
• no-unreachable-loop
• no-useless-backreference
• consistent-return
• no-div-regex
• no-unused-expressions
• no-void
• no-with
• prefer-named-capture-group
• prefer-regex-literals
• require-unicode-regexp
• wrap-iife
• func-names
• func-style
• function-paren-newline
• jsx-quotes
• new-parens
• newline-per-chained-call
• one-var
• one-var-declaration-per-line
• padding-line-between-statements
• unicode-bom
• no-new-symbol
• require-yield
• symbol-description
• yield-star-spacing

Other observations

• accessor-pairs has the default options. It doesn't warn for getters without setters.
• class-methods-use-this is ignored because we don't allow usage of class.
• max-classes-per-file is ignored because we don't allow usage of class.
• no-constructor-return is ignored because we don't allow usage of class.
• no-eq-null is ignored because eqeqeq is set to smart.