TypeScript AST 查询库 TsQuery 常见问题解决方案

TypeScript AST 查询库 TsQuery 常见问题解决方案

tsquery TypeScript AST query library 项目地址: https://gitcode.com/gh_mirrors/ts/tsquery

1. 项目基础介绍与主要编程语言

TsQuery 是一个开源项目，旨在为 TypeScript 提供类似于 ESQuery 的 API，使用户能够通过 CSS 选择器风格的语法来查询 TypeScript 的抽象语法树（AST）。这个项目主要使用 TypeScript 编写，并且依赖于 Node.js 环境。

2. 新手常见问题与解决方案

问题一：如何安装 TsQuery？

问题描述： 新手可能不清楚如何正确安装 TsQuery。

解决步骤：

1. 确保你的系统中已经安装了 Node.js。
2. 使用 npm（Node.js 包管理器）来安装 TsQuery。在命令行中执行以下命令：

   npm install @phenomnomnominal/tsquery --save-dev
   

3. 安装完成后，你可以在你的 TypeScript 项目中导入并使用 TsQuery。

问题二：如何查询 TypeScript AST 中的节点？

问题描述： 新手可能不知道如何使用 TsQuery 来查询 AST 节点。

解决步骤：

1. 首先需要安装 TsQuery，如问题一所述。
2. 在你的 TypeScript 文件中，导入 TsQuery：

   import { ast, query } from '@phenomnomnominal/tsquery';
   

3. 编写 TypeScript 代码字符串，并使用 ast 函数将其转换为 AST 对象。
4. 使用 query 函数和 CSS 选择器语法来查询你感兴趣的节点。例如，查询所有名为 "Animal" 的标识符：

   const typescript = `class Animal { constructor(public name: string) {} move(distanceInMeters: number = 0) { console.log(`${this.name} moved ${distanceInMeters}m`); } }`;
   const ast = ast(typescript);
   const nodes = query(ast, 'Identifier[name="Animal"]');
   console.log(nodes.length);  // 输出结果应为 2
   

问题三：TsQuery 支持哪些选择器？

问题描述： 新手可能不清楚 TsQuery 支持哪些类型的选择器。

解决步骤：

1. TsQuery 支持多种选择器，包括：

   • AST 节点类型选择器，如 ForStatement。
   • 通配符 *。
   • 属性存在性选择器 [attr]。
   • 属性值选择器 [attr="foo"] 或 [attr=123]。
   • 属性正则表达式选择器 [attr=/foo.*/]。
   • 属性条件选择器 [attr="foo"]、[attr>2]、[attr<3]、[attr>=2] 或 [attr<=3]。
   • 嵌套属性选择器 [attr.level2="foo"]。
   • 其他 CSS 选择器，如子选择器、兄弟选择器等。

2. 详细的使用方法和示例可以在 TsQuery 的官方文档中找到。

tsquery TypeScript AST query library 项目地址: https://gitcode.com/gh_mirrors/ts/tsquery