Rust 编写的 PHP 语法分析器

简介

这个库是一个用 Rust 编写的命令行工具，主要用于分析 PHP 包，以评估将新关键字（如 let、using 等）变为 PHP 保留关键字时可能带来的影响。它最初是为 PHP RFC（Request for Comments）“opt-in block scoping”（可选块作用域）提案而开发的，帮助检查这些关键字在现有 PHP 代码中的使用情况，避免引入破坏性变更。

关键特性

• 针对性分析：支持指定一个或多个关键字进行检查（可重复）。
• 包下载与提取：自动从 Packagist 下载并提取前 N 个最受欢迎的 PHP 包（默认 100-500 个，可自定义范围）。
• 冲突检测：扫描源文件，找出与指定关键字冲突的潜在问题（如变量名、函数名等使用该关键字）。
• 结果汇总：输出每个关键字的安全性（无冲突或冲突数量），并可选显示详细问题。
• 优化选项：支持跳过下载步骤（直接分析已下载包），或仅分析指定目录。

安装

该工具通过 Cargo（Rust 包管理器）构建，无需发布包：

git clone https://github.com/azjezz/php-syntax-analyzer.git
cd php-syntax-analyzer
cargo build --release

构建后，二进制文件位于 target/release/php-syntax-analyzer。

基本用法示例

使用 cargo run 或直接运行二进制文件。核心命令格式：php-syntax-analyzer [选项]。

1. 分析单个关键字（如 let），覆盖前 10,000 个包：

cargo run --release -- -k let --max 10000

1. 分析多个关键字，跳过下载（假设包已下载）：

cargo run --release -- -k let -k using -k scope -k block -k with --skip-download

重要选项

注意事项

• 与 RFC 相关：该工具专为 opt-in block scoping RFC 设计，用于验证关键字如 let、using 是否安全（示例结果显示 let 无冲突，但 with 有 111 个冲突，可能导致代码破坏）。
• 局限性：分析可能有警告（如包提取失败），结果基于 Packagist 流行包，不覆盖所有代码。
• 当前状态：仓库无正式发布版本，适合开发者手动构建使用。

RFC：https://wiki.php.net/rfc/optin_block_scoping