Skip to content

Commit

Permalink
fix: improve descriptions for CLI options (#3021)
Browse files Browse the repository at this point in the history
  • Loading branch information
snitin315 committed Feb 18, 2021
1 parent b134a6c commit 7d339d4
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions bin/cli-flags.js
Expand Up @@ -5,12 +5,12 @@ module.exports = {
{
name: 'host',
type: String,
description: 'The hostname/ip address the server will bind to',
description: 'The hostname/ip address the server will bind to.',
},
{
name: 'port',
type: Number,
description: 'The port',
description: 'The port server will listen to.',
},
{
name: 'static',
Expand All @@ -22,28 +22,28 @@ module.exports = {
{
name: 'live-reload',
type: Boolean,
description: 'Enables/Disables live reloading on changing files',
description: 'Enables live reloading on changing files.',
negative: true,
},
{
name: 'https',
type: Boolean,
description: 'HTTPS',
description: 'Use HTTPS protocol.',
},
{
name: 'http2',
type: Boolean,
description: 'HTTP/2, must be used with HTTPS',
description: 'Use HTTP/2, must be used with HTTPS.',
},
{
name: 'bonjour',
type: Boolean,
description: 'Broadcasts the server via ZeroConf networking on start',
description: 'Broadcasts the server via ZeroConf networking on start.',
},
{
name: 'client-progress',
type: Boolean,
description: 'Print compilation progress in percentage in the browser',
description: 'Print compilation progress in percentage in the browser.',
processor(opts) {
opts.client = opts.client || {};
opts.client.progress = opts.clientProgress;
Expand All @@ -53,7 +53,7 @@ module.exports = {
{
name: 'hot-only',
type: Boolean,
description: 'Do not refresh page if HMR fails',
description: 'Do not refresh page if HMR fails.',
processor(opts) {
opts.hot = 'only';
delete opts.hotOnly;
Expand All @@ -62,36 +62,36 @@ module.exports = {
{
name: 'setup-exit-signals',
type: Boolean,
description: 'Close and exit the process on SIGINT and SIGTERM',
description: 'Close and exit the process on SIGINT and SIGTERM.',
negative: true,
},
{
name: 'stdin',
type: Boolean,
description: 'Close when stdin ends',
description: 'Close when stdin ends.',
},
{
name: 'open',
type: [String, Boolean],
description:
'Open the default browser, or optionally specify a browser name',
'Open the default browser, or optionally specify a browser name.',
},
{
name: 'use-local-ip',
type: Boolean,
description: 'Open default browser with local IP',
description: 'Open default browser with local IP.',
},
{
name: 'open-page',
type: String,
description: 'Open default browser with the specified page',
description: 'Open default browser with the specified page.',
multiple: true,
},
{
name: 'client-logging',
type: String,
description:
'Log level in the browser (none, error, warn, info, log, verbose)',
'Log level in the browser (none, error, warn, info, log, verbose).',
processor(opts) {
opts.client = opts.client || {};
opts.client.logging = opts.clientLogging;
Expand All @@ -106,18 +106,18 @@ module.exports = {
{
name: 'compress',
type: Boolean,
description: 'Enable gzip compression',
description: 'Enable gzip compression.',
},
{
name: 'public',
type: String,
description: 'The public hostname/ip address of the server',
description: 'The public hostname/ip address of the server.',
},
{
name: 'firewall',
type: String,
description:
'Enable/disable firewall, or set hosts that are allowed to access the dev server',
'Enable/disable firewall, or set hosts that are allowed to access the dev server.',
multiple: true,
},
],
Expand Down

0 comments on commit 7d339d4

Please sign in to comment.