# eslint-config

#### 严格的针对[TypeScript 项目](https://github.com/Microsoft/TypeScript)的[TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint) [共享规则](https://eslint.org/docs/developer-guide/shareable-configs)，用于替代 [TSlint](https://github.com/palantir/tslint)

[![Version](https://img.shields.io/npm/v/@waiting/eslint-config.svg)](https://www.npmjs.com/package/@waiting/eslint-config)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

## 说明

- 规则根据`@waiting/eslint-config` fork，并根据自己项目进行修改

## 功能
- `@waiting/eslint-config/recommended` 扩展并定制于以下规则
  - `eslint-plugin-import`
  - `eslint-plugin-node`
  - `eslint-plugin-unicorn`
  - `eslint:recommended`
  - `@typescript-eslint/recommended`
  - `@typescript-eslint/recommended-requiring-type-checking`
- `@waiting/eslint-config` 扩展于 `@waiting/eslint-config/strict` 并开启更多限制规则


## 安装

```sh
npm i -D @waiting/eslint-config eslint
```


## 用途
共享配置用于 `.eslintrc.*` 文件 `extends` 项目，详细文档见 [Shareable Configs](https://cn.eslint.org/docs/developer-guide/shareable-configs)

添加以下内容到你的 `.eslintrc.*` 文件：
- `.eslintrc.yml` 
  ```yml
  extends: '@waiting/eslint-config' 
  ```
- `.eslintrc.json` 
  ```json
  {
    "extends": "@waiting/eslint-config"
  }
  ```

你可以在 `.eslintrc.*` 文件中覆盖共享配置中的设置。
并且可以添加在如 `./test` 目录下添加文件 `.eslintrc.yml` 使用较少规则以便提高检查速度：
```yml
# .eslintrc.yml
extends: '@waiting/eslint-config/recommended'
```


## 检查

```sh
eslint --fix src/**/*.ts
eslint src/**/*.{ts,js}
```


## Learn more
- [ESlint](https://cn.eslint.org/)
- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)
- [TSLint will be deprecated](https://github.com/palantir/tslint/issues/4534)
- [Eslint: Migrating to v6.0.0](https://eslint.org/docs/user-guide/migrating-to-6.0.0#package-loading-simplification)


## License
[MIT](LICENSE)


### Languages
- [English](README.md)
- [中文](README.zh-CN.md)