# @chax-at/eslint-config 中文文档

规范地址：https://npmcn.com/package/%40chax-at/eslint-config/

版本：0\.1\.1
npm 元数据更新时间：2025-09-24T11:13:25.604Z
中文译文更新时间：2026-11-09T11:46:15.594Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chax-at/eslint-config
原文对照：https://npmcn.com/package/%40chax-at/eslint-config/?lang=original
项目主页：https://github.com/chax-at/eslint-config#readme
源码仓库：https://github.com/chax-at/eslint-config

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：25.2 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：eslint \>= 7，eslint-plugin-react \>= 7\.0\.0，@typescript-eslint/parser \>= 4\.6\.0，eslint-plugin-react-hooks \>= 4\.0\.0，@typescript-eslint/eslint-plugin \>= 4\.6\.0
- 首次发布：2020-10-29T12:54:15.451Z
- 最新版本发布：2025-02-18T13:19:02.268Z
- 近 30 天下载量：5416（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

基本eslint 配置

## 安装

```sh
npm install @chax-at/eslint-config
```

也可以使用：`pnpm add @chax-at/eslint-config`、`yarn add @chax-at/eslint-config`、`bun add @chax-at/eslint-config`

## README

# chax-at/slint-配置

类型描述项目的基础 eslint 配置

## 安装

```
npm install @chax-at/eslint-config --save-dev
```

### 同伴依赖关系

默认 ts 工程 :

```
npm install eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser --save-dev
```

反应 ts 工程 :

```
npm install eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-react eslint-plugin-react-hooks --save-dev
```

## 使用量

将配置添加到您的扩展规则部分 `.eslintrc`

```json
{
  "extends": [
    "@chax-at/eslint-config"
  ]
}
```

## 示例配置

默认 ts 工程 :

```json
{
  "env": {
    "browser": true,
    "es6": true,
    "mocha": true,
    "node": true
  },
  "extends": [
    "@chax-at/eslint-config"
  ],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true,
      "legacyDecorators": true,
      "modules": true
    },
    "ecmaVersion": 6,
    "project": "./tsconfig.json",
    "sourceType": "module",
    "tsconfigRootDir": "./"
  },
  "plugins": [
    "@typescript-eslint",
    "mocha"
  ]
}
```

反应工程 :

```json
{
  "env": {
    "browser": true,
    "es6": true,
    "mocha": false
  },
  "extends": [
    "@chax-at/eslint-config/react"
  ],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true,
      "legacyDecorators": true,
      "modules": true
    },
    "ecmaVersion": 6,
    "project": "./tsconfig.json",
    "sourceType": "module",
    "tsconfigRootDir": "./"
  },
  "plugins": [
    "@typescript-eslint",
    "mocha",
    "react",
    "react-hooks"
  ],
  "settings": {
    "react": {
      "version": "detect"
    }
  },
  "overrides": [
    {
      "files": [
        "**/*.spec.ts",
        "**/*.spec.tsx"
      ],
      "env": {
        "mocha": true
      }
    }
  ]
}
```

## 开发者

要测试本地变化 :

-   运行 `npm link` 在已克隆的 eslint 配置工程目录中
-   运行 `npm link @chax-at/eslint-config` 您想要测试您的配置的工程
-   确定您在操作后重运行以上命令 `npm install`
-   运行 `npm unlink @chax-at/eslint-config` 在你完成之后

## 常见问题

### @chax-at/eslint-config 是什么？

基本eslint 配置

### 如何安装 @chax-at/eslint-config？

在项目目录运行 npm install @chax-at/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（\>= 7）、eslint-plugin-react（\>= 7\.0\.0）、@typescript-eslint/parser（\>= 4\.6\.0）、eslint-plugin-react-hooks（\>= 4\.0\.0）、@typescript-eslint/eslint-plugin（\>= 4\.6\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chax-at/eslint-config 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/chax-at\_\_eslint-config 是否存在。

### @chax-at/eslint-config 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @chax-at/eslint-config 可以商用吗？

@chax-at/eslint-config 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @chax-at/eslint-config 的下载量有多少？

根据 npm 官方下载统计，@chax-at/eslint-config 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,416 次，日均约 181 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chax-at/eslint-config 还在维护吗？

最新版本 0\.1\.1 发布于 2025/02/18（1\.7 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/10/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。