Automatically setup the best and future-proofed linting and formatting config for your project with or without VS Code
Uses ESLint, Prettier, eslint-config-airbnb, babel-eslint, eslint-config-prettier, eslint-plugin-html, eslint-plugin-import, eslint-plugin-jsx-a11y, eslint-config-wesbos, eslint-plugin-prettier, eslint-plugin-react, eslint-plugin-react-hooks under the hood.
These are opinionated settings for ESLint and Prettier. You might like them - or you might not. Don't worry, you can always change them.
What it does
- 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.
It's usually best to install this locally once per project, that way you can have project-specific settings as well as sync those settings with others working on your project via git.
You can also install globally so that any project or rogue JS file you write will have linting and formatting applied without having to go through the setup. You might disagree and that is okay, just don't do it then 😃.
Local / Per Project Install
If you don't already have a
package.jsonfile, create one with
Then we need to install everything needed by the config:
npx install-peerdeps --dev lint-format
(note: npx is not a spelling mistake of npm.
npx comes with when
npm are installed and makes script running easier 😃)
You can see in your package.json there are now a big list of devDependencies.
.eslintrcfile in the root of your project's directory (it should live where package.json does). Your
.eslintrcfile should look like this:
Tip: You can alternatively put this object in your
package.json under the property
"eslintConfig":. This makes one less file in your project.
- You can add two scripts to your package.json to lint and/or fix:
- Now you can manually lint your code by running
npm run lintand fix all fixable issues with
npm run lint:fix. You probably want your editor to do this though.
- First, install everything needed:
npx install-peerdeps --global lint-format
- Then you need to make a global
ESLint will look for one in your home directory
.eslintrc file, it should look like this:
- To use from the CLI, you can now run
eslint .or configure your editor as we show next.
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":"lint-format""rules":"no-console": 2"prettier/prettier":"error""trailingComma": "es5""singleQuote": true"printWidth": 120"tabWidth": 8
With VS Code
You should read this entire thing. Serious!
Once you have done one, or both, of the above installs. You probably want your editor to automatically lint and fix for you. Here are the instructions for the VS Code:
- Install the ESLint package
- Now we need to setup some VS Code settings via
Settings. It's easier to enter these settings while editing the
settings.jsonfile, so click the icon in the top right corner or open Command Pallet by pressing Ctrl/CMD+Shift+P and then type Preferences: Open Settings (JSON):
With Create React App
- You gotta eject first
npm run ejector
npx install-peerdeps --dev lint-format
- Crack open your
🤬🤬🤬🤬 IT'S NOT WORKING
Start fresh. Sometimes global modules can goof you up. This will remove them all:
npm remove --global lint-format babel-eslint eslint eslint-config-prettier eslint-config-airbnb eslint-plugin-html eslint-plugin-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react prettier eslint-plugin-react-hooks
To do the above for local, omit the
Then if you are using a local install, remove your
package-lock.json file and delete the
Then follow the above instructions again.