让开源，少一点语言距离。
npm包中文文档

@adonisjs/eslint-ast-grep

中文文档
1.0.0发布于 2026/09/15MITTypeScriptES Module近 30 天下载 2156

Run ast-grep YAML rules through ESLint

原始使用文档
中文原文
文档目录4 节
  1. Installation
  2. Usage
  3. How YAML fields map to ESLint
  4. Testing rules

@adonisjs/eslint-ast-grep

Run ast-grep YAML rules through ESLint.

Write lint rules as ast-grep YAML, test them with the ast-grep CLI, and enforce them from ESLint alongside your other rules. Matching runs on @ast-grep/napi inside the ESLint process, so editors, --cache, severity overrides, and disable comments all work as usual.

Installation

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

Usage

// 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 accepts one source or an array. A source is either:

  • a local file or directory, starting with ./, ../, or /, resolved from the current working directory
  • a path inside an installed package, such as @scope/pkg/rules, found by walking node_modules from the current working directory. The package does not need to export the directory.

Directories are searched recursively for .yml and .yaml files, and a file may hold several YAML documents. Duplicate rule ids are an error.

Options:

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
})

How YAML fields map to ESLint

The whole YAML document is handed to ast-grep as the matcher, so rule, constraints, utils, and transform behave exactly as documented by ast-grep.

YAML fieldESLint behaviour
idCreates the rule ast-grep/<id>.
languageSelects the grammar. NAPI bundles JavaScript, TypeScript, and TSX.
files, ignoresScope the rule with ESLint glob semantics. Without files, the rule runs on JS/TS files.
severityerror → error; hint, info, warning → warning; off → off. Defaults to hint.
messageInterpolates $VAR, $$VAR, and $$$VAR captures and transforms. Defaults to the id.
noteAppended to the message as a second sentence.
urlSets the rule's documentation URL.
fixUnsupported. Loading fails with an error naming the rule.

ESLint owns file discovery, so only files ESLint already lints are checked. labels, metadata, and anything from sgconfig.yml such as global utils are ignored.

Testing rules

Use the ast-grep CLI. Rules tested with ast-grep test run unchanged under ESLint.

版本与发布记录

@adonisjs/eslint-ast-grep 共发布 1 个版本，首次发布于 2026/09/15；过去 12 个月发布了 1 个版本。

版本发布日期距今
1.0.0latest2026/09/151 个月前

关于 @adonisjs/eslint-ast-grep 的常见问题

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

Run ast-grep YAML rules through ESLint

如何安装 @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 和提交记录判断。