GDSuite Docs
Existing projects

Add GDSuite to an existing project

Adopt GDSuite in a project that already has code, settings, or other tools, one step at a time.

A project with months of code will have a lot to report the first time. That is normal. Adopt GDSuite one step at a time, and keep each step in its own commit, so your history stays readable.

Set it up

Commit or stash your work, then in the project's folder:

gdsuite init

If the project had a gdlintrc or gdformatrc from gdtoolkit, their settings are converted into gdsuite.toml for you.

If it has a gdtest.toml, gdhealth.toml or gdtidy.toml, or was set up by an older GDSuite, also run:

gdsuite migrate

It moves those settings into gdsuite.toml, comments included, so you have one settings file. Review the result with git diff and commit.

Format everything, in one commit

gdsuite fmt

Run the game to make sure nothing changed (formatting never changes what code does, but it's a good habit), then commit this alone, with a message such as "Format with GDSuite". If your team uses git blame, add that commit to a .git-blame-ignore-revs file so it doesn't hide who wrote each line.

Tame the linter

gdsuite lint

Read the list by rule, not by line. For each rule that reports a lot:

  • if it catches real problems, fix them (gdsuite lint -- --fix repairs the simple ones);
  • if your team disagrees with it, turn it off in gdsuite.toml:
[lint]
disable = ["max-public-methods"]

Commit when gdsuite lint is clean.

Fix the errors

gdsuite typecheck

These are real errors: missing files, broken references, wrong calls. Fix them; warnings can wait.

Turn on the full check

Code health is the last step of gdsuite check and never fails it, so you can now run the whole check before every commit:

gdsuite check

Then add it to CI, so it stays clean.

Coming from another tool