spiral / framework

High-Performance PHP Framework
https://spiral.dev
MIT License
1.8k stars 87 forks source link

Add `scaffolder:info` Command for Enhanced Developer Experience #1063

Closed butschster closed 8 months ago

butschster commented 8 months ago

The Spiral Framework offers a scaffolding component, significantly aiding developers in generating application code for a variety of classes through a set of console commands. While this functionality streamlines development processes, there currently isn't a straightforward way for developers to view a consolidated list of all scaffolder declarations alongside their configurations.

I propose the addition of a new command, scaffolder:info. This command would serve as a comprehensive resource for developers, offering the following benefits:

  1. List All Scaffolder Declarations: Provide a list of all available scaffolder commands within the application, helping developers quickly understand the tools at their disposal.

  2. Display Configurations: Show the configurations for each command, including the namespace that will be used for the created class and the directory where the class will be placed. This clarity would aid in managing and organizing code effectively.

  3. Enhance Developer Understanding: Serve as a go-to reference for new team members or when returning to a project after a hiatus, improving overall efficiency and understanding of the project structure.

Looking forward to feedback and further discussion on this proposal.