wpstudio/hiring-test-one
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

switch to js standard style

Browse Source
This commit is contained in:
Lloyd Brookes
2015-10-30 11:31:59 +00:00
parent b10531166f
commit 867275a29d
3 changed files with 158 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,7 +1,7 @@
[![view on npm](http://img.shields.io/npm/v/local-web-server.svg)](https://www.npmjs.org/package/local-web-server) [![view on npm](http://img.shields.io/npm/v/local-web-server.svg)](https://www.npmjs.org/package/local-web-server)
[![npm module downloads per month](http://img.shields.io/npm/dm/local-web-server.svg)](https://www.npmjs.org/package/local-web-server) [![npm module downloads per month](http://img.shields.io/npm/dm/local-web-server.svg)](https://www.npmjs.org/package/local-web-server)
[![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server) [![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server)
![Analytics](https://ga-beacon.appspot.com/UA-27725889-12/local-web-server/README.md?pixel) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
# local-web-server # local-web-server
Fires up a simple, CORS-enabled, static web server on a given port. Use for local web development or file sharing (directory browsing enabled). Fires up a simple, CORS-enabled, static web server on a given port. Use for local web development or file sharing (directory browsing enabled).
@ -144,7 +144,7 @@ $ ws --config
``` ```
## mime-types ## mime-types
You can set additional mime-type/extension mappings, or override the defaults by setting a `mime` value in your local config. This value is passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine). Example: You can set additional mime-type/extension mappings, or override the defaults by setting a `mime` value in your local config. This value is passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine). Example:
```json ```json
{ {

257
bin/ws.js
View File

@ -1,46 +1,45 @@
#!/usr/bin/env node #!/usr/bin/env node
"use strict"; 'use strict'
var dope = require("console-dope"); var dope = require('console-dope')
var http = require("http"); var http = require('http')
var cliArgs = require("command-line-args"); var cliArgs = require('command-line-args')
var o = require("object-tools"); var o = require('object-tools')
var t = require("typical"); var t = require('typical')
var path = require("path"); var path = require('path')
var loadConfig = require("config-master"); var loadConfig = require('config-master')
var homePath = require("home-path"); var homePath = require('home-path')
var logStats = require("stream-log-stats"); var logStats = require('stream-log-stats')
var connect = require("connect"); var connect = require('connect')
var morgan = require("morgan"); var morgan = require('morgan')
var serveStatic = require("serve-static"); var serveStatic = require('serve-static')
var directory = require("serve-index"); var directory = require('serve-index')
var compress = require("compression"); var compress = require('compression')
var cliOptions = require("../lib/cli-options"); var cliOptions = require('../lib/cli-options')
var url = require("url");
/* specify the command line arg definitions and usage forms */ /* specify the command line arg definitions and usage forms */
var cli = cliArgs(cliOptions); var cli = cliArgs(cliOptions)
var usage = cli.getUsage({ var usage = cli.getUsage({
title: "local-web-server", title: 'local-web-server',
description: "Lightweight static web server, zero configuration.", description: 'Lightweight static web server, zero configuration.',
footer: "Project home: [underline]{https://github.com/75lb/local-web-server}", footer: 'Project home: [underline]{https://github.com/75lb/local-web-server}',
usage: { usage: {
forms: [ forms: [
"$ ws <server options>", '$ ws <server options>',
"$ ws --config", '$ ws --config',
"$ ws --help" '$ ws --help'
] ]
}, },
groups: { groups: {
server: "Server", server: 'Server',
misc: "Misc" misc: 'Misc'
} }
}); })
/* parse command line args */ /* parse command line args */
try { try {
var wsOptions = cli.parse(); var wsOptions = cli.parse()
} catch(err){ } catch (err) {
halt(err.message); halt(err.message)
} }
/* Load and merge together options from /* Load and merge together options from
@ -49,110 +48,108 @@ try {
- the `local-web-server` property of {cwd}/package.json - the `local-web-server` property of {cwd}/package.json
*/ */
var storedConfig = loadConfig( var storedConfig = loadConfig(
path.join(homePath(), ".local-web-server.json"), path.join(homePath(), '.local-web-server.json'),
path.join(process.cwd(), ".local-web-server.json"), path.join(process.cwd(), '.local-web-server.json'),
{ jsonPath: path.join(process.cwd(), "package.json"), configProperty: "local-web-server" } { jsonPath: path.join(process.cwd(), 'package.json'), configProperty: 'local-web-server' }
); )
var builtInDefaults = { var builtInDefaults = {
port: 8000, port: 8000,
directory: process.cwd(), directory: process.cwd(),
"refresh-rate": 500, 'refresh-rate': 500,
mime: {} mime: {}
}; }
/* override built-in defaults with stored config and then command line args */ /* override built-in defaults with stored config and then command line args */
wsOptions.server = o.extend(builtInDefaults, storedConfig, wsOptions.server); wsOptions.server = o.extend(builtInDefaults, storedConfig, wsOptions.server)
/* user input validation */ /* user input validation */
if (!t.isNumber(wsOptions.server.port)) { if (!t.isNumber(wsOptions.server.port)) {
halt("please supply a numeric port value"); halt('please supply a numeric port value')
} }
if (wsOptions.misc.config){ if (wsOptions.misc.config) {
dope.log("Stored config: "); dope.log('Stored config: ')
dope.log(storedConfig); dope.log(storedConfig)
process.exit(0); process.exit(0)
} else if (wsOptions.misc.help) {
} else if (wsOptions.misc.help){ dope.log(usage)
dope.log(usage);
} else { } else {
process.on("SIGINT", function(){ process.on('SIGINT', function () {
dope.showCursor(); dope.showCursor()
dope.log(); dope.log()
process.exit(0); process.exit(0)
}); })
dope.hideCursor();
launchServer();
/* write launch information to stderr (stdout is reserved for web log output) */ dope.hideCursor()
if (path.resolve(wsOptions.server.directory) === process.cwd()){ launchServer()
dope.error("serving at %underline{%s}", "http://localhost:" + wsOptions.server.port);
} else { /* write launch information to stderr (stdout is reserved for web log output) */
dope.error("serving %underline{%s} at %underline{%s}", wsOptions.server.directory, "http://localhost:" + wsOptions.server.port); if (path.resolve(wsOptions.server.directory) === process.cwd()) {
} dope.error('serving at %underline{%s}', 'http://localhost:' + wsOptions.server.port)
} } else {
dope.error('serving %underline{%s} at %underline{%s}', wsOptions.server.directory, 'http://localhost:' + wsOptions.server.port)
function halt(message){ }
dope.red.log("Error: %s", message); }
dope.log(usage);
process.exit(1); function halt (message) {
} dope.red.log('Error: %s', message)
dope.log(usage)
function launchServer(){ process.exit(1)
var app = connect(); }
/* enable cross-origin requests on all resources */ function launchServer () {
app.use(function(req, res, next){ var app = connect()
res.setHeader("Access-Control-Allow-Origin", "*");
next(); /* enable cross-origin requests on all resources */
}); app.use(function (req, res, next) {
res.setHeader('Access-Control-Allow-Origin', '*')
if (wsOptions.server["log-format"] !== "none") app.use(getLogger()); next()
})
/* --compress enables compression */
if (wsOptions.server.compress) app.use(compress()); if (wsOptions.server['log-format'] !== 'none') app.use(getLogger())
/* set the mime-type overrides specified in the config */ /* --compress enables compression */
serveStatic.mime.define(wsOptions.server.mime); if (wsOptions.server.compress) app.use(compress())
/* enable static file server, including directory browsing support */ /* set the mime-type overrides specified in the config */
app.use(serveStatic(path.resolve(wsOptions.server.directory))) serveStatic.mime.define(wsOptions.server.mime)
.use(directory(path.resolve(wsOptions.server.directory), { icons: true }));
/* enable static file server, including directory browsing support */
/* launch server */ app.use(serveStatic(path.resolve(wsOptions.server.directory)))
http.createServer(app) .use(directory(path.resolve(wsOptions.server.directory), { icons: true }))
.on("error", function(err){
if (err.code === "EADDRINUSE"){ /* launch server */
halt("port " + wsOptions.server.port + " is already is use"); http.createServer(app)
} else { .on('error', function (err) {
halt(err.message); if (err.code === 'EADDRINUSE') {
} halt('port ' + wsOptions.server.port + ' is already is use')
}) } else {
.listen(wsOptions.server.port); halt(err.message)
} }
})
function getLogger(){ .listen(wsOptions.server.port)
/* log using --log-format (if supplied) */ }
var logFormat = wsOptions.server["log-format"];
if(logFormat) { function getLogger () {
if (logFormat === "logstalgia"){ /* log using --log-format (if supplied) */
/* customised logger :date token, purely to satisfy Logstalgia. */ var logFormat = wsOptions.server['log-format']
morgan.token("date", function(){ if (logFormat) {
var d = new Date(); if (logFormat === 'logstalgia') {
return (d.getDate() + "/" + d.getUTCMonth() + "/" + d.getFullYear() + ":" + d.toTimeString()) /* customised logger :date token, purely to satisfy Logstalgia. */
.replace("GMT", "").replace(" (BST)", ""); morgan.token('date', function () {
}); var d = new Date()
logFormat = "combined"; return (d.getDate() + '/' + d.getUTCMonth() + '/' + d.getFullYear() + ':' + d.toTimeString())
} .replace('GMT', '').replace(' (BST)', '')
})
return morgan(logFormat); logFormat = 'combined'
/* if no `--log-format` was specified, pipe the default format output
into `log-stats`, which prints statistics to the console */
} else {
return morgan("common", { stream: logStats({ refreshRate: wsOptions.server["refresh-rate"] }) });
} }
return morgan(logFormat)
/* if no `--log-format` was specified, pipe the default format output
into `log-stats`, which prints statistics to the console */
} else {
return morgan('common', { stream: logStats({ refreshRate: wsOptions.server['refresh-rate'] }) })
}
} }

58
lib/cli-options.js
View File

@ -1,30 +1,30 @@
module.exports = [ module.exports = [
{ {
name: "port", alias: "p", type: Number, defaultOption: true, name: 'port', alias: 'p', type: Number, defaultOption: true,
description: "Web server port", group: "server" description: 'Web server port', group: 'server'
}, },
{ {
name: "log-format", alias: "f", type: String, 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" 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, name: 'directory', alias: 'd', type: String,
description: "Root directory, defaults to the current directory", group: "server" description: 'Root directory, defaults to the current directory', group: 'server'
}, },
{ {
name: "compress", alias: "c", type: Boolean, name: 'compress', alias: 'c', type: Boolean,
description: "Enable gzip compression, reduces bandwidth.", group: "server" description: 'Enable gzip compression, reduces bandwidth.', group: 'server'
}, },
{ {
name: "refresh-rate", alias: "r", type: Number, name: 'refresh-rate', alias: 'r', type: Number,
description: "Statistics view refresh rate in ms. Defaults to 500.", group: "server" description: 'Statistics view refresh rate in ms. Defaults to 500.', group: 'server'
}, },
{ {
name: "help", alias: "h", type: Boolean, name: 'help', alias: 'h', type: Boolean,
description: "Print these usage instructions", group: "misc" description: 'Print these usage instructions', group: 'misc'
}, },
{ {
name: "config", type: Boolean, name: 'config', type: Boolean,
description: "Print the stored config", group: "misc" description: 'Print the stored config', group: 'misc'
} }
]; ]