gdscript-format

minami110 的头像作者 minami110

使用gdscript-formatter格式化和检查GDScript文件。编辑GDScript文件后使用以确保代码风格一致性。

📖 中文导读:使用gdscript-formatter格式化和检查GDScript文件。编辑GDScript文件后使用以确保代码风格一致性。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: GDScript Format description: Format and lint GDScript files using gdscript-formatter. Use after editing GDScript files to ensure code style consistency. allowed-tools:

  • Bash hooks: PreToolUse:
    • matcher: "Bash" hooks:
      • type: command command: "${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/ensure-binary.sh" once: true

GDScript Format

Format and lint GDScript files using the gdscript-formatter tool from GDQuest.

When to Use

  • After creating or editing GDScript files
  • Before committing code to ensure style consistency
  • When running code quality checks

Format

Format GDScript files using the format script included in this skill (${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/format.sh).

Single File

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/format.sh path/to/file.gd

Multiple Files

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/format.sh path/to/file1.gd path/to/file2.gd

Safe Mode

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/format.sh --safe path/to/file.gd

Verifies that formatting doesn't change code semantics.

Check Mode (CI)

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/format.sh --check path/to/file.gd

Returns exit code 1 if changes are needed (useful for CI/CD).

Reorder Code

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/format.sh --reorder-code path/to/file.gd

Reorders code according to GDScript style guide.

Lint

Check code style using the lint script included in this skill (${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/lint.sh).

Single File

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/lint.sh path/to/file.gd

With Options

${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/lint.sh --max-line-length 120 path/to/file.gd
${CLAUDE_PLUGIN_ROOT}/skills/gdscript-format/scripts/lint.sh --disable unused-argument,private-access path/to/file.gd

Lint Rules

Available rules include:

  • Naming: function-name, class-name, variable-name, signal-name
  • Quality: unused-argument, max-line-length, no-else-return, private-access

Exit Codes

  • 0: Success (no issues or formatting applied)
  • 1: Issues found or changes needed
  • 2: Error (binary not found, invalid file, etc.)