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.0.tar.gz (8.2 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.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for godot_scene_signal_auditor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 566701d3a910604bd210ee9b00e32646cdee90222f9525e89c3837b5a7d25c16
MD5 7e312fa4357eb710ccc03adc61a7750f
BLAKE2b-256 3dd12a658f28bfcb44d11e0ba4ac5a52d34d148607a2a3d0231da2ad4e5aef1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_scene_signal_auditor-0.1.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_scene_signal_auditor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcbbc3077a840d02508a8904fe52b5a19df22632d6a6f56be6ecfb9a1322035e
MD5 2c2718a615add800139eb435f648db77
BLAKE2b-256 f5e598f70b7342910887e880aaa97cd923c6e7820116cdec92f33f88e08885b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_scene_signal_auditor-0.1.0-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