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.

Sign up for GitHub

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

Jump to bottom

Contour CLI help should sort the option flags. #2397

Closed
jpeach opened this issue Mar 29, 2020 · 5 comments · Fixed by #4958
Closed

Contour CLI help should sort the option flags. #2397

jpeach opened this issue Mar 29, 2020 · 5 comments · Fixed by #4958
Assignees
@izturn
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Milestone
1.24.0

Comments

@jpeach
Copy link
Contributor

jpeach commented Mar 29, 2020

Please describe the problem you have

When a Contour subcommand has a log of option flags, it is hard to find the one you want because the --help output doesn't sort them. Sorting the flags by name would make it easier to read and to find a flags in the category you are looking for.
@jpeach jpeach added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Mar 29, 2020
@jpeach
Copy link
Contributor Author

jpeach commented Mar 29, 2020

Hopefully, the kingpin library has a knob that sorts.

@poidag-zz
Copy link
Contributor

Kingpin doesn't appear to have a configurable way of setting flag order. Would we be open to alphabetically reorganising the current set of flags?

@jpeach
Copy link
Contributor Author

jpeach commented Mar 30, 2020

What did you have in mind?

@poidag-zz
Copy link
Contributor

  1. A custom usage template in kingpin, with an alphabetic sort function (potentially from sprig). However it doesn't seem possible to include template functions currently in Kingpin. Since kingpin is no longer actively maintained. Should we investigate an alternative? The original author of Kingpin now has Kong
  2. Manually re-ordering the short list that we currently have

@youngnick
Copy link
Member

I think that manually ordering the list we currently have is probably better, whether it's alpha or by function or something.

@stevesloka stevesloka added the Hacktoberfest Denotes an issue ready for any "Hacktoberfest" contributor. label Oct 1, 2020
@stevesloka stevesloka removed the Hacktoberfest Denotes an issue ready for any "Hacktoberfest" contributor. label Nov 5, 2020
izturn added a commit to izturn/contour that referenced this issue Jan 4, 2023
@izturn
sort the option flags fix projectcontour#2397
98574a4 
Signed-off-by: Gang Liu <gang.liu@daocloud.io>
@izturn izturn mentioned this issue Jan 4, 2023
Merged
@skriss skriss added this to the 1.24.0 milestone Jan 4, 2023
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@izturn izturn

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
Contour
Status: Done
Milestone
1.24.0
Development

Successfully merging a pull request may close this issue.

cmd/contour: sort the option flags izturn/contour
6 participants
@jpeach @stevesloka @skriss @poidag-zz @youngnick @izturn