rust-template/README.md

63 lines
1.3 KiB
Markdown
Raw Normal View History

2024-08-08 15:02:37 +08:00
# {{ project-name }}
{{ project_description }}
2024-03-20 13:00:16 +08:00
2024-08-08 15:02:37 +08:00
## 环境设置说明
2024-03-20 13:00:16 +08:00
### 安装 Rust
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2024-08-08 15:02:37 +08:00
### 推荐安装的 VSCode 插件
2024-03-20 13:00:16 +08:00
2024-08-08 15:02:37 +08:00
- Dependi: Rust 包管理
2024-03-20 13:00:16 +08:00
- Even Better TOML: TOML 文件支持
- Better Comments: 优化注释显示
- Error Lens: 错误提示优化
2024-08-08 15:02:37 +08:00
- GitLens — Git supercharged: Git 增强
2024-03-20 13:00:16 +08:00
- Github Copilot: 代码提示
- indent-rainbow: 缩进显示优化
- Prettier - Code formatter: 代码格式化
- REST client: REST API 调试
- rust-analyzer: Rust 语言支持
- Rust Test lens: Rust 测试支持
- Rust Test Explorer: Rust 测试概览
- TODO Highlight: TODO 高亮
- vscode-icons: 图标优化
- YAML: YAML 文件支持
### 安装 pre-commit
pre-commit 是一个代码检查工具,可以在提交代码前进行代码检查。
```bash
pipx install pre-commit
```
安装成功后运行 `pre-commit install` 即可。
### 安装 Cargo deny
Cargo deny 是一个 Cargo 插件,可以用于检查依赖的安全性。
```bash
cargo install --locked cargo-deny
```
### 安装 typos
typos 是一个拼写检查工具。
```bash
cargo install typos-cli
```
### 安装 cargo nextest
cargo nextest 是一个 Rust 增强测试工具。
```bash
cargo install cargo-nextest --locked
```