This repository contains rational presets for typical JavaScript or TypeScript based projects.
It is using:
- eslint (https://eslint.org/)
- prettier (https://prettier.io/)
- lint-staged (https://github.com/okonet/lint-staged#readme)
- husky (https://typicode.github.io/husky/)
- stylelint (https://stylelint.io/)
npm i -D stylelint-config-prettier eslint-config-prettier eslint-plugin-prettier prettier
npm i -D @typescript-eslint/eslint-plugin@latest eslint-config-standard@latest eslint@latest eslint-plugin-import@latest eslint-plugin-node@latest eslint-plugin-promise@latest @typescript-eslint/parser@latest
To get this combination of packages you can run:
npx eslint --init
with these answers:
✔ How would you like to use ESLint? · style
✔ What type of modules does your project use? · esm
✔ Which framework does your project use? · none
✔ Does your project use TypeScript? · Yes
✔ Where does your code run? · browser
✔ How would you like to define a style for your project? · guide
✔ Which style guide do you want to follow? · standard
✔ What format do you want your config file to be in? · JSON
You can add husky to your project by:
npx husky-init && npm install
npx mrm@2 lint-staged
Force version 2, because current version of mrm is not compatible with lint-staged.
npm i -D stylelint stylelint-prettier stylelint-config-standard stylelint-config-sass-guidelines
Copy these files to your project's root directory:
├── .eslintrc.json
└── .prettierrc.yaml
└── .stylelintrc.yaml
You can also find some npm script examples in the package.json that can be used as a reference.
“Run linters against staged git files only”
The common use case includes linting with eslint and stylelint.
Defining a lint-staged configuration in your package.json does all the work:
"lint-staged": {
"*.{js,ts}": "eslint --cache --fix",
"*.scss": "stylelint --fix"
}
To create a pre commit hook for your npm scripts run:
npx husky add .husky/pre-commit 'npm test'
npx husky add .husky/pre-commit 'npx lint-staged'
You can edit this new file (.husky/pre-commit) to modify the hook.
Husky is using the available git hooks: https://git-scm.com/docs/githooks
Please feel free to use and change all settings to fit your needs!
We desperately wait for your pull request!