关于 rust-code-quality
面向 Rust 开发者的代码质量审查技能,按结构、错误处理、异步、测试和文档等维度检查项目,并生成分项质量报告。
主要功能
- 01检查文件规模与模块结构
- 02审查错误处理与 unwrap 使用
- 03检查异步模式
- 04评估测试与文档
适用场景
- 01审查 Rust 项目的代码质量
- 02查找生产代码中的 unwrap
- 03整理测试覆盖与公共 API 文档问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ d-o-hub/ rust-self-learning-memory --skill rust-code-quality安装后在 Claude Code 中输入/rust-code-quality确认已加载。
附带文件quality-dimensions.md
详细介绍
Rust 代码质量审查
根据最佳实践,系统地审查 Rust 代码质量。
质量维度
| 维度 | 关注点 | 工具 |
|---|---|---|
| 结构 | 文件少于 500 行,模块层级 | find . -name "*.rs" |
| 错误处理 | 自定义 Error、Result、不使用 unwrap | rg "unwrap|Result<" |
| 异步模式 | async fn、spawn_blocking、不阻塞 | rg "async fn|spawn_blocking" |
| 测试 | 覆盖率超过 90%,集成测试 | cargo tarpaulin |
| 文档 | 100% 的公共 API 均有文档 | cargo doc --no-deps |
分析命令
# Project structure
find . -name "*.rs" -not -path "*/target/*" -exec wc -l {} + | sort -rn
# Error handling
rg "unwrap\(\)" --glob "!*/tests/*" --glob "*.rs"
# Async patterns
rg "async fn|spawn_blocking|tokio::" --glob "*.rs"
# Testing
cargo test --all
cargo tarpaulin --out Html
# Linting
./scripts/code-quality.sh fmt
./scripts/code-quality.sh clippy --workspace
cargo audit
输出格式
# Rust Code Quality Report
## Summary
- **Score**: X/100
- **Critical Issues**: N
- **Warnings**: M
## By Dimension
- Structure: X/10 - [Status]
- Error Handling: X/10 - [Status]
- Async Patterns: X/10 - [Status]
- Testing: X/10 - [Status]
- Documentation: X/10 - [Status]
## Critical Issues
1. [Issue] - File:line
- Fix: [Recommendation]
## Action Items
### High Priority
- [ ] Fix critical issues
### Medium Priority
- [ ] Address warnings
最佳实践检查清单
✓ 文件少于 500 行 ✓ 模块层级清晰 ✓ 自定义 Error 枚举 ✓ 易出错操作使用 Result ✓ 生产代码中不使用 unwrap() ✓ IO 操作使用 async fn ✓ CPU 密集型工作使用 spawn_blocking ✓ 测试覆盖率超过 90% ✓ 为公共 API 编写文档
评论
支持 Markdown