@koa/router 10.1.0 → 11.0.1

package/LICENSE

@@ -1,7 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Alexander C. Mingoia
-Copyright (c) 2019-present Nick Baugh and Koajs contributors
+Copyright (c) 2015 Alexander C. Mingoia and @koajs contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

package/README.md

@@ -1,55 +1,85 @@
 # [@koa/router](https://github.com/koajs/router)
 
-> Router middleware for [Koa](https://github.com/koajs/koa).
+> Router middleware for [Koa](https://github.com/koajs/koa). Maintained by [Forward Email][forward-email] and [Lad][].
 
-[![NPM version](https://img.shields.io/npm/v/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) 
-[![NPM Downloads](https://img.shields.io/npm/dm/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) 
-[![Node.js Version](https://img.shields.io/node/v/@koa/router.svg?style=flat)](http://nodejs.org/download/)
-[![Build Status](https://img.shields.io/travis/koajs/router.svg?style=flat)](http://travis-ci.org/koajs/router)
-[![gitter](https://img.shields.io/gitter/room/koajs/koa.svg?style=flat)](https://gitter.im/koajs/koa)
+[![build status](https://github.com/koajs/router/actions/workflows/ci.yml/badge.svg)](https://github.com/koajs/router/actions/workflows/ci.yml)
+[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
+[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
+[![license](https://img.shields.io/github/license/koajs/router.svg)](LICENSE)
+
+
+## Table of Contents
+
+* [Features](#features)
+* [Migrating to 7 / Koa 2](#migrating-to-7--koa-2)
+* [Install](#install)
+* [Typescript Support](#typescript-support)
+* [API Reference](#api-reference)
+* [Contributors](#contributors)
+* [License](#license)
+
+
+## Features
 
 * Express-style routing (`app.get`, `app.put`, `app.post`, etc.)
 * Named URL parameters
 * Named routes with URL generation
+* Match routes with specific host
 * Responds to `OPTIONS` requests with allowed methods
 * Support for `405 Method Not Allowed` and `501 Not Implemented`
 * Multiple route middleware
 * Multiple and nestable routers
 * `async/await` support
 
+
 ## Migrating to 7 / Koa 2
 
-- The API has changed to match the new promise-based middleware
+* The API has changed to match the new promise-based middleware
   signature of koa 2. See the [koa 2.x readme](https://github.com/koajs/koa/tree/2.0.0-alpha.3) for more
   information.
-- Middleware is now always run in the order declared by `.use()` (or `.get()`,
+* Middleware is now always run in the order declared by `.use()` (or `.get()`,
   etc.), which matches Express 4 API.
 
-## Installation
 
-```bash
-# npm .. 
-npm i @koa/router
-# yarn .. 
-yarn add @koa/router
+## Install
+
+[npm][]:
+
+```sh
+npm install @koa/router
 ```
 
-## [API Reference](./API.md)
 
-## Contributing
+## Typescript Support
+
+```sh
+npm install @types/koa__router
+```
+
+
+## API Reference
+
+See [API Reference](./API.md) for more documentation.
+
+
+## Contributors
+
+| Name             |
+| ---------------- |
+| **Alex Mingoia** |
+| **@koajs**       |
 
-Please submit all issues and pull requests to the [koajs/router](http://github.com/koajs/router) repository!
 
-## Support
+## License
 
-If you have any problem or suggestion please open an issue [here](https://github.com/koajs/router/issues).
+[MIT](LICENSE) © Alex Mingoia
 
-## Call for Maintainers
 
-This module is forked from the original [koa-router](https://github.com/ZijianHe/koa-router) due to its lack of activity. `koa-router` is the most widely used router module in the Koa community and we need maintainers. If you're interested in fixing bugs or implementing new features feel free to open a pull request. We'll be adding active contributors as collaborators.
+##
 
-Thanks to the original authors @alexmingoia and the original team for their great work.
+[forward-email]: https://forwardemail.net
 
-### License
+[lad]: https://lad.js.org
 
-[MIT](LICENSE)
+[npm]: https//www.npmjs.com

package/lib/layer.js

@@ -1,5 +1,5 @@
-const { pathToRegexp, compile, parse } = require('path-to-regexp');
 const { parse: parseUrl, format: formatUrl } = require('url');
+const { pathToRegexp, compile, parse } = require('path-to-regexp');
 
 module.exports = Layer;
 
@@ -17,31 +17,33 @@ module.exports = Layer;
  * @private
  */
 
-function Layer(path, methods, middleware, opts) {
-  this.opts = opts || {};
+function Layer(path, methods, middleware, opts = {}) {
+  this.opts = opts;
   this.name = this.opts.name || null;
   this.methods = [];
   this.paramNames = [];
   this.stack = Array.isArray(middleware) ? middleware : [middleware];
 
-  for (let i = 0; i < methods.length; i++) {
-    const l = this.methods.push(methods[i].toUpperCase());
+  for (const method of methods) {
+    const l = this.methods.push(method.toUpperCase());
     if (this.methods[l - 1] === 'GET') this.methods.unshift('HEAD');
   }
 
   // ensure middleware is a function
   for (let i = 0; i < this.stack.length; i++) {
     const fn = this.stack[i];
-    const type = (typeof fn);
+    const type = typeof fn;
     if (type !== 'function')
       throw new Error(
-        `${methods.toString()} \`${this.opts.name || path}\`: \`middleware\` must be a function, not \`${type}\``
+        `${methods.toString()} \`${
+          this.opts.name || path
+        }\`: \`middleware\` must be a function, not \`${type}\``
       );
   }
 
   this.path = path;
   this.regexp = pathToRegexp(path, this.paramNames, this.opts);
-};
+}
 
 /**
  * Returns whether request `path` matches route.
@@ -60,18 +62,17 @@ Layer.prototype.match = function (path) {
  *
  * @param {String} path
  * @param {Array.<String>} captures
- * @param {Object=} existingParams
+ * @param {Object=} params
  * @returns {Object}
  * @private
  */
 
-Layer.prototype.params = function (path, captures, existingParams) {
-  const params = existingParams || {};
-
+Layer.prototype.params = function (path, captures, params = {}) {
   for (let len = captures.length, i = 0; i < len; i++) {
     if (this.paramNames[i]) {
       const c = captures[i];
-      if (c && c.length !== 0) params[this.paramNames[i].name] = c ? safeDecodeURIComponent(c) : c;
+      if (c && c.length > 0)
+        params[this.paramNames[i].name] = c ? safeDecodeURIComponent(c) : c;
     }
   }
 
@@ -110,11 +111,11 @@ Layer.prototype.url = function (params, options) {
   let args = params;
   const url = this.path.replace(/\(\.\*\)/g, '');
 
-  if (typeof params != 'object') {
+  if (typeof params !== 'object') {
     args = Array.prototype.slice.call(arguments);
-    if (typeof args[args.length - 1] == 'object') {
+    if (typeof args[args.length - 1] === 'object') {
       options = args[args.length - 1];
-      args = args.slice(0, args.length - 1);
+      args = args.slice(0, -1);
     }
   }
 
@@ -124,11 +125,11 @@ Layer.prototype.url = function (params, options) {
   const tokens = parse(url);
   let replace = {};
 
-  if (args instanceof Array) {
+  if (Array.isArray(args)) {
     for (let len = tokens.length, i = 0, j = 0; i < len; i++) {
       if (tokens[i].name) replace[tokens[i].name] = args[j++];
     }
-  } else if (tokens.some(token => token.name)) {
+  } else if (tokens.some((token) => token.name)) {
     replace = params;
   } else if (!options) {
     options = params;
@@ -144,6 +145,7 @@ Layer.prototype.url = function (params, options) {
       replaced.search = undefined;
       replaced.query = options.query;
     }
+
     return formatUrl(replaced);
   }
 
@@ -159,7 +161,7 @@ Layer.prototype.url = function (params, options) {
  * router
  *   .param('user', function (id, ctx, next) {
  *     ctx.user = users[id];
- *     if (!user) return ctx.status = 404;
+ *     if (!ctx.user) return ctx.status = 404;
  *     next();
  *   })
  *   .get('/users/:user', function (ctx, next) {
@@ -174,11 +176,12 @@ Layer.prototype.url = function (params, options) {
  */
 
 Layer.prototype.param = function (param, fn) {
-  const stack = this.stack;
+  const { stack } = this;
   const params = this.paramNames;
   const middleware = function (ctx, next) {
     return fn.call(this, ctx.params[param], ctx, next);
   };
+
   middleware.param = param;
 
   const names = params.map(function (p) {
@@ -212,7 +215,10 @@ Layer.prototype.param = function (param, fn) {
 
 Layer.prototype.setPrefix = function (prefix) {
   if (this.path) {
-    this.path = (this.path !== '/' || this.opts.strict === true) ? `${prefix}${this.path}` : prefix
+    this.path =
+      this.path !== '/' || this.opts.strict === true
+        ? `${prefix}${this.path}`
+        : prefix;
     this.paramNames = [];
     this.regexp = pathToRegexp(this.path, this.paramNames, this.opts);
   }
@@ -232,7 +238,7 @@ Layer.prototype.setPrefix = function (prefix) {
 function safeDecodeURIComponent(text) {
   try {
     return decodeURIComponent(text);
-  } catch (e) {
+  } catch {
     return text;
   }
 }

package/lib/router.js

@@ -5,12 +5,15 @@
  * @link https://github.com/alexmingoia/koa-router
  */
 
-const debug = require('debug')('koa-router');
+const { debuglog } = require('util');
+
 const compose = require('koa-compose');
 const HttpError = require('http-errors');
 const methods = require('methods');
-const Layer = require('./layer');
 const { pathToRegexp } = require('path-to-regexp');
+const Layer = require('./layer');
+
+const debug = debuglog('koa-router');
 
 /**
  * @module koa-router
@@ -43,14 +46,16 @@ module.exports = Router;
  *
  * @alias module:koa-router
  * @param {Object=} opts
+ * @param {Boolean=false} opts.exclusive only run last matched route's controller when there are multiple matches
  * @param {String=} opts.prefix prefix router paths
+ * @param {String|RegExp=} opts.host host for router match
  * @constructor
  */
 
-function Router(opts) {
+function Router(opts = {}) {
   if (!(this instanceof Router)) return new Router(opts);
 
-  this.opts = opts || {};
+  this.opts = opts;
   this.methods = this.opts.methods || [
     'HEAD',
     'OPTIONS',
@@ -60,10 +65,12 @@ function Router(opts) {
     'POST',
     'DELETE'
   ];
+  this.exclusive = Boolean(this.opts.exclusive);
 
   this.params = {};
   this.stack = [];
-};
+  this.host = this.opts.host;
+}
 
 /**
  * Create `router.verb()` methods, where *verb* is one of the HTTP verbs such
@@ -72,7 +79,7 @@ function Router(opts) {
  * Match URL patterns to callback functions or controller actions using `router.verb()`,
  * where **verb** is one of the HTTP verbs such as `router.get()` or `router.post()`.
  *
- * Additionaly, `router.all()` can be used to match against all methods.
+ * Additionally, `router.all()` can be used to match against all methods.
  *
  * ```javascript
  * router
@@ -178,6 +185,24 @@ function Router(opts) {
  * The [path-to-regexp](https://github.com/pillarjs/path-to-regexp) module is
  * used to convert paths to regular expressions.
  *
+ *
+ * ### Match host for each router instance
+ *
+ * ```javascript
+ * const router = new Router({
+ *    host: 'example.domain' // only match if request host exactly equal `example.domain`
+ * });
+ *
+ * ```
+ *
+ * OR host cloud be a regexp
+ *
+ * ```javascript
+ * const router = new Router({
+ *     host: /.*\.?example\.domain$/ // all host end with .example.domain would be matched
+ * });
+ * ```
+ *
  * @name get|put|post|patch|delete|del
  * @memberof module:koa-router.prototype
  * @param {String} path
@@ -186,10 +211,10 @@ function Router(opts) {
  * @returns {Router}
  */
 
-for (let i = 0; i < methods.length; i++) {
+for (const method_ of methods) {
   function setMethodVerb(method) {
-    Router.prototype[method] = function(name, path, middleware) {
-      if (typeof path === "string" || path instanceof RegExp) {
+    Router.prototype[method] = function (name, path, middleware) {
+      if (typeof path === 'string' || path instanceof RegExp) {
         middleware = Array.prototype.slice.call(arguments, 2);
       } else {
         middleware = Array.prototype.slice.call(arguments, 1);
@@ -197,17 +222,27 @@ for (let i = 0; i < methods.length; i++) {
         name = null;
       }
 
-      this.register(path, [method], middleware, {
-        name: name
-      });
+      // Sanity check to ensure we have a viable path candidate (eg: string|regex|non-empty array)
+      if (
+        typeof path !== 'string' &&
+        !(path instanceof RegExp) &&
+        (!Array.isArray(path) || path.length === 0)
+      )
+        throw new Error(
+          `You have to provide a path when adding a ${method} handler`
+        );
+
+      this.register(path, [method], middleware, { name });
 
       return this;
     };
   }
-  setMethodVerb(methods[i]);
+
+  setMethodVerb(method_);
 }
 
 // Alias for `router.delete()` because delete is a reserved word
+// eslint-disable-next-line dot-notation
 Router.prototype.del = Router.prototype['delete'];
 
 /**
@@ -247,9 +282,8 @@ Router.prototype.use = function () {
 
   // support array of paths
   if (Array.isArray(middleware[0]) && typeof middleware[0][0] === 'string') {
-    let arrPaths = middleware[0];
-    for (let i = 0; i < arrPaths.length; i++) {
-      const p = arrPaths[i];
+    const arrPaths = middleware[0];
+    for (const p of arrPaths) {
       router.use.apply(router, [p].concat(middleware.slice(1)));
     }
 
@@ -259,12 +293,15 @@ Router.prototype.use = function () {
   const hasPath = typeof middleware[0] === 'string';
   if (hasPath) path = middleware.shift();
 
-  for (let i = 0; i < middleware.length; i++) {
-    const m = middleware[i];
+  for (const m of middleware) {
     if (m.router) {
-      const cloneRouter = Object.assign(Object.create(Router.prototype), m.router, {
-        stack: m.router.stack.slice(0)
-      });
+      const cloneRouter = Object.assign(
+        Object.create(Router.prototype),
+        m.router,
+        {
+          stack: [...m.router.stack]
+        }
+      );
 
       for (let j = 0; j < cloneRouter.stack.length; j++) {
         const nestedLayer = cloneRouter.stack[j];
@@ -282,18 +319,21 @@ Router.prototype.use = function () {
       if (router.params) {
         function setRouterParams(paramArr) {
           const routerParams = paramArr;
-          for (let j = 0; j < routerParams.length; j++) {
-            const key = routerParams[j];
+          for (const key of routerParams) {
             cloneRouter.param(key, router.params[key]);
           }
         }
+
         setRouterParams(Object.keys(router.params));
       }
     } else {
       const keys = [];
       pathToRegexp(router.opts.prefix || '', keys);
       const routerPrefixHasParam = router.opts.prefix && keys.length;
-      router.register(path || '([^\/]*)', [], m, { end: false, ignoreCaptures: !hasPath && !routerPrefixHasParam });
+      router.register(path || '([^/]*)', [], m, {
+        end: false,
+        ignoreCaptures: !hasPath && !routerPrefixHasParam
+      });
     }
   }
 
@@ -335,9 +375,15 @@ Router.prototype.prefix = function (prefix) {
 Router.prototype.routes = Router.prototype.middleware = function () {
   const router = this;
 
-  let dispatch = function dispatch(ctx, next) {
+  const dispatch = function dispatch(ctx, next) {
     debug('%s %s', ctx.method, ctx.path);
 
+    const hostMatched = router.matchHost(ctx.host);
+
+    if (!hostMatched) {
+      return next();
+    }
+
     const path = router.opts.routerPath || ctx.routerPath || ctx.path;
     const matched = router.match(path, ctx.method);
     let layerChain;
@@ -352,23 +398,30 @@ Router.prototype.routes = Router.prototype.middleware = function () {
 
     if (!matched.route) return next();
 
-    const matchedLayers = matched.pathAndMethod
-    const mostSpecificLayer = matchedLayers[matchedLayers.length - 1]
+    const matchedLayers = matched.pathAndMethod;
+    const mostSpecificLayer = matchedLayers[matchedLayers.length - 1];
     ctx._matchedRoute = mostSpecificLayer.path;
     if (mostSpecificLayer.name) {
       ctx._matchedRouteName = mostSpecificLayer.name;
     }
 
-    layerChain = matchedLayers.reduce(function(memo, layer) {
-      memo.push(function(ctx, next) {
+    layerChain = (
+      router.exclusive ? [mostSpecificLayer] : matchedLayers
+    ).reduce(function (memo, layer) {
+      memo.push(function (ctx, next) {
         ctx.captures = layer.captures(path, ctx.captures);
-        ctx.params = ctx.request.params = layer.params(path, ctx.captures, ctx.params);
+        ctx.params = ctx.request.params = layer.params(
+          path,
+          ctx.captures,
+          ctx.params
+        );
         ctx.routerPath = layer.path;
         ctx.routerName = layer.name;
         ctx._matchedRoute = layer.path;
         if (layer.name) {
           ctx._matchedRouteName = layer.name;
         }
+
         return next();
       });
       return memo.concat(layer.stack);
@@ -425,12 +478,11 @@ Router.prototype.routes = Router.prototype.middleware = function () {
  * @returns {Function}
  */
 
-Router.prototype.allowedMethods = function (options) {
-  options = options || {};
+Router.prototype.allowedMethods = function (options = {}) {
   const implemented = this.methods;
 
   return function allowedMethods(ctx, next) {
-    return next().then(function() {
+    return next().then(function () {
       const allowed = {};
 
       if (!ctx.status || ctx.status === 404) {
@@ -446,25 +498,27 @@ Router.prototype.allowedMethods = function (options) {
 
         if (!~implemented.indexOf(ctx.method)) {
           if (options.throw) {
-            let notImplementedThrowable = (typeof options.notImplemented === 'function')
-            ? options.notImplemented()  // set whatever the user returns from their function
-            : new HttpError.NotImplemented();
+            const notImplementedThrowable =
+              typeof options.notImplemented === 'function'
+                ? options.notImplemented() // set whatever the user returns from their function
+                : new HttpError.NotImplemented();
 
             throw notImplementedThrowable;
           } else {
             ctx.status = 501;
             ctx.set('Allow', allowedArr.join(', '));
           }
-        } else if (allowedArr.length) {
+        } else if (allowedArr.length > 0) {
           if (ctx.method === 'OPTIONS') {
             ctx.status = 200;
             ctx.body = '';
             ctx.set('Allow', allowedArr.join(', '));
           } else if (!allowed[ctx.method]) {
             if (options.throw) {
-              let notAllowedThrowable = (typeof options.methodNotAllowed === 'function')
-              ? options.methodNotAllowed() // set whatever the user returns from their function
-              : new HttpError.MethodNotAllowed();
+              const notAllowedThrowable =
+                typeof options.methodNotAllowed === 'function'
+                  ? options.methodNotAllowed() // set whatever the user returns from their function
+                  : new HttpError.MethodNotAllowed();
 
               throw notAllowedThrowable;
             } else {
@@ -486,7 +540,6 @@ Router.prototype.allowedMethods = function (options) {
  * @param {Function=} middleware You may also pass multiple middleware.
  * @param {Function} callback
  * @returns {Router}
- * @private
  */
 
 Router.prototype.all = function (name, path, middleware) {
@@ -498,6 +551,14 @@ Router.prototype.all = function (name, path, middleware) {
     name = null;
   }
 
+  // Sanity check to ensure we have a viable path candidate (eg: string|regex|non-empty array)
+  if (
+    typeof path !== 'string' &&
+    !(path instanceof RegExp) &&
+    (!Array.isArray(path) || path.length === 0)
+  )
+    throw new Error('You have to provide a path when adding an all handler');
+
   this.register(path, methods, middleware, { name });
 
   return this;
@@ -529,12 +590,21 @@ Router.prototype.all = function (name, path, middleware) {
 
 Router.prototype.redirect = function (source, destination, code) {
   // lookup source route by name
-  if (source[0] !== '/') source = this.url(source);
+  if (typeof source === 'symbol' || source[0] !== '/') {
+    source = this.url(source);
+    if (source instanceof Error) throw source;
+  }
 
   // lookup destination route by name
-  if (destination[0] !== '/' && !destination.includes('://')) destination = this.url(destination);
+  if (
+    typeof destination === 'symbol' ||
+    (destination[0] !== '/' && !destination.includes('://'))
+  ) {
+    destination = this.url(destination);
+    if (destination instanceof Error) throw destination;
+  }
 
-  return this.all(source, ctx => {
+  return this.all(source, (ctx) => {
     ctx.redirect(destination);
     ctx.status = code || 301;
   });
@@ -550,16 +620,13 @@ Router.prototype.redirect = function (source, destination, code) {
  * @private
  */
 
-Router.prototype.register = function (path, methods, middleware, opts) {
-  opts = opts || {};
-
+Router.prototype.register = function (path, methods, middleware, opts = {}) {
   const router = this;
-  const stack = this.stack;
+  const { stack } = this;
 
   // support array of paths
   if (Array.isArray(path)) {
-    for (let i = 0; i < path.length; i++) {
-      const curPath = path[i];
+    for (const curPath of path) {
       router.register.call(router, curPath, methods, middleware, opts);
     }
 
@@ -572,7 +639,7 @@ Router.prototype.register = function (path, methods, middleware, opts) {
     name: opts.name,
     sensitive: opts.sensitive || this.opts.sensitive || false,
     strict: opts.strict || this.opts.strict || false,
-    prefix: opts.prefix || this.opts.prefix || "",
+    prefix: opts.prefix || this.opts.prefix || '',
     ignoreCaptures: opts.ignoreCaptures
   });
 
@@ -603,7 +670,7 @@ Router.prototype.register = function (path, methods, middleware, opts) {
 Router.prototype.route = function (name) {
   const routes = this.stack;
 
-  for (let len = routes.length, i=0; i<len; i++) {
+  for (let len = routes.length, i = 0; i < len; i++) {
     if (routes[i].name && routes[i].name === name) return routes[i];
   }
 
@@ -653,7 +720,7 @@ Router.prototype.url = function (name, params) {
     return route.url.apply(route, args);
   }
 
-  return new Error(`No route found for name: ${name}`);
+  return new Error(`No route found for name: ${String(name)}`);
 };
 
 /**
@@ -680,12 +747,13 @@ Router.prototype.match = function (path, method) {
 
     debug('test %s %s', layer.path, layer.regexp);
 
+    // eslint-disable-next-line unicorn/prefer-regexp-test
     if (layer.match(path)) {
       matched.path.push(layer);
 
       if (layer.methods.length === 0 || ~layer.methods.indexOf(method)) {
         matched.pathAndMethod.push(layer);
-        if (layer.methods.length) matched.route = true;
+        if (layer.methods.length > 0) matched.route = true;
       }
     }
   }
@@ -693,6 +761,32 @@ Router.prototype.match = function (path, method) {
   return matched;
 };
 
+/**
+ * Match given `input` to allowed host
+ * @param {String} input
+ * @returns {boolean}
+ */
+
+Router.prototype.matchHost = function (input) {
+  const { host } = this;
+
+  if (!host) {
+    return true;
+  }
+
+  if (!input) {
+    return false;
+  }
+
+  if (typeof host === 'string') {
+    return input === host;
+  }
+
+  if (typeof host === 'object' && host instanceof RegExp) {
+    return host.test(input);
+  }
+};
+
 /**
  * Run middleware for named route parameters. Useful for auto-loading or
  * validation.
@@ -723,7 +817,7 @@ Router.prototype.match = function (path, method) {
  * @returns {Router}
  */
 
-Router.prototype.param = function(param, middleware) {
+Router.prototype.param = function (param, middleware) {
   this.params[param] = middleware;
   for (let i = 0; i < this.stack.length; i++) {
     const route = this.stack[i];

package/package.json

@@ -1,32 +1,47 @@
 {
   "name": "@koa/router",
-  "description": "Router middleware for koa. Provides RESTful resource routing.",
-  "version": "10.1.0",
+  "description": "Router middleware for koa. Maintained by Forward Email and Lad.",
+  "version": "11.0.1",
   "author": "Alex Mingoia <talk@alexmingoia.com>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
     "email": "niftylettuce@gmail.com"
   },
+  "contributors": [
+    "Alex Mingoia <talk@alexmingoia.com>",
+    "@koajs"
+  ],
   "dependencies": {
-    "debug": "^4.1.1",
-    "http-errors": "^1.7.3",
+    "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
     "methods": "^1.1.2",
-    "path-to-regexp": "^6.1.0"
+    "path-to-regexp": "^6.2.1"
   },
   "devDependencies": {
-    "@ladjs/env": "^1.0.0",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@ladjs/env": "^3.0.0",
+    "ava": "^4.3.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.19.0",
+    "eslint-config-xo-lass": "^2.0.1",
     "expect.js": "^0.3.1",
-    "jsdoc-to-markdown": "^5.0.3",
-    "koa": "^2.11.0",
-    "mocha": "^7.0.1",
-    "nyc": "^15.0.0",
+    "fixpack": "^4.0.0",
+    "husky": "^8.0.1",
+    "jsdoc-to-markdown": "^7.1.1",
+    "koa": "^2.13.4",
+    "lint-staged": "^13.0.3",
+    "mocha": "^10.0.0",
+    "nyc": "^15.1.0",
+    "remark-cli": "^11.0.0",
+    "remark-preset-github": "^4.0.4",
     "should": "^13.2.3",
-    "supertest": "^4.0.2",
-    "wrk": "^1.2.0"
+    "supertest": "^6.2.4",
+    "wrk": "^1.2.1",
+    "xo": "^0.50.0"
   },
   "engines": {
-    "node": ">= 8.0.0"
+    "node": ">= 12"
   },
   "files": [
     "lib"
@@ -45,9 +60,13 @@
     "url": "https://github.com/koajs/router.git"
   },
   "scripts": {
+    "bench": "make -C bench",
+    "coverage": "nyc npm run test",
     "docs": "NODE_ENV=test jsdoc2md -t ./lib/API_tpl.hbs --src ./lib/*.js  >| API.md",
+    "lint": "xo --fix && remark . -qfo && fixpack",
+    "prepare": "husky install",
+    "pretest": "npm run lint",
     "test": "mocha test/**/*.js",
-    "coverage": "nyc npm run test",
-    "bench": "make -C bench"
+    "test:watch": "mocha test/**/*.js --watch"
   }
 }

package/history.md

@@ -1,157 +0,0 @@
-9.0.0 / 2020-04-09
-==================
-
-- Update `path-to-regexp`. Migration path: change usage of `'*'` in routes to `(.*)` or `:splat*`.
-    - Example: `router.get('*', ....)` becomes `router.get('(.*)') ....)`
-
-
-8.0.0 / 2019-06-16
-==================
-
-**others**
-  * [[`b5dd5e8`](http://github.com/koajs/koa-router/commit/b5dd5e8f00e841b7061a62ab6228cbe96a999470)] - chore: rename to @koa/router (dead-horse <<dead_horse@qq.com>>)
-
--------------
-
-# Changelogs inherit from koa-router.
-
-## 7.4.0
-
-- Fix router.url() for multiple nested routers [#407](https://github.com/alexmingoia/koa-router/pull/407)
-- `layer.name` added to `ctx` at `ctx.routerName` during routing [#412](https://github.com/alexmingoia/koa-router/pull/412)
-- Router.use() was erroneously settings `(.*)` as a prefix to all routers nested with .use that did not pass an explicit prefix string as the first argument. This resulted in routes being matched that should not have been, included the running of multiple route handlers in error. [#369](https://github.com/alexmingoia/koa-router/issues/369) and [#410](https://github.com/alexmingoia/koa-router/issues/410) include information on this issue.
-
-## 7.3.0
-
-- Router#url() now accepts query parameters to add to generated urls [#396](https://github.com/alexmingoia/koa-router/pull/396)
-
-## 7.2.1
-
-- Respond to CORS preflights with 200, 0 length body [#359](https://github.com/alexmingoia/koa-router/issues/359)
-
-## 7.2.0
-
-- Fix a bug in Router#url and append Router object to ctx. [#350](https://github.com/alexmingoia/koa-router/pull/350)
-- Adds `_matchedRouteName` to context [#337](https://github.com/alexmingoia/koa-router/pull/337)
-- Respond to CORS preflights with 200, 0 length body [#359](https://github.com/alexmingoia/koa-router/issues/359)
-
-## 7.1.1
-
-- Fix bug where param handlers were run out of order [#282](https://github.com/alexmingoia/koa-router/pull/282)
-
-## 7.1.0
-
-- Backports: merge 5.4 work into the 7.x upstream. See 5.4.0 updates for more details.
-
-## 7.0.1
-
-- Fix: allowedMethods should be ctx.method not this.method [#215](https://github.com/alexmingoia/koa-router/pull/215)
-
-## 7.0.0
-
-- The API has changed to match the new promise-based middleware
-  signature of koa 2. See the
-  [koa 2.x readme](https://github.com/koajs/koa/tree/2.0.0-alpha.3) for more
-  information.
-- Middleware is now always run in the order declared by `.use()` (or `.get()`,
-  etc.), which matches Express 4 API.
-
-## 5.4.0
-
-- Expose matched route at `ctx._matchedRoute`.
-
-## 5.3.0
-
-- Register multiple routes with array of paths [#203](https://github.com/alexmingoia/koa-router/issue/143).
-- Improved router.url() [#143](https://github.com/alexmingoia/koa-router/pull/143)
-- Adds support for named routes and regular expressions
-  [#152](https://github.com/alexmingoia/koa-router/pull/152)
-- Add support for custom throw functions for 405 and 501 responses [#206](https://github.com/alexmingoia/koa-router/pull/206)
-
-## 5.2.3
-
-- Fix for middleware running twice when nesting routes [#184](https://github.com/alexmingoia/koa-router/issues/184)
-
-## 5.2.2
-
-- Register routes without params before those with params [#183](https://github.com/alexmingoia/koa-router/pull/183)
-- Fix for allowed methods [#182](https://github.com/alexmingoia/koa-router/issues/182)
-
-## 5.2.0
-
-- Add support for async/await. Resolves [#130](https://github.com/alexmingoia/koa-router/issues/130).
-- Add support for array of paths by Router#use(). Resolves [#175](https://github.com/alexmingoia/koa-router/issues/175).
-- Inherit param middleware when nesting routers. Fixes [#170](https://github.com/alexmingoia/koa-router/issues/170).
-- Default router middleware without path to root. Fixes [#161](https://github.com/alexmingoia/koa-router/issues/161), [#155](https://github.com/alexmingoia/koa-router/issues/155), [#156](https://github.com/alexmingoia/koa-router/issues/156).
-- Run nested router middleware after parent's. Fixes [#156](https://github.com/alexmingoia/koa-router/issues/156).
-- Remove dependency on koa-compose.
-
-## 5.1.1
-
-- Match routes in order they were defined. Fixes #131.
-
-## 5.1.0
-
-- Support mounting router middleware at a given path.
-
-## 5.0.1
-
-- Fix bug with missing parameters when nesting routers.
-
-## 5.0.0
-
-- Remove confusing API for extending koa app with router methods. Router#use()
-  does not have the same behavior as app#use().
-- Add support for nesting routes.
-- Remove support for regular expression routes to achieve nestable routers and
-  enable future trie-based routing optimizations.
-
-## 4.3.2
-
-- Do not send 405 if route matched but status is 404. Fixes #112, closes #114.
-
-## 4.3.1
-
-- Do not run middleware if not yielded to by previous middleware. Fixes #115.
-
-## 4.3.0
-
-- Add support for router prefixes.
-- Add MIT license.
-
-## 4.2.0
-
-- Fixed issue with router middleware being applied even if no route was
-matched.
-- Router.url - new static method to generate url from url pattern and data
-
-## 4.1.0
-
-Private API changed to separate context parameter decoration from route
-matching. `Router#match` and `Route#match` are now pure functions that return
-an array of routes that match the URL path.
-
-For modules using this private API that need to determine if a method and path
-match a route, `route.methods` must be checked against the routes returned from
-`router.match()`:
-
-```javascript
-var matchedRoute = router.match(path).filter(function (route) {
-  return ~route.methods.indexOf(method);
-}).shift();
-```
-
-## 4.0.0
-
-405, 501, and OPTIONS response handling was moved into separate middleware
-`router.allowedMethods()`. This resolves incorrect 501 or 405 responses when
-using multiple routers.
-
-### Breaking changes
-
-4.x is mostly backwards compatible with 3.x, except for the following:
-
-- Instantiating a router with `new` and `app` returns the router instance,
-  whereas 3.x returns the router middleware. When creating a router in 4.x, the
-  only time router middleware is returned is when creating using the
-  `Router(app)` signature (with `app` and without `new`).