Godot GDScript Architecture Guard
godot-gdscript-architecture-guard checks whether GDScript files still follow a
small architecture policy. It is aimed at projects where autoloads, shared
scripts, and feature modules can quietly become tangled during refactors.
It does not run the Godot editor. It scans .gd files and reports dependency
direction, autoload access, unresolved res:// script/resource references,
module owner summaries, high fan-in/fan-out from visible script references, and
possible unused scripts.
Install
python -m pip install godot-gdscript-architecture-guard
From a source checkout:
python -m pip install -e .\godot-gdscript-architecture-guard
Quick Start
godot-architecture-guard examples\tiny-architecture-project --config architecture-guard.toml
Write SARIF for code scanning:
godot-architecture-guard . --config architecture-guard.toml --format sarif --output reports\architecture.sarif
Write a Markdown refactor note:
godot-architecture-guard . --config architecture-guard.toml --format markdown --output reports\architecture.md --fail-on none
Policy Example
[modules.ui]
paths = ["scripts/ui/**"]
may_depend_on = ["shared"]
allowed_autoloads = ["Settings"]
[modules.gameplay]
paths = ["scripts/gameplay/**"]
may_depend_on = ["shared"]
allowed_autoloads = ["GameState"]
[modules.shared]
paths = ["scripts/shared/**"]
may_depend_on = []
allowed_autoloads = []
[autoloads]
names = ["GameState", "Settings"]
If scripts/ui/menu.gd preloads res://scripts/gameplay/inventory.gd, the tool
reports a module boundary violation unless ui may depend on gameplay.
If a configured module path matches no scripts, the tool reports that stale
policy path as a warning. JSON, text, and Markdown reports also include advisory
sections for module ownership, files with many visible script references, and
scripts that do not appear in visible res:// references or class_name
declarations.
Outputs
text: local terminal report.json: CI and scripts.markdown: PR comments and review notes.sarif: GitHub code scanning.mermaid: dependency graph.
JSON reports include metadata, rule_help, and per-finding suggestions so CI
jobs and small review scripts can explain the issue without hard-coding rule
text. They also include owner_summaries, hotspots, and
possible_unused_scripts arrays for refactor review.
SARIF output carries rule descriptions for code scanning tools.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file godot_gdscript_architecture_guard-0.1.3.tar.gz.
File metadata
- Download URL: godot_gdscript_architecture_guard-0.1.3.tar.gz
- Upload date:
- Size: 13.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f24337ef11b19a14ebf98463adbe2a77b487ff2c57bbf6765e71932ac5630ba0
|
|
| MD5 |
9277c70ea28c753adf33eb79379241f4
|
|
| BLAKE2b-256 |
cf5435db3f6e20258f431b441a783f2a904057a0e1421f95651477cc0a140a8d
|
Provenance
The following attestation bundles were made for godot_gdscript_architecture_guard-0.1.3.tar.gz:
Publisher:
publish-gdscript-architecture-guard.yml on NonniGB/godot-production-toolkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
godot_gdscript_architecture_guard-0.1.3.tar.gz -
Subject digest:
f24337ef11b19a14ebf98463adbe2a77b487ff2c57bbf6765e71932ac5630ba0 - Sigstore transparency entry: 1853625376
- Sigstore integration time:
-
Permalink:
NonniGB/godot-production-toolkit@80657e2f3b0554f15f243459e2c51e6facd02e5b -
Branch / Tag:
refs/tags/godot-gdscript-architecture-guard-v0.1.3 - Owner: https://github.com/NonniGB
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-gdscript-architecture-guard.yml@80657e2f3b0554f15f243459e2c51e6facd02e5b -
Trigger Event:
push
-
Statement type:
File details
Details for the file godot_gdscript_architecture_guard-0.1.3-py3-none-any.whl.
File metadata
- Download URL: godot_gdscript_architecture_guard-0.1.3-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9e88ec2f4d1e30630e001a485a3f6dd7e63ab646d94fa908390e25b11507de5
|
|
| MD5 |
2466cd2063e132b5ef28c09b93596ba2
|
|
| BLAKE2b-256 |
458cb771fde5298acb86db65d559a46f215f8d86b77b008c3186d4afa7ec7def
|
Provenance
The following attestation bundles were made for godot_gdscript_architecture_guard-0.1.3-py3-none-any.whl:
Publisher:
publish-gdscript-architecture-guard.yml on NonniGB/godot-production-toolkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
godot_gdscript_architecture_guard-0.1.3-py3-none-any.whl -
Subject digest:
f9e88ec2f4d1e30630e001a485a3f6dd7e63ab646d94fa908390e25b11507de5 - Sigstore transparency entry: 1853625436
- Sigstore integration time:
-
Permalink:
NonniGB/godot-production-toolkit@80657e2f3b0554f15f243459e2c51e6facd02e5b -
Branch / Tag:
refs/tags/godot-gdscript-architecture-guard-v0.1.3 - Owner: https://github.com/NonniGB
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-gdscript-architecture-guard.yml@80657e2f3b0554f15f243459e2c51e6facd02e5b -
Trigger Event:
push
-
Statement type:
