evgenyorekhov/eslint-config-hardcore

The most strict (yet practical) ESLint config. 53 plugins. 1333 rules. React, Vue, Node, and pure JS/TS.

eslint-config-hardcore

The most strict (yet practical) ESLint config.

Aims to include as many plugins and rules as possible to make your code extremely consistent and robust.

53 plugins. 1333 rules.

Usage

npm install eslint-config-hardcore --save-dev

Available configs:

• hardcore - base framework-agnostic config
• hardcore/ts - additional config for TypeScript
• hardcore/node- additional config for Node.js
• hardcore/react - additional config for React
• hardcore/react-performance - additional React config with performance rules
• hardcore/vue - additional config for Vue 3/Nuxt 3
• hardcore/react-testing-library - additional config for React Testing Library
• hardcore/jest - additional config for Jest
• hardcore/fp - additional config for functional programming
• hardcore/ts-for-js - additional config for linting JavaScript with typescript-eslint

Example .eslintrc.json for a React project:

{
  "root": true,

  "extends": [
    "hardcore",
    "hardcore/react",
    "hardcore/react-performance",
    "hardcore/react-testing-library",
    "hardcore/jest",
    "hardcore/fp"
  ],

  "env": {
    "browser": true
  },

  "overrides": [
    {
      "files": ["server/**/*.js"],

      "extends": ["hardcore/node"],

      "env": {
        "browser": false
      }
    }
  ]
}

Example .eslintrc.json for a TypeScript React project:

{
  "root": true,

  "extends": [
    "hardcore",
    "hardcore/react",
    "hardcore/react-performance",
    "hardcore/react-testing-library",
    "hardcore/jest",
    "hardcore/fp",
    "hardcore/ts"
  ],

  "parserOptions": {
    "project": true
  },

  "env": {
    "browser": true
  },

  "overrides": [
    {
      "files": ["server/**/*.ts"],

      "extends": ["hardcore/node"],

      "env": {
        "browser": false
      }
    }
  ]
}

Example .eslintrc.json for a Vue 3 project:

{
  "root": true,

  "extends": ["hardcore", "hardcore/vue"],

  "settings": {
    "import/resolver": {
      "alias": {
        "map": [["@", "./src/"]],
        "extensions": [".js", ".vue"]
      }
    }
  }
}

Example .eslintrc.json for a Nuxt 3 project:

{
  "root": true,

  "extends": ["hardcore", "hardcore/vue"],

  "settings": {
    "import/resolver": {
      "alias": {
        "map": [
          ["@", "./"],
          ["#imports", ".nuxt/imports.d.ts"]
        ],

        "extensions": [".js", ".vue"]
      }
    }
  }
}

Example .eslintrc.json for a TypeScript Vue 3 project (depending on project configuration, you might want to change "project": true to "project": "tsconfig.app.json"):

{
  "root": true,

  "extends": ["hardcore", "hardcore/ts", "hardcore/vue"],

  "parserOptions": {
    "project": true
  },

  "overrides": [
    {
      "files": [
        "vite.config.*",
        "vitest.config.*",
        "cypress.config.*",
        "playwright.config.*"
      ],

      "parserOptions": {
        "project": "tsconfig.node.json"
      }
    },

    {
      "files": ["src/**/__tests__/*"],

      "parserOptions": {
        "project": "tsconfig.vitest.json"
      }
    }
  ]
}

Example .eslintrc.json for a TypeScript Nuxt 3 project:

{
  "root": true,

  "extends": ["hardcore", "hardcore/ts", "hardcore/vue"],

  "parserOptions": {
    "project": true
  }
}

Configs

hardcore

Base framework-agnostic config.

Plugin	Enabled rules
ESLint core rules	180
eslint-plugin-unicorn	97
eslint-plugin-regexp	80
eslint-plugin-putout	73
eslint-plugin-sonar	51
eslint-plugin-import	33
eslint-plugin-sonarjs	31
HTML ESLint	22
eslint-plugin-promise	13
eslint-plugin-security	12
eslint-plugin-perfectionist	7
eslint-plugin-eslint-comments	6
eslint-plugin-sdl	5
eslint-plugin-array-func	3
eslint-plugin-unused-imports	2
eslint-plugin-simple-import-sort	2
eslint-plugin-no-constructor-bind	1
eslint-plugin-no-unsanitized	2
@shopify/eslint-plugin	1
eslint-plugin-no-use-extend-native	1
eslint-plugin-ext	1
eslint-plugin-no-only-tests	1
eslint-plugin-compat	1
eslint-plugin-json¹	1
eslint-plugin-yml¹	1
eslint-plugin-toml¹	1
Total:	637

¹ json/yml/toml plugins actually include several rules, but I consider each plugin as a single "no-invalid" rule.

hardcore/ts

Config for TypeScript.

Plugin	Enabled rules
typescript-eslint	105
eslint-plugin-etc	10
eslint-plugin-total-functions	8
@shopify/eslint-plugin	3
eslint-plugin-sonar	1
eslint-plugin-sort-class-members	1
eslint-plugin-decorator-position	1
eslint-plugin-no-explicit-type-exports	1
eslint-plugin-typescript-compat	1
Total:	131

hardcore/node

Config for Node.js.

Plugin	Enabled rules
eslint-plugin-sonar	53
eslint-plugin-n	35
eslint-plugin-sdl	1
Total:	89

hardcore/react

Config for React.

Plugin	Enabled rules
eslint-plugin-react	74
eslint-plugin-styled-components-a11y	33
eslint-plugin-jsx-a11y	34
eslint-plugin-storybook	14
eslint-plugin-react-form-fields	4
eslint-plugin-ssr-friendly	4
@shopify/eslint-plugin	3
eslint-plugin-react-hook-form	3
eslint-plugin-react-hooks	2
eslint-plugin-sonar	2
eslint-plugin-validate-jsx-nesting	1
eslint-plugin-react-prefer-function-component	1
Total:	175

hardcore/react-performance

Config with performance rules for React.

Plugin	Enabled rules
eslint-plugin-react	4
eslint-plugin-react-perf	4
eslint-plugin-react-usememo	1
Total:	9

hardcore/vue

Config for Vue 3/Nuxt 3.

Plugin	Enabled rules
eslint-plugin-vue	168
eslint-plugin-vuejs-accessibility	20
eslint-plugin-vue-scoped-css	12
eslint-plugin-sonar	1
Total:	201

hardcore/react-testing-library

Config for React Testing Library.

Plugin	Enabled rules
eslint-plugin-testing-library	24
Total:	24

hardcore/jest

Config for Jest.

Plugin	Enabled rules
eslint-plugin-jest	49
eslint-plugin-jest-dom	11
eslint-plugin-jest-formatting	7
Total:	67

hardcore/fp

Config for functional programming.

Plugin	Enabled rules
eslint-plugin-functional	9
Total:	9

hardcore/ts-for-js

Config for linting JavaScript with typescript-eslint.

Plugin	Enabled rules
typescript-eslint	28
eslint-plugin-etc	4
@shopify/eslint-plugin	2
eslint-plugin-sort-class-members	1
eslint-plugin-decorator-position	1
eslint-plugin-typescript-compat	1
Total:	37

Did you know you can lint JavaScript code with typescript-eslint?

Use this config to take advantage of typescript-eslint's advanced type-aware rules (like @typescript-eslint/naming-convention and @typescript-eslint/prefer-optional-chain) without the need to switch to writing TypeScript.

1. First, you'll need to create tsconfig.json in the root of your project. You don't have to specify any options, just {} should do it.
2. Then add hardcore/ts-for-js to the overrides section in your .eslintrc like this:

{
  "extends": ["hardcore"],

  "env": {
    "browser": true
  },

  "overrides": [
    {
      "files": ["*.js"],
      "extends": ["hardcore/ts-for-js"],
      "parserOptions": {
        "project": true
      }
    }
  ]
}

Changelog

License

MIT

eslint-config-hardcore's Issues

Perhaps the "object-property-newline" rule is too strict

Compare:

h(
    Component,
    {
        someProp: 123,
        anotherProp: 321
    },
    [
        h(Component, {
            someProp: 123,
            anotherProp: 321
        }),
        h(Component, {
            someProp: 123,
            anotherProp: 321
        }),
        h(
            Component,
            {
                someProp: 123,
                anotherProp: 321
            },
            [
                h(Component, {
                    someProp: 123,
                    anotherProp: 321
                }),
                h(Component, {
                    someProp: 123,
                    anotherProp: 321
                })
            ]
        )
    ]
);

h(Component, {someProp: 123, anotherProp: 321}, [
    h(Component, {someProp: 123, anotherProp: 321}),
    h(Component, {someProp: 123, anotherProp: 321}),
    h(Component, {someProp: 123, anotherProp: 321}, [
        h(Component, {someProp: 123, anotherProp: 321}),
        h(Component, {someProp: 123, anotherProp: 321})
    ])
]);

Perhaps the "object-property-newline" rule should be reconfigured to

["error", {"allowAllPropertiesOnSameLine": true}]

unicorn/regex-shorthand vs eslint-plugin-optimize-regex

See sindresorhus/eslint-plugin-unicorn#473

Update examples for `hardcore/node`

Do not declare the node env:

• in README.md
• in release notes

Consider adding eslint-plugin-functional

• Compare https://github.com/jonaskello/eslint-plugin-functional with https://github.com/jfmengels/eslint-plugin-fp

Add eslint-plugin-optimize-regex

https://github.com/BrainMaestro/eslint-plugin-optimize-regex

Resolve conflict between padded-blocks and lines-around-comment

function checkAuthorization({id, pwd}) {
    // promisified

Produces: Expected line before comment. (lines-around-comment)

function checkAuthorization({id, pwd}) {

    // promisified

Produces: Block must not be padded by blank lines. (padded-blocks)

Submit eslint-config-hardcore to Awesome ESLint

https://github.com/dustinspecker/awesome-eslint

Add more plugins

Add eslint-find-rules to CI

https://github.com/sarbbottam/eslint-find-rules

Add eslint-plugin-no-use-extend-native

https://github.com/dustinspecker/eslint-plugin-no-use-extend-native

Add eslint-plugin-eslint-comments

https://github.com/mysticatea/eslint-plugin-eslint-comments

Choose between unicorn/prefer-spread and array-func/prefer-array-from

https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/prefer-spread.md

https://github.com/freaktechnik/eslint-plugin-array-func#prefer-array-from

https://stackoverflow.com/questions/40548213/array-from-vs-spread-syntax

Crash in projects without *.js files

See import-js/eslint-plugin-import#1645.

TODO:

• Verify if adding plugin:import/typescript to extends can solve this (see https://github.com/benmosher/eslint-plugin-import#typescript). Update: it doesn't solve the issue, it's not related to TypeScript.

Add linting of hidden files

Add ignorePatterns with "!.*". Don't forget to add default ignore patterns.

Add eslint-plugin-array-func

https://github.com/freaktechnik/eslint-plugin-array-func

Add eslint-plugin-json-format

https://github.com/bkucera/eslint-plugin-json-format

• Wait for kuceb/eslint-plugin-json-format#14
• Wait for a new release

Replace es6 env with es2020

https://github.com/eslint/eslint/blob/master/conf/environments.js

Add smoke test

1. Create .eslintrc.json file with the following contents: {"extends": ["./index.json"]}.
2. Change the test script to node test.js && eslint **/*.js.

Enable the "unicorn/prevent-abbreviations" rule

https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/prevent-abbreviations.md

It needs to be battle-tested first.

• Check for open issues for the rule before starting working on this issue: https://github.com/sindresorhus/eslint-plugin-unicorn/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+abbreviations

Automate releasing

The simplest way is

"preversion": "npm test",
"postversion": "git push && git push --tags && npm publish"

Investigate:

• https://github.com/semantic-release/semantic-release (aims to make releasing fully automatic)
• https://github.com/zeit/release (not standardized, the scope is limited only to publishing changelogs to GitHub releases)
• https://github.com/commitizen/cz-cli (uses an interactive prompt on commit, guides you to create a valid commit message, which is better than just throwing an "Invalid format" error; not sure how it would work for intermediate WIP-commits)
• https://github.com/conventional-changelog/commitlint
• https://github.com/jlegrone/create-semantic-module (I have enough experience to know that it's better to use the original tool than a wrapper)
• https://github.com/conventional-changelog/conventional-changelog (recommends using standard-version or semantic-release)
• https://github.com/conventional-changelog/standard-version (unlike semantic-release, it doesn't aim to fully automate the release process)
• https://github.com/changesets/changesets

Enable "node" env in `hardcore/node`

Or not?

Set "non-zero" option for "explicit-length-check" rule

https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/explicit-length-check.md#non-zero-comparisons

Remove eslint-plugin-no-secrets

1. It may produce many false positives
2. It can't catch secrets where they are most common (configs)

Conflict with index files

There is a conflict between import/extensions, import/no-useless-path-segments, and unicorn/import-index, when referencing index files, e. g. ./index.js.

Add eslint-plugin-json-files

https://github.com/kellyselden/eslint-plugin-json-files

Waiting for:

• kellyselden/eslint-plugin-json-files#40 (blocker)
• kellyselden/eslint-plugin-json-files#35
• kellyselden/eslint-plugin-json-files#36
• kellyselden/eslint-plugin-json-files#37
• kellyselden/eslint-plugin-json-files#38
• kellyselden/eslint-plugin-json-files#39

Enable the "enforceInMethodNames" option for the "no-underscore-dangle" rule

https://eslint.org/docs/rules/no-underscore-dangle#enforceinmethodnames

Add eslint-plugin-json

https://github.com/azeemba/eslint-plugin-json

Enable "builtinGlobals" option for "no-shadow" rule

https://eslint.org/docs/rules/no-shadow#builtinglobals

It could be a breaking change for some codebases.

Add eslint-plugin-sort-class-members

https://github.com/bryanrsmith/eslint-plugin-sort-class-members

• Wait until class properties are part of ECMAScript

Add eslint-plugin-security

https://github.com/nodesecurity/eslint-plugin-security

Move disabled rules out of the config

A Shareable Config should not disable rules.

Add "files" to package.json

The "newline-per-chained-call" rule is incompatible with the latest JSLint

JSLint's rule for chained calls is different now.

The "newline-per-chained-call" rule should be disabled.

Add common ignore patterns

• https://github.com/EvgenyOrekhov/lints/blob/master/src/default.lints.json#L3
• EvgenyOrekhov/lints#32

Review "import/extensions" rule

A file extension must be provided when using the import keyword. Directory indexes (e.g. './startup/index.js') must also be fully specified.

https://nodejs.org/api/esm.html#esm_mandatory_file_extensions

Add eslint-plugin-node

https://github.com/mysticatea/eslint-plugin-node

Remove the rules that are already enabled in the configs that we extend

• https://github.com/eslint/eslint/blob/master/conf/eslint-recommended.js
• https://github.com/xjamundx/eslint-plugin-promise/blob/master/index.js

Add 1 to the list of non-magic numbers?

Or not?

Turn on the "strict" rule

Turn on the "strict" rule when eslint/eslint#8953 is resolved.

Add eslint-plugin-import

https://github.com/benmosher/eslint-plugin-import

Add more configs

• Move eslint-config-hardcore-fp to hardcore/fp
• Add hardcore/node

One would use them like this:

{
    "extends": ["hardcore", "hardcore/fp"],
    "overrides": [
        {
            "files": ["server/**/*.js"],
            "extends": ["hardcore/node"]
        }
    ]
}

Add varsIgnorePattern and argsIgnorePattern to no-unused-vars

• https://eslint.org/docs/rules/no-unused-vars#varsignorepattern
• https://eslint.org/docs/rules/no-unused-vars#argsignorepattern

Add eslint-plugin-no-constructor-bind

https://github.com/markalfred/eslint-plugin-no-constructor-bind

Add eslint-plugin-sonarjs

https://github.com/SonarSource/eslint-plugin-sonarjs

Add eslint-plugin-no-secrets

https://github.com/nickdeis/eslint-plugin-no-secrets

Add eslint-plugin-unicorn

https://github.com/sindresorhus/eslint-plugin-unicorn

Get rid of `eslint . --ext .json` requirement for linting JSON

eslint/eslint#12677

There will probably be proper documentation once ESLint 7.0.0 is released.

Relax no-shadow rule

"hoist": "all" seems too strict. Perhaps it should have the default functions value.

Or not?

Note: JSLint works the same as the all value.

Add eslint-plugin-ramda

https://github.com/ramda/eslint-plugin-ramda

The "indent" rule is incompatible with the latest JSLint

JSLint's rule for the ternary operator is different now.

Should change the "indent" rule to

        "indent": [
            "error",
            4,
            { 
                "ignoredNodes": [
                    "ConditionalExpression"
                ]
            }
        ],