Add --format="text" option to vip logs #2121
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
sjinks
reviewed
Nov 24, 2024
| @@ -243,7 +249,7 @@ command( { | |||
| `The maximum number of entries to return. Accepts an integer value between 1 and 5000 (defaults to ${ LIMIT_DEFAULT }).` | |||
| ) | |||
| .option( 'follow', 'Output new entries as they are generated.' ) | |||
| .option( 'format', 'Render output in a particular format. Accepts “csv”, and “json”.', 'table' ) | |||
| .option( 'format', 'Render output in a particular format. Accepts “csv”, “json”, and “text”.', 'table' ) | |||
There was a problem hiding this comment.
Suggested change
| .option( 'format', 'Render output in a particular format. Accepts “csv”, “json”, and “text”.', 'table' ) | |
| .option( 'format', 'Render output in a particular format. Accepts “csv”, “json”, “table”, and “text”.', 'table' ) |
@yolih what do you think?
rinatkhaziev
force-pushed
the
restore-text-log-format
branch
from
fb4b1f4
to
c1cddce
Compare
rinatkhaziev
approved these changes
Nov 26, 2024
|
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In #2089 the
tableoption was formatted to meet a style guide's requirements. I see the default option was actually previouslytablebut not formatted as a table so this change makes sense.The previous basic text format was nice to have especially when using the
--followflag and matches what is described here https://docs.wpvip.com/logs/runtime-logs/cli/The docs mention an option for formatting called
textand this PR enables that option and restores the previous formatting of the logs under that option:https://github.com/Automattic/vip-cli/blame/19c65e4758b30be5d9708ae807f754f2a6883ef1/src/bin/vip-logs.js#L146-L151
Pull request checklist
New release checklist
Steps to Test
Outline the steps to test and verify the PR here.
Example:
npm run build./dist/bin/vip-cookies.js nom