Different style configs ready to be used in multiple Scorum projects
npm install @scorum/js-style
Shared ESLint config for Scorum projects
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.
Required dependencies for ALL configs
``bashdependencies only for all configs
npm install --save-de eslint eslint-config-scorum
`
Additionall dependencies for base config
`bashdependencies only for base config
npm install --save-dev eslint babel-eslint eslint-config-scorum eslint-plugin-import
`
Additionall dependencies for react config
`bashdependencies only for react config
npm install --save-dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
`
Additionall dependencies for ramda config
`bashdependencies only for ramda config
npm install --save-dev eslint-plugin-ramda
`
Additionall dependencies for jest config
`bashdependencies only for jest config
npm install --save-dev eslint-plugin-ramda
`
Additionall dependencies for prettier config
`bashdependencies only for prettier config
npm install --save-dev prettier eslint-plugin-prettier
`
Create an .eslintrc file that extends this config. For more configuration options, check out the ESLint docs.
`json`
{
"extends": "scorum"
}
`json`
{
"extends": "scorum/react"
}
`json`
{
"extends": "scorum/node"
}
Server config includes base and node configs
`json`
{
"extends": "scorum/server"
}
This config for vanilla JS (includes base config)
`json`
{
"extends": "scorum/client"
}
`json`
{
"extends": "scorum/jest"
}
`json`
{
"extends": "scorum/ramda"
}
`json`
{
"extends": [
"scorum/prettier",
"scorum/prettier/react",
]
}
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": {}
}