diff --git a/bin/ws.js b/bin/ws.js index 715f59e..a9b976e 100755 --- a/bin/ws.js +++ b/bin/ws.js @@ -1,29 +1,36 @@ #!/usr/bin/env node "use strict"; -var dope = require("console-dope"), - http = require("http"), - cliArgs = require("command-line-args"), - o = require("object-tools"), - t = require("typical"), - path = require("path"), - loadConfig = require("config-master"), - homePath = require("home-path"), - logStats = require("stream-log-stats"), - connect = require("connect"), - morgan = require("morgan"), - serveStatic = require("serve-static"), - directory = require("serve-index"), - compress = require("compression"), - cliOptions = require("../lib/cli-options"); +var dope = require("console-dope"); +var http = require("http"); +var cliArgs = require("command-line-args"); +var o = require("object-tools"); +var t = require("typical"); +var path = require("path"); +var loadConfig = require("config-master"); +var homePath = require("home-path"); +var logStats = require("stream-log-stats"); +var connect = require("connect"); +var morgan = require("morgan"); +var serveStatic = require("serve-static"); +var directory = require("serve-index"); +var compress = require("compression"); +var cliOptions = require("../lib/cli-options"); /* specify the command line arg definitions and usage forms */ var cli = cliArgs(cliOptions); var usage = cli.getUsage({ + title: "local-web-server", + header: "Lightweight static web server, zero configuration.", + footer: "Project home: https://github.com/75lb/local-web-server", forms: [ "$ ws ", "$ ws --config", "$ ws --help" - ] + ], + groups: { + server: "Server", + misc: "Server" + } }); /* parse command line args */ @@ -52,20 +59,20 @@ var builtInDefaults = { }; /* override built-in defaults with stored config and then command line args */ -argv.Server = o.extend(builtInDefaults, storedConfig, argv.Server); +argv.server = o.extend(builtInDefaults, storedConfig, argv.server); /* user input validation */ -var logFormat = argv.Server["log-format"]; -if (!t.isNumber(argv.Server.port)) { +var logFormat = argv.server["log-format"]; +if (!t.isNumber(argv.server.port)) { halt("please supply a numeric port value"); } -if (argv.Misc.config){ +if (argv.misc.config){ dope.log("Stored config: "); dope.log(storedConfig); process.exit(0); -} else if (argv.Misc.help){ +} else if (argv.misc.help){ dope.log(usage); } else { @@ -105,35 +112,35 @@ if (argv.Misc.config){ into `log-stats`, which prints statistics to the console */ } else { dope.hideCursor(); - app.use(morgan("common", { stream: logStats({ refreshRate: argv.Server["refresh-rate"] }) })); + app.use(morgan("common", { stream: logStats({ refreshRate: argv.server["refresh-rate"] }) })); } /* --compress enables compression */ - if (argv.Server.compress) app.use(compress()); + if (argv.server.compress) app.use(compress()); /* set the mime-type overrides specified in the config */ - serveStatic.mime.define(argv.Server.mime); + serveStatic.mime.define(argv.server.mime); /* enable static file server, including directory browsing support */ - app.use(serveStatic(path.resolve(argv.Server.directory))) - .use(directory(path.resolve(argv.Server.directory), { icons: true })); + app.use(serveStatic(path.resolve(argv.server.directory))) + .use(directory(path.resolve(argv.server.directory), { icons: true })); /* launch server */ http.createServer(app) .on("error", function(err){ if (err.code === "EADDRINUSE"){ - halt("port " + argv.Server.port + " is already is use"); + halt("port " + argv.server.port + " is already is use"); } else { halt(err.message); } }) - .listen(argv.Server.port); + .listen(argv.server.port); /* write launch information to stderr (stdout is reserved for web log output) */ - if (path.resolve(argv.Server.directory) === process.cwd()){ - dope.error("serving at %underline{%s}", "http://localhost:" + argv.Server.port); + if (path.resolve(argv.server.directory) === process.cwd()){ + dope.error("serving at %underline{%s}", "http://localhost:" + argv.server.port); } else { - dope.error("serving %underline{%s} at %underline{%s}", argv.Server.directory, "http://localhost:" + argv.Server.port); + dope.error("serving %underline{%s} at %underline{%s}", argv.server.directory, "http://localhost:" + argv.server.port); } } diff --git a/lib/cli-options.js b/lib/cli-options.js index d8d0fe4..dd317ed 100644 --- a/lib/cli-options.js +++ b/lib/cli-options.js @@ -1,40 +1,30 @@ module.exports = [ { - groups: "Server", - options: [ - { - name: "port", alias: "p", type: Number, defaultOption: true, - description: "Web server port" - }, - { - name: "log-format", alias: "f", type: String, - description: "If a format is supplied an access log is written to stdout. If not, a statistics view is displayed. Use a preset ('none', 'dev','combined', 'short', 'tiny' or 'logstalgia') or supply a custom format (e.g. ':method -> :url')." - }, - { - name: "directory", alias: "d", type: String, - description: "Root directory, defaults to the current directory" - }, - { - name: "compress", alias: "c", type: Boolean, - description: "Enables compression" - }, - { - name: "refresh-rate", alias: "r", type: Number, - description: "Statistics view refresh rate in ms. Defaults to 500." - } - ] + name: "port", alias: "p", type: Number, defaultOption: true, + description: "Web server port", group: "server" }, { - groups: "Misc", - options: [ - { - name: "help", alias: "h", type: Boolean, - description: "Print these usage instructions" - }, - { - name: "config", type: Boolean, - description: "Print the stored config" - } - ] + name: "log-format", alias: "f", type: String, + description: "If a format is supplied an access log is written to stdout. If not, a 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" + }, + { + name: "directory", alias: "d", type: String, + description: "Root directory, defaults to the current directory", group: "server" + }, + { + name: "compress", alias: "c", type: Boolean, + description: "Enables compression", group: "server" + }, + { + name: "refresh-rate", alias: "r", type: Number, + description: "Statistics view refresh rate in ms. Defaults to 500.", group: "server" + }, + { + name: "help", alias: "h", type: Boolean, + description: "Print these usage instructions", group: "misc" + }, + { + name: "config", type: Boolean, + description: "Print the stored config", group: "misc" } ]; diff --git a/package.json b/package.json index 11dc0a0..0f96717 100644 --- a/package.json +++ b/package.json @@ -15,18 +15,18 @@ "repository": "https://github.com/75lb/local-web-server", "author": "Lloyd Brookes", "dependencies": { - "command-line-args": "~0.5.0", + "command-line-args": "^1", "compression": "^1.0.2", "config-master": "^1", "connect": "^3.0.0", "console-dope": "~0.3.0", - "home-path": "~0.1.1", + "home-path": "^1", "morgan": "^1.0.0", - "object-tools": "^1.0.3", + "object-tools": "^2", "serve-index": "^1.6.3", "serve-static": "^1.8", "stream-log-stats": "^1", - "typical": "^1.0.0" + "typical": "^2.0.0" }, "local-web-server": { "mime": {