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 list generators command / move current commands under "generate" #148

Open
ovflowd opened this issue Nov 18, 2024 · 4 comments
Open
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

Enter your suggestions in details:

  • There should be a simple top-level command called list to list the current generators. (Version, Name, Description, Examples)
  • The current top-level command to generate API docs should be called "generate"
  • Help should also be a "top" level command and be accessible within each subcommand.

cc @canerakdas @redyetidev for opinions

@ovflowd ovflowd added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Nov 18, 2024
@avivkeller
Copy link
Member

I agree with the idea of listing the generators, but I don't know if it needs to be "list". It could just be "generate" without any arguments.

Regardless on that slight difference or not, +1

@canerakdas
Copy link
Member

I think it's a great idea 🙇 As far as I understand, we will be able to use the existing mandatory fields with top-level generate and other commands (help, list, etc.) at the top-level

Bonus:
We can add a top-level wizard, ask questions, and able to run interactive generators like sentry-wizard

A tool that we will use internally may seem like overkill, but IMO it will make things a lot easier for those who want to contribute or try it for the first time

@avivkeller
Copy link
Member

We can add a top-level wizard, ask questions, and able to run interactive generators

@ovflowd mentioned Clark in another issue. It would be great for this use case.

@ovflowd
Copy link
Member Author

ovflowd commented Nov 18, 2024

I think it's a great idea 🙇 As far as I understand, we will be able to use the existing mandatory fields with top-level generate and other commands (help, list, etc.) at the top-level

Bonus: We can add a top-level wizard, ask questions, and able to run interactive generators like sentry-wizard

A tool that we will use internally may seem like overkill, but IMO it will make things a lot easier for those who want to contribute or try it for the first time

Two cents: If we want an iterative mode, it should be an EXPLICIT iterative mode. We should still be able to run this just with CLI args/no iterative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants