What problem does it solve?
Developers working on the gh-aw compiler internals lack a single reference explaining how the validation system, safe output messaging, JSON schema validation, YAML parsing behavior, and MCP logs guardrail are designed and where to add new logic.
Core Features & Use Cases
- Validation Architecture Guide: Maps centralized validation in validation.go versus domain-specific validators (strict mode, pip, npm, expression safety) with a decision tree for placing new checks.
- Safe Output Message Patterns: Documents consistent formatting for AI attribution footers, staged mode previews, patch previews, and installation instructions across GitHub API write operations.
- Schema and YAML Compatibility Notes: Explains strict JSON schema validation with additionalProperties disabled and the YAML 1.1 versus 1.2 boolean parsing issue affecting the on: trigger key.
- Use Case: When adding a new strict-mode permission check, consult this reference to decide whether the validator belongs in strict_mode_validation.go or a new domain file, then follow the allowlist validation pattern shown.
Quick Start
Ask the agent to explain where to add a new validation rule in the gh-aw compiler and which existing validation pattern to follow.