Metadata-Version: 2.4
Name: godot-scene-signal-auditor
Version: 0.1.2
Summary: Static audits for Godot scene signal connections and autoload signal usage.
Author: Godot Scene Signal Auditor contributors
License-Expression: MIT
Project-URL: Homepage, https://github.com/NonniGB/godot-production-toolkit/tree/main/godot-scene-signal-auditor
Project-URL: Issues, https://github.com/NonniGB/godot-production-toolkit/issues
Keywords: godot,signals,scene,autoload,ci,gamedev
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 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

```powershell
python -m pip install -e .
```

When published:

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

## Quick Start

```powershell
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:

```powershell
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.
- Report metadata and readable rule explanations in text and JSON output.

## Documentation

- [Rule reference](docs/RULE_REFERENCE.md)
- [Mermaid graphs](docs/MERMAID.md)
- [Autoload usage](docs/AUTOLOADS.md)
- [Limitations](docs/LIMITATIONS.md)
- [CI usage](docs/CI.md)

## Development

```powershell
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.
