cli options, readme
This commit is contained in:
19
README.md
19
README.md
@ -18,4 +18,23 @@ $ ws [port]
|
||||
```
|
||||
The `port` arg is optional, the default is 8000.
|
||||
|
||||
Use with Logstalgia
|
||||
===================
|
||||
The `default` log format is compatible with [logstalgia](http://code.google.com/p/logstalgia/).
|
||||
|
||||
Write your log output to disk:
|
||||
```sh
|
||||
$ ws --logger default > web.log
|
||||
```
|
||||
|
||||
Then visualise in logstalgia:
|
||||
```sh
|
||||
$ logstalgia web.log
|
||||
```
|
||||
|
||||
Or pipe directly into logstalgia for real-time visualisation:
|
||||
```sh
|
||||
$ ws --logger default | logstalgia -
|
||||
```
|
||||
|
||||
[](http://githalytics.com/75lb/local-web-server)
|
||||
|
@ -1,14 +1,15 @@
|
||||
{
|
||||
"name": "local-web-server",
|
||||
"version": "0.1.3",
|
||||
"version": "0.1.4",
|
||||
"description": "Local web server",
|
||||
"bin": {
|
||||
"ws": "./server.js"
|
||||
"ws": "./server.js"
|
||||
},
|
||||
"repository": "https://github.com/75lb/local-web-server",
|
||||
"author": "Lloyd Brookes",
|
||||
"license": "BSD",
|
||||
"dependencies": {
|
||||
"connect": "~2.7.11"
|
||||
"connect": "~2.7.11",
|
||||
"nature": "0.0.4"
|
||||
}
|
||||
}
|
||||
|
54
server.js
54
server.js
@ -1,24 +1,38 @@
|
||||
#!/usr/bin/env node
|
||||
var connect = require('connect');
|
||||
var connect = require('connect'),
|
||||
Thing = require("nature").Thing;
|
||||
|
||||
/**
|
||||
usage:
|
||||
$ ws <port> <connect-logger-profile>
|
||||
*/
|
||||
process.argv.splice(0, 2);
|
||||
|
||||
var port = process.argv[2] || 8000,
|
||||
loggerProfile = process.argv[3] || "dev";
|
||||
var usage = "usage: ws [--port|-p <port>] [--log-format|-p dev|default|short|tiny]";
|
||||
var options = new Thing()
|
||||
.define({ name: "port", alias: "p", type: "number", defaultOption: true, default: 8000 })
|
||||
.define({ name: "log-format", alias: "f", type: "string", default: "dev" })
|
||||
.define({ name: "help", alias: "h", type: "boolean" })
|
||||
.set(process.argv);
|
||||
|
||||
connect.logger.token('date', function(req, res){
|
||||
var a = new Date();
|
||||
return (a.getDate() + "/" + a.getUTCMonth() + "/" + a.getFullYear() + ":" + a.toTimeString())
|
||||
.replace("GMT", "").replace(" (BST)", "");
|
||||
});
|
||||
|
||||
connect()
|
||||
.use(connect.logger(loggerProfile))
|
||||
.use(connect.static(process.cwd()))
|
||||
.use(connect.directory(process.cwd()))
|
||||
.listen(port);
|
||||
|
||||
process.stderr.write("listening on port " + port + "\n");
|
||||
if (!options.valid){
|
||||
console.log(usage);
|
||||
throw new Error(options.validationMessages);
|
||||
|
||||
} else if (options.help){
|
||||
console.log(usage);
|
||||
|
||||
} else {
|
||||
/**
|
||||
customised connect.logger :date token, purely to satisfy Logstalgia.
|
||||
*/
|
||||
connect.logger.token('date', function(req, res){
|
||||
var a = new Date();
|
||||
return (a.getDate() + "/" + a.getUTCMonth() + "/" + a.getFullYear() + ":" + a.toTimeString())
|
||||
.replace("GMT", "").replace(" (BST)", "");
|
||||
});
|
||||
|
||||
connect()
|
||||
.use(connect.logger(options["log-format"]))
|
||||
.use(connect.static(process.cwd()))
|
||||
.use(connect.directory(process.cwd()))
|
||||
.listen(options.port);
|
||||
|
||||
process.stderr.write("listening on port " + options.port + "\n");
|
||||
}
|
||||
|
Reference in New Issue
Block a user