From 350d63a2775327a83fc78a6e696401a6b0637cc5 Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Tue, 9 Apr 2024 15:34:42 -0700 Subject: [PATCH 1/5] Updates to descriptions and examples for vip db --- src/bin/vip-db-phpmyadmin.ts | 4 ++-- src/bin/vip-db.ts | 6 +++--- src/bin/vip.js | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/bin/vip-db-phpmyadmin.ts b/src/bin/vip-db-phpmyadmin.ts index d08f3b000..a2948e6d9 100755 --- a/src/bin/vip-db-phpmyadmin.ts +++ b/src/bin/vip-db-phpmyadmin.ts @@ -14,8 +14,8 @@ import { makeCommandTracker } from '../lib/tracker'; const examples = [ { - usage: 'vip db phpmyadmin @mysite.develop', - description: 'Open PhpMyAdmin console for the database of the @mysite.develop environment', + usage: 'vip @example-app.develop db phpmyadmin', + description: 'Access a read-only phpMyAdmin console for the environment\'s database.', }, ]; diff --git a/src/bin/vip-db.ts b/src/bin/vip-db.ts index 8bf650f68..129274f1d 100755 --- a/src/bin/vip-db.ts +++ b/src/bin/vip-db.ts @@ -11,10 +11,10 @@ import command from '../lib/cli/command'; import { trackEvent } from '../lib/tracker'; void command( { usage: 'vip db' } ) - .command( 'phpmyadmin', 'Open PhpMyAdmin console for your application database' ) + .command( 'phpmyadmin', 'Access a read-only phpMyAdmin console for an environment database.' ) .example( - 'vip db phpmyadmin @mysite.develop', - 'Open PhpMyAdmin console for your database of the @mysite.develop environment' + 'vip @example-app.develop db phpmyadmin', + 'Access a read-only phpMyAdmin console for the environment\'s database.' ) .argv( process.argv, async () => { await trackEvent( 'vip_db_command_execute' ); diff --git a/src/bin/vip.js b/src/bin/vip.js index b132f08ff..c41b6797f 100755 --- a/src/bin/vip.js +++ b/src/bin/vip.js @@ -36,7 +36,7 @@ const runCmd = async function () { .command( 'logs', 'Get logs from your VIP applications' ) .command( 'search-replace', 'Perform search and replace tasks on files' ) .command( 'slowlogs', 'Get slowlogs from your VIP applications' ) - .command( 'db', 'Run operations on your VIP application database' ) + .command( 'db', 'Connect to an environment database.' ) .command( 'sync', 'Sync production to a development environment' ) .command( 'whoami', 'Display details about the currently logged-in user' ) .command( 'validate', 'Validate your VIP application and environment' ) From f7b69af723d09320bb9291dcc4107de7a6af17bf Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Tue, 9 Apr 2024 15:59:56 -0700 Subject: [PATCH 2/5] prettier linting --- src/bin/vip-db-phpmyadmin.ts | 2 +- src/bin/vip-db.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/bin/vip-db-phpmyadmin.ts b/src/bin/vip-db-phpmyadmin.ts index a2948e6d9..43549ffd5 100755 --- a/src/bin/vip-db-phpmyadmin.ts +++ b/src/bin/vip-db-phpmyadmin.ts @@ -15,7 +15,7 @@ import { makeCommandTracker } from '../lib/tracker'; const examples = [ { usage: 'vip @example-app.develop db phpmyadmin', - description: 'Access a read-only phpMyAdmin console for the environment\'s database.', + description: "Access a read-only phpMyAdmin console for the environment's database.", }, ]; diff --git a/src/bin/vip-db.ts b/src/bin/vip-db.ts index 129274f1d..878869c6e 100755 --- a/src/bin/vip-db.ts +++ b/src/bin/vip-db.ts @@ -14,7 +14,7 @@ void command( { usage: 'vip db' } ) .command( 'phpmyadmin', 'Access a read-only phpMyAdmin console for an environment database.' ) .example( 'vip @example-app.develop db phpmyadmin', - 'Access a read-only phpMyAdmin console for the environment\'s database.' + "Access a read-only phpMyAdmin console for the environment's database." ) .argv( process.argv, async () => { await trackEvent( 'vip_db_command_execute' ); From 28ef3a271d4d6416aba0e9b8ac5a1b83070c3cf4 Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Tue, 16 Apr 2024 12:48:53 -0700 Subject: [PATCH 3/5] Edits as per Terri --- src/bin/vip-db-phpmyadmin.ts | 2 +- src/bin/vip-db.ts | 4 ++-- src/bin/vip.js | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/bin/vip-db-phpmyadmin.ts b/src/bin/vip-db-phpmyadmin.ts index 43549ffd5..9dd608e60 100755 --- a/src/bin/vip-db-phpmyadmin.ts +++ b/src/bin/vip-db-phpmyadmin.ts @@ -15,7 +15,7 @@ import { makeCommandTracker } from '../lib/tracker'; const examples = [ { usage: 'vip @example-app.develop db phpmyadmin', - description: "Access a read-only phpMyAdmin console for the environment's database.", + description: "Generate access a read-only phpMyAdmin web interface for the environment's database.", }, ]; diff --git a/src/bin/vip-db.ts b/src/bin/vip-db.ts index 878869c6e..ddafb04d0 100755 --- a/src/bin/vip-db.ts +++ b/src/bin/vip-db.ts @@ -11,10 +11,10 @@ import command from '../lib/cli/command'; import { trackEvent } from '../lib/tracker'; void command( { usage: 'vip db' } ) - .command( 'phpmyadmin', 'Access a read-only phpMyAdmin console for an environment database.' ) + .command( 'phpmyadmin', 'Generate access to a read-only phpMyAdmin web interface for an environment database.' ) .example( 'vip @example-app.develop db phpmyadmin', - "Access a read-only phpMyAdmin console for the environment's database." + "Generate access a read-only phpMyAdmin web interface for the environment's database." ) .argv( process.argv, async () => { await trackEvent( 'vip_db_command_execute' ); diff --git a/src/bin/vip.js b/src/bin/vip.js index c41b6797f..34a37de9e 100755 --- a/src/bin/vip.js +++ b/src/bin/vip.js @@ -36,7 +36,7 @@ const runCmd = async function () { .command( 'logs', 'Get logs from your VIP applications' ) .command( 'search-replace', 'Perform search and replace tasks on files' ) .command( 'slowlogs', 'Get slowlogs from your VIP applications' ) - .command( 'db', 'Connect to an environment database.' ) + .command( 'db', 'Access an environment database.' ) .command( 'sync', 'Sync production to a development environment' ) .command( 'whoami', 'Display details about the currently logged-in user' ) .command( 'validate', 'Validate your VIP application and environment' ) From 265363fa07e71df98f9f4b5317ba5a8283f8b9ae Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Tue, 16 Apr 2024 15:13:31 -0700 Subject: [PATCH 4/5] Prettier linting --- src/bin/vip-db-phpmyadmin.ts | 3 ++- src/bin/vip-db.ts | 5 ++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/bin/vip-db-phpmyadmin.ts b/src/bin/vip-db-phpmyadmin.ts index 9dd608e60..f357de195 100755 --- a/src/bin/vip-db-phpmyadmin.ts +++ b/src/bin/vip-db-phpmyadmin.ts @@ -15,7 +15,8 @@ import { makeCommandTracker } from '../lib/tracker'; const examples = [ { usage: 'vip @example-app.develop db phpmyadmin', - description: "Generate access a read-only phpMyAdmin web interface for the environment's database.", + description: + "Generate access a read-only phpMyAdmin web interface for the environment's database.", }, ]; diff --git a/src/bin/vip-db.ts b/src/bin/vip-db.ts index ddafb04d0..a33450a7c 100755 --- a/src/bin/vip-db.ts +++ b/src/bin/vip-db.ts @@ -11,7 +11,10 @@ import command from '../lib/cli/command'; import { trackEvent } from '../lib/tracker'; void command( { usage: 'vip db' } ) - .command( 'phpmyadmin', 'Generate access to a read-only phpMyAdmin web interface for an environment database.' ) + .command( + 'phpmyadmin', + 'Generate access to a read-only phpMyAdmin web interface for an environment database.' + ) .example( 'vip @example-app.develop db phpmyadmin', "Generate access a read-only phpMyAdmin web interface for the environment's database." From 986f05be889b7fe6a37f58dfdbb0a1e312a610fa Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Wed, 17 Apr 2024 14:29:31 -0700 Subject: [PATCH 5/5] Updates as per feedback in review. --- src/bin/vip-db-phpmyadmin.ts | 2 +- src/bin/vip-db.ts | 2 +- src/bin/vip.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/bin/vip-db-phpmyadmin.ts b/src/bin/vip-db-phpmyadmin.ts index f357de195..c21d7ec6c 100755 --- a/src/bin/vip-db-phpmyadmin.ts +++ b/src/bin/vip-db-phpmyadmin.ts @@ -16,7 +16,7 @@ const examples = [ { usage: 'vip @example-app.develop db phpmyadmin', description: - "Generate access a read-only phpMyAdmin web interface for the environment's database.", + "Generate access to a read-only phpMyAdmin web interface for the environment's database.", }, ]; diff --git a/src/bin/vip-db.ts b/src/bin/vip-db.ts index a33450a7c..2e3d75d12 100755 --- a/src/bin/vip-db.ts +++ b/src/bin/vip-db.ts @@ -17,7 +17,7 @@ void command( { usage: 'vip db' } ) ) .example( 'vip @example-app.develop db phpmyadmin', - "Generate access a read-only phpMyAdmin web interface for the environment's database." + "Generate access to a read-only phpMyAdmin web interface for the environment's database." ) .argv( process.argv, async () => { await trackEvent( 'vip_db_command_execute' ); diff --git a/src/bin/vip.js b/src/bin/vip.js index 4a6ee45e4..4ed98db55 100755 --- a/src/bin/vip.js +++ b/src/bin/vip.js @@ -36,7 +36,7 @@ const runCmd = async function () { .command( 'logs', 'Get logs from your VIP applications' ) .command( 'search-replace', 'Perform search and replace tasks on files' ) .command( 'slowlogs', 'Get slowlogs from your VIP applications' ) - .command( 'db', 'Access an environment database.' ) + .command( 'db', "Access an environment's database." ) .command( 'sync', 'Sync production to a development environment' ) .command( 'whoami', 'Display details about the currently logged-in user' ) .command( 'validate', 'Validate your VIP application and environment' )