bind: Add JSON parameter to DescribeFlags #370
Merged
Conversation
This file contains 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
alexh-sauce
force-pushed
the
alexh/add-describe-flags-as-json
branch
2 times, most recently
from
788b290 to
2c1dd94
Compare
alexh-sauce
changed the title
alexh-sauce
force-pushed
the
alexh/add-describe-flags-as-json
branch
2 times, most recently
from
945ac9a to
736327c
Compare
Choraden
reviewed
Aug 28, 2023
bind/flag.go
Outdated
| @@ -25,6 +27,13 @@ import ( | |||
| "github.com/spf13/pflag" | |||
| ) | |||
|
|
|||
| type Format int | |||
There was a problem hiding this comment.
Let's name it DescribeFormat. This is bind package and bind.Format might be misleading.
Choraden
reviewed
Aug 28, 2023
bind/flag.go
Outdated
Comment on lines
32
to
35
| const ( | ||
| Plain Format = 0 | ||
| JSON Format = 1 | ||
| ) |
There was a problem hiding this comment.
nit:
const (
Plain Format = iota
JSON
)
Choraden
reviewed
Aug 28, 2023
Choraden
reviewed
Aug 28, 2023
bind/flag.go
Outdated
Comment on lines
341
to
342
| args := make(map[string]any, 0) | ||
| keys := make([]string, 0) |
There was a problem hiding this comment.
nit: use fs.NFlag() to preallocate
Choraden
reviewed
Aug 28, 2023
cmd/forwarder/run/run.go
Outdated
| @@ -43,7 +43,10 @@ type command struct { | |||
| } | |||
|
|
|||
| func (c *command) RunE(cmd *cobra.Command, _ []string) error { | |||
| config := bind.DescribeFlags(cmd.Flags()) | |||
| config, err := bind.DescribeFlags(cmd.Flags(), false, bind.JSON) | |||
There was a problem hiding this comment.
How about we stick to the Plain format here?
There was a problem hiding this comment.
Oof, yes. Thanks for catching that.
|
How about we move it to a separate file e.g. |
alexh-sauce
force-pushed
the
alexh/add-describe-flags-as-json
branch
from
736327c to
9b1e25c
Compare
|
@Choraden Make sense, I've moved the function to a new file. |
Choraden
reviewed
Aug 28, 2023
bind/describe.go
Outdated
|
|
||
| func DescribeFlags(fs *pflag.FlagSet, showHidden bool, format DescribeFormat) (string, error) { | ||
| args := make(map[string]any, fs.NFlag()) | ||
| keys := make([]string, fs.NFlag()) |
There was a problem hiding this comment.
keys := make([]string, 0, fs.NFlag()) - allocate the capacity, but make it 0 elements
This is useful for exporting or recording config settings.
alexh-sauce
force-pushed
the
alexh/add-describe-flags-as-json
branch
from
9b1e25c to
266f93e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds an option to describe flags in JSON format.
This is useful for exporting or recording config settings.