@griffithswaite/ts-plsql-parser

中文文档
1.1.1发布于 2026/07/23BSD-3-ClauseTypeScriptESM + CJS近 30 天下载 2.2万

TypeScript中的PL/SQL解析器. 使用Antlr4生成.

中文使用文档
文档目录6 节
  1. 类型脚本中的 PL/SQL 解析器
  2. 蚂蚁是什么?
  3. 为什么我要分析PL/SQL?
  4. 安装
  5. 使用量
  6. 听众

类型脚本中的 PL/SQL 解析器

使用 蚂蚁4软件包和实例 格里菲斯·韦特。 。 。 .

蚂蚁是什么?

从文件: "美国人 (ANother Tool for Language Accidentation)是一个强大的解析器生成器,用于读取,处理,执行,或翻译结构化文本或二进制文件. 它被广泛用于构建语言,工具和框架. 从语法上,ANTLR生成一个可构建剖析树的剖析器,并生成一个听者界面(或访问者),从而容易对感兴趣的短语的识别作出反应"

找到更多关于Antlr的线索 其网站。 。 。 .

为什么我要分析PL/SQL?

解析代码如PL/SQL等,由于一些原因可以有用,特别是在企业环境(或其他你有很多遗留代码的环境)中. 例如:

  • 从您的代码库生成文档 .
  • 创建代码库中所有函数和程序的列表.
  • 为您的 API 创建类型安全消费者代码 .
  • 在表格上查找未使用的列.
  • 你可以用它... 来推断你想要的代码.

能够轻易解析PL/SQL代码 可以成为你武库中 一个令人难以置信的强大工具 用来询问你的代码在做什么 和我们的结合 PL/SQL 查看器,你可以快速和容易地利用 遗产代码 通过询问它.

看看这个 此寄存器内的例子 来查看如何使用此软件包来解析 PL/SQL 代码.

为尝试实例, 您可以拉出重播, 安装依赖性后进行以下操作 :

node --loader=ts-node/esm examples/interface-generator/index.ts

安装

npm install @griffithswaite/ts-plsql-parser

使用量

Antlr 生成两种解析代码的方法: 访问者和收听者. 我们还提供了一种方法,将代码解析成树的单一JSON代表(getParsedNodes),这可用于快速解析和调试. 您可以阅读更多关于 Antlr 的访客和听众模式 这里。 。 。 .

下面以无害环境管理格式记录了听众方法。 如果您使用普通JS, 您可能需要修改此代码( 例如去除节点: url导入和 dirname 定义) .

听众

import * as url from "node:url";
import { ParseTreeWalker, ParseTreeListener } from "antlr4";
import {
  ParseTreeListener,
  PlSqlParserListener,
  getParserFromFile,
} from "@griffithswaite/ts-plsql-parser";

const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
const parser = getParserFromFile(__dirname + "/your-code.pbp");

class YourListener
  extends ParseTreeListener
  implements PlSqlParserListener
{
  enterUnit_statement(ctx: PlSqlParser.Unit_statementContext) {
    // Do something when entering a unit_statement
  }
}

const listener = new YourListener();
// Use the entry point for listeners
ParseTreeWalker.DEFAULT.walk(listener, parser.sql_script());

版本与发布记录

@griffithswaite/ts-plsql-parser 共发布 8 个版本,首次发布于 2023/10/05;过去 12 个月发布了 2 个版本。

版本发布日期距今
1.1.1latest2026/07/233 个月前
1.1.02026/07/233 个月前
1.0.52023/10/173 年前
1.0.42023/10/113 年前
1.0.32023/10/063 年前
1.0.22023/10/063 年前

关于 @griffithswaite/ts-plsql-parser 的常见问题

@griffithswaite/ts-plsql-parser 是什么?

TypeScript中的PL/SQL解析器. 使用Antlr4生成.

如何安装 @griffithswaite/ts-plsql-parser?

在项目目录运行 npm install @griffithswaite/ts-plsql-parser,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:antlr4(4.13.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@griffithswaite/ts-plsql-parser 支持 TypeScript 吗?

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

@griffithswaite/ts-plsql-parser 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@griffithswaite/ts-plsql-parser 可以商用吗?

@griffithswaite/ts-plsql-parser 使用 BSD-3-Clause 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括,不构成法律意见,请以许可原文为准。

@griffithswaite/ts-plsql-parser 的下载量有多少?

根据 npm 官方下载统计,@griffithswaite/ts-plsql-parser 在 2026/10/17 – 2026/11/15 这 30 天内被下载 21,697 次,日均约 723 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@griffithswaite/ts-plsql-parser 还在维护吗?

最新版本 1.1.1 发布于 2026/07/23(3 个月前);至今共发布 8 个版本,其中过去 12 个月发布了 2 个;首次发布于 2023/10/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。