These are my configurations for ESLint and Prettier
English / Russian
Don't worry you can always change them.
- Lints JavaScript based on the latest standards;
- Fixes issues and formatting errors with Prettier;
- Lints + Fixes inside of html script tags;
- Lints + Fixes React via eslint-config-airbnb;
- You can see all the rules here. You are very welcome to overwrite any of these settings, or just fork the entire thing to create your own.
You can use eslint globally and/or locally per project.
-
If you don't already have a
package.json
file, create one withnpm init
. -
Then you need to install everything needed by the config:
npx install-peerdeps --dev eslint-config-alex-myzgin
-
You can see in your package.json there are now a big list of devDependencies.
-
Create a
.eslintrc
file in the root of your project's directory (it should live where package.json does). Your.eslintrc
file should look like this:
{
"extends": [ "alex-myzgin" ]
}
For TypeScript projects, use alex-myzgin/typescript
.
{
"extends": [ "alex-myzgin/typescript" ]
}
TypeScript users will also need a tsconfig.json
file in their project. An empty object ({}
) will do if this is a new project.
Tip: You can alternatively put this object in your package.json
under the property "eslintConfig":
.
- You can add two scripts to your package.json to lint and/or fix:
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
},
- Now you can manually lint your code by running
npm run lint
and fix all fixable issues withnpm run lint:fix
.
If you'd like to overwrite eslint or prettier settings, you can add the rules in your .eslintrc
file. The ESLint rules go directly under "rules"
while prettier options go under "prettier/prettier"
. Note that prettier rules overwrite anything in my config (trailing comma, and single quote), so you'll need to include those as well.
{
"extends": [
"alex-myzgin"
],
"rules": {
"no-console": 2,
"prettier/prettier": [
"error",
{
"trailingComma": "all",
"singleQuote": true,
"printWidth": 80,
"tabWidth": 2,
}
]
}
}
You should read this entire thing!
Once you have done one, or both, of the above installs. You probably want your editor to lint and fix for you. Here are the instructions for VS Code:
- Install the ESLint package
- Now you need to setup some VS Code settings via
Code/File
→Preferences
→Settings
. It's easier to enter these settings while editing thesettings.json
file, so click the Open (Open Settings) icon in the top right corner:
// These are all my auto-save configs
"editor.formatOnSave": true,
// turn it off for JS and JSX, we will do this via eslint
"[javascript]": {
"editor.formatOnSave": false
},
"[javascriptreact]": {
"editor.formatOnSave": false
},
// show eslint icon at bottom toolbar
"eslint.alwaysShowStatus": true,
// tell the ESLint plugin to run on save
"editor.codeActionsOnSave": {
"source.fixAll": true
}
After attempting to lint your file for the first time, you may need to click on 'ESLint' in the bottom right and select 'Allow Everywhere' in the alert window.
Finally you'll usually need to restart VS code.
- Run
npx install-peerdeps --dev eslint-config-alex-myzgin
- Crack open your
package.json
and replace"extends": "react-app"
with"extends": "alex-myzgin"
- Run
npx install-peerdeps --dev eslint-config-alex-myzgin
- If you have an existing
.prettierrc
file, delete it. - follow the
Local / Per Project Install
steps above
If you have previously configured ESLint to run via a File Watcher, turn that off.
- Open ESLint configuration by going to File > Settings (Edit > Preferences on Mac) > Languages & Frameworks > Code Quality Tools > ESLint (optionally just search settings for "eslint")
- Select Automatic ESLint Configuration
- Check Run eslint --fix on save
The following steps are for a typical Node / ESLint global installtion. If you have a customized setup, refer to JetBrains docs for more ESLint Configuration Options.
- Open ESLint configuration by going to File > Settings (Edit > Preferences on Mac) > Languages & Frameworks > Code Quality Tools > ESLint (optionally just search settings for "eslint")
- Select Manual ESLint configuration
- Choose your Node interpreter from the detected installations
- Select the global ESLint package from the dropdown
- Leave Configuration File as Automatic Search
- Check Run eslint --fix on save
- Open Prettier configuration by going to File > Settings (Edit > Preferences on Mac) > Languages & Frameworks > Code Quality Tools > Prettier (optionally just search settings for "prettier")
- Uncheck both On code reformat and On save
- Optional BUT IMPORTANT: If you have the Prettier extension enabled for other languages like CSS and HTML, turn it off for JS since we are doing it through Eslint already.
- Make sure the Run for files glob does not include
js,ts,jsx,tsx
. - An example glob for styles, config, and markdown.
{**/*,*}.{yml,css,sass,md}
- Make sure the Run for files glob does not include
Same instructions as above, just make sure you extend alex-myzgin/typescript
instead of just alex-myzgin
.
It should just work, but if they aren't showing up in your package.json, try npx install-peerdeps --dev eslint-config-alex-myzgin -Y