PEG.js 命令行工具使用指南

PEG.js 命令行工具使用指南

pegjs PEG.js: Parser generator for JavaScript 项目地址: https://gitcode.com/gh_mirrors/pe/pegjs

什么是PEG.js命令行工具

PEG.js是一个流行的解析器生成器，它允许开发者通过定义语法规则来创建解析器。PEG.js提供了命令行接口(CLI)，让开发者无需直接调用API就能从语法文件生成解析器代码。

基本使用方法

PEG.js命令行工具的基本使用格式如下：

pegjs [选项] [输入文件] [--]

其中：

• 选项：控制解析器生成的各种参数
• 输入文件：包含PEG.js语法规则的文件
• --：用于分隔传递给插件的额外参数

配置文件的使用

为了简化复杂的配置，PEG.js支持使用配置文件：

pegjs -c config.json

配置文件中可以包含以下内容：

1. 必填项：

   • input：指定语法文件路径
   • output：指定生成的解析器输出路径

2. 可选项： 所有PEG.js API支持的选项都可以在配置文件中使用

注意：

• 如果命令行已经指定了输入文件，则配置文件中的input会被忽略
• 配置文件中的output选项优先级低于命令行直接指定的-o选项

输入文件处理

PEG.js CLI对输入文件有以下要求：

• 每次只能处理一个语法文件
• 如果提供多个输入文件，CLI会报错并终止
• 输入文件通常使用.pegjs扩展名

选项参数格式

PEG.js CLI支持两种选项格式：

1. 传统空格分隔格式：

   pegjs grammar.pegjs -o parser.js -c config.js
   

2. 赋值运算符格式：

   pegjs grammar.pegjs -o=parser.js -c=config.js
   

常用命令行选项详解

解析器控制选项

• -a, --allowed-start-rules：指定允许的起始规则列表（逗号分隔），默认为语法中的第一条规则
• --cache/--no-cache：启用/禁用解析结果缓存，影响解析性能
• --trace/--no-trace：启用/禁用解析过程追踪，调试时很有用

输出控制选项

• -o, --output：指定输出文件路径
• -f, --format：指定输出格式，支持：
  • amd：AMD模块格式
  • bare：无包装的纯函数
  • commonjs：CommonJS模块（默认）
  • es：ES模块
  • globals：全局变量
  • umd：UMD通用模块

依赖和插件选项

• -d, --dependency：指定解析器依赖的模块（可多次使用）
• -p, --plugin：指定使用的PEG.js插件（可多次使用）

优化选项

• -O, --optimize：优化目标，可选：
  • speed：优化解析速度（默认）
  • size：优化代码体积

信息选项

• -h, --help：显示帮助信息
• -v, --version：显示版本信息

高级特性

可重复选项处理

某些选项可以多次指定，PEG.js会合并这些值：

pegjs -a start -a rule1,rule2

等价于：

pegjs -a start,rule1,rule2

选项优先级规则

对于非可重复选项，后指定的选项会覆盖前面的：

pegjs --no-trace --trace

最终会启用trace功能

向插件传递额外参数

使用--分隔符可以向插件传递自定义参数：

pegjs grammar.pegjs -- pluginArg1 pluginArg2

这些参数会存储在options["--"]中，由各插件自行处理。

最佳实践建议

1. 项目中使用：

   • 将PEG.js命令集成到构建流程中
   • 对于复杂配置，使用配置文件管理选项

2. 调试技巧：

   • 开发阶段使用--trace选项跟踪解析过程
   • 使用-f bare格式输出便于调试

3. 性能优化：

   • 生产环境使用-O speed优化解析速度
   • 考虑使用--cache处理复杂语法

通过掌握这些命令行选项，开发者可以灵活地控制PEG.js解析器的生成过程，满足各种项目需求。

pegjs PEG.js: Parser generator for JavaScript 项目地址: https://gitcode.com/gh_mirrors/pe/pegjs