Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/etienne-bechara/eslint-config-bechara-ts
https://github.com/etienne-bechara/eslint-config-bechara-ts
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/etienne-bechara/eslint-config-bechara-ts
- Owner: etienne-bechara
- License: mit
- Created: 2020-10-30T16:37:02.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-13T15:32:17.000Z (about 1 month ago)
- Last Synced: 2024-12-19T11:12:06.200Z (6 days ago)
- Language: JavaScript
- Size: 381 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Bechara - TypeScript ESLint Configuration
This package offers a custom set of rules to be used across Node.js projects written in TypeScript.
## Quick Start
1\. Install ESLint and this rule package in your project:
```
npm i -D eslint @bechara/eslint-config-bechara-ts
```
2\. Create a `.eslintrc.js` file at the root of your workspace that extends the recently installed package:
```js
module.exports = {
extends: [
'@bechara/eslint-config-bechara-ts'
]
}
```
3\. To prevent unverified code being committed, install these supporting tools for git hooks:
```
npm i -D husky lint-staged
```
4\. Configure lint execution during pre-commit by adding the following properties to your `package.json`:
```json
"script": {
"prepare": "husky install .config/husky"
},
"lint-staged": {
"*.ts": "eslint --cache --fix"
}
```
5\. Run `npm i` to create `husky` configuration directory and create a file at `/.config/husky/pre-commit`:
```bash
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npx lint-staged --allow-empty
```
6\. Finally, run `npm i` again to create the git hooks.
Remember to add `.eslintcache` to your `.gitignore` as it is irrelevant to the project.
## Rules
### IDE Integration
To increase productivity, it is highly recommended to install an ESLint extension for your IDE and enable auto-fixing.
Please refer to this guide that includes all the most popular coding tools:
[Even faster code formatting using ESLint](https://medium.com/@netczuk/even-faster-code-formatting-using-eslint-22b80d061461)
### Starting Definition
Our rule set uses as entry point these following predefined sets:
- [ESLint Recommended](https://eslint.org/docs/rules/)
- [ESLint TypeScript Recommended](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin)
- [Import Errors](https://github.com/benmosher/eslint-plugin-import/blob/master/config/errors.js)
- [Import Warnings](https://github.com/benmosher/eslint-plugin-import/blob/master/config/warnings.js)
- [Jest Recommended](https://github.com/jest-community/eslint-plugin-jest#rules)
- [Unicorn Recommended](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/index.js)
Further customizations are defined in the property `rules` of `index.js`. These include adding, modifying and disabling existing ones.
Please refer to comments inside `index.js` for clarifications.
### Overwriting
To lower or increase severity of a rule, as well as disable it, overwrite its definition in your `.eslintrc.js` e.g.:
```js
module.exports = {
extends: [
'@bechara/eslint-config-bechara-ts'
],
rules: {
'eqeqeq': [ 'warn' ], // Originally 'error'
'no-console': [ 'off' ], // Originally 'warn'
}
}
```
## Troubleshooting
### "Parsing error: Invalid ecmaVersion"
To use the most up-to-date features (currently ecma 2020), you must use ESLint `>= 7.8.0`.
In case you are not able to do so, overwrite the `parserOptions` in your `.eslintrc.js` with a previous version, e.g.:
```js
module.exports = {
parserOptions: {
ecmaVersion: 6,
},
extends: [
'@bechara/eslint-config-bechara-ts'
]
}
```