cargo-make 项目教程

cargo-make 项目教程

cargo-make Rust task runner and build tool. 项目地址: https://gitcode.com/gh_mirrors/ca/cargo-make

1. 项目目录结构及介绍

cargo-make 是一个 Rust 任务运行器和构建工具，其项目目录结构如下：

cargo-make/
├── docs/
├── examples/
├── extra/
│   └── shell/
├── src/
├── buildnumber.toml
├── editorconfig
├── gitattributes
├── gitignore
├── rusty-hook.toml
├── typos.toml
├── CHANGELOG.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── Makefile.toml
└── README.md

目录结构介绍

• docs/: 包含项目的文档文件。
• examples/: 包含项目的示例代码。
• extra/shell/: 包含额外的 Shell 脚本或工具。
• src/: 包含项目的 Rust 源代码。
• buildnumber.toml: 构建编号配置文件。
• editorconfig: 编辑器配置文件。
• gitattributes: Git 属性配置文件。
• gitignore: Git 忽略文件配置。
• rusty-hook.toml: Rusty Hook 配置文件。
• typos.toml: 拼写检查配置文件。
• CHANGELOG.md: 项目变更日志。
• Cargo.lock: Cargo 锁定文件，用于确保依赖版本一致性。
• Cargo.toml: Cargo 配置文件，定义项目的依赖和元数据。
• LICENSE: 项目许可证文件。
• Makefile.toml: cargo-make 的任务配置文件。
• README.md: 项目自述文件，包含项目的基本信息和使用说明。

2. 项目启动文件介绍

cargo-make 的启动文件主要是 Makefile.toml，它定义了项目的任务和构建流程。以下是 Makefile.toml 的基本结构和内容：

[tasks.format]
install_crate = "rustfmt"
command = "cargo"
args = ["fmt", "--", "--emit=files"]

[tasks.clean]
command = "cargo"
args = ["clean"]

[tasks.build]
command = "cargo"
args = ["build"]
dependencies = ["clean"]

[tasks.test]
command = "cargo"
args = ["test"]
dependencies = ["clean"]

[tasks.my-flow]
dependencies = ["format", "build", "test"]

启动文件介绍

• tasks.format: 定义了一个名为 format 的任务，用于格式化代码。
• tasks.clean: 定义了一个名为 clean 的任务，用于清理目标目录。
• tasks.build: 定义了一个名为 build 的任务，用于构建项目，依赖于 clean 任务。
• tasks.test: 定义了一个名为 test 的任务，用于运行测试，依赖于 clean 任务。
• tasks.my-flow: 定义了一个名为 my-flow 的任务，依赖于 format、build 和 test 任务，用于执行整个构建流程。

3. 项目配置文件介绍

cargo-make 的主要配置文件是 Makefile.toml，它定义了项目的任务和构建流程。以下是 Makefile.toml 的一些关键配置项：

配置文件介绍

• install_crate: 指定需要安装的 Rust crate。
• command: 指定要执行的命令。
• args: 指定命令的参数。
• dependencies: 指定任务的依赖关系，即在执行当前任务之前需要先执行的依赖任务。

通过这些配置项，cargo-make 可以灵活地定义和执行各种任务，从而实现项目的自动化构建和测试。

cargo-make Rust task runner and build tool. 项目地址: https://gitcode.com/gh_mirrors/ca/cargo-make