Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scaffolder:info Command for Enhanced Developer Experience #1063

Closed
butschster opened this issue Jan 18, 2024 · 0 comments · Fixed by #1068
Closed

Add scaffolder:info Command for Enhanced Developer Experience #1063

butschster opened this issue Jan 18, 2024 · 0 comments · Fixed by #1068

Comments

@butschster
Copy link
Member

butschster commented Jan 18, 2024

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.

@butschster butschster self-assigned this Jan 18, 2024
@butschster butschster added this to the 3.12 milestone Jan 18, 2024
@butschster butschster changed the title Add scaffolder info command with list of all scaffolder declarations + config. Add scaffolder:info Command for Enhanced Developer Experience Jan 18, 2024
butschster added a commit that referenced this issue Jan 23, 2024
@butschster butschster linked a pull request Jan 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant