Rust语法树搜索与代码转换工具ast-grep-config的使用，支持高效AST模式匹配与重构

安装方法

在项目目录中运行以下Cargo命令：

cargo add ast-grep-config

或者在Cargo.toml中添加以下行：

ast-grep-config = "0.39.2"

示例代码

下面是一个使用ast-grep-config进行AST模式匹配和代码转换的完整示例：

use ast_grep_config::{RuleConfig, SgRootConfig};
use std::path::Path;

fn main() {
    // 1. 创建一个规则配置来匹配所有println!宏调用
    let rule = RuleConfig {
        id: "no-println".to_string(),
        pattern: "println!($ARGS)".to_string(),
        message: "Avoid using println! macro".to_string(),
        severity: "warning".to_string(),
        ..Default::default()
    };

    // 2. 创建根配置并添加规则
    let mut config = SgRootConfig::default();
    config.rules.push(rule);

    // 3. 扫描项目目录
    let project_path = Path::new("./src");
    let matches = config.scan(project_path).unwrap();

    // 4. 处理匹配结果
    for m in matches {
        println!("Found println! at {}:{}", m.file_path, m.line_number);
        // 这里可以添加代码转换逻辑，例如替换为log::info!
    }

    // 5. 代码转换示例
    let transform_rule = RuleConfig {
        id: "replace-println".to_string(),
        pattern: "println!($ARGS)".to_string(),
        fix: "log::info!($ARGS)".to_string(),
        ..Default::default()
    };

    let mut transform_config = SgRootConfig::default();
    transform_config.rules.push(transform_rule);

    // 6. 执行代码转换
    let _ = transform_config.replace(project_path);
}

完整功能示例

use ast_grep_config::{RuleConfig, SgRootConfig};
use std::path::Path;

fn main() {
    // 示例1: 检测所有未处理的Result
    let result_rule = RuleConfig {
        id: "unhandled-result".to_string(),
        pattern: "$VAR.unwrap()".to_string(),
        message: "Avoid using unwrap() directly".to_string(),
        severity: "error".to_string(),
        ..Default::default()
    };

    // 示例2: 检测所有panic!调用
    let panic_rule = RuleConfig {
        id: "no-panic".to_string(),
        pattern: "panic!($ARGS)".to_string(),
        message: "Avoid using panic! macro".to_string(),
        severity: "error".to_string(),
        ..Default::default()
    };

    // 创建配置并添加规则
    let mut config = SgRootConfig::default();
    config.rules.push(result_rule);
    config.rules.push(panic_rule);

    // 扫描项目目录
    let project_path = Path::new("./src");
    let matches = config.scan(project_path).unwrap();

    // 处理检测结果
    for m in matches {
        println!("发现潜在问题: {} 在 {}:{}", 
            m.message, 
            m.file_path, 
            m.line_number
        );
    }

    // 代码转换示例: 将unwrap()转换为expect()
    let transform_rule = RuleConfig {
        id: "replace-unwrap".to_string(),
        pattern: "$VAR.unwrap()".to_string(),
        fix: "$VAR.expect(\"处理错误\")".to_string(),
        ..Default::default()
    };

    let mut transform_config = SgRootConfig::default();
    transform_config.rules.push(transform_rule);

    // 执行代码转换
    let _ = transform_config.replace(project_path);
}

功能说明

1. AST模式匹配：通过定义规则模式，可以精确匹配代码中的特定语法结构
2. 代码重构：支持自动替换匹配到的代码片段
3. 批量处理：可以扫描整个项目目录并批量处理所有匹配项

该工具使用MIT许可证，由Herrington Darkholme维护。