🚀 rct — Rust 项目模板

一个面向工程实践的 Rust 项目模板，内置现代开发最佳实践。

---

🌍 语言

• 中文 | English

---

✨ 项目简介

rct 是一个开箱即用的 Rust 工程模板，帮助你从项目一开始就具备完善的工程化能力。

无需手动搭建工具链，rct 已内置完整开发流程，包括：

• 代码质量控制
• 依赖安全检查
• 版本管理与变更日志
• CI/CD 自动化支持

无需重复配置，专注业务开发。

---

⚡ 核心特性

🧱 项目初始化

• 基于 cargo generate 一键生成项目
• 支持模板变量替换，灵活定制项目结构

🔍 代码质量

• 集成 cargo clippy + cargo fmt
• typos 拼写检查
• 默认包含基础 lint 约束与 Rust 版本声明

🔐 依赖安全

• 使用 cargo-deny 检查：

  • 许可证合规
  • 安全漏洞（advisories）
  • 重复依赖

📝 版本与日志管理

• 集成 cargo-cliff
• 支持 Conventional Commits
• 遵循语义化版本（SemVer）

⚙️ CI/CD 支持

• 预置 GitHub Actions 结构
• 可快速接入自动化构建 / 测试 / 发布

🌐 跨平台支持

• 支持 Windows / macOS / Linux

---

🚀 快速开始

1. 安装依赖

# 如果尚未安装 Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup update stable

# 项目生成工具
cargo install cargo-generate

# 工程工具链
cargo install cargo-deny cargo-cliff typos-cli cargo-make cargo-nextest

---

2. 初始化项目

cargo generate --git https://github.com/lhui-dev/rct --name my-app

---

3. 项目初始化

cd my-app
cargo build

---

4. 执行检查流程

cargo make do

一条命令完成：格式化 → 检查 → 测试

cargo make release

单独执行提交和生成 CHANGELOG。

---

🧩 任务流水线（cargo-make）

内置基于 cargo-make 的自动化任务系统。

一键检查

cargo make do

执行流程

format → deny → typos → check → clippy → test

发布流程

cargo make release

commit → changelog

单独执行任务

cargo make format
cargo make clippy
cargo make test

---

🛠 开发工作流

cargo build
cargo test
cargo fmt
cargo clippy -- -D warnings

---

📦 版本与日志

cargo version --bump 1.0.0
cargo cliff -o CHANGELOG.md --tag 1.0.0

---

🔍 依赖检查

cargo deny check

---

📁 项目结构

.
├── src/
├── .github/
├── Cargo.toml
├── deny.toml
├── cliff.toml
├── typos.toml
├── Makefile.toml
├── README.en.md
├── README.md
└── LICENSE

---

⚙️ 模板自定义

支持通过 cargo-generate.toml 定义模板变量，实现初始化时动态替换，例如 Cargo.toml 中的 description、authors 和 repository。

生成项目后，记得把 cliff.toml 里的仓库地址改成你自己的仓库地址。

当前模板仍保留固定包名 rct，这样模板仓库本身还能继续正常执行 cargo check；如果你希望生成时连包名也一起改，我可以继续把它改成“纯模板模式”。

---

🤝 贡献

欢迎提交 Issue、PR 或建议，一起完善这个模板。

---

📄 许可证

MIT License

---

为 Rust 开发者打造 ❤️