@ast-grep/wasm (英语)

网络大会构建 ast- grep 图像 用于浏览器和节点.js.

此软件包提供的API与 @ast-grep/napi 但运行在任何支持WebAssembly的JavaScript环境中,包括浏览器,Deno,以及边缘运行时间.

安装

yarn add @ast-grep/wasm web-tree-sitter

web-tree-sitter 是一个必要的同伴依赖.

维特

在使用Vite时,需要制作 tree-sitter.wasm 可在您的公共目录中找到。 你可以将这个自动化 postinstall 您的脚本 package.json (见 网络植树人设置:

"postinstall": "cp node_modules/web-tree-sitter/tree-sitter.wasm public"

使用量

与 @ast-grep/napi,此软件包没有预定义的语言支持。 所有语言都必须在运行时通过加载其树保姆WASM 解析器来注册.

import { initializeTreeSitter, registerDynamicLanguage, parse, kind } from '@ast-grep/wasm'

// 1. Initialize the tree-sitter WASM runtime (once)
await initializeTreeSitter()

// 2. Register a language by loading its WASM parser
await registerDynamicLanguage({
  javascript: { libraryPath: '/path/to/tree-sitter-javascript.wasm' },
})

// 3. Parse and search code
const sg = parse('javascript', 'console.log("hello world")')
const node = sg.root().find('console.log($ARG)')
console.log(node.getMatch('ARG').text()) // "hello world"

注册语文

registerDynamicLanguage 接受注册配置的语文名称地图。 它可以被多次调用来添加或更新语言.

await registerDynamicLanguage({
  javascript: { libraryPath: '/path/to/tree-sitter-javascript.wasm' },
  python: {
    libraryPath: '/path/to/tree-sitter-python.wasm',
    expandoChar: 'µ',  // custom expando char for languages where $ is special
  },
})

这个 expandoChar 选项设置内部用于表示可变变量的字符(默认为 $) (中文(简体) ). 对语言使用不同的字符 $ 是有效的标识符字符(例如PHP, Bash).

模式匹配

// By pattern string
sg.root().find('console.log($$$ARGS)')

// By kind number
const k = kind('javascript', 'call_expression')
sg.root().find(k)

// By rule config (same as YAML rules)
sg.root().find({
  rule: { pattern: 'console.log($A)' },
  constraints: { A: { kind: 'string' } },
})

代码重写

const match = sg.root().find('console.log($A)')
const edit = match.replace('console.error($A)')
const newCode = sg.root().commitEdits([edit])

API 参考

高级职能

initializeTreeSitter(): Promise<void>

初始化树保姆 WASM 运行时间 。 必须在其他功能之前调用一次 .

registerDynamicLanguage(langs: Record<string, { libraryPath: string, expandoChar?: string }>): Promise<void>

通过加载其WASM 二进制来注册一个或多个语言解析器. 可以多次调用;现有语言被更新.

parse(lang: string, src: string): SgRoot

解析源代码并返回一个 SgRoot 举个例子 如果语言尚未注册, 则丢弃 .

kind(lang: string, kindName: string): number

返回给定语言中命名的节点类型的数字类型ID。 用于以节点类型匹配 .

pattern(lang: string, patternStr: string): object

将模式字符串编译为规则配置对象(相当于 { rule: { pattern: patternStr } }) (中文(简体) ). 用于在程序上构建规则配置.

dumpPattern(lang: string, patternStr: string, selector?: string, strictness?: string): PatternTree

倾倒检查和调试模式的内部结构。 返回显示 ast- grep 描述模式的树, 包括源位置和节点类型 .

• selector:背景图案的可选类型名称(例如:. 'field_definition'(中文(简体) )
• strictness: 一个 "cst", (中文(简体) ), "smart" (违约), "ast", (中文(简体) ), "relaxed", (中文(简体) ), "signature", (中文(简体) ), "template"

每个 PatternTree 节点有:

• kind: 树保姆节点类型字符串
• pattern数字 : "metaVar", (中文(简体) ), "terminal",或 "internal"
• isNamed: 节点是否是一个命名的节点
• text: 源文本(用于元和终端节点)
• children: 儿童 PatternTree 节点
• start, (中文(简体) ), end数字 : { line, column } 模式来源中的职位

SgRoot

代表代码的解析树 .

root(): SgNode

返回根数 SgNode。 。 。 .

filename(): string

回返 "anonymous" 当实例是通过 parse。 。 。 .

getInnerTree(): Tree

返回基础 web-tree-sitter Tree 对象。 用于低级检查或调试.

SgNode

代表一个AST节点.

立场和信息

搜索中

匹配符可以是图案字符串,类型数(来自 kind()),或规则配置对象.

关系匹配者

匹配环境

树倒转

编辑

WasmEdit 已经 start_pos, (中文(简体) ), end_pos (单位:千美元) inserted_text。这些字段在调用前可以修改 commitEdits。 。 。 .

来源建筑

要求数 包装。 。 。 .

# For browser (ES module)
yarn build

# For Node.js (CommonJS)
yarn build:nodejs

# For bundlers
yarn build:bundler

测试

yarn install

粗瓦斯M测试

yarn test

说明: wasm-pack test --node 从临时目录运行测试带. 这个 test 脚本集 NODE_PATH=$PWD/node_modules 这样 web-tree-sitter 财务报告和审定财务报表 解析器 WASM 文件可以解决。 如果你运行 wasm-pack test --node 直接, 设定 NODE_PATH 自己说:

NODE_PATH=$PWD/node_modules wasm-pack test --node

Java 脚本测试

yarn test:js

这为Node.js构建了WASM软件包,并对其进行AVA测试.