2022-02-19 16:05:21 +01:00
< h1 align = "center" > eslint-config-conventions< / h1 >
< p align = "center" >
< strong > < a href = "https://eslint.org/docs/developer-guide/shareable-configs" > ESLint shareable config< / a > to enforce strict conventions and good code quality.< / strong >
< / p >
< / p >
< p align = "center" >
< a href = "./CONTRIBUTING.md" > < img src = "https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" / > < / a >
< a href = "./LICENSE" > < img src = "https://img.shields.io/badge/licence-MIT-blue.svg" alt = "Licence MIT" / > < / a >
< a href = "./CODE_OF_CONDUCT.md" > < img src = "https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt = "Contributor Covenant" / > < / a >
< br / >
2023-07-02 15:57:44 +02:00
< a href = "https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml" > < img src = "https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" / > < / a >
< a href = "https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml" > < img src = "https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" / > < / a >
2022-02-19 16:05:21 +01:00
< br / >
< a href = "https://conventionalcommits.org" > < img src = "https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt = "Conventional Commits" / > < / a >
< a href = "https://github.com/semantic-release/semantic-release" > < img src = "https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt = "semantic-release" / > < / a >
< a href = "https://www.npmjs.com/package/eslint-config-conventions" > < img src = "https://img.shields.io/npm/v/eslint-config-conventions.svg" alt = "npm version" > < / a >
< / p >
## 📜 About
2022-02-20 12:36:37 +01:00
**eslint-config-conventions** is a [ESLint ](https://eslint.org ) configuration to enforce strict conventions and good code quality, it is highly inspired from [eslint-config-standard-with-typescript ](https://github.com/standard/eslint-config-standard-with-typescript ) but it is **stricter** and with **no formatting rules** , **only code-quality rules** . It supports both **JavaScript** and **TypeScript** .
2022-02-19 16:05:21 +01:00
2022-09-20 23:08:10 +02:00
This configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier ](https://prettier.io/ ) for a consistent code style, it works with any `.prettierrc.json` configuration.
2022-02-19 16:05:21 +01:00
More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters ](https://prettier.io/docs/en/comparison.html ).
## ⚙️ Getting Started
### Prerequisites
2023-10-18 12:59:19 +02:00
[Node.js ](https://nodejs.org/ ) >= 18.0.0
2022-02-19 16:05:21 +01:00
### Installation
```sh
npm install --save-dev \
2023-10-18 12:59:19 +02:00
eslint@^8.51.0 \
eslint-plugin-import@^2.28.1 \
2023-02-06 23:33:28 +01:00
eslint-plugin-promise@^6.1.1 \
2023-10-18 12:59:19 +02:00
eslint-plugin-unicorn@^48.0.1 \
2022-02-19 16:05:21 +01:00
eslint-config-conventions@latest
```
This list of dependencies are:
- [ESLint ](https://github.com/eslint/eslint )
- 3 [ESLint Plugins ](https://eslint.org/docs/user-guide/configuring/plugins )
- [eslint-plugin-import ](https://github.com/import-js/eslint-plugin-import )
- [eslint-plugin-promise ](https://github.com/xjamundx/eslint-plugin-promise )
- [eslint-plugin-unicorn ](https://github.com/sindresorhus/eslint-plugin-unicorn )
2022-02-20 12:36:37 +01:00
- This package: `eslint-config-conventions`
If you want to use **TypeScript** , you also need to install:
```sh
npm install --save-dev \
2023-10-18 12:59:19 +02:00
typescript@^5.2.2 \
@typescript -eslint/eslint-plugin@^6.8.0 \
@typescript -eslint/parser@^6.8.0
2022-02-20 12:36:37 +01:00
```
Dependencies are:
2022-02-19 16:05:21 +01:00
- [TypeScript ](https://github.com/Microsoft/TypeScript )
2023-07-02 16:02:28 +02:00
- [@typescript-eslint/eslint-plugin ](https://github.com/typescript-eslint/typescript-eslint ): ESLint rules for TypeScript.
- [@typescript-eslint/parser ](https://github.com/typescript-eslint/typescript-eslint ): ESLint parser for TypeScript.
2022-02-19 16:05:21 +01:00
### Configuration with [Prettier](https://prettier.io/) (recommended)
You will need to install some dependencies in addition to those required:
```sh
npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
# Create an empty config file to let editors and other tools know you are using Prettier
# You can personalize it with your own rules
2023-07-02 16:02:28 +02:00
echo "{}" > .prettierrc.json
2022-02-19 16:05:21 +01:00
```
#### `.eslintrc.json`
```json
{
"extends": ["conventions", "prettier"],
"plugins": ["prettier"],
2023-07-18 20:25:19 +02:00
"parser": "@typescript-eslint/parser",
2022-02-19 16:05:21 +01:00
"parserOptions": {
"project": "./tsconfig.json"
},
"rules": {
"prettier/prettier": "error"
}
}
```
**Note:** Please read some important instructions regarding the `project` option [here ](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration ).
2022-02-20 12:36:37 +01:00
`"parserOptions.project"` is only required if you use **TypeScript** .
2022-02-19 16:05:21 +01:00
#### `package.json`
```jsonc
{
"scripts": {
2023-07-18 20:25:19 +02:00
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
2023-07-14 23:19:09 +02:00
"lint:prettier": "prettier . --check"
2022-02-19 16:05:21 +01:00
}
}
```
### Usage
```sh
2023-01-10 13:27:35 +01:00
npm run lint:eslint
2022-02-19 16:05:21 +01:00
# or to apply automatic fixes to code
2023-01-10 13:27:35 +01:00
npm run lint:eslint -- --fix
2022-02-19 16:05:21 +01:00
# Validate code formatting in all supported languages by Prettier
npm run lint:prettier
```
## 💡 Contributing
Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
The steps to contribute can be found in the [CONTRIBUTING.md ](./CONTRIBUTING.md ) file.
## 📄 License
[MIT ](./LICENSE )