ESLint config with dependencies in a single package
npm install --save-dev @methodexists/eslint-config
Ignore these warnings:
npm WARN [email protected] requires a peer of eslint@^3.0.0 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of eslint@^3.19.0 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of [email protected] - 3.x but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of eslint@^2.10.2 || 3.x but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of eslint@^3.19.0 || ^4.5.0 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of eslint-plugin-import@^2.7.0 but none is installed. You must install peer dependencies yourself.
In your package.json
add the following:
"scripts": {
"lint-fix": "./node_modules/.bin/eslint --fix <YOUR_PROJECT_SRC>",
"lint": "./node_modules/.bin/eslint --ext .js <YOUR_PROJECT_SRC>",
}
where <YOUR_PROJECT_SRC>
is a dir or space-separated dirs where your javascript code lives. E.g. src
or src tests
.
To keep your repo clean from lint errors add pre-commit lint check. Make it smart enough to check only commited files rather than whole repo by using lint-staged
util:
npm install --save-dev pre-commit lint-staged
In your package.json
add the following:
"scripts": {
"lint-staged": "lint-staged"
},
"pre-commit": [
"lint-staged"
],
"lint-staged": {
"*.js": "eslint"
}
npm run lint
npm run lint-fix
Make sure that your editor set up to use locally installed eslint (./node_modules/.bin/eslint
)