fix(help): 🎨 improve options output (#246)

- Use yargs option groups
- Update some descriptions
- Add more defaults

Author: ErisDS

lib/bootstrap.js

@@ -106,7 +106,7 @@ module.exports = {
                 type: 'boolean'
             })
             .options('prompt', {
-                describe: 'Allow UI prompting (`--no-prompt` is useful for bash scripting)',
+                describe: '[--no-prompt] Allow/Disallow UI prompting',
                 type: 'boolean',
                 default: true
             })

lib/commands/config/advanced.js

@@ -20,23 +20,20 @@ const knownMailServices = [
     options will have been handled prior to it being run.
  */
 module.exports = {
-    ip: {
-        description: 'IP ghost should listen on',
-        configPath: 'server.host',
-        type: 'string'
-    },
     url: {
-        description: 'Blog url protocol required ex http://loveghost.com ',
+        description: 'Blog URL with protocol E.g. http://loveghost.com',
         validate: value => validator.isURL(value, {require_protocol: true}) ||
             'Invalid URL. Your URL should include a protocol, E.g. http://my-ghost-blog.com',
-        type: 'string'
+        type: 'string',
+        group: 'Ghost Options:'
     },
     adminUrl: {
-        description: 'Url for the admin client, if different than the normal url',
+        description: 'URL for the admin client, if different than the normal URL',
         configPath: 'admin.url',
         validate: value => validator.isURL(value, {require_protocol: true}) ||
             'Invalid URL. Your URL should include a protocol, E.g. http://my-ghost-blog.com',
-        type: 'string'
+        type: 'string',
+        group: 'Ghost Options:'
     },
     port: {
         description: 'Port ghost should listen on',
@@ -56,45 +53,55 @@ module.exports = {
             let port = url.parse(config.get('url')).port || BASE_PORT;
             return portfinder.getPortPromise({port: parseInt(port)});
         },
-        type: 'number'
+        default: 2368,
+        type: 'number',
+        group: 'Ghost Options:'
     },
-    process: {
-        description: 'Type of process manager to run Ghost with',
-        defaultValue: (c, env) => env === 'production' ? 'systemd' : 'local',
-        type: 'string'
+    ip: {
+        description: 'IP ghost should listen on',
+        configPath: 'server.host',
+        default: '127.0.0.1',
+        type: 'string',
+        group: 'Ghost Options:'
     },
 
     // Database options
     db: {
-        description: 'Type of database Ghost should use',
+        description: 'Type of database Ghost should use E.g. mysql or sqlite3',
         validate: value => includes(['sqlite3', 'mysql'], value),
         configPath: 'database.client',
-        type: 'string'
+        type: 'string',
+        group: 'Database Options:'
     },
     dbpath: {
         description: 'Path to the database file (sqlite3 only)',
         configPath: 'database.connection.filename',
-        type: 'string'
+        type: 'string',
+        group: 'Database Options:'
     },
     dbhost: {
         description: 'Database host',
         configPath: 'database.connection.host',
-        type: 'string'
+        type: 'string',
+        group: 'Database Options:'
     },
     dbuser: {
         description: 'Database username',
         configPath: 'database.connection.user',
-        type: 'string'
+        type: 'string',
+        group: 'Database Options:'
     },
     dbpass: {
         description: 'Database password',
         configPath: 'database.connection.password',
-        type: 'string'
+        type: 'string',
+        group: 'Database Options:'
     },
     dbname: {
         description: 'Database name',
         configPath: 'database.connection.database',
-        type: 'string'
+        type: 'string',
+        group: 'Database Options:'
     },
 
     // Mail options:
@@ -104,37 +111,44 @@ module.exports = {
         validate: value => includes(['SMTP', 'Sendmail', 'Direct'], value),
         configPath: 'mail.transport',
         type: 'string',
-        default: 'Direct'
+        default: 'Direct',
+        group: 'Mail Options:'
     },
     mailservice: {
         description: 'Mail service (used with SMTP transport), E.g. Mailgun, Sendgrid, Gmail, SES...',
         configPath: 'mail.options.service',
         validate: value => includes(knownMailServices, value),
-        type: 'string'
+        type: 'string',
+        group: 'Mail Options:'
     },
     mailuser: {
         description: 'Mail auth user (used with SMTP transport)',
         configPath: 'mail.options.auth.user',
         type: 'string',
-        implies: 'mailpass'
+        implies: 'mailpass',
+        group: 'Mail Options:'
     },
     mailpass: {
         description: 'Mail auth pass (used with SMTP transport)',
         configPath: 'mail.options.auth.pass',
         type: 'string',
-        implies: 'mailuser'
+        implies: 'mailuser',
+        group: 'Mail Options:'
     },
     mailhost: {
         description: 'Mail host (used with SMTP transport)',
         configPath: 'mail.options.host',
-        type: 'string'
+        type: 'string',
+        group: 'Mail Options:'
     },
     mailport: {
         description: 'Mail port (used with SMTP transport)',
         configPath: 'mail.options.port',
-        type: 'number'
+        type: 'number',
+        group: 'Mail Options:'
     },
 
+    // Log options
     log: {
         description: 'Transport to send Ghost log output to',
         configPath: 'logging.transports',
@@ -143,6 +157,15 @@ module.exports = {
             return transports;
         },
         default: ['file', 'stdout'], // used for config command handling
-        type: 'array'
+        type: 'array',
+        group: 'Ghost Options:'
+    },
+
+    // Customise how Ghost-CLI runs
+    process: {
+        description: 'Type of process manager to run Ghost with',
+        defaultValue: (c, env) => env === 'production' ? 'systemd' : 'local',
+        type: 'string',
+        group: 'Service Options:'
     }
 };

lib/commands/install.js

@@ -121,7 +121,7 @@ InstallCommand.options = {
         type: 'string'
     },
     setup: {
-        description: 'Automatically run the setup command',
+        description: '[--no-setup] Enable/Disable auto-running the setup command',
         type: 'boolean',
         default: true
     }

lib/commands/setup.js

@@ -132,18 +132,19 @@ SetupCommand.description = 'Setup an installation of Ghost (after it is installe
 SetupCommand.params = '[stage]';
 SetupCommand.options = {
     stack: {
-        description: 'Check the system stack on setup',
+        description: '[--no-stack] Enable/Disable system stack checks on setup',
         type: 'boolean',
-        default: true
-    },
-    local: {
-        alias: 'l',
-        description: 'Quick setup for a local install of Ghost',
-        type: 'boolean'
+        default: false
     },
     start: {
         name: 'start',
         description: 'Automatically start Ghost without prompting',
+        type: 'boolean',
+        default: false
+    },
+    local: {
+        alias: 'l',
+        description: 'Quick setup for a local install of Ghost',
         type: 'boolean'
     },
     pname: {