GDSuite Docs

Check everything at once

One command runs formatting, lint, type checking and code health, the same way everywhere.

gdsuite check runs the checks one after the other, and stops at the first that finds a problem:

gdsuite check
pass: Formatting check passed (fmt, 10ms)
pass: Lint check passed (lint, 9ms)
pass: GDScript type check passed (typecheck, 289ms)
pass: Health checks passed (health, 78ms)

Run it whenever you finish a change, before you commit. Run it in CI too: when it passes on your machine, it passes there.

The steps

StepWhat it doesIt fails whenFix it with
fmtChecks formatting, changes nothingA script isn't formattedgdsuite fmt
lintRuns the linterA rule reports a problemgdsuite lint -- --fix, then by hand
typecheckRuns the type checkGodot reports an errorBy hand
testRuns your tests (not by default)A test failsBy hand
healthMeasures code healthCode health could not run

Tests are left out by default because they take longer than the rest. Run gdsuite test separately, or add them:

# gdsuite.toml
[check]
steps = ["fmt", "lint", "typecheck", "test", "health"]

Remove a step from the list to skip it, for example health while you set it up.

When it fails

The failing step says what it found and how to fix it:

pass: Formatting check passed (fmt, 10ms)
error: Lint check failed (lint, 9ms)
test/test_player.gd:12:24 [duplicated-load] duplicated loading of "res://player/player.gd"

Found 1 lint problem. Fix them and rerun `gdsuite check`.
error: check failed

Fix, run gdsuite check again, and the next step runs.

In the Godot editor

The editor addon has a Check icon in the top bar: it runs the same steps, shows by its colour whether the project has errors or warnings, and lists each step's result in its tooltip.

For scripts and CI

gdsuite check --report json prints the result of every step as JSON and saves it in reports/gdsuite/check.json. See Run it in CI and Reports.