@automattic/vip 3.8.4 → 3.8.6

package/dist/bin/vip-import-media-abort.js

@@ -15,6 +15,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // eslint-disable-next-line no-duplicate-imports
 
+const usage = 'vip import media abort';
 const appQuery = `
 	id,
 	name,
@@ -44,16 +45,23 @@ const ABORT_IMPORT_MUTATION = (0, _graphqlTag.default)`
 		}
 	}
 `;
+
+// Command examples
+const examples = [{
+  usage: `vip @example-app.production import media abort`,
+  description: 'Abort the media file import that is currently in progress on the production environment of the "example-app" application.'
+}];
 (0, _command.default)({
   appContext: true,
   appQuery,
   envContext: true,
   requiredArgs: 0,
+  usage,
   requireConfirm: `
-${_chalk.default.red.bold("By running this command, the Media Import running on your App will stop and can't be resumed.")}
-${_chalk.default.red.bold('Are you sure you want to abort this Media Import?')}
+${_chalk.default.red.bold('Running this command will stop the currently running media import. The import process cannot be resumed.')}
+${_chalk.default.red.bold('Are you sure you want to abort this media import?')}
 `
-}).argv(process.argv, async (arg, {
+}).examples(examples).argv(process.argv, async (arg, {
   app,
   env
 }) => {
@@ -66,14 +74,14 @@ ${_chalk.default.red.bold('Are you sure you want to abort this Media Import?')}
     await track('import_media_command_error', {
       errorType: 'unsupported-app'
     });
-    exit.withError('The type of application you specified does not currently support Media imports.');
+    exit.withError('The type of application you specified does not currently support media file imports.');
   }
   const api = (0, _api.default)();
   await track('import_media_abort_execute');
   const progressTracker = new _progress.MediaImportProgressTracker([]);
   progressTracker.prefix = `
 =============================================================
-Aborting the Media Import running on your App
+Aborting this media import.
 `;
   try {
     await api.mutate({

package/dist/bin/vip-import-media-status.js

@@ -25,12 +25,23 @@ const appQuery = `
 		}
 	}
 `;
+const usage = 'vip import media status';
+
+// Command examples
+const examples = [{
+  usage: 'vip @example-app.production import media status',
+  description: 'Check the status of the most recent media import.\n' + '       * If the import is still in progress, the command will poll until the import is complete.\n' + '       * If the import is already complete, the command will download an error log for the most recent import.'
+}, {
+  usage: 'vip @example-app.production import media status --saveErrorLog --exportFileErrorsToJson',
+  description: 'Check the status of the most recent media import and automatically download the error log in JSON format.'
+}];
 (0, _command.default)({
   appContext: true,
   appQuery,
   envContext: true,
-  requiredArgs: 0
-}).option('exportFileErrorsToJson', 'Export any file errors encountered to a JSON file instead of a plain text file', false).option('saveErrorLog', 'Download file-error logs without prompting', 'prompt').argv(process.argv, async (arg, {
+  requiredArgs: 0,
+  usage
+}).option('exportFileErrorsToJson', 'Format an error log in JSON. Default is TXT.').option('saveErrorLog', 'Skip the confirmation prompt and download an error log automatically.', 'prompt').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
   exportFileErrorsToJson,
@@ -45,7 +56,7 @@ const appQuery = `
     await track('import_media_command_error', {
       errorType: 'unsupported-app'
     });
-    exit.withError('The type of application you specified does not currently support this feature');
+    exit.withError('The type of application you specified does not currently support this feature.');
   }
   await track('import_media_check_status_command_execute');
   const progressTracker = new _progress.MediaImportProgressTracker([]);

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

@@ -40,22 +40,28 @@ const START_IMPORT_MUTATION = (0, _graphqlTag.default)`
 		}
 	}
 `;
+const usage = 'vip import media';
 const debug = (0, _debug.default)('vip:vip-import-media');
 
 // Command examples for the `vip import media` help prompt
 const examples = [{
-  usage: 'vip import media @mysite.production https://<path_to_publicly_accessible_archive>',
-  description: 'Start a media import with the contents of the archive file in the URL'
+  usage: 'vip @example-app.production import media https://example.com/uploads.tar.gz',
+  description: 'Import the archived file "uploads.tar.gz" from a publicly accessible URL to a production environment.'
+},
+// Format error logs
+{
+  usage: 'vip @example-app.production import media https://example.com/uploads.tar.gz --overwriteExistingFiles --exportFileErrorsToJson',
+  description: 'Overwrite existing files with the imported files if they have the same file path and name, and format the error log for the import in JSON.'
 },
 // `media status` subcommand
 {
-  usage: 'vip import media status @mysite.production',
-  description: 'Check the status of the most recent import. If an import is running, this will poll until it is complete.'
+  usage: 'vip @example-app.production import media status',
+  description: 'Check the status of the most recent media import.'
 },
 // `media abort` subcommand
 {
-  usage: 'vip import media abort @mysite.production',
-  description: 'Abort an ongoing import'
+  usage: 'vip @example-app.production import media abort',
+  description: 'Abort the currently running media import.'
 }];
 function isSupportedUrl(urlToTest) {
   let url;
@@ -72,14 +78,15 @@ function isSupportedUrl(urlToTest) {
   envContext: true,
   module: 'import-media',
   requiredArgs: 1,
+  usage,
   requireConfirm: `
 ${_chalk.default.red.bold("NOTE: If the provided archive's directory structure contains an `uploads/` directory,")}
 ${_chalk.default.red.bold('only the files present inside that directory will be imported and the rest will be ignored.')}
 ${_chalk.default.red.bold('If no `uploads/` directory is found, all files will be imported, as is.')}
 
-Are you sure you want to import the contents of the url?
+Are you sure you want to import the contents of the URL?
 `
-}).command('status', 'Check the status of the latest Media Import').command('abort', 'Abort the Media Import running for your App').option('exportFileErrorsToJson', 'Export any file errors encountered to a JSON file instead of a plain text file', false).option('saveErrorLog', 'Download file-error logs without prompting').option('overwriteExistingFiles', 'Overwrite any existing files', false).option('importIntermediateImages', 'Import intermediate image files', false).examples(examples).argv(process.argv, async (args, opts) => {
+}).command('status', 'Check the status of a currently running media import or retrieve an error log of the most recent media import.').command('abort', 'Abort the media import currently in progress.').option('exportFileErrorsToJson', 'Format the error log in JSON. Default is TXT.').option('saveErrorLog', 'Skip the confirmation prompt and download an error log for the import automatically.').option('overwriteExistingFiles', 'Overwrite existing files with the imported files if they have the same path and file name.', false).option('importIntermediateImages', 'Include intermediate image files in the import.', false).examples(examples).argv(process.argv, async (args, opts) => {
   const {
     app,
     env,
@@ -93,7 +100,7 @@ Are you sure you want to import the contents of the url?
     console.log(_chalk.default.red(`
 Error:
 	Invalid URL provided: ${url}
-	Please make sure that it is a publicly accessible web URL containing an archive of the media files to import`));
+	Please make sure that it is a publicly accessible web URL containing an archive of the media files to import.`));
     return;
   }
   const track = _tracker.trackEventWithEnv.bind(null, app.id, env.id);

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

@@ -27,12 +27,20 @@ environments{
 	}
 }
 `;
+const usage = 'vip import sql status';
+
+// Command examples
+const examples = [{
+  usage: 'vip @example-app.develop import sql status',
+  description: 'Check the status of the most recent SQL database import to the develop environment of the "example-app" application.\n' + '       * If the import is still in progress, the command will poll until the import is complete.'
+}];
 (0, _command.default)({
   appContext: true,
   appQuery,
   envContext: true,
-  requiredArgs: 0
-}).argv(process.argv, async (arg, {
+  requiredArgs: 0,
+  usage
+}).examples(examples).argv(process.argv, async (arg, {
   app,
   env
 }) => {

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

@@ -66,16 +66,17 @@ const START_IMPORT_MUTATION = (0, _graphqlTag.default)`
 		}
 	}
 `;
+const usage = 'vip import sql';
 const debug = (0, _debug.default)('@automattic/vip:bin:vip-import-sql');
 const SQL_IMPORT_PREFLIGHT_PROGRESS_STEPS = [{
   id: 'replace',
-  name: 'Performing Search and Replace'
+  name: 'Performing search and replace'
 }, {
   id: 'upload',
   name: 'Uploading file'
 }, {
   id: 'queue_import',
-  name: 'Queueing Import'
+  name: 'Queueing import'
 }];
 
 /**
@@ -156,7 +157,7 @@ async function gates(app, env, fileMeta) {
     await track('import_sql_command_error', {
       error_type: 'empty-import-status'
     });
-    exit.withError('Could not determine the import status for this environment. Check the app/environment and if the problem persists, contact support for assistance');
+    exit.withError('Could not determine the import status for this environment. Check the app/environment and if the problem persists, contact support for assistance.');
   }
   const {
     importStatus: {
@@ -182,33 +183,33 @@ async function gates(app, env, fileMeta) {
 const examples = [
 // `sql` subcommand
 {
-  usage: 'vip import sql @mysite.develop file.sql',
-  description: 'Import the given SQL file to your site'
+  usage: 'vip @example-app.develop import sql file.sql',
+  description: 'Import the local SQL database backup file "file.sql" to the develop environment of the "example-app" application.'
 },
 // `search-replace` flag
 {
-  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com"',
-  description: 'Perform a Search and Replace, then import the replaced file to your site.\n' + '       * Ensure there are no spaces between your search-replace parameters'
+  usage: 'vip @example-app.develop import sql file.sql --search-replace="https://from.example.com,https://to.example.com"',
+  description: 'Perform a search and replace operation on the SQL database file during the import process.'
 },
 // `search-replace` flag
 {
-  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com" --search-replace="example.com/from,example.com/to"',
-  description: 'Perform multiple search and replace tasks, then import the updated file to your site.'
+  usage: 'vip @example-app.develop import sql file.sql --search-replace="from.example.com,to.example.com" --search-replace="example.com/from,example.com/to"',
+  description: 'Perform multiple search and replace operations on the SQL database file during the import process.'
 },
 // `in-place` flag
 {
-  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com" --in-place',
-  description: 'Search and Replace on the input `file.sql`, then import the updated file to your site'
+  usage: 'vip @example-app.develop import sql file.sql --search-replace="https://from.example.com,https://to.example.com" --in-place',
+  description: 'Perform a search and replace operation on "file.sql" locally, save the changes, then import the updated file.'
 },
 // `output` flag
 {
-  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com" --output="output.sql"',
-  description: 'Output the performed Search and Replace to the specified output file, then import the replaced file to your site\n' + '       * Has no effect when the `in-place` flag is used'
+  usage: 'vip @example-app.develop import sql file.sql --search-replace="https://from.example.com,https://to.example.com" --output="updated-file.sql"',
+  description: 'Create a copy of the imported file with the completed search and replace operations and save it locally to a file named "updated-file.sql".'
 },
 // `sql status` subcommand
 {
-  usage: 'vip import sql status @mysite.develop',
-  description: 'Check the status of the most recent import. If an import is running, this will poll until it is complete.'
+  usage: 'vip @example-app.develop import sql status',
+  description: 'Check the status of the most recent SQL database import to the develop environment of the "example-app" application.\n' + '       * This will continue to poll until the import is complete.'
 }];
 const promptToContinue = async ({
   launched,
@@ -224,7 +225,7 @@ const promptToContinue = async ({
   const promptResponse = await (0, _enquirer.prompt)({
     type: 'input',
     name: 'confirmedDomain',
-    message: `You are about to import ${source} into a ${launched ? 'launched' : 'un-launched'} ${formattedEnvironment} site ${_chalk.default.yellow(domain)}.\nType '${_chalk.default.yellow(promptToMatch)}' (without the quotes) to continue:\n`
+    message: `You are about to import ${source} into the ${launched ? 'launched' : 'unlaunched'} ${formattedEnvironment} environment ${_chalk.default.yellow(domain)}.\nType '${_chalk.default.yellow(promptToMatch)}' (without the quotes) to continue:\n`
   });
   if (promptResponse.confirmedDomain.toUpperCase() !== promptToMatch) {
     await track('import_sql_unexpected_tables');
@@ -253,7 +254,7 @@ async function validateAndGetTableNames({
   } catch (validateErr) {
     console.log('');
     exit.withError(`${validateErr.message}\n
-If you are confident the file does not contain unsupported statements, you can retry the command with the ${_chalk.default.yellow('--skip-validate')} option.
+If you are confident that the file does not contain unsupported statements, you can retry the command with the ${_chalk.default.yellow('--skip-validate')} option.
 `);
   }
   // this can only be called after static validation of the SQL file
@@ -289,20 +290,20 @@ const displayPlaybook = ({
     siteArray = selectedEnvironmentObj?.wpSitesSDS?.nodes;
   }
   if (!tableNames.length) {
-    debug('Validation was skipped, no playbook information will be displayed');
+    debug('Validation was skipped. No playbook information will be displayed.');
   } else {
     // output the table names
     console.log();
     if (!isMultiSite) {
-      console.log('Below are a list of Tables that will be imported by this process:');
+      console.log('Tables that will be imported by this process:');
       console.log((0, _cliColumns.default)(tableNames));
     } else {
       // we have siteArray from the API, use it and the table names together
       if (siteArray === 'undefined' || !siteArray) {
-        console.log(_chalk.default.yellowBright('Unable to determine the subsites affected by this import, please proceed only if you are confident on the contents in the import file.'));
+        console.log(_chalk.default.yellowBright('Unable to determine the network sites affected by this import. Please proceed only if you are confident that the contents of the file are valid for import.'));
         return;
       } else if (!siteArray?.length) {
-        throw new Error('There were no sites in your multisite installation');
+        throw new Error('There were no sites in your multisite installation.');
       }
       const multiSiteBreakdown = siteArray.map(wpSite => {
         let siteRegex;
@@ -320,7 +321,7 @@ const displayPlaybook = ({
         };
       });
       if (launched) {
-        console.log(_chalk.default.yellowBright('You are updating tables in a launched multi site installation. Sites in the same network may have their performance impacted by this operation.'));
+        console.log(_chalk.default.yellowBright('You are updating tables in a launched multisite environment. The performance of sites on the network might be impacted by this operation.'));
       }
       console.log(_chalk.default.yellow('The following sites will be affected by the import:'));
       multiSiteBreakdown.forEach(siteObject => {
@@ -336,8 +337,9 @@ void (0, _command.default)({
   appQuery,
   envContext: true,
   requiredArgs: 1,
-  module: 'import-sql'
-}).command('status', 'Check the status of the current running import').option('skip-validate', 'Do not perform pre-upload file validation. If unsupported entries are present, the import is likely to fail').option('search-replace', 'Search for a given URL in the SQL file and replace it with another. The format for the value is `<from-url>,<to-url>` (e.g. --search-replace="https://from.com,https://to.com"').option('in-place', 'Search and Replace explicitly on the given input file').option('output', 'Specify the replacement output file for Search and Replace', 'process.stdout').examples(examples).argv(process.argv, async (arg, opts) => {
+  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) => {
   const {
     app,
     env
@@ -354,7 +356,7 @@ void (0, _command.default)({
   const isMultiSite = await (0, _isMultiSite.isMultiSiteInSiteMeta)(appId, envId);
   let fileMeta = await (0, _clientFileUploader.getFileMeta)(fileName);
   if (fileMeta.isCompressed) {
-    console.log(_chalk.default.yellowBright('You are importing a compressed file. Validation and search-replace operation will be skipped.'));
+    console.log(_chalk.default.yellowBright('You are importing a compressed file. Validation and search-replace operations will be skipped.'));
     skipValidate = true;
     searchReplace = undefined;
   }
@@ -441,11 +443,11 @@ Processing the SQL import for your environment...
     } = await (0, _searchAndReplace.searchAndReplace)(fileName, searchReplace, {
       isImport: true,
       inPlace: opts.inPlace,
-      output: true
+      output: opts.output ?? true // "true" creates a temp output file instead of printing to stdout, as we need to upload the output to S3.
     });
     if (typeof outputFileName !== 'string') {
       progressTracker.stepFailed('replace');
-      return failWithError('Unable to determine location of the intermediate search & replace file.');
+      return failWithError('Unable to determine location of the intermediate search and replace file.');
     }
     fileNameToUpload = outputFileName;
     fileMeta = await (0, _clientFileUploader.getFileMeta)(fileNameToUpload);

package/dist/bin/vip-import-validate-files.js

@@ -29,7 +29,7 @@ async function vipImportValidateFilesCmd(arg = []) {
   const filePath = arg.path; // Extract the path of the file
 
   if (!(await (0, _vipImportValidateFiles.isDirectory)(filePath))) {
-    console.error(_chalk.default.red('✕ Error:'), 'The given path is not a directory, please provide a valid directory path.');
+    console.error(_chalk.default.red('✕ Error:'), 'The given path is not a directory. Provide a valid directory path.');
     return;
   }
   let folderValidation = [];
@@ -66,7 +66,7 @@ async function vipImportValidateFilesCmd(arg = []) {
    * - Intermediate image validation
    */
   if (!files || !files.length || files.length <= 0) {
-    console.error(_chalk.default.red('✕ Error:'), 'Media files directory cannot be empty');
+    console.error(_chalk.default.red('✕ Error:'), 'The media files directory cannot be empty.');
   }
 
   /**
@@ -147,10 +147,11 @@ async function vipImportValidateFilesCmd(arg = []) {
 
   await (0, _tracker.trackEvent)('import_validate_files_command_success', allErrors);
 }
+const usage = 'vip import validate-files';
 (0, _command.default)({
   requiredArgs: 1,
-  format: true
+  usage
 }).examples([{
-  usage: 'vip import validate-files <folder_name>',
-  description: 'Run the import validation against the folder of media files'
+  usage: 'vip import validate-files /Users/user-name/Desktop/uploads',
+  description: 'Validate the directory structure and contents of the local directory "uploads/".'
 }]).argv(process.argv, vipImportValidateFilesCmd);

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

@@ -7,12 +7,14 @@ var _sql = require("../lib/validations/sql");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const usage = 'vip import validate-sql';
 (0, _command.default)({
-  requiredArgs: 1
-}).example('vip import validate-sql <file>', 'Run the import validation against file').argv(process.argv, async arg => {
+  requiredArgs: 1,
+  usage
+}).example('vip import validate-sql file.sql', 'Scan the local file named "file.sql" for SQL validation errors and potential incompatibilities with platform databases.').argv(process.argv, async arg => {
   const filename = arg[0];
   if (!filename) {
-    exit.withError('You must pass in a filename');
+    exit.withError('You must pass in a filename.');
   }
   await (0, _sql.validate)(filename);
 });

package/dist/bin/vip-import.js

@@ -4,6 +4,6 @@
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _tracker = require("../lib/tracker");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-(0, _command.default)().command('sql', 'Import SQL to your database from a file').command('validate-sql', 'Validate your SQL dump').command('validate-files', 'Validate your media file library').command('media', 'Import media files to the production environment of your application from a compressed web archive').example('vip import sql @mysite.develop <file.sql>', 'Import the given SQL file to your site').example('vip import media @mysite.production https://<path_to_publicly_accessible_archive>', 'Import contents of the given archive file into the media library of your site').argv(process.argv, async () => {
+(0, _command.default)().command('sql', 'Import a SQL database file to an environment.').command('validate-sql', 'Validate a local SQL database file prior to import.').command('validate-files', 'Validate the directory structure and contents of a local media file directory prior to archiving and uploading it to a publicly accessible URL.').command('media', 'Import media files to an environment from an archived file located at a publicly accessible URL.').example('vip @example-app.develop import sql example-file.sql', 'Import the local SQL database file "example-file.sql" to the develop environment.').example('vip @example-app.production import media https://www.example.com/uploads.tar.gz', 'Import an archived file from a publicly accessible URL to the production environment.').argv(process.argv, async () => {
   await (0, _tracker.trackEvent)('vip_import_command_execute');
 });

package/dist/bin/vip-logs.js

@@ -7,6 +7,7 @@ exports.followLogs = followLogs;
 exports.getLogs = getLogs;
 exports.validateInputs = validateInputs;
 var _chalk = _interopRequireDefault(require("chalk"));
+var _cliTable = _interopRequireDefault(require("cli-table3"));
 var _promises = require("timers/promises");
 var logsLib = _interopRequireWildcard(require("../lib/app-logs/app-logs"));
 var _command = _interopRequireDefault(require("../lib/cli/command"));
@@ -18,6 +19,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const LIMIT_MIN = 1;
 const LIMIT_MAX = 5000;
+const LIMIT_DEFAULT = 500;
 const ALLOWED_TYPES = ['app', 'batch'];
 const ALLOWED_FORMATS = ['csv', 'json', 'table'];
 const DEFAULT_POLLING_DELAY_IN_SECONDS = 30;
@@ -139,14 +141,30 @@ function printLogs(logs, format) {
   });
   let output = '';
   if (format && 'table' === format) {
-    const rows = [];
+    const options = {
+      wordWrap: true,
+      wrapOnWordBoundary: true,
+      head: ['Timestamp', 'Message'],
+      style: {
+        head: ['cyan'],
+        border: ['grey']
+      }
+    };
+    if (process.stdout.isTTY && process.stdout.columns) {
+      options.colWidths = ['YYYY-MM-DDTHH:MM:SS.nnnnnnnnnZ'.length + 2 /* padding */, Math.max(process.stdout.columns - '│  │  │'.length - 'YYYY-MM-DDTHH:MM:SS.nnnnnnnnnZ'.length, 20)];
+    } else {
+      options.style.head = [];
+      options.style.border = [];
+    }
+    const table = new _cliTable.default(options);
     for (const {
       timestamp,
       message
     } of logs) {
-      rows.push(`${timestamp} ${message}`);
-      output = rows.join('\n');
+      const msg = message.trimRight().replace(/\t/g, '    ');
+      table.push([timestamp, msg]);
     }
+    output = table.toString();
   } else {
     output = (0, _format.formatData)(logs, format);
   }
@@ -159,6 +177,9 @@ 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(', ')}.`);
   }
@@ -188,7 +209,9 @@ const appQuery = exports.appQuery = `
   appQuery,
   envContext: true,
   module: 'logs'
-}).option('type', 'The type of logs to be returned: "app" or "batch"', 'app').option('limit', 'The maximum number of log lines', 500).option('follow', 'Keep fetching new logs as they are generated').option('format', 'Output the log lines in CSV or JSON format', 'table').examples([{
+}).option('type', 'The type of logs to be returned: "app" or "batch"', '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'
 }, {

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

@@ -29,7 +29,7 @@ const examples = [
 }];
 (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', 'Specify the replacement output file for Search and Replace').examples(examples).argv(process.argv, async (arg, opt) => {
+}).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) => {
   // TODO: tracks event for usage of this command stand alone
   const {
     searchReplace,

package/dist/bin/vip-sync.js

@@ -21,21 +21,21 @@ const appQuery = `id,name,environments{
   childEnvContext: true,
   module: 'sync',
   requireConfirm: 'Are you sure you want to sync from production?'
-}).argv(process.argv, async (arg, opts) => {
+}).example('vip @example-app.develop sync', 'Sync the production environment database of the "example-app" application to the develop environment.').argv(process.argv, async (arg, opts) => {
   const api = (0, _api.default)();
   let syncing = false;
   await (0, _tracker.trackEvent)('sync_command_execute');
   try {
     await api.mutate({
       mutation: (0, _graphqlTag.default)`
-				mutation SyncEnvironmentMutation($input: AppEnvironmentSyncInput) {
-					syncEnvironment(input: $input) {
-						environment {
-							id
+					mutation SyncEnvironmentMutation($input: AppEnvironmentSyncInput) {
+						syncEnvironment(input: $input) {
+							environment {
+								id
+							}
 						}
 					}
-				}
-			`,
+				`,
       variables: {
         input: {
           id: opts.app.id,
@@ -99,28 +99,28 @@ const appQuery = `id,name,environments{
       // The rest of the iterations are just for moving the spinner
       api.query({
         query: (0, _graphqlTag.default)`
-						query App($id: Int, $sync: Int) {
-							app(id: $id) {
-								id
-								name
-								environments {
+							query App($id: Int, $sync: Int) {
+								app(id: $id) {
 									id
 									name
-									defaultDomain
-									branch
-									datacenter
-									syncProgress(sync: $sync) {
-										status
-										sync
-										steps {
-											name
+									environments {
+										id
+										name
+										defaultDomain
+										branch
+										datacenter
+										syncProgress(sync: $sync) {
 											status
+											sync
+											steps {
+												name
+												status
+											}
 										}
 									}
 								}
 							}
-						}
-					`,
+						`,
         fetchPolicy: 'network-only',
         variables: {
           id: opts.app.id,

package/dist/bin/vip-validate-preflight.js

@@ -19,7 +19,7 @@ var _tracker = require("../lib/tracker");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const ALLOWED_NODEJS_VERSIONS = ['14', '16', '18'];
+const ALLOWED_NODEJS_VERSIONS = ['18', '20', '22'];
 const appQuery = exports.appQuery = `
 	id
 	name
@@ -42,7 +42,7 @@ const appQuery = exports.appQuery = `
 	}
 `;
 let suppressOutput = false;
-let outputJson = false;
+let outputFormat = 'table';
 let harmoniaArgs = [];
 
 /**
@@ -321,7 +321,7 @@ async function handleResults(harmonia, results) {
   });
 
   // If the output is JSON, reenable the logToConsole output and print-out the json format.
-  if (outputJson) {
+  if (outputFormat === 'json') {
     suppressOutput = false;
     logToConsole(harmonia.resultsJSON());
     process.exit(0);
@@ -383,9 +383,9 @@ async function validateArgs(opt) {
   }
 
   // If the JSON option is enabled, all the stdout should be suppressed to prevent polluting the output.
-  if (opt.json) {
+  if (opt.format === 'json') {
     suppressOutput = true;
-    outputJson = true;
+    outputFormat = 'json';
   }
   if (opt.app) {
     // Get build information from API and store it in the env object
@@ -459,10 +459,10 @@ if (parsedAlias.app) {
 } else {
   logToConsole(_chalk.default.bold.yellow('Warning: ') + 'The preflight tests are running without a provided application and/or environment.\n' + 'Some app-dependent configurations, such as environment variables, might not defined.');
 }
-(0, _command.default)(commandOpts).option('verbose', 'Increase logging level to include app build and server boot up messages', false).option('node-version', 'Select a specific target Node.JS version in semver format (MAJOR.MINOR.PATCH) or a MAJOR').option('wait', 'Configure the time to wait in ms for the app to boot up. Do not change unless you have issues', 3000).option(['p', 'port'], 'Configure the port to use for the app (defaults to a random port between 3001 and 3999)').option('json', 'Output the results as JSON', false).option(['P', 'path'], 'Path to the app to be tested', process.cwd()).examples([{
+(0, _command.default)(commandOpts).option('verbose', 'Increase logging level to include app build and server boot up messages', false).option('node-version', `Select a specific target Node.JS version in semver format (MAJOR.MINOR.PATCH) or a MAJOR (${ALLOWED_NODEJS_VERSIONS.join(', ')})`).option('wait', 'Configure the time to wait in ms for the app to boot up. Do not change unless you have issues', 3000).option(['p', 'port'], 'Configure the port to use for the app (defaults to a random port between 3001 and 3999)').option('format', 'Output the log lines in CSV or JSON format', 'table').option(['P', 'path'], 'Path to the app to be tested', process.cwd()).examples([{
   usage: 'vip @mysite.production validate preflight',
   description: 'Runs the preflight tests to validate if your application is ready to be deployed to VIP Go'
 }, {
-  usage: 'vip @mysite.production validate preflight --json > results.json',
+  usage: 'vip @mysite.production validate preflight --format json > results.json',
   description: 'Runs the preflight tests, but output the results in JSON format, and redirect the output to a file'
 }]).argv(process.argv, vipValidatePreflightCommand);