# rust-cli-01

**Repository Path**: YusHome/rust-cli-01

## Basic Information

- **Project Name**: rust-cli-01
- **Description**: Rust Cli code
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-16
- **Last Updated**: 2025-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目描述

## 执行 pre-commit

```bash
pre-commit install
```

## git 配置

```bash
git status

git add .

git commit -a   #:wq
```

### 在仓库中建 repo，配置项目的访问

#### 全局

```bash
git config --global user.name "Yu'sHome"
git config --global user.email "464602584@qq.com"
```

#### 或者针对项目

```bash
git config user.name "Yu'sHome"
git config user.email "464602584@qq.com"
```

#### 提交

```bash
git commit -a
```

#### 推送

```bash
git push
```

#### tag

```bash
git tag -a 0.1.1
git push --tags
```

#### review 代码时

1. 切换分支、提交

```bash
git checkout -b feature/fix-how-review-code
git add .
git commit -a
git push origin feature/fix-how-review-code
```

2. 创建 PR, 填写描述
3. 合并分支，删除分支
4. 切回分支

```bash
git checkout master
git pull
```

## 环境设置

### 安装 Rust

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

### 安装 VSCode 插件

- crates: Rust 包管理
- Even Better TOML: TOML 文件支持
- Better Comments: 优化注释显示
- Error Lens: 错误提示优化
- GitLens: Git 增强
- 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 文件支持

### 安装 cargo generate

cargo generate 是一个用于生成项目模板的工具。它可以使用已有的 github repo 作为模版生成新的项目。

```bash
cargo install cargo-generate
```

在我们的课程中，新的项目会使用 `tyr-rust-bootcamp/template` 模版生成基本的代码：

配置 `~/.cargo/config.toml`
[favorites.tpl]
git = "https://gitee.com/YusHome/template"
branch = "master"

```bash
cargo generate tpl
```

### 安装 pre-commit

pre-commit 是一个代码检查工具，可以在提交代码前进行代码检查。

```bash
pipx install pre-commit
```

安装成功后运行 `pre-commit install` 即可。

### 安装 Cargo deny

Cargo deny 是一个 Cargo 插件，可以用于检查依赖的安全性。

```bash
cargo install --locked cargo-deny
```

cd ~/.cargo/advisory-db
git clone https://github.com/rustsec/advisory-db && mv advisory-db github.com-2f857891b7f43c59

--https://github.com/EmbarkStudios/cargo-deny/issues/692

### 安装 typos

typos 是一个拼写检查工具。

```bash
cargo install typos-cli
```

### 安装 git cliff

git cliff 是一个生成 changelog 的工具。

```bash
cargo install git-cliff
```

### 安装 cargo nextest

cargo nextest 是一个 Rust 增强测试工具。

```bash
cargo install cargo-nextest --locked
```

### 生成项目

cargo generate tpl