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

Update thevip logs command to follow the VIP-CLI style guide #2089

Merged
merged 21 commits into from
Nov 21, 2024

Conversation

yolih
Copy link
Contributor

@yolih yolih commented Nov 12, 2024

Description

Updated the voice, tense, and format of command descriptions, examples, and usage models for the vip logs command group to follow the VIP-CLI style guide.

Pull request checklist

New release checklist

Steps to Test

Observe the results of the --help display for impacted commands:

  • vip
  • vip logs
  • vip slowlogs

@yolih yolih added the [Type] Documentation Pull request to update documentation. label Nov 12, 2024
@yolih yolih requested a review from terriann November 12, 2024 00:05
Copy link
Contributor

github-actions bot commented Nov 12, 2024

Dependency Review

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

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

src/bin/vip-slowlogs.ts Outdated Show resolved Hide resolved
src/bin/vip-logs.js Outdated Show resolved Hide resolved
src/bin/vip-logs.js Outdated Show resolved Hide resolved
src/bin/vip-logs.js Outdated Show resolved Hide resolved
src/bin/vip-logs.js Outdated Show resolved Hide resolved
Co-authored-by: Terri Ann Swallow <[email protected]>
Copy link
Contributor

@terriann terriann left a comment

Choose a reason for hiding this comment

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

👍

src/bin/vip-logs.js Outdated Show resolved Hide resolved
src/bin/vip-logs.js Outdated Show resolved Hide resolved
src/bin/vip-slowlogs.ts Outdated Show resolved Hide resolved
src/bin/vip-slowlogs.ts Outdated Show resolved Hide resolved
src/lib/cli/command.js Outdated Show resolved Hide resolved
@sjinks sjinks self-requested a review November 21, 2024 18:48
@sjinks
Copy link
Member

sjinks commented Nov 21, 2024

@yolih @terriann I have updated the code a bit; does it look good?

Copy link

sonarcloud bot commented Nov 21, 2024

@yolih yolih merged commit ec2ea84 into trunk Nov 21, 2024
16 checks passed
@yolih yolih deleted the update/docs-pt-vip-logs branch November 21, 2024 19:34
@owen-cole
Copy link
Contributor

owen-cole commented Nov 23, 2024

Hello, this new version only allows the default table, csv and json options for --format all of which add noise to the output. There should be an option to provide the previous format like the documentation states here --format=text
https://docs.wpvip.com/logs/runtime-logs/cli/

I submitted a PR restoring the prior behavior under the missing --format=text flag #2121

This change probably is more than a patch version bump if following semver as I have parsers and other tools built around the old format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Documentation Pull request to update documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

vip logs @env fails with Error: Invalid type: undefined. The supported types are: app, batch
5 participants