Configure GDSuite
All your settings in one file, gdsuite.toml, next to project.godot.
GDSuite works without any settings. When you want to change something (a
lint rule, a code health limit, the steps of the check), it goes in one file:
gdsuite.toml, next to project.godot. Commit it, so everyone on the
project, and CI, uses the same settings.
What init writes
[project]
root = "."
# The tools are built into gdsuite: updating gdsuite updates them. To use
# another build of a tool instead, add a [tools] section:
# https://q-rault.github.io/gdsuite/reference/gdsuite-toml
[commands]
default_test_target = "test/"
default_health_subcommand = "health"
[reports]
default = "text"
artifacts_dir = "reports/gdsuite"
[check]
steps = ["fmt", "lint", "typecheck", "health"]The ones you are most likely to change:
[check] steps: the steps ofgdsuite check, in order. Add"test"to run your tests too.[commands] default_test_target: the foldergdsuite testruns.
There is no tool version in it: the tools are built into GDSuite, so
updating GDSuite updates them. To use another
build of a tool, such as one you are working on, give it a source in
[tools] (tool sources).
A section per feature
Each feature reads its own section, which you add when you need it:
# Formatting
[fmt]
dict-brace-spaces = false
# Linting
[lint]
disable = ["max-public-methods"]
[lint.rules.max-line-length]
max = 130
# Testing
[test]
exclude = ["test/helpers/**"]
timeout = 15000
# Code health
[health.thresholds]
cyclomatic_warn = 12
[health.discovery]
exclude = ["addons/**", "reports/**"]Every key of each section is in the reference: Format and lint settings, Test settings, Health settings. Type checking has no settings.
These sections apply however a feature runs: through gdsuite, from the
Tests dock in the Godot editor, or when one of the tools is started on its
own.
Settings that differ between your computer and CI
The test runner has profiles: a set of settings you switch on by name.
[test.profile.ci]
fail_fast = true
reporter = "junit"gdsuite test -- --profile ciWhere Godot is
Godot's path is not in gdsuite.toml, since it differs from one computer to
the next. gdsuite init --godot-exe <path> remembers it for the project on
your computer, and the GODOT_EXE environment variable sets it everywhere.
[project] godot_exe works too, if every computer has Godot at the same
place.
Older settings files
GDSuite's tools also accept their own settings files: gdtest.toml,
gdhealth.toml and gdtidy.toml. They are meant for people who use one of
the tools without GDSuite. In a GDSuite project, keep everything in
gdsuite.toml:
- when
gdsuite.tomlhas a tool's section, that tool ignores its own file and prints a warning; the two are never merged; gdsuite migratemoves those files intogdsuite.tomlfor you, comments included.
gdtoolkit's gdlintrc and gdformatrc are converted by gdsuite init; see
Coming from gdtoolkit.
Go further
gdsuite.toml reference lists every key of GDSuite's own sections.