@alza54/eslint-config-typescript
Shareable configuration for eslint
.
The main idea of this configuration is to:
- Be opinionated
- Be strict about syntax and secure by default
- Enforce best-practices
- Be nice for developer and pleasant to work with.
The goal of this project is to be nicer version of wemake-frontend-styleguide
.
Warning: this configuration has a very personal character.
Installation
npm install --save-dev @alza54/eslint-config-typescript
or yarn
yarn add -D @alza54/eslint-config-typescript
Then, modify your eslint
configuration:
{
"extends": [
"@alza54/typescript/base"
]
}
It's highly advised to use the recommended (more opinionated) config, which relies on Typescript's AST:
{
"extends": [
"@alza54/typescript/recommended"
]
}
Or option configuration "strict", which is even more strict, but requires your code to compile:
{
"extends": [
"@alza54/typescript/strict"
]
}
You can also extend config for eslint-plugin-import
, but usage of this plugin is not recommended by typescript-eslint.
{
"extends": [
"@alza54/typescript/import",
"@alza54/typescript/recommended"
]
}
Done! Later you can modify your configuration to include any extra rules you need.
License
MIT.