Godot Verification Skill

Validate Godot project changes using gdlint, gdformat, gdradon, godot export commands, and LSP diagnostics.

排除规则

不要检查和处理 addons 目录下的任何文件。

addons 目录通常包含第三方插件或外部资源，这些代码不由项目维护，不应纳入项目代码质量检查范围。

检查项

gdradon 输出

gdradon cc <path>

输出格式：

F <line>:<col> <function_name> - <grade> (<cc>)

示例：

.\character_body_2d.gd
    F 13:0 _physics_process - C (15)

使用示例

# Lint 检查
gdlint "D:/project/scripts/Player.gd"

# Format 检查
gdformat --check "D:/project/scripts/Player.gd"

# 代码指标
gdradon cc D:/project/scripts/

# LSP 诊断（DiagnosticsServer 为开机自启动服务）
# 调用 MCP 工具获取诊断（只需 uri 参数）
godot-lsp__diagnostics(uri="file:///D:/project/game/player.gd")

# LSP 诊断（修改代码后使用 refresh=true）
godot-lsp__diagnostics(uri="file:///D:/project/game/player.gd", refresh=true)

# 完整检查
gdlint D:/project/scripts/ && gdformat D:/project/scripts/ && gdradon cc D:/project/scripts/

# 导出验证
godot --headless --path "D:/project" --export-pack "Web" "D:/export.pck"

LSP Diagnostics

Godot LSP 诊断提供实时的语法检查和错误检测，与 Godot 编辑器显示的诊断一致。

前置条件

1. Godot 编辑器运行（Godot LSP 服务器在编辑器启动时自动开启，默认端口 6005）
2. DiagnosticsServer 运行（开机自启动服务，提供诊断缓存）

MCP 工具调用

工具名: godot-lsp__diagnostics

参数:

• uri (必需): file:// URI，例如 file:///D:/project/game/player.gd
• refresh (可选): 是否强制刷新诊断缓存，默认 false

返回:

{
  "uri": "file:///D:/project/game/player.gd",
  "diagnostics": [
    {
      "range": { "start": { "line": 4, "character": 0 }, "end": { "line": 4, "character": 56 } },
      "severity": 2,
      "code": 9,
      "source": "gdscript",
      "message": "(SHADOWED_GLOBAL_IDENTIFIER): The constant \"AttackType\" has the same name as a global class..."
    }
  ],
  "cached": false  // true 表示从缓存返回，false 表示新打开文件
}

说明:

• DiagnosticsServer 会自动读取文件内容，无需传递 text 参数
• 首次查询会打开文件并等待诊断（约 500ms）
• 后续查询直接从缓存返回，速度更快
• 修改代码后推荐使用 refresh=true 强制刷新缓存，确保获取最新诊断结果

诊断级别 (severity)

常见诊断代码

HTTP API（直接访问 DiagnosticsServer）

# 获取诊断
curl "http://127.0.0.1:3457/diagnostics?path=D:/project/game/player.gd"

# 刷新诊断
curl -X POST "http://127.0.0.1:3457/refresh" -d "{\"path\":\"D:/project/game/player.gd\"}"

# 查看状态
curl "http://127.0.0.1:3457/stats"

与 gdlint 对比

建议: 使用 LSP Diagnostics 作为快速检查，gdlint 作为补充 lint 规则检查。

Lint Rules (gdlint)

Error Handling

Common Workflows

After Code Changes

gdlint "D:/project/scripts/Player.gd"

Pre-commit Validation

gdlint D:/project/scripts/ && gdformat D:/project/scripts/

Code Metrics Analysis

gdradon cc D:/project/scripts/

输出示例：

.\character_body_2d.gd
    F 13:0 _physics_process - C (15)

Export Validation

godot --headless --path "D:/project" --export-pack "Web" "D:/export.pck"

安装要求

• pip install gdtoolkit (gdlint, gdformat)
• pip install gdradon (code metrics)
• godot in PATH (export validation)

Tips

• Use file param to check only changed files (faster)
• gdformat --check shows what would change without modifying
• gdradon cc shows complexity and maintainability metrics
• Export validation catches dependency issues lint misses