feat: Add valid config fields to its help#217
Merged
Conversation
dbolson
commented
Apr 29, 2024
| The LaunchDarkly CLI allows you to save preferred settings, either within a config file using the `config` commands, or set as environment variables. | ||
|
|
||
| Current respected settings: | ||
| Current settings: |
Contributor
Author
There was a problem hiding this comment.
Updated the readme to be consistent with the config help output.
Member
There was a problem hiding this comment.
How about:
Suggested change
| Current settings: | |
| Supported settings: |
?
| } | ||
|
|
||
| helpFun := cmd.HelpFunc() | ||
| cmd.SetHelpFunc(func(cmd *cobra.Command, args []string) { |
Contributor
Author
There was a problem hiding this comment.
This runs the existing help fn after updating the command's Long value.
| ProjectFlag = "project" | ||
| RoleFlag = "role" | ||
|
|
||
| AccessTokenFlagDescription = "LaunchDarkly access token with write-level access" |
Contributor
Author
There was a problem hiding this comment.
Moved these to constants to remove duplication.
| cmd.SetHelpFunc(func(cmd *cobra.Command, args []string) { | ||
| var sb strings.Builder | ||
| sb.WriteString("\n\nCurrent settings:\n") | ||
| for _, s := range []string{ |
Contributor
Author
There was a problem hiding this comment.
This uses a slice to preserve order since a map doesn't.
bwoskow-ld
reviewed
Apr 29, 2024
| The LaunchDarkly CLI allows you to save preferred settings, either within a config file using the `config` commands, or set as environment variables. | ||
|
|
||
| Current respected settings: | ||
| Current settings: |
Member
There was a problem hiding this comment.
How about:
Suggested change
| Current settings: | |
| Supported settings: |
?
|
|
||
| * `access-token` A LaunchDarkly API token with write-level access | ||
| * `access-token` A LaunchDarkly access token with write-level access | ||
| * `analytics-optout` Opt out of analytics tracking (default false) |
Member
There was a problem hiding this comment.
Suggested change
| * `analytics-optout` Opt out of analytics tracking (default false) | |
| * `analytics-opt-out` Opt out of analytics tracking (default false) |
| helpFun := cmd.HelpFunc() | ||
| cmd.SetHelpFunc(func(cmd *cobra.Command, args []string) { | ||
| var sb strings.Builder | ||
| sb.WriteString("\n\nCurrent settings:\n") |
Member
There was a problem hiding this comment.
How about:
Suggested change
| sb.WriteString("\n\nCurrent settings:\n") | |
| sb.WriteString("\n\nSupported settings:\n") |
?
| @@ -10,7 +16,7 @@ Flags: | |||
| --unset string Unset a config field | |||
Member
There was a problem hiding this comment.
Minor (and I know, I'm tagging this on a test file) but I noticed that --unset is marked as taking a string parameter whereas --set isn't marked to have any parameter. It should also have string.
Contributor
Author
There was a problem hiding this comment.
sunnyguduru
approved these changes
Apr 29, 2024
bwoskow-ld
approved these changes
Apr 29, 2024
3 tasks
This was referenced Apr 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Running
ldcli config --helpshowsRequirements
Related issues
Provide links to any issues in this repository or elsewhere relating to this pull request.
Describe the solution you've provided
Provide a clear and concise description of what you expect to happen.
Describe alternatives you've considered
Provide a clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context about the pull request here.