Fix `--output` option of `vip import sql` command

[mehmoodak]

Description

Fixed an issue with the output option of the vip import sql command, which wasn't creating an output file as expected. Alongside this fix, this PR also improves the help text for the vip search-replace command.

Pull request checklist

• [N/A] Update SETUP.md with any new environmental variables.
• [N/A] Update the documentation.
• [x] Manually test the relevant changes.
• [x] Follow the pull request checklist
• [ ] Add/update automated tests as needed.

New release checklist

• [ ] Automated tests pass.
• [ ] The Preparing for release checklist is completed.

Steps to Test

1. Check out PR.
2. Run vip @example-app.develop export sql --output=output.sql.gz
3. Extracts the sql file from gzip.
4. Run node ./dist/bin/vip-import-sql.js @example-app.develop output.sql --search-replace="from,to" --output="test-output.sql"
5. Verify test-output.sql file is created with the updated content.

[github-actions[bot]]

Dependency Review

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

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Manifest Files

[mehmoodak]

Would it be possible for your PR to only fix the --output bug and for my PR to make the updates to the --help menu?

@yolih I have made some changes, please take a look again.

[yolih]

Thanks, @mehmoodak ! 🙌

A couple more questions:

• Does the --output option behave differently when passed with the vip import sql and the vip search-replace commands? If the behavior of --output is the same for both commands then I think the description for the option should also be the same where it appears in the --help menu.
• Could you tell me why you removed "Defaults to STDOUT" for the vip import sql command? I believe that is the correct default for --output with that command as well.

[mehmoodak]

@yolih The key difference is that vip import sql requires a SQL file to be uploaded to S3, and printing to stdout will result in an error. In contrast, vip search-replace can use stdout without any issues.

[yolih]

Oooohhhh... interesting. Thank you for your patience with all of my questions!

Based on your explanation, I agree with removing Defaults to STDOUT from the vip import sql version of --output.

For the vip search-replace version of --output, I suggest that the description in the help menu reads something like:

Create a local copy of the file with the completed search and replace operations. Ignored if the command includes --in-place. Accepts a local file path. Defaults to STDOUT.

What do you think?

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[mehmoodak]

What do you think?

@yolih help text updated. Thanks for helping me improve it.