Rust语法树注释处理库swc_node_comments的使用指南

以下是内容中提供的示例代码：

基本使用方法

1. 解析代码并获取注释

use swc_common::{SourceMap, comments::Comments};
use swc_ecma_parser::{lexer::Lexer, Parser, StringInput, Syntax};

fn parse_code_with_comments(code: &str) {
    let cm = SourceMap::default();
    let comments = swc_node_comments::SwcComments::default();
    
    let lexer = Lexer::new(
        Syntax::Es(Default::default()),
        Default::default(),
        StringInput::from(&*cm.new_source_file("test.js".into(), code.into())),
        Some(&comments),
    );
    
    let mut parser = Parser::new_from(lexer);
    let _module = parser.parse_module().unwrap();
    
    // 现在可以访问comments对象来获取注释信息
}

2. 遍历注释

use swc_common::BytePos;

fn print_comments(comments: &SwcComments) {
    // 获取所有注释
    let all_comments = comments.get_all();
    
    for (pos, comment) in all_comments {
        println!("Comment at {:?}: {}", pos, comment.text);
    }
    
    // 获取特定位置的注释
    if let Some(comment) = comments.get_leading(BytePos(10)) {
        println!("Leading comment at position 10: {}", comment.text);
    }
}

3. 添加注释

use swc_common::{BytePos, comments::Comment};

fn add_comment(comments: &mut SwcComments) {
    let comment = Comment {
        kind: swc_common::comments::CommentKind::Line,
        text: " This is a new comment".to_string(),
        span: Default::default(),
    };
    
    // 在特定位置添加注释
    comments.add_leading(BytePos(50), comment);
}

4. 修改注释

fn modify_comment(comments: &mut SwcComments) {
    if let Some(comment) = comments.get_leading_mut(BytePos(10)) {
        comment.text = " Modified comment text".to_string();
    }
}

高级用法

1. 与SWC转换器一起使用

use swc_ecma_visit::{VisitMut, VisitMutWith};

struct CommentProcessor {
    comments: SwcComments,
}

impl VisitMut for CommentProcessor {
    fn visit_mut_module(&mut self, module: &mut Module) {
        // 处理AST节点
        module.visit_mut_children_with(self);
        
        // 处理相关注释
        if let Some(comments) = self.comments.get_leading(module.span.lo) {
            println!("Module has leading comments: {:?}", comments);
        }
    }
}

2. 提取JSDoc注释

fn extract_jsdocs(comments: &SwcComments) -> Vec<String> {
    comments
        .get_all()
        .into_iter()
        .filter(|(_, comment)| comment.text.trim_start().starts_with('*'))
        .map(|(_, comment)| comment.text.clone())
        .collect()
}

完整示例demo

下面是一个完整的示例，展示了如何使用swc_node_comments处理JavaScript代码中的注释：

use swc_common::{comments::Comment, BytePos, comments::Comments, SourceMap};
use swc_ecma_parser::{lexer::Lexer, Parser, StringInput, Syntax};
use swc_node_comments::SwcComments;

fn main() {
    // 示例JavaScript代码
    let code = r#"
    // 这是一个单行注释
    function greet(name) {
        /*
         * 这是一个多行注释
         * 这是第二行
         */
        console.log('Hello, ' + name);
    }
    
    // 另一个单行注释
    greet('World');
    "#;

    // 初始化SourceMap和注释收集器
    let cm = SourceMap::default();
    let mut comments = SwcComments::default();

    // 创建词法分析器
    let lexer = Lexer::new(
        Syntax::Es(Default::default()), // 使用默认的ES语法配置
        Default::default(),             // ECMAScript版本
        StringInput::from(&*cm.new_source_file("example.js".into(), code.into())),
        Some(&comments),                // 传递注释收集器
    );

    // 创建解析器并解析代码
    let mut parser = Parser::new_from(lexer);
    let _module = parser.parse_module().expect("Failed to parse module");

    // 1. 打印所有注释
    println!("=== 所有注释 ===");
    for (pos, comment) in comments.get_all() {
        println!("位置: {:?}, 类型: {:?}, 内容: {}", 
            pos, 
            comment.kind, 
            comment.text.trim()
        );
    }

    // 2. 添加新注释
    println!("\n=== 添加新注释 ===");
    let new_comment = Comment {
        kind: swc_common::comments::CommentKind::Block,
        text: " 这是一个新添加的块注释 ".to_string(),
        span: Default::default(),
    };
    comments.add_leading(BytePos(150), new_comment);
    println!("在位置150添加了新注释");

    // 3. 修改现有注释
    println!("\n=== 修改注释 ===");
    if let Some(comment) = comments.get_leading_mut(BytePos(5)) {
        let original_text = comment.text.clone();
        comment.text = " 修改后的单行注释 ".to_string();
        println!("修改位置5的注释: '{}' -> '{}'", 
            original_text.trim(), 
            comment.text.trim()
        );
    }

    // 4. 提取JSDoc风格注释
    println!("\n=== JSDoc注释 ===");
    let jsdocs = comments.get_all()
        .into_iter()
        .filter(|(_, c)| c.text.trim_start().starts_with('*'))
        .collect::<Vec<_>>();
    
    if !jsdocs.is_empty() {
        println!("找到JSDoc注释:");
        for (pos, comment) in jsdocs {
            println!("位置 {:?}: {}", pos, comment.text);
        }
    } else {
        println!("没有找到JSDoc注释");
    }

    // 5. 打印修改后的所有注释
    println!("\n=== 最终所有注释 ===");
    for (pos, comment) in comments.get_all() {
        println!("位置: {:?}, 内容: {}", pos, comment.text.trim());
    }
}

这个完整示例演示了：

1. 如何解析JavaScript代码并收集注释
2. 如何遍历和打印所有注释
3. 如何在特定位置添加新注释
4. 如何修改现有注释
5. 如何提取特定类型的注释（如JSDoc）
6. 最终查看所有注释（包括修改后的）

运行此程序将输出类似以下内容：

=== 所有注释 ===
位置: BytePos(5), 类型: Line, 内容: 这是一个单行注释
位置: BytePos(50), 类型: Block, 内容: 这是一个多行注释
* 这是第二行

=== 添加新注释 ===
在位置150添加了新注释

=== 修改注释 ===
修改位置5的注释: '这是一个单行注释' -> '修改后的单行注释'

=== JSDoc注释 ===
找到JSDoc注释:
位置 BytePos(50): 这是一个多行注释
* 这是第二行

=== 最终所有注释 ===
位置: BytePos(5), 内容: 修改后的单行注释
位置: BytePos(50), 内容: 这是一个多行注释
* 这是第二行
位置: BytePos(150), 内容: 这是一个新添加的块注释