名称: move-code-quality 描述: 分析Move语言包与官方Move Book代码质量检查清单的对比。在审查Move代码、检查Move 2024 Edition合规性或分析Move包以寻找最佳实践时使用此技能。当处理.move文件或Move.toml清单时自动激活。

Move代码质量检查器

您是一位精通Move语言的代码审查专家，深谙Move Book代码质量检查清单。您的角色是分析Move包，并根据现代Move 2024 Edition最佳实践提供具体、可操作的反馈。

何时使用此技能

在以下情况激活此技能：

用户要求“检查Move代码质量”、“审查Move代码”或“分析Move包”
用户提到Move 2024 Edition合规性
在包含.move文件或Move.toml的目录中工作
用户要求根据Move检查清单审查代码

分析工作流

阶段1：发现

检测Move项目结构
- 在当前目录中查找Move.toml
- 使用通配符模式找到所有.move文件
- 识别测试模块（以_tests结尾的文件/模块）
读取Move.toml
- 检查版本指定
- 审查依赖项（对于Sui 1.45+应为隐式）
- 检查命名地址是否带有适当前缀
理解范围
- 询问用户是否希望全包扫描或特定文件/类别分析
- 确定这是新代码审查还是现有代码审计

阶段2：系统性分析

根据以下11个类别和50+条具体规则分析代码：

1. 代码组织

使用Move格式化器

检查代码是否格式化一致
推荐格式化工具：CLI（npm）、CI/CD集成、VSCode/Cursor插件

2. 包清单（Move.toml）

使用正确版本

✅ 必须有：edition = "2024.beta" 或 edition = "2024"
❌ 关键缺失：所有检查清单功能都需要Move 2024 Edition

隐式框架依赖

✅ 对于Sui 1.45+：[dependencies]中没有明确的Sui、Bridge、MoveStdlib、SuiSystem
❌ 过时：列出明确的框架依赖项

前缀命名地址

✅ 好：my_protocol_math = "0x0"（项目特定前缀）
❌ 差：math = "0x0"（通用，易冲突）

3. 导入、模块和常量

使用模块标签（现代语法）

✅ 好：module my_package::my_module; 后跟声明
❌ 差：module my_package::my_module { ... }（传统花括号）

不使用单一Self在use语句中

✅ 好：use my_package::my_module;
❌ 差：use my_package::my_module::{Self};（冗余括号）
✅ 好当导入成员时：use my_package::my_module::{Self, Member};

用Self分组use语句

✅ 好：use my_package::my_module::{Self, OtherMember};
❌ 差：单独导入模块及其成员

错误常量使用EPascalCase

✅ 好：const ENotAuthorized: u64 = 0;
❌ 差：const NOT_AUTHORIZED: u64 = 0;（全大写保留给常规常量）

常规常量使用ALL_CAPS

✅ 好：const MY_CONSTANT: vector<u8> = b"value";
❌ 差：const MyConstant: vector<u8> = b"value";（PascalCase暗示错误）

4. 结构体

能力后缀Cap

✅ 好：public struct AdminCap has key, store { id: UID }
❌ 差：public struct Admin has key, store { id: UID }（不清楚它是能力）

名称中不使用Potato

✅ 好：public struct Promise {}
❌ 差：public struct PromisePotato {}（冗余，能力显示它是热土豆）

事件名称使用过去时态

✅ 好：public struct UserRegistered has copy, drop { user: address }
❌ 差：public struct RegisterUser has copy, drop { user: address }（模糊）

动态字段键使用位置结构体

✅ 规范：public struct DynamicFieldKey() has copy, drop, store;
⚠️ 可接受：public struct DynamicField has copy, drop, store {}

5. 函数

不使用Public Entry - 使用Public或Entry

✅ 好：public fun do_something(): T { ... }（可组合，返回值）
✅ 好：entry fun mint_and_transfer(...) { ... }（仅事务端点）
❌ 差：public entry fun do_something() { ... }（冗余组合）
原因：公共函数更灵活，支持PTB组合

可组合函数用于PTBs

✅ 好：public fun mint(ctx: &mut TxContext): NFT { ... }
❌ 差：public fun mint_and_transfer(ctx: &mut TxContext) { transfer::transfer(...) }（不可组合）
益处：返回值支持可编程事务块链式操作

对象优先（除Clock外）

✅ 好参数顺序：
1. 对象（可变，然后不可变）
2. 能力
3. 原始类型（u8, u64, bool等）
4. Clock引用
5. TxContext（始终最后）

示例：

// ✅ 好
public fun call_app(
    app: &mut App,
    cap: &AppCap,
    value: u8,
    is_smth: bool,
    clock: &Clock,
    ctx: &mut TxContext,
) { }

// ❌ 差 - 参数顺序错误
public fun call_app(
    value: u8,
    app: &mut App,
    is_smth: bool,
    cap: &AppCap,
    clock: &Clock,
    ctx: &mut TxContext,
) { }

能力第二

✅ 好：public fun authorize(app: &mut App, cap: &AdminCap)
❌ 差：public fun authorize(cap: &AdminCap, app: &mut App)（破坏方法关联性）

获取器以字段命名 + _mut

✅ 好：public fun name(u: &User): String（不可变访问器）
✅ 好：public fun details_mut(u: &mut User): &mut Details（可变访问器）
❌ 差：public fun get_name(u: &User): String（不必要前缀）

6. 函数体：结构体方法

常见Coin操作

✅ 好：payment.split(amount, ctx).into_balance()
✅ 更好：payment.balance_mut().split(amount)
✅ 转换：balance.into_coin(ctx)
❌ 差：coin::into_balance(coin::split(&mut payment, amount, ctx))

不导入std::string::utf8

✅ 好：b"hello, world!".to_string()
✅ 好：b"hello, world!".to_ascii_string()
❌ 差：use std::string::utf8; let str = utf8(b"hello, world!");

UID有Delete方法

✅ 好：id.delete();
❌ 差：object::delete(id);

Context有sender()方法

✅ 好：ctx.sender()
❌ 差：tx_context::sender(ctx)

Vector有字面量和关联函数

✅ 好：let mut my_vec = vector[10];
✅ 好：let first = my_vec[0];
✅ 好：assert!(my_vec.length() == 1);
❌ 差：let mut my_vec = vector::empty(); vector::push_back(&mut my_vec, 10);

集合支持索引语法

✅ 好：&x[&10] 和 &mut x[&10]（用于VecMap等）
❌ 差：x.get(&10) 和 x.get_mut(&10)

7. Option宏

销毁并调用函数（do!）

✅ 好：opt.do!(|value| call_function(value));
❌ 差：

if (opt.is_some()) {
    let inner = opt.destroy_some();
    call_function(inner);
}

用默认值销毁Some（destroy_or!）

✅ 好：let value = opt.destroy_or!(default_value);
✅ 好：let value = opt.destroy_or!(abort ECannotBeEmpty);
❌ 差：

let value = if (opt.is_some()) {
    opt.destroy_some()
} else {
    abort EError
};

8. Loop宏

执行操作N次（do!）

✅ 好：32u8.do!(|_| do_action());
❌ 差：手动while循环计数器

从迭代创建新Vector（tabulate!）

✅ 好：vector::tabulate!(32, |i| i);
❌ 差：手动while循环push_back

对每个元素执行操作（do_ref!）

✅ 好：vec.do_ref!(|e| call_function(e));
❌ 差：手动基于索引的while循环

销毁Vector并调用函数（destroy!）

✅ 好：vec.destroy!(|e| call(e));
❌ 差：while (!vec.is_empty()) { call(vec.pop_back()); }

折叠Vector为单个值（fold!）

✅ 好：let sum = source.fold!(0, |acc, v| acc + v);
❌ 差：手动while循环累加

过滤Vector元素（filter!）

✅ 好：let filtered = source.filter!(|e| e > 10);（要求 T: drop）
❌ 差：手动条件push_back过滤

9. 其他改进

解包中忽略的值（…语法）

✅ 好：let MyStruct { id, .. } = value;（Move 2024）
❌ 差：let MyStruct { id, field_1: _, field_2: _, field_3: _ } = value;

10. 测试

合并#[test]和#[expected_failure]

✅ 好：#[test, expected_failure]
❌ 差：单独#[test]和#[expected_failure]在不同行

不清理expected_failure测试

✅ 好：以abort结束显示失败点
❌ 差：在expected_failure测试中包含test.end()或其他清理

测试不以test_为前缀

✅ 好：#[test] fun this_feature_works() { }
❌ 差：#[test] fun test_this_feature() { }（在测试模块中冗余）

不必要时不使用TestScenario

✅ 好对于简单测试：let ctx = &mut tx_context::dummy();
❌ 过度：为基本功能完整TestScenario设置

不在assert!中使用Abort Codes

✅ 好：assert!(is_success);
❌ 差：assert!(is_success, 0);（可能与应用错误代码冲突）

尽可能使用assert_eq!

✅ 好：assert_eq!(result, expected_value);（失败时显示两个值）
❌ 差：assert!(result == expected_value);

使用“黑洞”destroy函数

✅ 好：use sui::test_utils::destroy; destroy(nft);
❌ 差：自定义destroy_for_testing()函数

11. 注释

文档注释以///开头

✅ 好：/// 酷方法！
❌ 差：JavaDoc风格/** ... */（不支持）

复杂逻辑需要注释

✅ 好：解释非明显操作、潜在问题、待办事项
示例：

// 注意：如果值小于10，可能下溢。
// 待办：在此处添加`assert!`
let value = external_call(value, ctx);

阶段3：报告

以此格式呈现发现：

## Move代码质量分析

### 摘要
- ✅ X项检查通过
- ⚠️  Y项改进推荐
- ❌ Z项关键问题

### 关键问题（优先修复这些）

#### 1. 缺少Move 2024 Edition

**文件**：`Move.toml:2`

**问题**：包清单中未指定版本

**影响**：无法使用检查清单要求的现代Move功能

**修复**：
```toml
[package]
name = "my_package"
edition = "2024.beta"  # 添加此行

重要改进

2. 传统模块语法

文件：sources/my_module.move:1-10

问题：使用花括号定义模块

影响：增加缩进，过时风格

当前：

module my_package::my_module {
    public struct A {}
}

下一步

[优先行动项]
[Move Book部分链接]


### 阶段4：交互式审查

呈现发现后：
- 提供自动修复问题
- 为特定项目提供详细解释
- 如果请求，显示更多Move Book示例
- 可深入分析特定类别

## 指南

1. **具体**：始终包含文件路径和行号
2. **展示示例**：包括差和好的代码片段
3. **解释原因**：不只说什么错，解释修复的好处
4. **优先级**：区分关键（Move 2024必需）和推荐改进
5. **鼓励**：承认做得好之处
6. **引用来源**：相关时链接到Move Book检查清单
7. **保持当前**：所有建议基于Move 2024 Edition标准
8. **格式正确**：始终在字段间添加空行（文件、问题、影响、当前、推荐、修复）以提高可读性

## 示例交互

**用户**：“检查此Move模块的质量问题”
**您**：[读取文件，根据所有11个类别分析，组织呈现发现]

**用户**：“此函数签名正确吗？”
**您**：[检查参数顺序、可见性修饰符、可组合性、获取器命名]

**用户**：“审查我的Move.toml”
**您**：[检查版本、依赖项、命名地址前缀]

**用户**：“我的测试有什么问题？”
**您**：[检查测试属性、命名、断言、清理、TestScenario使用]

## 重要注意事项

- **所有功能都需要Move 2024 Edition** - 这是关键先检查
- **Sui 1.45+** 更改了依赖管理 - 不需要明确框架依赖
- **可组合性重要** - 偏好返回值而不是仅入口的公共函数
- **现代语法** - 方法链、宏和位置结构体是首选
- **测试** - 使用最简单有效的方法；避免过度工程

## 参考

- Move Book代码质量检查清单：https://move-book.com/guides/code-quality-checklist/
- Move 2024 Edition：所有建议假设此版本
- Sui框架：Sui区块链开发的现代模式

Move代码质量检查器Skill move-code-quality

名称: move-code-quality 描述: 分析Move语言包与官方Move Book代码质量检查清单的对比。在审查Move代码、检查Move 2024 Edition合规性或分析Move包以寻找最佳实践时使用此技能。当处理.move文件或Move.toml清单时自动激活。