# parse_vendor

**Repository Path**: rust-lerning/parse_vendor

## Basic Information

- **Project Name**: parse_vendor
- **Description**: 这是一个 Rust 程序，用于解析指定目录下的 `Cargo.toml` 文件，并将包信息输出到一个 CSV 文件中。输出的 CSV 文件将包含每个包的名称、版本、作者、类别、许可证和仓库地址。包信息将按包名的首字母进行升序排序。
- **Primary Language**: Rust
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-22
- **Last Updated**: 2024-10-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Parse Vendor Packages

## 简介

这是一个 Rust 程序，用于解析指定目录下的 `Cargo.toml` 文件，并将包信息输出到一个 CSV 文件中。输出的 CSV 文件将包含每个包的名称、版本、作者、类别、许可证和仓库地址。包信息将按包名的首字母进行升序排序。

## 安装

### 前提条件

- Rust 工具链（包括 `rustc` 和 `cargo`）
- Cargo.toml 文件中已添加必要的依赖项

### 安装依赖项

确保 `Cargo.toml` 文件中包含以下依赖项：

```toml
[dependencies]
toml = "0.5.8"
csv = "1.1.6"

## 构建项目
在项目根目录下运行以下命令来构建项目：

cargo build

## 使用
###命令行参数
程序接受两个命令行参数：

vendor_directory：包含 Cargo.toml 文件的目录路径。
output_csv_file：输出的 CSV 文件路径。
###示例
假设你的 vendor 目录位于 /path/to/vendor，你希望将输出保存到 output.csv 文件中，可以运行以下命令：

sh
cargo run -- /path/to/vendor output.csv
###输出格式
输出的 CSV 文件将包含以下列：

Module：模块名
Path：Cargo.toml 文件的路径
Name：包名
Version：包版本
Authors：包作者（多个作者以逗号分隔）
Categories：包类别（多个类别以逗号分隔）
License：包许可证
Repository：包仓库地址
###注意事项
确保 vendor_directory 存在且是一个目录。
如果 vendor_directory 中没有 Cargo.toml 文件，程序将不会输出任何信息。
包信息将按包名的首字母进行升序排序。
##代码结构
###主要文件
src/main.rs：程序的入口点，包含主逻辑。
Cargo.toml：项目配置文件，包含依赖项和其他元数据。
###主要函数
main：程序的入口函数，处理命令行参数并调用其他函数。
collect_package_info：递归地遍历目录，收集所有 Cargo.toml 文件中的包信息。
read_package_info：读取单个 Cargo.toml 文件中的包信息。
write_to_csv：将收集的包信息写入 CSV 文件。
##贡献
欢迎贡献！如果你有任何改进建议或发现任何问题，请提交 issue 或 pull request。

###提交 Issue
确保你的问题没有被重复报告。
提供详细的错误信息和复现步骤。
###提交 Pull Request
在提交 PR 之前，请确保你的代码已经通过了所有测试。
请遵循项目的代码风格和命名规范。
##许可证
本项目采用XXX许可证，详情参见 LICENSE 文件。

##联系方式
如果有任何问题或建议，可以通过以下方式联系我：

邮箱：example@example.com

感谢使用本项目！希望它能对你有所帮助。




### 说明

- **简介**：简要介绍程序的功能。
- **安装**：说明如何安装和构建项目。
- **使用**：详细说明如何使用程序，包括命令行参数和示例。
- **输出格式**：说明输出 CSV 文件的格式。
- **注意事项**：列出一些需要注意的事项。
- **代码结构**：简要介绍项目的主要文件和函数。
- **贡献**：鼓励贡献者参与项目，并提供提交 Issue 和 Pull Request 的指南。
- **许可证**：说明项目的许可证信息。
- **联系方式**：提供联系信息，方便用户反馈问题或提出建议。

希望这个 `README` 文件能帮助其他开发者更好地理解和使用你的程序！