repolog

repolog 是一款命令行工具，旨在增强代码组织和简化代码审查流程。它提供添加文件标题注释和从项目中导出特定语言文件的功能。

功能

• 添加标题：递归地向存储库中的文件添加注释标题，指示其在项目结构中的位置。
• 文件导出：将指定编程语言的所有文件合并为一个文件，以便于审查或分析。
• 语言支持：目前支持 Rust 和 Python，设计灵活，易于添加更多语言。
• 灵活输出：可以写入 stdout 或指定的文件。

安装

要安装 repolog，您需要在您的系统上安装 Rust 和 Cargo。如果您还没有安装，可以从 rustup.rs 获取它们。

安装 Rust 和 Cargo 后，您可以使用 cargo 安装 repolog

cargo install repolog

用法

repolog 有两个主要命令：title 和 export。

添加标题

要向目录中所有特定语言的文件添加标题

repolog title --lang <language> <path>

例如，要将当前目录中所有 Rust 文件添加标题

repolog title --lang rust .

导出文件

要从目录中导出所有特定语言的文件

repolog export --lang <language> --output <output_file> <path>

例如，要将当前目录中的所有 Python 文件导出到名为 combined_python_files.py 的文件中

repolog export --lang python --output combined_python_files.py .

如果您未指定输出文件，则结果将打印到 stdout

repolog export --lang rust .

用例

1. 代码审查：将特定语言的所有文件导出到单个文件中，以便于审查，特别适用于拉取请求或代码审计。

2. 项目组织：为项目中的所有文件添加一致的标题注释，以便一目了然地理解项目结构。

3. 文档生成：使用导出功能生成包含特定语言所有代码的单个文件，这对于文档目的或创建“文献编程”风格的文档很有用。

4. 重构：在大型项目中移动文件时，使用标题功能确保所有文件都有最新的位置注释。

贡献

欢迎贡献！请随时提交Pull Request。