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.

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

Merged
merged 2 commits into from
Dec 4, 2024
Merged

group options #463

merged 2 commits into from
Dec 4, 2024

Conversation

echo-bravo-yahoo
Copy link
Collaborator

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.

before:
image

after:
image

Copy link
Contributor

@ptpaterson ptpaterson Dec 4, 2024

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"?

Copy link
Collaborator Author

@echo-bravo-yahoo echo-bravo-yahoo Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here's what's in the group now:
image

i feel like database and url are only tenuously auth? but it is a clearer expression of what they do than "API". except for those 2? bleh.

Copy link
Contributor

@ptpaterson ptpaterson left a 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

src/cli.mjs Outdated Show resolved Hide resolved
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.
@echo-bravo-yahoo echo-bravo-yahoo merged commit 8d1fb06 into v3 Dec 4, 2024
4 checks passed
@echo-bravo-yahoo echo-bravo-yahoo deleted the group-options branch December 4, 2024 21:58
},
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`.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this!

@cleve-fauna cleve-fauna mentioned this pull request Dec 5, 2024
This was referenced Dec 6, 2024
@cleve-fauna cleve-fauna mentioned this pull request Dec 13, 2024
@mwilde345 mwilde345 mentioned this pull request Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants