No-Sweat™ Eslint and Prettier Setup - with or without VS Code
These are my settings for ESLint and Prettier
You might like them - or you might not. Don't worry you can always change them.
It's recommended you install this once per every project. ESLint used to have global configs, but no longer.
If you don't already have a package.json
file, create one with npm init -y
.
Then we need to install this config
npm install eslint-config-wesbos
package.json
, and add an eslintConfig
property. You can also create a new .eslintrc
or .eslintrc.js
file that lives where package.json does:in package.json, add this anywhere top level. Like right under your "scripts" object.
"eslintConfig": {
"extends": ["wesbos"]
}
Or put this in a .eslintrc
file
{
"extends": ["wesbos"]
}
For TypeScript projects, use wesbos/typescript
.
{
"extends": ["wesbos/typescript"]
}
TypeScript users will also need a tsconfig.json
file in their project. An empty object ({}
) or my base will do!
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
},
npm run lint
and fix all fixable issues with npm run lint:fix
. You probably want your editor to do this though.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"
.
{
"extends": [
"wesbos"
],
"rules": {
"no-console": 2,
}
}
There are only 2 prettier rules included in my config - singleQuote: true
and endOfLine: 'auto'
.
If you want custom prettier options, it's recommended to create a .prettierrc
file in your root directory like so:
{
"singleQuote": true,
"endOfLine": "auto",
"tabWidth": 4
}
You can also put this in your EsLint config as a rule like so:
{
"extends": ["wesbos"],
"rules": {
... any eslint rules here
"prettier/prettier": [
"error",
{
"singleQuote": true,
"endOfLine": "auto",
"tabWidth": 4
},
],
}
}
Note if you are switching to double quotes, you'll also need to add this eslint rule, or they will fight to the death!
quotes: ["error", "double"];
You should read this entire thing. Serious!
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:
Code/File
→ Preferences
→ Settings
. It's easier to enter these settings while editing the settings.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][javascriptreact][typescript][typescriptreact]": {
"editor.formatOnSave": false
},
// tell the ESLint plugin to run on save
"editor.codeActionsOnSave": {
"source.fixAll.eslint": 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. They say you don't need to, but it's never worked for me until I restart.
npx install-peerdeps --dev eslint-config-wesbos
package.json
and replace "extends": "react-app"
with "extends": "wesbos"
npx install-peerdeps --dev eslint-config-wesbos
Local / Per Project Install
steps aboveIt should work as above.
If you have previously configured ESLint to run via a File Watcher, turn that off.
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.
js,ts,jsx,tsx
.{**/*,*}.{yml,css,sass,md}
Same instructions as above, just make sure you extend wesbos/typescript
instead of just wesbos
.
It should just work! Open an issue if not.
It should just work! Open an issue if not.
If you experience issues with ESLint not formatting the code or you receive a Parsing error: Cannot find module '@babel/preset-react
error message then you need to check that you opened the folder where you installed and configured ESLint directly in VS Code. The correct folder to open will be the one where you installed the eslint-config-wesbos
npm package and where you created the .eslintrc
file.
Opening a parent folder or child folder in your code editor will cause ESLint to fail in finding the ESLint npm packages and the formatting won't work.
your-username
|
projects
|
beginner-javascript # <- Open this folder directly in your code editor
.eslintrc
package.json
node_modules/
exercises/
playground/