gdsuite.toml
Every key of gdsuite.toml, with its default.
gdsuite.toml sits next to project.godot. Every key is optional: a missing
key takes the default below. Configure GDSuite explains how the
file is organized.
GDSuite's sections
| Key | Default | Description |
|---|---|---|
[project] root | "." | The Godot project folder, relative to this file |
[project] godot_exe | none | The Godot program, when every computer has it at the same place. Usually left out: see Where Godot is |
[tools] gdtest_source | Built in | Another build of gdtest (tool sources) |
[tools] gdhealth_source | Built in | Another build of gdhealth (tool sources) |
[tools] gdtypecheck_source | Built in | Another build of gdtypecheck (tool sources) |
[tools] gdtidy_source | Built in | Another build of gdtidy (tool sources) |
[commands] default_test_target | "test/" | What gdsuite test runs when given no arguments |
[commands] default_health_subcommand | "health" | What gdsuite health runs when given no arguments |
[reports] default | "text" | "json" makes --report json the default |
[reports] artifacts_dir | "reports/gdsuite" | Where JSON reports are saved |
[check] steps | ["fmt", "lint", "typecheck", "health"] | The steps of gdsuite check, in order: any of fmt, lint, typecheck, test, health |
[editor] format_on_save | Each person's choice | Format scripts when they are saved in the Godot editor, for everyone |
[editor] lint_on_save | Each person's choice | Lint scripts when they are saved in the Godot editor, for everyone |
[editor] type_check_on_save | Each person's choice | Type check the project after saving in the Godot editor, for everyone |
[editor] run_tests_on_save | Each person's choice | Run the tests again when a script is saved in the Godot editor, for everyone |
Tool sources
Without a source, GDSuite runs the tool built into it, at the version it was
tested with. Give a source only to try another build of a tool, such as one
you are working on: gdsuite setup then builds it into .gdsuite/, with
Rust.
A tool source is one of:
| Form | Example | Meaning |
|---|---|---|
path:<folder> | path:../gdtest | Built from a local copy (needs Rust) |
git:<url>?rev=<rev> | git:https://github.com/q-rault/gdtest?rev=v0.2.3 | Built from a Git repository at a tag or commit (needs Rust and Git) |
GDSuite 0.5 and earlier also took github: (a release archive) and crate:
(a crates.io version) sources. gdsuite update
removes them for GDSuite's own tools, which are built in now.
The features' sections
| Section | Feature | Keys |
|---|---|---|
[fmt] | Formatting | Format and lint settings |
[lint], [lint.rules.<rule>] | Linting | Format and lint settings, Lint rules |
[test], [test.profile.<name>] | Testing | Test settings |
[health.<section>] | Code health | Health settings |
On those pages, the keys are shown as they are written in each tool's own
file: write [health.groups] where the page says [groups], and
[test.profile.ci] where it says [profile.ci].