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

fix: make the help text for the format option consistent for all commands #2129

Merged
merged 2 commits into from
Nov 27, 2024

Conversation

sjinks
Copy link
Member

@sjinks sjinks commented Nov 27, 2024

Description

As discussed, this PR changes the help text for the --format option to

Render output in a particular format. Accepts “table“ (default), “csv“, and “json“.

Affected commands:

  • vip app list
  • vip config envvar get-all
  • vip config software get
  • vip config envvar list
  • vip logs (a text option is added to the list)
  • vip slowlogs
  • vip validate preflight

Pull request checklist

New release checklist

Steps to Test

Run the mentioned commands and make sure they still work.

@sjinks sjinks requested a review from yolih November 27, 2024 14:27
@sjinks sjinks self-assigned this Nov 27, 2024
Copy link
Contributor

github-actions bot commented Nov 27, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

@yolih
Copy link
Contributor

yolih commented Nov 27, 2024

@sjinks This is amazing! Thank you!

I tested this branch locally, and have a couple questions after looking at the --help menu output for the affected commands:

  • Is the --format option intentionally removed from vip app list? There have actually been recent valid use cases for formatting that output in JSON and CSV so I think it should still be supported.
  • In the released version of VIP-CLI, the --format option does not appear in the --help menu for the config envvar get command. Should it?

Copy link

sonarcloud bot commented Nov 27, 2024

@sjinks
Copy link
Member Author

sjinks commented Nov 27, 2024

Is the --format option intentionally removed from vip app list?

No, it's the wrong file. I need more sleep :-) I intended to remove it from the VIP app. Fixed, thanks!

In the released version of VIP-CLI, the --format option does not appear in the --help menu for the config envvar get command.

Wrong command; it is vip config software get.

Copy link
Contributor

@yolih yolih left a comment

Choose a reason for hiding this comment

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

This works perfectly. Thank you so much for making this change! I think this is a huge improvement for the help menu.

@yolih yolih merged commit e0f471f into trunk Nov 27, 2024
16 checks passed
@yolih yolih deleted the update/format-option branch November 27, 2024 19:50
@mjangda mjangda mentioned this pull request Dec 9, 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.

3 participants