Skip to content

fix: improve descriptions for CLI options #3021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2021
Merged

fix: improve descriptions for CLI options #3021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions bin/cli-flags.js
View file
Open in desktop
Original file line number Diff line number Diff line change
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