108 lines
3.0 KiB
Markdown
108 lines
3.0 KiB
Markdown
# Move代码质量检查
|
||
|
||
`Move语言` `代码质量` `Claude Code` `静态分析`
|
||
|
||
# Move 代码质量检查器 - Claude Code 技能
|
||
|
||
一个 Claude Code 技能，用于根据官方 [Move Book 代码质量清单](https://move-book.com/guides/code-quality-checklist/) 分析 Move 语言包，帮助你编写更优质、更易维护的 Move 代码。
|
||
|
||
## 概述
|
||
|
||
本技能为 Claude Code 扩展了 Move 语言最佳实践的深度知识，提供：
|
||
|
||
- **自动化代码质量分析** — 涵盖 10+ 类最佳实践
|
||
- **具体可执行的建议** — 附带 Move Book 中的示例
|
||
- **Move 2024 版本合规性检查**
|
||
- **包清单（Package Manifest）验证**
|
||
- **函数签名与结构分析**
|
||
- **测试最佳实践审查**
|
||
|
||
## 检查内容
|
||
|
||
本技能从多个维度分析你的 Move 代码：
|
||
|
||
1. **代码组织** — 格式一致性
|
||
2. **包清单** — 版本要求、依赖项、命名地址
|
||
3. **导入与模块** — 现代语法、命名约定
|
||
4. **结构体** — 能力模式、事件命名、动态字段
|
||
5. **函数** — 可见性修饰符、可组合性、参数顺序
|
||
6. **函数体** — 方法链式调用、字符串操作、集合使用
|
||
7. **Option 与循环宏** — 现代惯用模式
|
||
8. **测试** — 属性使用、断言、清理模式
|
||
9. **文档** — 注释质量与完整性
|
||
|
||
## 安装
|
||
|
||
### 通过 Claude Code 安装
|
||
|
||
```bash
|
||
# 克隆到你的 Claude 技能目录
|
||
git clone https://github.com/1NickPappas/move-code-quality-skill ~/.claude/skills/move-code-quality
|
||
```
|
||
|
||
### 手动安装
|
||
|
||
1. 如果技能目录不存在，先创建它：
|
||
```bash
|
||
mkdir -p ~/.claude/skills
|
||
```
|
||
|
||
2. 将本技能克隆或复制到技能目录：
|
||
```bash
|
||
cd ~/.claude/skills
|
||
git clone https://github.com/1NickPappas/move-code-quality-skill
|
||
```
|
||
|
||
3. Claude Code 在处理 Move 代码时会自动加载该技能
|
||
|
||
## 使用方法
|
||
|
||
处理 Move 代码时，本技能会自动激活。你也可以显式调用它：
|
||
|
||
```
|
||
分析这个 Move 包的代码质量问题
|
||
```
|
||
|
||
```
|
||
根据 Move 代码质量清单审查这个模块
|
||
```
|
||
|
||
```
|
||
检查这段代码是否符合 Move 2024 最佳实践
|
||
```
|
||
|
||
## 示例
|
||
|
||
本技能根据 Move Book 示例提供具体反馈：
|
||
|
||
- **修改前**：`use my_package::{Self};`
|
||
- **修改后**：`use my_package;`
|
||
- **原因**：避免冗余的 Self 导入
|
||
|
||
- **修改前**：`public entry fun transfer(...)`
|
||
- **修改后**：`public fun transfer(...)`
|
||
- **原因**：公共函数对可编程事务块（PTB）具有更好的可组合性
|
||
|
||
## 环境要求
|
||
|
||
- Claude Code CLI
|
||
- Move 2024 版本项目
|
||
- 对 Move 语言有基本了解
|
||
|
||
## 贡献
|
||
|
||
欢迎贡献！详情请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
||
|
||
## 许可证
|
||
|
||
本项目基于 MIT 许可证 — 详情请参阅 [LICENSE](LICENSE) 文件。
|
||
|
||
## 相关资源
|
||
|
||
- [Move Book 代码质量清单](https://move-book.com/guides/code-quality-checklist/)
|
||
- [Move 语言文档](https://move-language.github.io/move/)
|
||
- [Claude Code 技能文档](https://docs.claude.com/claude-code)
|
||
|
||
## 致谢
|
||
|
||
本技能基于 Move 社区 [The Move Book](https://move-book.com/) 中全面的代码质量指南开发。 |