README
eslint-config-flitto-typescript
Flitto Typescript Style Guide
Get Started
1. Installing packages
npm install --save-dev \
typescript@^4 \
eslint@^7.32.0 \
eslint-plugin-import@^2.22.1 \
eslint-plugin-node@^11.1.0 \
eslint-plugin-promise@^5.0.0 \
@typescript-eslint/eslint-plugin@^4.0.1 \
eslint-config-flitto-typescript@latest
Most of the packages need to be installed as Peer Dependency
of eslint-config-standard-with-typescript
package.
This list of dependencies is(same with eslint-config-standard-with-typescript):
- TypeScript, which you may already have installed
- ESLint
- 3 Peer dependencies of eslint-config-standard @typescript-eslint/eslint-plugin; ESLint rules for TypeScript.
- This package
2. Create Eslint configuration file
Create .eslintrc.json
file at the top of the project directory like below.
{
"parserOptions": {
"project": "./tsconfig.json"
},
"extends": "flitto-typescript",
"rules": {
}
}
Configuration On WebStorm
- Open
Preferences
( ⌘ + ,) Language & Frameworks
▸javascript Code
▸Quality tools
▸Eslint
- Select
Manual ESLint Configuration
- ESLint package:
/{project_path}/node_modules/eslint
- Configuration file:
/{project_path}/.eslintrc.json
- ESLint package:
- (Optional) check
Run eslint --fix on save
- Click
OK
Rules
Flags
- Configuring Rules
- Disabling Rules
- Sample Files (You can apply eslint to these files)