Scorum JavaScript Style Guide


Shared ESLint config for Scorum projects

Principles

Our lint rules are to help us write bug-free, readable and maintainable code.
Rules are usually added because the patterns they are checking for have been proven to be problematic
and frequently come up in code reviews.
The intention is to save both authors and reviewers time by providing the author early feedback at the time of writing.

Installation

$3

Required dependencies for ALL configs

``bash


dependencies only for all configs

npm install --save-de eslint eslint-config-scorum
`

$3

Additionall dependencies for base config

`bash


dependencies only for base config

npm install --save-dev eslint babel-eslint eslint-config-scorum eslint-plugin-import
`

$3

Additionall dependencies for react config

`bash


dependencies only for react config

npm install --save-dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
`

$3

Additionall dependencies for ramda config

`bash


dependencies only for ramda config

npm install --save-dev eslint-plugin-ramda
`

$3

Additionall dependencies for jest config

`bash


dependencies only for jest config

npm install --save-dev eslint-plugin-ramda
`

$3

Additionall dependencies for prettier config

`bash


dependencies only for prettier config

npm install --save-dev prettier eslint-plugin-prettier
`

Usage

Create an .eslintrc file that extends this config. For more configuration options, check out the ESLint docs.

$3

`json
{
"extends": "scorum"
}
`

$3

`json
{
"extends": "scorum/react"
}
`

$3

`json
{
"extends": "scorum/node"
}
`

$3

Server config includes base and node configs

`json
{
"extends": "scorum/server"
}
`

$3

This config for vanilla JS (includes base config)

`json
{
"extends": "scorum/client"
}
`

$3

`json
{
"extends": "scorum/jest"
}
`

$3

`json
{
"extends": "scorum/ramda"
}
`

$3

`json
{
"extends": [
"scorum/prettier",
"scorum/prettier/react",
]
}
`

$3

If you need to override or turn off rules:

If you need to override a rule, your .eslintrc.json file should look like the example below. All shared rules will be used, but eqeqeq will be turned off.

``json
{
"extends": "scorum",
"rules": {
"eqeqeq": "off"
},
"env": {},
"globals": {},
"rules": {}
}