@automattic/vip 3.8.7 → 3.8.8

package/dist/bin/vip-import-sql.js

@@ -339,7 +339,7 @@ void (0, _command.default)({
   requiredArgs: 1,
   module: 'import-sql',
   usage
-}).command('status', 'Check the status of a SQL database import currently in progress.').option('skip-validate', 'Do not perform file validation prior to import. If the file contains unsupported entries, the import is likely to fail.').option('search-replace', 'Search for a string in the SQL file and replace it with a new string. Separate the values by a comma only; no spaces (e.g. --search-replace=“from,to”).').option('in-place', 'Perform a search and replace operation on a local SQL file, save the results to the file, then import the updated file.').option('output', 'Create a local copy of the imported file with the completed search and replace operations. Ignored if the command includes --in-place, or excludes a --search-replace operation. Accepts a local file path.').examples(examples).argv(process.argv, async (arg, opts) => {
+}).command('status', 'Check the status of a SQL database import currently in progress.').option('skip-validate', 'Do not perform file validation prior to import. If the file contains unsupported entries, the import is likely to fail.').option('search-replace', 'Search for a string in the SQL file and replace it with a new string. Separate the values by a comma only; no spaces (e.g. --search-replace=“from,to”).').option('in-place', 'Overwrite the local input file with the results of the search and replace operation prior to import.').option('output', 'The local file path to save a copy of the results from the search and replace operation when the --search-replace option is passed. Ignored when used with the --in-place option.').examples(examples).argv(process.argv, async (arg, opts) => {
   const {
     app,
     env

package/dist/bin/vip-logs.js

@@ -30,6 +30,9 @@ const MAX_POLLING_DELAY_IN_SECONDS = 300;
  * @param {string[]} arg
  */
 async function getLogs(arg, opt) {
+  opt.type ??= 'app';
+  opt.limit ??= LIMIT_DEFAULT;
+  opt.format ??= 'table';
   validateInputs(opt.type, opt.limit, opt.format);
   const trackingParams = getBaseTrackingParams(opt);
   await (0, _tracker.trackEvent)('logs_command_execute', trackingParams);
@@ -177,9 +180,6 @@ function printLogs(logs, format) {
  * @param {string} format
  */
 function validateInputs(type, limit, format) {
-  if (limit === undefined) {
-    limit = LIMIT_DEFAULT;
-  }
   if (!ALLOWED_TYPES.includes(type)) {
     exit.withError(`Invalid type: ${type}. The supported types are: ${ALLOWED_TYPES.join(', ')}.`);
   }
@@ -187,7 +187,7 @@ function validateInputs(type, limit, format) {
     exit.withError(`Invalid format: ${format}. The supported formats are: ${ALLOWED_FORMATS.join(', ')}.`);
   }
   if (!Number.isInteger(limit) || limit < LIMIT_MIN || limit > logsLib.LIMIT_MAX) {
-    exit.withError(`Invalid limit: ${limit}. It should be a number between ${LIMIT_MIN} and ${logsLib.LIMIT_MAX}.`);
+    exit.withError(`Invalid limit: ${limit}. Set the limit to an integer between ${LIMIT_MIN} and ${logsLib.LIMIT_MAX}.`);
   }
 }
 const appQuery = exports.appQuery = `
@@ -209,21 +209,18 @@ const appQuery = exports.appQuery = `
   appQuery,
   envContext: true,
   module: 'logs'
-}).option('type', 'The type of logs to be returned: "app" or "batch"', 'app')
+}).option('type', 'Specify the type of Runtime Logs to retrieve. Accepts "batch" (only valid for WordPress environments).', 'app')
 // The default limit is set manually in the validateInputs function to address validation issues, avoiding incorrect replacement of the default value.
-.option('limit', `The maximum number of log lines (defaults to ${LIMIT_DEFAULT})`).option('follow', 'Keep fetching new logs as they are generated').option('format', 'Output the log lines in CSV or JSON format', 'table').examples([{
-  usage: 'vip @mysite.production logs',
-  description: 'Get the most recent app logs'
-}, {
-  usage: 'vip @mysite.production logs --type batch',
-  description: 'Get the most recent batch logs'
+.option('limit', `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').examples([{
+  usage: 'vip @example-app.production logs',
+  description: 'Retrieve up to 500 of the most recent entries of application Runtime Logs from web containers.'
 }, {
-  usage: 'vip @mysite.production logs --limit 100',
-  description: 'Get the most recent 100 log entries'
+  usage: 'vip @example-app.production logs --type=batch',
+  description: 'Retrieve up to 500 of the most recent entries generated by cron tasks or WP-CLI commands from batch containers.'
 }, {
-  usage: 'vip @mysite.production logs --limit 100 --format csv',
-  description: 'Get the most recent 100 log entries formatted as comma-separated values (CSV)'
+  usage: 'vip @example-app.production logs --limit=100',
+  description: 'Retrieve up to 100 of the most recent entries of application logs.'
 }, {
-  usage: 'vip @mysite.production logs --limit 100 --format json',
-  description: 'Get the most recent 100 log entries formatted as JSON'
+  usage: 'vip @example-app.production logs --type=batch --limit=800 --format=csv',
+  description: 'Retrieve up to 800 of the most recent entries of batch logs and output them in CSV format.'
 }]).argv(process.argv, getLogs);

package/dist/bin/vip-search-replace.js

@@ -14,22 +14,22 @@ const debug = (0, _debug.default)('@automattic/vip:bin:vip-search-replace');
 const examples = [
 // `search-replace` flag
 {
-  usage: 'vip search-replace <file.sql> --search-replace="from,to"',
-  description: 'Replace instances of <from> with <to> in the provided <file.sql>\n' + '       * Ensure there are no spaces between your search-replace parameters'
+  usage: 'vip search-replace file.sql --search-replace="from,to"',
+  description: 'Search for every instance of the value "from" in the local input file named "file.sql" and replace it with the value "to".\n' + '       * Results of the operation output to STDOUT by default.'
 },
 // `in-place` flag
 {
-  usage: 'vip search-replace <file.sql> --search-replace="from,to" --in-place',
-  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 on the local input file "file.sql" and overwrite the file with the results.'
 },
 // `output` flag
 {
-  usage: 'vip search-replace <file.sql> --search-replace="from,to" --output="<output.sql>"',
-  description: 'Search and Replace to the specified output <output.sql> file\n' + '       * Has no effect when the `in-place` flag is used'
+  usage: 'vip search-replace file.sql --search-replace="from,to" --output=output-file.sql',
+  description: 'Perform the search and replace operation and save the results to a local clone of the input file named "output-file.sql".'
 }];
 (0, _command.default)({
   requiredArgs: 1
-}).option('search-replace', 'Specify the <from> and <to> pairs to be replaced').option('in-place', 'Perform the search and replace explicitly on the input file').option('output', '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.').examples(examples).argv(process.argv, async (arg, opt) => {
+}).option('search-replace', 'A comma-separated pair of strings that specify the values to search for and replace (e.g. --search-replace="from,to").').option('in-place', 'Overwrite the local input file with the results of the search and replace operation.').option('output', 'The local file path used to save a copy of the results from the search and replace operation. Ignored when used with the --in-place option.').examples(examples).argv(process.argv, async (arg, opt) => {
   // TODO: tracks event for usage of this command stand alone
   const {
     searchReplace,

package/dist/bin/vip-slowlogs.js

@@ -25,6 +25,7 @@ const MAX_POLLING_DELAY_IN_SECONDS = 300;
 const exampleUsage = 'vip @example-app.develop slowlogs';
 const baseUsage = 'vip slowlogs';
 async function getSlowlogs(arg, opt) {
+  opt.format ??= 'table';
   validateInputs(opt.limit, opt.format);
   const trackingParams = getBaseTrackingParams(opt);
   await (0, _tracker.trackEvent)('slowlogs_command_execute', trackingParams);
@@ -147,7 +148,7 @@ function validateInputs(limit, format) {
     exit.withError(`Invalid format: ${format}. The supported formats are: ${ALLOWED_FORMATS.join(', ')}.`);
   }
   if (!Number.isInteger(limit) || limit < LIMIT_MIN || limit > slowlogsLib.LIMIT_MAX) {
-    exit.withError(`Invalid limit: ${limit}. It should be a number between ${LIMIT_MIN} and ${slowlogsLib.LIMIT_MAX}.`);
+    exit.withError(`Invalid limit: ${limit}. Set the limit to an integer between ${LIMIT_MIN} and ${slowlogsLib.LIMIT_MAX}.`);
   }
 }
 const appQuery = exports.appQuery = `
@@ -171,7 +172,7 @@ void (0, _command.default)({
   format: false,
   module: 'slowlogs',
   usage: baseUsage
-}).option('limit', 'The maximum number of log entries', 500).option('format', 'Output the log entries in CSV or JSON format', 'table').examples([{
+}).option('limit', 'Set the maximum number of log entries. Accepts an integer value between 1 and 500.', 500).option('format', 'Render output in a particular format. Accepts “csv”, and “json”.', 'table').examples([{
   description: 'Retrieve up to 500 of the most recent entries from the MySQL slow query logs in the default format.',
   usage: exampleUsage
 }, {

package/dist/bin/vip.js

@@ -22,7 +22,7 @@ const tokenURL = 'https://dashboard.wpvip.com/me/cli/token';
 const customDeployToken = process.env.WPVIP_DEPLOY_TOKEN;
 const runCmd = async function () {
   const cmd = (0, _command.default)();
-  cmd.command('logout', 'Log out the current authenticated VIP-CLI user.').command('app', 'Interact with applications that the current authenticated VIP-CLI user has permission to access.').command('backup', 'Generate a backup of an environment.').command('cache', 'Manage page cache for an environment.').command('config', 'Manage environment configurations.').command('dev-env', 'Create and manage VIP Local Development Environments.').command('export', 'Export a copy of data associated with an environment.').command('import', 'Import media or SQL database files to an environment.').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Retrieve MySQL slow query logs from an environment.').command('db', "Access an environment's database.").command('sync', 'Sync the database from production to a non-production environment.').command('whoami', 'Retrieve details about the current authenticated VIP-CLI user.').command('validate', 'Validate your VIP application and environment').command('wp', 'Execute a WP-CLI command against an environment.');
+  cmd.command('logout', 'Log out the current authenticated VIP-CLI user.').command('app', 'Interact with applications that the current authenticated VIP-CLI user has permission to access.').command('backup', 'Generate a backup of an environment.').command('cache', 'Manage page cache for an environment.').command('config', 'Manage environment configurations.').command('dev-env', 'Create and manage VIP Local Development Environments.').command('export', 'Export a copy of data associated with an environment.').command('import', 'Import media or SQL database files to an environment.').command('logs', 'Retrieve Runtime Logs from an environment.').command('search-replace', 'Search for a string in a local SQL file and replace it with a new string.').command('slowlogs', 'Retrieve MySQL slow query logs from an environment.').command('db', "Access an environment's database.").command('sync', 'Sync the database from production to a non-production environment.').command('whoami', 'Retrieve details about the current authenticated VIP-CLI user.').command('validate', 'Validate your VIP application and environment').command('wp', 'Execute a WP-CLI command against an environment.');
   cmd.argv(process.argv);
 };
 

package/dist/lib/cli/command.js

@@ -534,7 +534,7 @@ function _default(opts) {
     _args.default.option('force', 'Skip confirmation.', false);
   }
   if (_opts.format) {
-    _args.default.option('format', 'Render output in a particular format. Accepts "table" (default), "csv", and "json".');
+    _args.default.option('format', 'Render output in a particular format. Accepts “csv”, and “json”.', 'table');
   }
 
   // Add help and version to all subcommands

package/docs/CHANGELOG.md

@@ -1,18 +1,29 @@
 ## Changelog
 
-## 3.8.7
+### 3.8.8
+
+* build(deps-dev): bump @types/dockerode from 3.3.31 to 3.3.32
+* Update the `search-replace` command to follow the VIP-CLI style guide
+* Update the`vip logs` command to follow the VIP-CLI style guide
+* build(deps-dev): bump @types/node from 22.9.0 to 22.9.1
+* build(deps): bump actions/dependency-review-action from 4.4.0 to 4.5.0
+* build(deps): bump step-security/harden-runner from 2.10.1 to 2.10.2
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.7...3.8.8
+
+### 3.8.7
 
 * fix(dev-env): SQL sync for single sites
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.6...3.8.7
 
-## 3.8.6
+### 3.8.6
 
 * Updating Node.js versions and standardize the format
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.5...3.8.6
 
-## 3.8.5
+### 3.8.5
 
 * build(deps-dev): bump the babel group with 4 updates
 * build(deps-dev): bump typescript from 5.6.2 to 5.6.3
@@ -52,7 +63,7 @@
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.4...3.8.5
 
-## 3.8.4
+### 3.8.4
 
 * build(deps): bump step-security/harden-runner from 2.9.1 to 2.10.1
 * build(deps-dev): bump @types/jest from 29.5.12 to 29.5.13 in the testing group
@@ -66,7 +77,7 @@
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.3...3.8.4
 
-## 3.8.3
+### 3.8.3
 
 * build(deps): bump adm-zip from 0.5.15 to 0.5.16
 * build(deps): bump debug from 4.3.6 to 4.3.7
@@ -78,7 +89,7 @@
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.2...3.8.3
 
-## 3.8.2
+### 3.8.2
 
 * chore(deps): make `node-fetch` 2.x depend on `whatwg-url` 14.x to address deprecations
 * build(deps-dev): bump nock from 13.5.4 to 13.5.5
@@ -93,14 +104,14 @@
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.1...3.8.2
 
-## 3.8.1
+### 3.8.1
 
 * fix(dev-env): clean up data after `vip dev-env sync sql`
 * security: fix high severity CVE-2024-39338 in `axios`
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.8.0...3.8.1
 
-## 3.8.0
+### 3.8.0
 
 * build(deps-dev): bump @babel/preset-env from 7.24.8 to 7.25.0 in the babel group
 * build(deps): bump debug from 4.3.5 to 4.3.6
@@ -115,7 +126,7 @@
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.7.1...3.8.0
 
-## 3.7.1
+### 3.7.1
 
 * build(deps): bump step-security/harden-runner from 2.8.1 to 2.9.0
 * build(deps): bump semver from 7.6.2 to 7.6.3
@@ -131,7 +142,7 @@
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.7.0...3.7.1
 
-## 3.7.0
+### 3.7.0
 
 * build(deps-dev): bump @automattic/eslint-plugin-wpvip from 0.12.0 to 0.13.0
 * build(deps-dev): bump the babel group with 3 updates
@@ -143,14 +154,14 @@
   
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.6.0...3.7.0
 
-## 3.6.0
+### 3.6.0
 
 * build(deps-dev): bump rimraf from 5.0.7 to 5.0.8
 * feat(dev-env): add DNS check to health check to ensure domains resolve correctly
 
 **Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.5.1...3.6.0
 
-## 3.5.1
+### 3.5.1
 
 * fix(dev-env): display cron status in `vip dev-env info --extended`
 * build(deps-dev): bump typescript from 5.5.2 to 5.5.3

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "3.8.7",
+  "version": "3.8.8",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.8.7",
+      "version": "3.8.8",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
@@ -3526,9 +3526,9 @@
       }
     },
     "node_modules/@types/dockerode": {
-      "version": "3.3.31",
-      "resolved": "https://registry.npmjs.org/@types/dockerode/-/dockerode-3.3.31.tgz",
-      "integrity": "sha512-42R9eoVqJDSvVspV89g7RwRqfNExgievLNWoHkg7NoWIqAmavIbgQBb4oc0qRtHkxE+I3Xxvqv7qVXFABKPBTg==",
+      "version": "3.3.32",
+      "resolved": "https://registry.npmjs.org/@types/dockerode/-/dockerode-3.3.32.tgz",
+      "integrity": "sha512-xxcG0g5AWKtNyh7I7wswLdFvym4Mlqks5ZlKzxEUrGHS0r0PUOfxm2T0mspwu10mHQqu3Ck3MI3V2HqvLWE1fg==",
       "dev": true,
       "dependencies": {
         "@types/docker-modem": "*",
@@ -3618,9 +3618,9 @@
       "dev": true
     },
     "node_modules/@types/node": {
-      "version": "22.9.0",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.0.tgz",
-      "integrity": "sha512-vuyHg81vvWA1Z1ELfvLko2c8f34gyA0zaic0+Rllc5lbCnbSyuvb2Oxpm6TAUAC/2xZN3QGqxBNggD1nNR2AfQ==",
+      "version": "22.9.1",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.1.tgz",
+      "integrity": "sha512-p8Yy/8sw1caA8CdRIQBG5tiLHmxtQKObCijiAa9Ez+d4+PRffM4054xbju0msf+cvhJpnFEeNjxmVT/0ipktrg==",
       "dependencies": {
         "undici-types": "~6.19.8"
       }
@@ -15786,9 +15786,9 @@
       }
     },
     "@types/dockerode": {
-      "version": "3.3.31",
-      "resolved": "https://registry.npmjs.org/@types/dockerode/-/dockerode-3.3.31.tgz",
-      "integrity": "sha512-42R9eoVqJDSvVspV89g7RwRqfNExgievLNWoHkg7NoWIqAmavIbgQBb4oc0qRtHkxE+I3Xxvqv7qVXFABKPBTg==",
+      "version": "3.3.32",
+      "resolved": "https://registry.npmjs.org/@types/dockerode/-/dockerode-3.3.32.tgz",
+      "integrity": "sha512-xxcG0g5AWKtNyh7I7wswLdFvym4Mlqks5ZlKzxEUrGHS0r0PUOfxm2T0mspwu10mHQqu3Ck3MI3V2HqvLWE1fg==",
       "dev": true,
       "requires": {
         "@types/docker-modem": "*",
@@ -15878,9 +15878,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "22.9.0",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.0.tgz",
-      "integrity": "sha512-vuyHg81vvWA1Z1ELfvLko2c8f34gyA0zaic0+Rllc5lbCnbSyuvb2Oxpm6TAUAC/2xZN3QGqxBNggD1nNR2AfQ==",
+      "version": "22.9.1",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.1.tgz",
+      "integrity": "sha512-p8Yy/8sw1caA8CdRIQBG5tiLHmxtQKObCijiAa9Ez+d4+PRffM4054xbju0msf+cvhJpnFEeNjxmVT/0ipktrg==",
       "requires": {
         "undici-types": "~6.19.8"
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "3.8.7",
+  "version": "3.8.8",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {