# @alephic/eslint-plugin 中文文档

规范地址：https://npmcn.com/package/%40alephic/eslint-plugin/

版本：0\.2\.0
npm 元数据更新时间：2026-10-01T16:26:49.099Z
中文译文更新时间：2026-11-06T15:32:40.984Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alephic/eslint-plugin
原文对照：https://npmcn.com/package/%40alephic/eslint-plugin/?lang=original
源码仓库：https://github.com/alephic-ai/eslint-plugin

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

- 包体积（解压后）：50.2 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：24\.x
- 运行依赖：1 个
- peer 依赖：eslint \>=9
- 首次发布：2026-07-30T21:21:40.115Z
- 最新版本发布：2026-10-01T16:26:48.083Z
- 近 30 天下载量：2892（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

Alephic 的自定义 ESLint 规则

## 安装

```sh
npm install @alephic/eslint-plugin
```

也可以使用：`pnpm add @alephic/eslint-plugin`、`yarn add @alephic/eslint-plugin`、`bun add @alephic/eslint-plugin`

## README

# @alephic/eslint-plugin (英语)

阿莱菲克的习俗ESLint规则.

## 安装

```bash
pnpm add -D @alephic/eslint-plugin
```

需要ESLint QQ 9(平面配置).

## 使用量

```js
// eslint.config.js
import alephic from '@alephic/eslint-plugin'
import { defineConfig } from 'eslint/config'

export default defineConfig([...alephic.configs.recommended])
```

或者单独配置规则 :

```js
import alephic from '@alephic/eslint-plugin'
import { defineConfig } from 'eslint/config'

export default defineConfig([
  {
    plugins: { '@alephic': alephic },
    rules: {
      '@alephic/symmetric-never-exclusions': 'error',
    },
  },
])
```

## 规则

QQ 配置启用 .  
设置在 `recommended` 配置 .  
自动修复 [`--fix` CLI 选项](https://eslint.org/docs/user-guide/command-line-interface#--fix)。 。 。 .

| 名称                       | 说明 | 💼 | 🔧 |
| :-- | :-- | :-- | :-- |
| [对称- 绝不排斥](https://npmcn.com/package/%40alephic/eslint-plugin/docs/rules/symmetric-never-exclusions.md) | 强制对称性? :从不排斥受歧视的工会类型 | ✅ | 🔧 |
| [测试操作码](https://npmcn.com/package/%40alephic/eslint-plugin/docs/rules/test-exercises-code.md) | 需要测试描述/it标题来命名文件实际引用的标识符,因此测试要练习真实的代码,而不是并行的再执行. | ✅ |  |

## 捐款

```bash
pnpm install
pnpm test    # vitest rule-tester suites (watch mode locally, single run in CI)
pnpm lint    # eslint --fix + prettier --write + typecheck
pnpm build   # tsdown → dist/ (ESM)
pnpm build && pnpm eslint-doc-generator   # regenerate rules docs
```

新规则进入 `src/rules/<rule-name>.ts` 与合用地点 `<rule-name>.test.ts` (单位:千美元) `docs/rules/<rule-name>.md` 页面,并且必须是 登记在册 `src/index.ts` (两者) `rules` 财务报告和审定财务报表 `configs.recommended` ——默认 严重性是 `error`) (中文(简体) ). 添加或编辑规则后运行 `pnpm build && pnpm eslint-doc-generator` 重新生成 README 规则表 财务报告和审定财务报表 `docs/rules` 页眉( 生成器将插件从 `dist/`页:1 失败了,如果他们是呆子.

## 发布最新消息

释放是自动的 [变化](https://github.com/changesets/changesets)数字 :

1.  在你的公关,运行 `pnpm changeset` 然后挑个接头 增加或收紧规则 实值 **对消费者的突破** (新的 CI 失败) - 使用大起大落 一旦超过 1. 0; 错误修正只去除假阳性是补丁 .
2.  合并公关. 释放工作在 `ci.yml` 打开(或更新) a `chore: release` 正在累积等待更改的 PR 及其更改日志 条目.
3.  合并发布公关. 一旦CI工作通过 主,释放工作 将新版本发布到 npmjs( 通过信任的出版/ OIDC, 使用 页:1.

没有 npm 符号涉及: npmjs 信任 `ci.yml` 工作流程直接.

## 许可证

麻省理工学院

## 常见问题

### @alephic/eslint-plugin 是什么？

Alephic 的自定义 ESLint 规则

### 如何安装 @alephic/eslint-plugin？

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

### @alephic/eslint-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alephic/eslint-plugin 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @alephic/eslint-plugin 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js 24\.x。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @alephic/eslint-plugin 可以商用吗？

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

### @alephic/eslint-plugin 的下载量有多少？

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

### @alephic/eslint-plugin 还在维护吗？

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