.eslintrc

@@ -0,0 +1,2 @@
+---
+extends: standard

.gitignore

@@ -1,2 +1,3 @@
+package-lock.json
 node_modules
 coverage

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,10 +1,6 @@
 node_js:
-- "0.12"
-- "1"
-- "2"
-- "3"
-- "4"
-- "5"
+  - 8
+  - 10
 language: node_js
 script: "npm run-script test-travis"
 after_script: "npm install coveralls@2 && cat ./coverage/lcov.info | coveralls"

History.md

@@ -1,4 +1,38 @@
 
+5.0.0 / 2018-06-19
+==================
+
+ * bump deps
+
+4.0.3 / 2018-05-17
+==================
+
+ * npm: disable package-lock
+ * bump deps
+
+4.0.2 / 2017-11-16
+==================
+
+* Fix: `serve` mutates `opts` argument so it cannot be reused (#117)
+
+4.0.1 / 2017-07-09
+==================
+
+ * Fix: throw error if error status not 404
+ * fix `index: false` bug if path is directory
+
+4.0.0 / 2017-07-03
+==================
+
+ * upgrade to koa-send@4
+ * use async function
+
+3.0.0 / 2016-03-24
+==================
+
+ * support koa 2.x
+ * travis: test node@4+
+
 2.0.0 / 2016-01-07
 ==================
 

Readme.md

@@ -18,8 +18,8 @@ $ npm install koa-static
 ## API
 
 ```js
-var koa = require('koa');
-var app = koa();
+const Koa = require('koa');
+const app = new Koa();
 app.use(require('koa-static')(root, opts));
 ```
 
@@ -31,15 +31,18 @@ app.use(require('koa-static')(root, opts));
  - `maxage` Browser cache max-age in milliseconds. defaults to 0
  - `hidden` Allow transfer of hidden files. defaults to false
  - `index` Default file name, defaults to 'index.html'
- - `defer` If true, serves after `yield next`, allowing any downstream middleware to respond first.
+ - `defer` If true, serves after `return next()`, allowing any downstream middleware to respond first.
  - `gzip`  Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. defaults to true.
+ - `br`  Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists (note, that brotli is only accepted over https). defaults to true.
+ - [setHeaders](https://github.com/koajs/send#setheaders) Function to set custom headers on response.
+ - `extensions` Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to `false`)
 
 ## Example
 
 ```js
-var serve = require('koa-static');
-var koa = require('koa');
-var app = koa();
+const serve = require('koa-static');
+const Koa = require('koa');
+const app = new Koa();
 
 // $ GET /package.json
 app.use(serve('.'));

example.js

@@ -1,22 +1,23 @@
 
-'use strict';
+'use strict'
 
-const serve = require('./');
-const koa = require('koa');
-const app = koa();
+const serve = require('./')
+const Koa = require('koa')
+const app = new Koa()
 
 // $ GET /package.json
 // $ GET /
 
-app.use(serve('.'));
+app.use(serve('.'))
 
-app.use(function *(next){
-  yield next;
-  if ('/' == this.path) {
-    this.body = 'Try `GET /package.json`';
-  }
+app.use((ctx, next) => {
+  return next().then(() => {
+    if (ctx.path === '/') {
+      ctx.body = 'Try `GET /package.json`'
+    }
+  })
 })
 
-app.listen(3000);
+app.listen(3000)
 
-console.log('listening on port 3000');
+console.log('listening on port 3000')

index.js

@@ -1,20 +1,20 @@
 
-'use strict';
+'use strict'
 
 /**
  * Module dependencies.
  */
 
-const resolve = require('path').resolve;
-const assert = require('assert');
-const debug = require('debug')('koa-static');
-const send = require('koa-send');
+const debug = require('debug')('koa-static')
+const { resolve } = require('path')
+const assert = require('assert')
+const send = require('koa-send')
 
 /**
  * Expose `serve()`.
  */
 
-module.exports = serve;
+module.exports = serve
 
 /**
  * Serve static files from `root`.
@@ -25,32 +25,49 @@ module.exports = serve;
  * @api public
  */
 
-function serve(root, opts) {
-  opts = opts || {};
+function serve (root, opts) {
+  opts = Object.assign({}, opts)
 
-  assert(root, 'root directory is required to serve files');
+  assert(root, 'root directory is required to serve files')
 
   // options
-  debug('static "%s" %j', root, opts);
-  opts.root = resolve(root);
-  if (opts.index !== false) opts.index = opts.index || 'index.html';
+  debug('static "%s" %j', root, opts)
+  opts.root = resolve(root)
+  if (opts.index !== false) opts.index = opts.index || 'index.html'
 
   if (!opts.defer) {
-    return function *serve(next){
-      if (this.method == 'HEAD' || this.method == 'GET') {
-        if (yield send(this, this.path, opts)) return;
+    return async function serve (ctx, next) {
+      let done = false
+
+      if (ctx.method === 'HEAD' || ctx.method === 'GET') {
+        try {
+          done = await send(ctx, ctx.path, opts)
+        } catch (err) {
+          if (err.status !== 404) {
+            throw err
+          }
+        }
+      }
+
+      if (!done) {
+        await next()
       }
-      yield* next;
-    };
+    }
   }
 
-  return function *serve(next){
-    yield* next;
+  return async function serve (ctx, next) {
+    await next()
 
-    if (this.method != 'HEAD' && this.method != 'GET') return;
+    if (ctx.method !== 'HEAD' && ctx.method !== 'GET') return
     // response is already handled
-    if (this.body != null || this.status != 404) return;
+    if (ctx.body != null || ctx.status !== 404) return // eslint-disable-line
 
-    yield send(this, this.path, opts);
-  };
+    try {
+      await send(ctx, ctx.path, opts)
+    } catch (err) {
+      if (err.status !== 404) {
+        throw err
+      }
+    }
+  }
 }

package.json

@@ -2,7 +2,7 @@
   "name": "koa-static",
   "description": "Static file serving middleware for koa",
   "repository": "koajs/static",
-  "version": "2.0.0",
+  "version": "5.0.0",
   "keywords": [
     "koa",
     "middleware",
@@ -14,19 +14,29 @@
     "index.js"
   ],
   "devDependencies": {
-    "istanbul": "0",
-    "koa": "1",
-    "mocha": "2",
-    "supertest": "1"
+    "eslint": "^4.19.1",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-plugin-import": "^2.12.0",
+    "eslint-plugin-node": "^6.0.1",
+    "eslint-plugin-promise": "^3.8.0",
+    "eslint-plugin-standard": "^3.1.0",
+    "istanbul": "^0.4.5",
+    "koa": "^2.5.1",
+    "mocha": "^5.2.0",
+    "supertest": "^3.1.0"
   },
   "license": "MIT",
   "dependencies": {
-    "debug": "*",
-    "koa-send": "~3.1.0"
+    "debug": "^3.1.0",
+    "koa-send": "^5.0.0"
   },
   "scripts": {
-    "test": "mocha --harmony --reporter spec",
-    "test-cov": "node --harmony ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha",
-    "test-travis": "node --harmony ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --report lcovonly"
+    "lint": "eslint --fix .",
+    "test": "mocha --harmony --reporter spec --exit",
+    "test-cov": "node --harmony ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- --exit",
+    "test-travis": "node --harmony ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --report lcovonly -- --exit"
+  },
+  "engines": {
+    "node": ">= 7.6.0"
   }
 }

test/.eslintrc

@@ -0,0 +1,3 @@
+---
+env:
+  mocha: true