# @adonisjs/eslint-ast-grep 中文文档

规范地址：https://npmcn.com/package/%40adonisjs/eslint-ast-grep/

版本：1\.0\.0
npm 元数据更新时间：2026-09-15T09:48:10.792Z
中文译文更新时间：2026-11-06T23:42:51.220Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：13.5 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：2 个
- peer 依赖：eslint ^9\.9\.1 \|\| ^10\.0\.0
- 首次发布：2026-09-15T09:48:10.178Z
- 最新版本发布：2026-09-15T09:48:10.481Z
- 近 30 天下载量：2156（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

通过 ESLint 运行 ast- grep YAML 规则

## 安装

```sh
npm install @adonisjs/eslint-ast-grep
```

也可以使用：`pnpm add @adonisjs/eslint-ast-grep`、`yarn add @adonisjs/eslint-ast-grep`、`bun add @adonisjs/eslint-ast-grep`

## README

# @adonisjs/slint-ast-grep (英语)

> 运行 [ast- grep 图像](https://ast-grep.github.io/) YAML规则通过ESLint.

将 Lint 规则写成 ast- grep YAML, 用 ast- grep CLI 测试它们, 并用 ESLint 执行它们和您的其他规则。 匹配运行 [`@ast-grep/napi`](https://www.npmjs.com/package/@ast-grep/napi) 因此,编辑器, `--cache`, 重度覆盖, 并禁用注释 .

## 安装

```sh
npm i -D @adonisjs/eslint-ast-grep
```

## 使用量

```js
// eslint.config.js
import { configApp } from '@adonisjs/eslint-config'
import { astGrep } from '@adonisjs/eslint-ast-grep'

export default configApp(...astGrep(['./rules', '@adonisjs/core/rules']))
```

`astGrep` 接受一个源或数组。 一个来源是:

-   本地文件或目录,从 `./`, (中文(简体) ), `../`,或 `/`,从当前工作目录中解决
-   已安装软件包内的路径, 例如 `@scope/pkg/rules`,通过行走找到 `node_modules` 从当前工作目录。 软件包不需要导出目录 .

逐一搜索目录 `.yml` 财务报告和审定财务报表 `.yaml` 文件,一个文件可能持有多个YAML文件。 重复规则 ID 是一个错误.

选项 :

```js
astGrep('./rules', {
  root: import.meta.dirname, // where sources resolve from, defaults to process.cwd()
  namespace: 'ast-grep', // rule id prefix, "ast-grep/<id>" by default
})
```

## YAML 字段映射到 ESLint 的方式

整个YAML文档被交给了 ast -grep 作为匹配者,所以 `rule`, (中文(简体) ), `constraints`, (中文(简体) ), `utils`,以及 `transform` 表现得跟ast -grep记录的一样.

| YAML 字段 | ESLint 行为 |
| --- | --- |
| `id` | 创建规则 `ast-grep/<id>`。 。 。 . |
| `language` | 选择语法。 NAPI捆绑了JavaScript,TypeScript,和TSX. |
| `files`, (中文(简体) ), `ignores` | 用 ESLint glob 语义来限定规则范围. 无 `files`规则在JS/TS文件上生效. |
| `severity` | `error` • 错误; `hint`, (中文(简体) ), `info`, (中文(简体) ), `warning` 警告; `off` 关闭。 默认提示 . |
| `message` | 内插 `$VAR`, (中文(简体) ), `$$VAR`,以及 `$$$VAR` 捕取并变相. 默认为 id. |
| `note` | 附电为第二句. |
| `url` | 设置规则的文档 URL. |
| `fix` | **不支持 .** 装入失败, 错误命名规则 . |

ESLint拥有文件发现,因此仅检查已存在的文件ESLint. `labels`, (中文(简体) ), `metadata`,以及来自 `sgconfig.yml` 例如全球功用被忽略.

## 测试规则

使用 ast- grep CLI 。 试用规则 `ast-grep test` 在ESLint下运行不变.

## 常见问题

### @adonisjs/eslint-ast-grep 是什么？

通过 ESLint 运行 ast- grep YAML 规则

### 如何安装 @adonisjs/eslint-ast-grep？

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

### @adonisjs/eslint-ast-grep 支持 TypeScript 吗？

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

### @adonisjs/eslint-ast-grep 支持 ESM 还是 CommonJS？

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

### @adonisjs/eslint-ast-grep 需要什么版本的 Node\.js？

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

### @adonisjs/eslint-ast-grep 可以商用吗？

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

### @adonisjs/eslint-ast-grep 的下载量有多少？

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

### @adonisjs/eslint-ast-grep 还在维护吗？

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