Update the search-replace command to follow the VIP-CLI style guide
#2079
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files |
| description: 'Perform Search and Replace explicitly on the provided input <file.sql> file', | ||
| usage: 'vip search-replace file.sql --search-replace="from,to" --in-place', | ||
| description: | ||
| 'Perform the search and replace operation and save the results to the local input file "file.sql".', |
There was a problem hiding this comment.
Should we mention that the S&R operation is performed on file.sql?
There was a problem hiding this comment.
I'm having a hard time understanding what needs to be improved in order to address your concern.
Is this wording a bit better?
Perform the search and replace operation on the local input file "file.sql" and overwrite the file with the results.
If not, I welcome a version of the description from you that is clearer. 🙏
| 'Search and Replace to the specified output <output.sql> file\n' + | ||
| ' * Has no effect when the `in-place` flag is used', | ||
| 'Perform the search and replace operation and save the results to a local clone of the input file named "output-file.sql".', |
There was a problem hiding this comment.
It is unclear to me (from the previous description) where the output will go. Given the "Has no effect when the in-place flag is used," I would assume that the in-place operation would be performed on the source file (file.sql) and the result will be saved to that very file, not to output-file.sql.
There was a problem hiding this comment.
There was a problem hiding this comment.
One of the goals of the updated descriptions is to put any limitations or requirements for a command option in the description for the option, not in the usage example.
I agree with you that the "Has no effect" phrase is unclear. What if we updated the description for --output to something like this:
.option(
'output',
'Clone the local input file and overwrite the clone with the results of the search and replace operation. Accepts a local file path. Overridden by --in-place if both options are run in the same command.'
)
(I edited the above description after reading the suggestion from @aswasif007)
Co-authored-by: Volodymyr Kolesnykov <[email protected]>
|
Description
Updated the voice, tense, and format of command descriptions, examples, and usage models for the
vip search-replacecommand to follow the VIP-CLI style guide.Pull request checklist
New release checklist
Steps to Test
Observe the results of the
--helpdisplay for the impacted commands:vipvip search-replace