2015-11-11 17:53:01 +00:00
module . exports = {
definitions : [
{
name : 'port' , alias : 'p' , type : Number , defaultOption : true ,
description : 'Web server port' , group : 'server'
} ,
{
2015-11-16 13:22:51 +00:00
name : 'log-format' , alias : 'f' , type : String ,
2015-11-16 23:02:27 +00:00
description : "If a format is supplied an access log is written to stdout. If not, a dynamic statistics view is displayed. Use a preset ('none', 'dev','combined', 'short', 'tiny' or 'logstalgia') or supply a custom format (e.g. ':method -> :url')." , group : 'server'
2015-11-11 17:53:01 +00:00
} ,
{
name : 'directory' , alias : 'd' , type : String ,
description : 'Root directory, defaults to the current directory' , group : 'server'
} ,
{
name : 'compress' , alias : 'c' , type : Boolean ,
description : 'Enable gzip compression, reduces bandwidth.' , group : 'server'
} ,
{
2015-11-16 13:22:51 +00:00
name : 'forbid' , alias : 'b' , type : String , multiple : true , typeLabel : '[underline]{regexp} ...' ,
2015-11-15 23:00:17 +00:00
description : 'A list of forbidden routes' , group : 'server'
} ,
{
2015-11-15 15:51:18 +00:00
name : 'no-cache' , alias : 'n' , type : Boolean ,
2015-11-15 21:15:25 +00:00
description : 'Disable etag-based caching - forces loading from disk each request.' , group : 'server'
2015-11-15 15:51:18 +00:00
} ,
{
2015-11-16 13:22:51 +00:00
name : 'rewrite' , alias : 'r' , type : String , multiple : true , typeLabel : '[underline]{expression} ...' ,
description : 'A list of URL rewrite rules' , group : 'server'
} ,
{
2015-11-17 16:44:14 +00:00
name : 'spa' , alias : 's' , type : String ,
description : 'Single Page App page' , group : 'server'
} ,
{
2015-11-11 17:53:01 +00:00
name : 'help' , alias : 'h' , type : Boolean ,
description : 'Print these usage instructions' , group : 'misc'
} ,
{
name : 'config' , type : Boolean ,
2015-11-16 23:02:27 +00:00
description : 'Print the config found in [underline]{package.json} and/or [underline]{.local-web-server}' , group : 'misc'
2015-11-11 17:53:01 +00:00
}
] ,
usageData : {
title : 'local-web-server' ,
2015-11-16 23:02:27 +00:00
description : 'A simple web-server for productive front-end development.' ,
2015-11-11 17:53:01 +00:00
footer : 'Project home: [underline]{https://github.com/75lb/local-web-server}' ,
synopsis : [
2015-11-16 23:02:27 +00:00
'$ ws [server options]' ,
2015-11-11 17:53:01 +00:00
'$ ws --config' ,
'$ ws --help'
] ,
groups : {
server : 'Server' ,
misc : 'Misc'
}
2015-10-30 11:31:59 +00:00
}
2015-11-11 17:53:01 +00:00
}