usage descriptions

This commit is contained in:
Lloyd Brookes
2015-11-17 16:52:01 +00:00
parent c6f6fcdcc1
commit 93852d4abb

View File

@ -17,7 +17,7 @@ module.exports = {
description: 'Enable gzip compression, reduces bandwidth.', group: 'server' description: 'Enable gzip compression, reduces bandwidth.', group: 'server'
}, },
{ {
name: 'forbid', alias: 'b', type: String, multiple: true, typeLabel: '[underline]{regexp} ...', name: 'forbid', alias: 'b', type: String, multiple: true, typeLabel: '[underline]{path} ...',
description: 'A list of forbidden routes', group: 'server' description: 'A list of forbidden routes', group: 'server'
}, },
{ {
@ -26,11 +26,11 @@ module.exports = {
}, },
{ {
name: 'rewrite', alias: 'r', type: String, multiple: true, typeLabel: '[underline]{expression} ...', name: 'rewrite', alias: 'r', type: String, multiple: true, typeLabel: '[underline]{expression} ...',
description: 'A list of URL rewrite rules', group: 'server' description: "A list of URL rewrite rules, e.g. '/from -> /to'", group: 'server'
}, },
{ {
name: 'spa', alias: 's', type: String, name: 'spa', alias: 's', type: String, typeLabel: '[underline]{file}',
description: 'Single Page App page', group: 'server' description: 'Path to a Single Page App, e.g. app.html', group: 'server'
}, },
{ {
name: 'help', alias: 'h', type: Boolean, name: 'help', alias: 'h', type: Boolean,
@ -38,7 +38,7 @@ module.exports = {
}, },
{ {
name: 'config', type: Boolean, name: 'config', type: Boolean,
description: 'Print the config found in [underline]{package.json} and/or [underline]{.local-web-server}', group: 'misc' description: 'Print the config local-web-server would be launched with, then exit', group: 'misc'
} }
], ],
usageData: { usageData: {