GDSuite Docs

Under the hood

The four tools GDSuite runs for you. You don't need to install them separately.

GDSuite is one program you install and one command you learn. Behind it, four specialized tools do the work. They are built into the gdsuite program, at versions tested together: you never need to install them yourself.

gdtidy, gdtest and gdhealth read GDScript with gdsyntax, a port of Godot's own parser, so they understand your code the way Godot does. gdtypecheck and gdtest run Godot itself, without a window.

Why separate tools?

Each tool can be used on its own, and released on its own, by people who only want one of them. GDSuite builds in a version of each that was tested with the others, and gives them one command, one settings file and one place to read about them: this site. Each GDSuite release says which tool versions it contains, and gdsuite doctor shows them.

When to read a tool's own site

Rarely. The pages you need, such as the lint rules or how to write tests, are on this site. A tool's site covers what only matters when you use it without GDSuite (installing it, its own settings file), and every option of its command line, which you reach through GDSuite with --:

gdsuite test -- --help

Where things are

my-game/
├── gdsuite.toml          settings for GDSuite and every tool
├── addons/
│   ├── gdtest/           lets your tests run inside Godot
│   └── gdsuite/          GDSuite in the Godot editor: Check, Problems, Tests, formatting
├── .gdsuite/             not committed
│   ├── bin/              the gdsuite the editor addon runs
│   ├── tools/gdtest/     the test addon's source, and the gdtest the Tests dock runs
│   └── state/            what was installed, and where Godot is
└── reports/              not committed: JSON reports and code health's report