Skip to content

Commit 7d339d4

Browse files
authored
fix: improve descriptions for CLI options (#3021)
1 parent b134a6c commit 7d339d4

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

bin/cli-flags.js

+17-17
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ module.exports = {
55
{
66
name: 'host',
77
type: String,
8-
description: 'The hostname/ip address the server will bind to',
8+
description: 'The hostname/ip address the server will bind to.',
99
},
1010
{
1111
name: 'port',
1212
type: Number,
13-
description: 'The port',
13+
description: 'The port server will listen to.',
1414
},
1515
{
1616
name: 'static',
@@ -22,28 +22,28 @@ module.exports = {
2222
{
2323
name: 'live-reload',
2424
type: Boolean,
25-
description: 'Enables/Disables live reloading on changing files',
25+
description: 'Enables live reloading on changing files.',
2626
negative: true,
2727
},
2828
{
2929
name: 'https',
3030
type: Boolean,
31-
description: 'HTTPS',
31+
description: 'Use HTTPS protocol.',
3232
},
3333
{
3434
name: 'http2',
3535
type: Boolean,
36-
description: 'HTTP/2, must be used with HTTPS',
36+
description: 'Use HTTP/2, must be used with HTTPS.',
3737
},
3838
{
3939
name: 'bonjour',
4040
type: Boolean,
41-
description: 'Broadcasts the server via ZeroConf networking on start',
41+
description: 'Broadcasts the server via ZeroConf networking on start.',
4242
},
4343
{
4444
name: 'client-progress',
4545
type: Boolean,
46-
description: 'Print compilation progress in percentage in the browser',
46+
description: 'Print compilation progress in percentage in the browser.',
4747
processor(opts) {
4848
opts.client = opts.client || {};
4949
opts.client.progress = opts.clientProgress;
@@ -53,7 +53,7 @@ module.exports = {
5353
{
5454
name: 'hot-only',
5555
type: Boolean,
56-
description: 'Do not refresh page if HMR fails',
56+
description: 'Do not refresh page if HMR fails.',
5757
processor(opts) {
5858
opts.hot = 'only';
5959
delete opts.hotOnly;
@@ -62,36 +62,36 @@ module.exports = {
6262
{
6363
name: 'setup-exit-signals',
6464
type: Boolean,
65-
description: 'Close and exit the process on SIGINT and SIGTERM',
65+
description: 'Close and exit the process on SIGINT and SIGTERM.',
6666
negative: true,
6767
},
6868
{
6969
name: 'stdin',
7070
type: Boolean,
71-
description: 'Close when stdin ends',
71+
description: 'Close when stdin ends.',
7272
},
7373
{
7474
name: 'open',
7575
type: [String, Boolean],
7676
description:
77-
'Open the default browser, or optionally specify a browser name',
77+
'Open the default browser, or optionally specify a browser name.',
7878
},
7979
{
8080
name: 'use-local-ip',
8181
type: Boolean,
82-
description: 'Open default browser with local IP',
82+
description: 'Open default browser with local IP.',
8383
},
8484
{
8585
name: 'open-page',
8686
type: String,
87-
description: 'Open default browser with the specified page',
87+
description: 'Open default browser with the specified page.',
8888
multiple: true,
8989
},
9090
{
9191
name: 'client-logging',
9292
type: String,
9393
description:
94-
'Log level in the browser (none, error, warn, info, log, verbose)',
94+
'Log level in the browser (none, error, warn, info, log, verbose).',
9595
processor(opts) {
9696
opts.client = opts.client || {};
9797
opts.client.logging = opts.clientLogging;
@@ -106,18 +106,18 @@ module.exports = {
106106
{
107107
name: 'compress',
108108
type: Boolean,
109-
description: 'Enable gzip compression',
109+
description: 'Enable gzip compression.',
110110
},
111111
{
112112
name: 'public',
113113
type: String,
114-
description: 'The public hostname/ip address of the server',
114+
description: 'The public hostname/ip address of the server.',
115115
},
116116
{
117117
name: 'firewall',
118118
type: String,
119119
description:
120-
'Enable/disable firewall, or set hosts that are allowed to access the dev server',
120+
'Enable/disable firewall, or set hosts that are allowed to access the dev server.',
121121
multiple: true,
122122
},
123123
],

0 commit comments

Comments
 (0)