st 1.1.0 → 2.0.0

package/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: node_js
+node_js:
+  - '10'
+  - '12'
+  - lts/*
+  - current
+branches:
+  only:
+    - master
+notifications:
+  email:
+    - rod@vagg.org

package/README.md

@@ -1,5 +1,7 @@
 # st
 
+[![Travis Status](https://api.travis-ci.org/isaacs/st.svg?branch=master)](https://travis-ci.org/isaacs/st)
+
 A module for serving static files.  Does etags, caching, etc.
 
 ## USAGE
@@ -9,8 +11,8 @@ Here are some very simple usage examples.
 Just serve the files in the cwd at the root of the http server url:
 
 ```javascript
-var st = require('st')
-var http = require('http')
+const st = require('st')
+const http = require('http')
 
 http.createServer(
   st(process.cwd())
@@ -22,9 +24,11 @@ Serve the files in static under the /static url.  Otherwise do a
 different thing:
 
 ```javascript
-var mount = st({ path: __dirname + '/static', url: '/static' })
-http.createServer(function(req, res) {
-  var stHandled = mount(req, res);
+const path = require('path')
+const mount = st({ path: path.join(__dirname, '/static'), url: '/static' })
+
+http.createServer((req, res) => {
+  const stHandled = mount(req, res)
   if (stHandled)
     return
   else
@@ -35,11 +39,11 @@ http.createServer(function(req, res) {
 The same sort of thing, but using an express middleware style:
 
 ```javascript
-var mount = st({ path: __dirname + '/static', url: '/static' })
-http.createServer(function(req, res) {
-  mount(req, res, function() {
-    res.end('this is not a static file')
-  })
+const path = require('path')
+const mount = st({ path: path.join(__dirname, '/static'), url: '/static' })
+
+http.createServer((req, res) => {
+  mount(req, res, () => res.end('this is not a static file'))
 }).listen(1339)
 ```
 
@@ -48,8 +52,10 @@ Serve the files in static under the / url, but only if not some doing
 other thing:
 
 ```javascript
-var mount = st({ path: __dirname + '/static', url: '/' })
-http.createServer(function(req, res) {
+const path = require('path')
+const mount = st({ path: path.join(__dirname, '/static'), url: '/' })
+
+http.createServer((req, res) => {
   if (shouldDoThing(req)) {
     doTheThing(req, res)
   } else {
@@ -62,12 +68,12 @@ Serve the files in static under the / url, but don't serve a 404 if
 the file isn't found, so that the rest of the app can handle it:
 
 ```javascript
-var mount = st({ path: __dirname + '/static', url: '/', passthrough: true })
-http.createServer(function(req, res) {
-  mount(req, res, function() {
-    res.end('this is not a static file');
-  });
-}).listen(1341);
+const path = require('path')
+const mount = st({ path: path.join(__dirname, '/static'), url: '/', passthrough: true})
+
+http.createServer((req, res) => {
+  mount(req, res, () => res.end('this is not a static file'))
+}).listen(1341)
 ```
 
 Serve the files with
@@ -106,8 +112,8 @@ Here are all the options described with their defaults values and a
 few possible settings you might choose to use:
 
 ```javascript
-var st = require('st')
-var mount = st({
+const st = require('st')
+const mount = st({
   path: 'resources/static/', // resolved against the process cwd
   url: 'static/', // defaults to '/'
 
@@ -160,7 +166,7 @@ var mount = st({
 })
 
 // with bare node.js
-http.createServer(function (req, res) {
+http.createServer((req, res) => {
   if (mount(req, res)) return // serving a static file
   myCustomLogic(req, res)
 }).listen(PORT)
@@ -168,7 +174,7 @@ http.createServer(function (req, res) {
 // with express
 app.use(mount)
 // or
-app.route('/static/:fooblz', function (req, res, next) {
+app.route('/static/:fooblz', (req, res, next) => {
   mount(req, res, next) // will call next() if it doesn't do anything
 })
 ```
@@ -186,6 +192,10 @@ Options:
 
 -p --port PORT        Listen on PORT (default=1337)
 
+-H --host HOST        Bind address HOST (default=*)
+
+-l --localhost        Same as "--host localhost"
+
 -d --dir DIRECTORY    Serve the contents of DIRECTORY (default=cwd)
 
 -u --url MOUNTURL     Serve the contents at MOUNTURL mount path (default=/)
@@ -278,3 +288,7 @@ not, will be replaced with `'/'`.  If your application depends on url
 traversal, then you are encouraged to please refactor so that you do
 not depend on having `..` in url paths, as this tends to expose data
 that you may be surprised to be exposing.
+
+Consider using the `--localhost` setting if you don't want other
+people on your local network to read the files served by the command
+line server.  This may become the default in a future major version.

package/bin/server.js

@@ -1,23 +1,36 @@
 #!/usr/bin/env node
-var st = require('../st.js')
-var http = require('http')
-var port = +(process.env.PORT || 1337)
-var dir = ''
-var url = '/'
-var cacheSize = 0
-var dot = false
-var index = true
-var cache = true
-var age = null
-var cors = false
-
-for (var i = 2; i < process.argv.length; i++) {
+const st = require('../st.js')
+const http = require('http')
+let port = +(process.env.PORT || 1337)
+let host
+let dir = ''
+let url = '/'
+let dot = false
+let index = true
+let cache = true
+let age = null
+let cors = false
+
+for (let i = 2; i < process.argv.length; i++) {
   switch (process.argv[i]) {
     case '-p':
     case '--port':
       port = +(process.argv[++i])
       break
 
+    case '-H':
+    case '--host':
+      host = process.argv[++i]
+      if (host === '*') {
+        host = undefined
+      }
+      break
+
+    case '-l':
+    case '--localhost':
+      host = 'localhost'
+      break
+
     case '-d':
     case '--dir':
       dir = process.argv[++i]
@@ -31,9 +44,11 @@ for (var i = 2; i < process.argv.length; i++) {
     case '-.':
     case '--dot':
       dot = process.argv[++i]
-      if (dot === undefined || dot === 'true') dot = true
-      else if (dot === 'false') dot = false
-      else if (dot.charAt(0) === '-') {
+      if (dot === undefined || dot === 'true') {
+        dot = true
+      } else if (dot === 'false') {
+        dot = false
+      } else if (dot.charAt(0) === '-') {
         --i
         dot = true
       }
@@ -47,9 +62,11 @@ for (var i = 2; i < process.argv.length; i++) {
     case '-i':
     case '--index':
       index = process.argv[++i]
-      if (index === undefined || index === 'true') index = true
-      if (index === 'false') index = false
-      if (index.charAt(0) === '-') {
+      if (index === undefined || index === 'true') {
+        index = true
+      } else if (index === 'false') {
+        index = false
+      } else if (index.charAt(0) === '-') {
         --i
         index = true
       }
@@ -81,50 +98,56 @@ for (var i = 2; i < process.argv.length; i++) {
 
     case '-co':
     case '--cors':
-      cors = true;
+      cors = true
       break
   }
 }
 
 function help () {
   console.log(
-['st'
-,'Static file server in node'
-,''
-,'Options:'
-,''
-,'-h --help             Show this help'
-,''
-,'-p --port PORT        Listen on PORT (default=1337)'
-,''
-,'-d --dir DIRECTORY    Serve the contents of DIRECTORY (default=cwd)'
-,''
-,'-u --url /url         Serve at this mount url (default=/)'
-,''
-,'-i --index [INDEX]    Use the specified INDEX filename as the result'
-,'                      when a directory is requested.  Set to "true"'
-,'                      to turn autoindexing on, or "false" to turn it'
-,'                      off.  If no INDEX is provided, then it will turn'
-,'                      autoindexing on.  (default=true)'
-,''
-,'-ni --no-index        Same as "--index false"'
-,''
-,'-. --dot [DOT]        Allow .files to be served.  Set to "false" to'
-,'                      disable.'
-,''
-,'-n. --no-dot          Same as "--dot false"'
-,''
-,'-co --cors            Enable CORS to serve files to any domain.'
-,''
-,'-nc --no-cache        Turn off all caching.'
-,''
-,'-a --age AGE          Max age (in ms) of cache entries.'
-].join('\n'))
+    ['st',
+      'Static file server in node',
+      '',
+      'Options:',
+      '',
+      '-h --help             Show this help',
+      '',
+      '-p --port PORT        Listen on PORT (default=1337)',
+      '',
+      '-H --host HOST        Bind address HOST (default=*)',
+      '',
+      '-l --localhost        Same as "--host localhost"',
+      '',
+      '-d --dir DIRECTORY    Serve the contents of DIRECTORY (default=cwd)',
+      '',
+      '-u --url /url         Serve at this mount url (default=/)',
+      '',
+      '-i --index [INDEX]    Use the specified INDEX filename as the result',
+      '                      when a directory is requested.  Set to "true"',
+      '                      to turn autoindexing on, or "false" to turn it',
+      '                      off.  If no INDEX is provided, then it will turn',
+      '                      autoindexing on.  (default=true)',
+      '',
+      '-ni --no-index        Same as "--index false"',
+      '',
+      '-. --dot [DOT]        Allow .files to be served.  Set to "false" to',
+      '                      disable.',
+      '',
+      '-n. --no-dot          Same as "--dot false"',
+      '',
+      '-co --cors            Enable CORS to serve files to any domain.',
+      '',
+      '-nc --no-cache        Turn off all caching.',
+      '',
+      '-a --age AGE          Max age (in ms) of cache entries.'
+    ].join('\n'))
 }
 
-if (isNaN(port)) throw new Error('invalid port: '+port)
+if (isNaN(port)) {
+  throw new Error('invalid port: ' + port)
+}
 
-var opt = {
+const opt = {
   path: dir,
   url: url,
   index: index,
@@ -143,19 +166,31 @@ if (cache === false) {
   opt.cache = false
 } else {
   if (age) {
-    Object.keys(opt.cache).forEach(function (k) {
+    for (const k in opt.cache) {
       opt.cache[k].maxAge = age
-    })
+    }
   }
   // maybe other cache-manipulating CLI flags?
 }
 
-var mount = st(opt)
+const mount = st(opt)
 
 http.createServer(function (q, s) {
-  if (mount(q, s)) return
+  if (mount(q, s)) {
+    return
+  }
   s.statusCode = 404
   s.end('not found')
-}).listen(port)
+}).listen(port, host, function () {
+  const addr = this.address()
+  const port = addr.port
+
+  if (!host) {
+    host = addr.address
+  }
+  if (/:/.test(host)) {
+    host = '[' + host + ']'
+  }
 
-console.log('listening at http://127.0.0.1:' + port)
+  console.log('listening at http://' + host + ':' + port)
+})

package/package.json

@@ -1,26 +1,28 @@
 {
   "name": "st",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "A module for serving static files.  Does etags, caching, etc.",
   "main": "st.js",
   "bin": "bin/server.js",
   "dependencies": {
-    "async-cache": "~1.0.0",
-    "bl": "~1.0.0",
+    "async-cache": "^1.1.0",
+    "bl": "^4.0.0",
     "fd": "~0.0.2",
-    "mime": "~1.3.4",
-    "negotiator": "~0.6.0"
+    "mime": "^2.4.4",
+    "negotiator": "~0.6.2"
   },
   "optionalDependencies": {
-    "graceful-fs": "~4.1.2"
+    "graceful-fs": "^4.2.3"
   },
   "devDependencies": {
-    "request": "~2.67.0",
-    "rimraf": "~2.4.4",
-    "tap": "~2.3.1"
+    "request": "^2.88.0",
+    "rimraf": "^3.0.0",
+    "standard": "^14.3.1",
+    "tap": "^14.9.2"
   },
   "scripts": {
-    "test": "tap test/*.js"
+    "lint": "standard",
+    "test": "npm run lint && tap test/*.js test/cli/*-test.js"
   },
   "repository": {
     "type": "git",