# @fighting-design/eslint-config

> Fighting design out of the box eslint configuration item.

Latest version **0.1.2** (published 2022-10-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install @fighting-design/eslint-config
pnpm add @fighting-design/eslint-config
yarn add @fighting-design/eslint-config
bun add @fighting-design/eslint-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2022-10-26 |
| First published | 2022-10-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 21.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 561 |
| Author | tyh2001 |
| Maintainers | tyh2001 |
| Keywords | eslint, eslint-config, fighting-design, eslint-config-fighting, vue, typescript, eslint-plugin, typescript-eslint |

## Links

- npm: https://www.npmjs.com/package/@fighting-design/eslint-config
- Repository: https://github.com/FightingDesign/fighting-design.git#master
- Homepage: https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-eslint-config
- Issues: https://github.com/FightingDesign/fighting-design/issues
- npm.io page: https://npm.io/package/@fighting-design/eslint-config

## Dependencies (3)

- [eslint-plugin-vue](https://npm.io/package/eslint-plugin-vue.md) ^9.4.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.34.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.34.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2022-10-26
- 0.1.1 — 2022-10-18
- 0.1.0 — 2022-10-18

## README

# @fighting-design/eslint-config <a href="https://www.npmjs.com/package/@fighting-design/eslint-config"><img src="https://badgen.net/npm/v/@fighting-design/eslint-config" /></a>

中文 | <a href="https://github.com/FightingDesign/fighting-design/blob/master/packages/fighting-eslint-config/README.en-US.md">English</a>

## 🤟 介绍

`Fighting Design` 专属 `eslint` 配置项，开箱即用。

`@fighting-design/eslint-config` 主要针对于 `*.vue` 和 `*.ts` 文件做了很大强度的格式校验规则，如果想追求更严格的校验规则和更优质的代码风格，可放心使用。反之如果并不太了解其中的规范，或不习惯过多的强制校验规则，可能会在使用中感到十分痛苦。

## 🔑 安装

使用 `pnpm` 安装

```shell
pnpm add --save-dev eslint @fighting-design/eslint-config
```

使用 `npm` 安装

```shell
npm install --save-dev eslint @fighting-design/eslint-config
```

使用 `yarn` 安装

```shell
yarn add --save-dev eslint @fighting-design/eslint-config
```

## 🐳 使用

将下面代码添加到 `.eslintrc` 文件中

```json
{
  "extends": "@fighting-design"
}
```

在 `package.json` 中新增以下配置：

```json
"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
}
```

执行命令：

```shell
# 检测代码格式规范
pnpm lint

# 修复格式规范
pnpm lint:fix
```

## 🚧 规则

详情参考 [index.js](https://github.com/FightingDesign/fighting-design/blob/master/packages/fighting-eslint-config/index.js)

## 💬 执照

[MIT](https://github.com/FightingDesign/fighting-design/blob/master/packages/fighting-eslint-config/LICENSE)

---
_Source: https://npm.io/package/@fighting-design/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._