-
Notifications
You must be signed in to change notification settings - Fork 16
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
group options #463
group options #463
Conversation
ae9fc8d
to
94d6250
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about something like "Authentication/Authorization" instead of "API"? definitely more verbose... "AuthN/Z"? "Auth"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thought on names, but otherwise LGTM
right now, we present all the options in one blob. this change groups the config options into these groups: - Output (format, quiet, color) - Config (config, profile) - API (user, role, database, secret) - Debug (verbosity, verboseComponent) - Options (help and all command-specific options) these groups can/should be renamed and rearranged, but this grouping should be a readability improvement over the current soup of flags.
94d6250
to
c5c1cb6
Compare
}, | ||
verboseComponent: { | ||
description: | ||
"Components to emit diagnostic logs for. Takes precedence over the `--verbosity` flag. Pass components as a comma-separate list, such as `--verboseComponent fetch, error`, or as separate flags, such as `--verboseComponent fetch --verboseComponent error`.", | ||
"Components to emit diagnostic logs for. Takes precedence over the `--verbosity` flag. Pass components as a space-separated list, such as `--verboseComponent fetch error`, or as separate flags, such as `--verboseComponent fetch --verboseComponent error`.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing this!
right now, we present all the options in one blob. this change groups the config options into these groups:
these groups can/should be renamed and rearranged, but this grouping should be a readability improvement over the current soup of flags.
before:
![image](https://private-user-images.githubusercontent.com/759892/392554961-d3413028-df68-4761-9862-835c47ff7ed7.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMDUyMjQsIm5iZiI6MTczOTAwNDkyNCwicGF0aCI6Ii83NTk4OTIvMzkyNTU0OTYxLWQzNDEzMDI4LWRmNjgtNDc2MS05ODYyLTgzNWM0N2ZmN2VkNy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjA4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIwOFQwODU1MjRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1lZmY4ODFjMDFjMDkxZGQ2NzA5MWQwN2ExN2Q3NTA0ZDljMGVkMGVlYTNmZDk1ZjEwNWE5Mzg0MDhiNDJiMzRmJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.yC6OvVKjVmGLEFdMuSOKpAg322kA5Z8awi6y-NLDDXM)
after:
![image](https://private-user-images.githubusercontent.com/759892/392555148-7077c326-9a7f-4c14-8844-c4a464eaee0e.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMDUyMjQsIm5iZiI6MTczOTAwNDkyNCwicGF0aCI6Ii83NTk4OTIvMzkyNTU1MTQ4LTcwNzdjMzI2LTlhN2YtNGMxNC04ODQ0LWM0YTQ2NGVhZWUwZS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjA4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIwOFQwODU1MjRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT0wZjhhMmQ2YzFmNmQ5ZjFjNjkwZGZlOTM0NTJjNjk4MTE2NGJhMjQxMGU5ZjJkZTU5YmRjNWM1NGIyYTMwZDBiJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.O5byka73wH5YuWOZarp4Lw3qI-ARDawrrtED8oSghmg)