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 description for the project command #90

Closed
omatheusmesmo opened this issue Feb 5, 2025 · 2 comments
Closed

Add description for the project command #90

omatheusmesmo opened this issue Feb 5, 2025 · 2 comments
Labels
good first issue Denotes an issue ready for a new contributor. help wanted Extra attention is needed

Comments

@omatheusmesmo
Copy link
Collaborator

Description

Add a clear and concise description for the project command, which can also be triggered with the alias p.

Tasks

  • Add a description in the @Command annotation for the project command.
  • Ensure the description explains the purpose of the command, such as handling project-related operations.
  • Verify the description is included when running buildcli help.

Additional Notes

  • This description should be informative and concise.
@omatheusmesmo omatheusmesmo added the good first issue Denotes an issue ready for a new contributor. label Feb 5, 2025
@felipemelozx
Copy link
Contributor

I need to add a description for the project command (and its alias p) that will appear when running buildcli p --help.

Should I update the @command annotation for the project command to include this description?

Also, are there any other related commands that require similar updates to their descriptions so that they show up correctly when running buildcli p <command> --help ?

Image

@omatheusmesmo
Copy link
Collaborator Author

@felipemelozx, hi!

It's exactly as you tried. Just add a string in the 'description' parameter that describes the command.

@Command(name = "project", aliases = {"p"}, description = "Project's description", ...)

Also, are there any other related commands that require similar updates to their descriptions so that they show up correctly when running buildcli p <command> --help ?

Actually, almost all of them. You can check the commands in BuildCLI.java in the classes listed after 'subcommands'. We made a major refactor in BuildCLI (see #79), and the old descriptions were not added to the new interfaces. However, you can check some of them in OptionCommandMap.java

I kindly ask you to create a subtask in issue #89 for each command or subcommand. Feel free to use AI models to generate the issue descriptions; it will help a lot. ☕

@omatheusmesmo omatheusmesmo added the help wanted Extra attention is needed label Feb 9, 2025
omatheusmesmo added a commit that referenced this issue Feb 10, 2025
…-the-command

Add description for the project command [#90]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants