Skip to main content

Static audits for Godot scene signal connections and autoload signal usage.

Project description

Godot Scene Signal Auditor

Static CI checks for Godot scene signal connections, signal declarations, autoload signal usage, and coupling patterns that become hard to debug in larger projects.

The analyzer is deliberately conservative. It reports only what it can infer from .tscn and .gd files without running Godot.

Install

python -m pip install -e .

When published:

python -m pip install godot-scene-signal-auditor

Quick Start

godot-signal-audit C:\Projects\MyGame --strict-stale-connections
godot-signal-audit . --autoload EventBus,SignalBus
godot-signal-audit . --format mermaid --output docs\SIGNAL_GRAPH.md
godot-signal-audit . --format json --output signal-report.json

Run the sample:

godot-signal-audit examples\tiny-godot-project --format mermaid --fail-on none

What It Checks

  • Persistent scene connections in .tscn files.
  • Target method existence when the target script is resolvable.
  • GDScript signal declarations and method names.
  • Configured autoload signal connect usage.
  • Mermaid signal graph output.

Documentation

Development

python -m pip install -e .
python -m unittest discover -s tests -v
godot-signal-audit examples\tiny-godot-project --format mermaid --fail-on none

Examples use generic scene and signal names so the repository can be published safely.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

godot_scene_signal_auditor-0.1.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

godot_scene_signal_auditor-0.1.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file godot_scene_signal_auditor-0.1.1.tar.gz.

File metadata

File hashes

Hashes for godot_scene_signal_auditor-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3f3c4e50a10a607656d13c653ad5edf9a2dc2adbc55e2bd864ebb537482ebe3a
MD5 10771cc80ea83006c2ff5ec6e9eb835d
BLAKE2b-256 2f33bba0c48bfb07f3428254010e5d70c6683e14783fddd443aecb30af242576

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_scene_signal_auditor-0.1.1.tar.gz:

Publisher: publish-scene-signal-auditor.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file godot_scene_signal_auditor-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_scene_signal_auditor-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed669bcc6c59b840a65d22696400be1c3a010d31c65a132f6c269a1890afe934
MD5 60235b22b51395ccdb152e7407fb0532
BLAKE2b-256 4a4b7c2ebbdc828123141ae5ca150899f1f8e28b827c36935279fbca7dae6641

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_scene_signal_auditor-0.1.1-py3-none-any.whl:

Publisher: publish-scene-signal-auditor.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page