2.0.1 • Published 3 years ago
@reservando/eslint-config v2.0.1
Linters config
eslint
&prettier
standard configs for Reservando.
It allows to work withhusky
andlint-staged
Getting started
- Install dependency. Make sure to use
--save
so it installs all the required dependencieseslint
prettier
,husky
,plugins
, etc
npm install --save @reservando/eslint-config
- Create file
.eslintrc.js
.
Add only the configs you need for your project.
module.exports = {
extends: [
"@reservando/eslint-config/config/eslint",
"@reservando/eslint-config/config/eslint-testcafe",
"@reservando/eslint-config/config/eslint-jest",
"@reservando/eslint-config/config/eslint-typescript",
"@reservando/eslint-config/config/eslint-vue",
],
rules: {
// My custom rules
},
};
- Create file
.prettierrc.js
const sharedConfig = require("@reservando/eslint-config/config/prettier");
module.exports = {
...sharedConfig,
// My custom rules
};
- Update your
package.json
{
"scripts": {
"lint": "npm run lint:prettier && npm run lint:eslint",
"lint:fix": "npm run lint:prettier -- --write && npm run lint:eslint -- --fix",
"lint:eslint": "eslint '**/*.{js,ts,vue}'",
"lint:prettier": "prettier --check '**/*.{md,scss,json}'"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"*.{js,ts,vue}": "eslint --fix",
"*.{md,scss,json}": "prettier --write"
}
}