eslint-config-alanramsay-node v3.0.1
eslint-config-alanramsay-node
ESLint config based on prettier.
How to install
- Run
npx install-peerdeps eslint-config-alanramsay-node --dev
How to configure
- Create a file named
.eslintrc.js
with the following contents:
module.exports = {
extends: ['eslint-config-alanramsay-node']
};
- Create a file named
.eslintignore
with the following contents:
node_modules
!.eslintrc.js
- Add any folders that you do not want to be linted into the
.eslintignore
file, e.g.build
,out
- Add
lint
andlint-fix
entries under thescripts
section of your package.json, e.g:
"scripts": {
"lint": "eslint .",
"lint-fix": "eslint . --fix"
}
Note these commands will lint all JavaScript files in your project so you it is important that you have ignored any output folders by adding them to the .eslintignore
file (copying the globs from your .gitignore file is normally helpful)
Configure rules for Jest
If you are using Jest in your project, you should install the Jest plugin for ESLint by doing the following:
- Run
npm install --save-dev eslint-plugin-jest
- Add
'plugin:jest/recommended'
to youreslintrc.js
file, e.g.
module.exports = {
extends: ['eslint-config-alanramsay-node', 'plugin:jest/recommended']
};
Configure rules for React
If you are using React in your project, you should use eslint-config-alanramsay-react instead, which extends this configuration with rules for React, JSX and Jest.
How to run
- Use
npm run lint-fix
to lint all files and fix any fixable errors automatically
Lint on commit using Husky and lint-staged
- Run
npm install --save-dev lint-staged husky
- Add a
lint-staged
section within yourpackage.json
file with the following content (note this is not within thescripts
section but in the root):
"lint-staged": {
"**/*.js": [
"eslint --fix",
"git add"
]
}
- Add a
lint-staged
script to yourpackage.json
, scripts, e.g.
"scripts": {
"lint": "eslint .",
"lint-fix": "eslint . --fix",
"lint-staged": "lint-staged"
}
- You can now run
npm run lint-staged
to fix linting errors in any JavaScript files that are currently staged in Git. When you have a large codebase, this will be significantly faster than linting all files in your project unnecessarily. - Add a
precommit
command to the scripts in yourpackage.json
file, e.g."precommit": "lint-staged"
- Whenever you commit to Git, the system will now automatically run
lint-staged
, which will automatically fix any fixable linting issues in files that that are currently staged in Git.
Bonus: Install the ESLint plugin for your code editor
Most modern code editors and IDEs have an ESLint plugin available which improve the developer experience when using ESLint.
For example, if you use Visual Studio Code, search for ESLint
in the Extension Marketplace, and install it. After reloading the app, it should automatically detect your .eslintrc.js
file and will now show you any linting errors within the editor as you type. If you like, you can add "eslint.autoFixOnSave": true
to your properties file, so that all fixable ESLint errors in a file will be automatically fixed whenever that file is saved.