README
eslint-config-significa
This package provides Significa's .eslintrc
extensible shared config.
Install
yarn add eslint babel-eslint @significa/eslint-config-significa --dev
Usage
Create a new file in the root of your project with name .eslintrc
, then extend the eslint config already installed.
{
"extends": "@significa/significa"
}
IDE Setup
Install Prettier and ESLint packages on your IDE. Set up Prettier to use Eslint's config .eslintrc
. We recommend checking the "Format on save" option on Prettier's package.
Atom
- Install linter-eslint
- Install prettier-atom
- Turn on "ESLint Integration" and "Format Files on Save" on
prettier-atom
Settings
VSCode
"prettier.eslintIntegration": true,
"[javascript]": {
"editor.formatOnSave": true
}
Overwriting rules
If you need to overwrite rules both in eslint or prettier, edit .eslintrc
file.
Example
{
"extends": "@significa/significa",
"rules": {
"semi": ["error", "always"],
"no-use-before-define": 0,
"prettier/prettier": [
"error",
{
"singleQuote": true,
"semi": true
}
]
}
}