GDScript API Comment Coverage

Generate a Markdown API index for Godot GDScript projects and enforce configurable comment coverage for public classes, signals, exported properties, constants, and public functions.

The goal is practical maintainability: a codebase-level map that can run in CI and catch undocumented public APIs before they spread.

Install

python -m pip install -e .

When published:

python -m pip install gdscript-api-comment-coverage

Quick Start

gdscript-api-coverage C:\Projects\MyGame --min-all 80
gdscript-api-coverage . --min-public-func 80 --min-signal 100
gdscript-api-coverage . --write-docs docs\API_INDEX.md
gdscript-api-coverage . --format json --output gdscript-api-report.json

Run against the sample:

gdscript-api-coverage examples\tiny-godot-project --write-docs API_INDEX.md --fail-on none

What It Finds

• class_name declarations.
• signal declarations.
• @export var properties, including annotation-on-previous-line style.
• Public func declarations that do not start with _.
• Public constants.
• Whether each item has an immediately preceding comment.
• Report metadata and readable threshold explanations in text and JSON output.

Comment Style

Prefer Godot doc comments:

## Emitted when data changes.
signal data_changed(id: String)

Single # comments are accepted, but ## is easier to distinguish as public documentation.

Documentation

• Comment conventions
• Thresholds
• Generated docs
• CI usage
• Limitations

Development

python -m pip install -e .
python -m unittest discover -s tests -v
gdscript-api-coverage examples\tiny-godot-project --min-all 60 --write-docs API_INDEX.md

Examples and fixtures are generic and should not expose private project content.