This package includes ESLint configuration files, this configuration files only include rules to prevent environment problems and conflicts with other rules.
Currently, there is 2 configurations:
javascript
- the default one that includes ESLint rules onlytypescript
- includes typescript/eslint rules only
npm i -D eslint-config-vamp
The javascript configuration requires only eslint
package to be installed.
.eslintrc.json
{
"extends": [
"vamp/javascript"
]
}
Example of advanced configuration with javascript
:
Packages required:
eslint
eslint-config-prettier
.eslintrc.json
{
"extends": [
"eslint:recommended",
"vamp/javascript",
"prettier"
]
}
The typescript configuration require those packages in order to work:
eslint
@typescript-eslint/eslint-plugin
@typescript-eslint/parser
.eslintrc.json
{
"extends": [
"vamp/javascript",
"vamp/typescript"
]
}
Example of advanced configuration with typescript
:
Packages required:
eslint
@typescript-eslint/eslint-plugin
@typescript-eslint/parser
prettier
.eslintrc.json
{
"extends": [
"eslint:recommended",
"vamp/javascript",
"plugin:@typescript-eslint/recommended",
"vamp/typescript",
"prettier"
]
}
All the rules considered as best practices but some of them can make to your existing projects problems, so those rules can be disabled easily with the rules object:
{
"rules": {
"id-length": "off",
"max-classes-per-file": "off",
"max-depth": "off",
"max-nested-callbacks": "off",
"max-params": "off"
}
}