Rule Doc Generator Contracts Laravel Package

symplify/rule-doc-generator-contracts

Contracts for Symplify’s rule doc generator: shared interfaces and value objects used to describe, format, and export rule documentation across Symplify tools. Useful when building custom rule providers, printers, or integrations without depending on full implementations.

Technical Evaluation

Architecture fit is strong for decoupling rule documentation logic in Laravel projects, as it provides pure interfaces requiring minimal dependencies. However, its value is entirely contingent on downstream implementations, which may not exist in the current stack. Integration feasibility is high via Composer, but the unknown repository and low engagement metrics (17 stars, 0.115 score) raise concerns about long-term support and community backing. Technical risk is low for immediate implementation (no runtime code) but high for dependency management—without active downstream generators or clear maintenance of the contract interfaces, the package becomes a dead dependency. Key questions: Are there existing generators in our stack that consume these contracts (e.g., Rector, PHP-CS-Fixer integrations)? If not, what’s the plan to build/maintain a generator? How will we ensure rule metadata (title, description, code samples) stays in sync with rule logic? Is there a viable alternative with better community support?

Integration Approach

Stack fit is limited to Laravel projects actively using Rector or PHP-CS-Fixer for code analysis