Rust文件头生成插件file-header的使用指南

插件介绍

file-header是一个Rust插件，用于自动为代码文件添加标准化的头部注释。它可以帮助团队保持一致的代码文件头部格式，通常包含版权信息、作者、创建日期、文件描述等内容。

安装方法

1. 在Cargo.toml中添加依赖：

[dependencies]
file-header = "0.1.0"  # 请使用最新版本

或者直接使用cargo命令安装：

cargo add file-header

基本使用方法

1. 生成默认文件头

use file_header::FileHeader;

fn main() {
    let header = FileHeader::default()
        .author("Your Name")
        .description("Example file header usage");
    
    println!("{}", header.generate());
}

2. 自定义文件头格式

use file_header::{FileHeader, FileHeaderTemplate};

fn main() {
    let template = FileHeaderTemplate::new()
        .line("// =============================================")
        .line("// File: {{file_name}}")
        .line("// Author: {{author}}")
        .line("// Created: {{date}}")
        .line("// Description: {{description}}")
        .line("// =============================================");
    
    let header = FileHeader::with_template(template)
        .author("Jane Doe")
        .description("Custom header example");
    
    println!("{}", header.generate());
}

3. 自动为文件添加头部

use file_header::FileHeader;
use std::fs;

fn main() -> std::io::Result<()> {
    let header = FileHeader::default()
        .author("Team Rust")
        .description("Main application module");
    
    let mut content = header.generate();
    content.push_str("\n\nfn main() {\n    println!(\"Hello, world!\");\n}");
    
    fs::write("src/main.rs", content)?;
    Ok(())
}

高级功能

1. 使用环境变量

use file_header::FileHeader;

fn main() {
    let header = FileHeader::default()
        .author(&std::env::var("USER").unwrap_or("unknown".to_string()))
        .description("Using environment variables in header");
    
    println!("{}", header.generate());
}

2. 多行描述

use file_header::FileHeader;

fn main() {
    let header = FileHeader::default()
        .author("John Smith")
        .description("This is a multi-line\ndescription example\nfor demonstration purposes");
    
    println!("{}", header.generate());
}

3. 自定义日期格式

use file_header::FileHeader;
use chrono::Local;

fn main() {
    let header = FileHeader::default()
        .author("Date Formatter")
        .date(Local::now().format("%Y-%m-%d").to_string());
    
    println!("{}", header.generate());
}

配置文件

可以在项目根目录创建.fileheader文件来配置默认值：

[default]
author = Your Team Name
license = MIT
description = Default file description
template = """
// {{file_name}}
// Author: {{author}}
// Created: {{date}}
// License: {{license}}
"""

IDE集成

大多数Rust IDE插件支持自动触发文件头生成：

1. 在VS Code中，可以设置保存时自动添加文件头
2. 在IntelliJ Rust插件中，可以配置文件模板

注意事项

1. 确保文件头不会重复添加
2. 对于已有文件的修改要小心，避免覆盖重要内容
3. 团队内部应统一文件头格式标准

这个插件特别适合需要维护大量代码文件的企业环境，可以显著提高代码规范性和可维护性。

完整示例demo

下面是一个整合了多种功能的完整示例：

use file_header::{FileHeader, FileHeaderTemplate};
use chrono::Local;
use std::{fs, env};

fn main() -> std::io::Result<()> {
    // 创建自定义模板
    let template = FileHeaderTemplate::new()
        .line("// =============================================")
        .line("// 项目名称: Awesome Project")
        .line("// 文件: {{file_name}}")
        .line("// 作者: {{author}}")
        .line("// 创建日期: {{date}}")
        .line("// 描述: {{description}}")
        .line("// 许可证: {{license}}")
        .line("// =============================================");
    
    // 创建文件头并设置属性
    let header = FileHeader::with_template(template)
        .author(&env::var("USERNAME").unwrap_or_else(|_| "匿名".to_string()))
        .description("这是主程序入口文件\n包含应用程序的核心逻辑")
        .date(Local::now().format("%Y-%m-%d %H:%M:%S").to_string())
        .license("Apache-2.0");
    
    // 生成文件内容
    let mut content = header.generate();
    content.push_str("\n\n// 主函数\nfn main() {\n    println!(\"程序启动...\");\n    \n    // 业务逻辑\n    run_business_logic();\n}\n\nfn run_business_logic() {\n    // 实现业务逻辑\n    println!(\"执行业务逻辑...\");\n}");

    // 写入文件
    fs::write("src/main.rs", content)?;
    
    println!("文件生成成功！");
    Ok(())
}

这个示例展示了如何：

1. 创建自定义模板
2. 使用环境变量获取用户名
3. 添加多行描述
4. 自定义日期时间格式
5. 写入文件
6. 添加实际的代码内容

执行后会在src/main.rs中生成包含自定义文件头和实际代码内容的文件。