IBM-Cloud / IBM-Cloud/ibm-cloud-cli-sdk
Add BX help rendering
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 35
- Forks
- 53
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
Hello,
we try to create a BX plugin.
In your documentation is mentioned, that a command is incorrect usage should print out the help page:
https://github.com/IBM-Cloud/ibm-cloud-cli-sdk/blob/master/docs/plugin_developer_guide.md#25-incorrect-usage
The help page is defined by that structure of yours:
https://github.com/IBM-Cloud/ibm-cloud-cli-sdk/blob/master/docs/plugin_developer_guide.md#11-register-a-new-plug-in
--- SNIP ---
func (p *FssPlugin) GetMetadata() plugin.PluginMetadata {
...
--- SNAP ---
But there is no method to render manually (as mentioned in the dev guide), as it's not a good pattern to maintain data twice, and bx is able to render the help out, we would like to use a function here. Until then, we will ignore that best practice.
Regards,
Michael Decker
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read docs/plugin_developer_guide.md sections “Incorrect usage” and “Register a new plug-in” first, then trace how bx currently renders plugin help. Define the rendering entry point from the existing PluginMetadata structure and verify that incorrect-usage handling can invoke it without duplicating help data.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100