itty-router 4.0.7 → 4.0.8

package/CONTRIBUTING.md

@@ -2,8 +2,8 @@
 
 The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies. These resources help people who want to learn how to run and contribute to open source projects. Contributors and people new to open source alike will find the following guides especially useful:
 
-* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-* [Building Welcoming Communities](https://opensource.guide/building-community/)
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Building Welcoming Communities](https://opensource.guide/building-community/)
 
 ## Bugs
 

package/README.md

@@ -8,7 +8,6 @@
 <h2 align="center"><a href="https://itty.dev/itty-router">v4.x Documentation @ itty.dev</a>
 <br /></h2>
 
-
 <p align="center">
   <a href="https://npmjs.com/package/itty-router" target="_blank">
     <img src="https://img.shields.io/npm/v/itty-router.svg?style=flat-square" alt="npm version" />
@@ -50,28 +49,29 @@
 
 ---
 
-Itty aims to be the world's smallest (~440 bytes), feature-rich JavaScript router, enabling beautiful API code with a near-zero bundlesize.  Designed originally for [Cloudflare Workers](https://itty.dev/itty-router/runtimes#Cloudflare%20Workers), itty can be used in browsers, Service Workers, edge functions, or standalone runtimes like [Node](https://itty.dev/itty-router/runtimes#Node), [Bun](https://itty.dev/itty-router/runtimes#Bun), etc.!
+Itty aims to be the world's smallest (~440 bytes), feature-rich JavaScript router, enabling beautiful API code with a near-zero bundlesize. Designed originally for [Cloudflare Workers](https://itty.dev/itty-router/runtimes#Cloudflare%20Workers), itty can be used in browsers, Service Workers, edge functions, or standalone runtimes like [Node](https://itty.dev/itty-router/runtimes#Node), [Bun](https://itty.dev/itty-router/runtimes#Bun), etc.!
 
 ## Features:
-- Absurdly tiny.  The Router itself is ~440 bytes gzipped, and the **entire** library is under 1.5k!
-- Absurdly easy to use.  We believe route code should be self-evident, obvious, and read more like poetry than code.
+
+- Absurdly tiny. The Router itself is ~440 bytes gzipped, and the **entire** library is under 1.5k!
+- Absurdly easy to use. We believe route code should be self-evident, obvious, and read more like poetry than code.
 - Absurdly agnostic. We leave **you** with full control over response types, matching order, upstream/downstream effects, etc.
 - Works [anywhere, in any environment](https://itty.dev/itty-router/runtimes).
 - [Fully typed/TypeScript support](https://itty.dev/itty-router/typescript), including hinting.
-- Parses [route params](https://itty.dev/itty-router/route-patterns#params), 
+- Parses [route params](https://itty.dev/itty-router/route-patterns#params),
   [optional params](https://itty.dev/itty-router/route-patterns#optional),
-  [wildcards](https://itty.dev/itty-router/route-patterns#wildcards), 
+  [wildcards](https://itty.dev/itty-router/route-patterns#wildcards),
   [greedy params](https://itty.dev/itty-router/route-patterns#greedy),
   and [file formats](https://itty.dev/itty-router/route-patterns#file-formats).
 - Automatic [query parsing](https://itty.dev/itty-router/route-patterns#query).
 - Easy [error handling](https://itty.dev/itty-router/errors), including throwing errors with HTTP status codes!
-- Easy [Response](https://itty.dev/itty-router/responses) creation, with helpers for major formats (e.g. 
-  [json](https://itty.dev/itty-router/api#json), 
-  [html](https://itty.dev/itty-router/api#html), 
-  [png](https://itty.dev/itty-router/api#png), 
+- Easy [Response](https://itty.dev/itty-router/responses) creation, with helpers for major formats (e.g.
+  [json](https://itty.dev/itty-router/api#json),
+  [html](https://itty.dev/itty-router/api#html),
+  [png](https://itty.dev/itty-router/api#png),
   [jpeg](https://itty.dev/itty-router/api#jpeg), etc.)
 - Deep APIs via [router nesting](https://itty.dev/itty-router/nesting).
-- Full [middleware](https://itty.dev/itty-router/middleware) support.  Includes the following by default:
+- Full [middleware](https://itty.dev/itty-router/middleware) support. Includes the following by default:
   - [withParams](https://itty.dev/itty-router/api#withParams) - access the params directly off the `Request` (instead of `request.params`).
   - [withCookies](https://itty.dev/itty-router/api#withCookies) - access cookies in a convenient Object format.
   - [withContent](https://itty.dev/itty-router/api#withContent) - auto-parse Request bodies as `request.content`.
@@ -79,35 +79,39 @@ Itty aims to be the world's smallest (~440 bytes), feature-rich JavaScript route
 - Fully readable regex... yeah right! 😆
 
 ## [Full Documentation](https://itty.dev/itty-router)
+
 Complete documentation/API is available at [itty.dev](https://itty.dev/itty-router), or join our [Discord](https://discord.com/channels/832353585802903572) channel to chat with community members for quick help!
 
 ## Installation
+
 ```
 npm install itty-router
 ```
 
 ## Example
+
 ```js
-import { 
-  error,                  // creates error responses
-  json,                   // creates JSON responses
-  Router,                 // the ~440 byte router itself
-  withParams,             // middleware: puts params directly on the Request
+import {
+  error,      // creates error responses
+  json,       // creates JSON responses
+  Router,     // the ~440 byte router itself
+  withParams, // middleware: puts params directly on the Request
 } from 'itty-router'
 import { todos } from './external/todos'
 
 // create a new Router
-const router = Router()   
+const router = Router()
 
 router
   // add some middleware upstream on all routes
-  .all('*', withParams) 
+  .all('*', withParams)
 
   // GET list of todos
   .get('/todos', () => todos)
 
   // GET single todo, by ID
-  .get('/todos/:id', 
+  .get(
+    '/todos/:id',
     ({ id }) => todos.getById(id) || error(404, 'That todo was not found')
   )
 
@@ -116,19 +120,22 @@ router
 
 // Example: Cloudflare Worker module syntax
 export default {
-  fetch: (request, ...args) => router
-                                 .handle(request, ...args)
-                                 .then(json)    // send as JSON
-                                 .catch(error)  // catch errors
+  fetch: (request, ...args) =>
+    router
+      .handle(request, ...args)
+      .then(json)     // send as JSON
+      .catch(error),  // catch errors
 }
 ```
 
 ## Join the Discussion!
+
 Have a question? Suggestion? Complaint? Want to send a gift basket?
 
 Join us on [Discord](https://discord.com/channels/832353585802903572)!
 
 ## Testing and Contributing
+
 1. Fork repo
 1. Install dev dependencies via `yarn`
 1. Start test runner/dev mode `yarn dev`
@@ -138,21 +145,29 @@ Join us on [Discord](https://discord.com/channels/832353585802903572)!
 1. I'll add you to the credits! :)
 
 ## Special Thanks: Contributors
-These folks are the real heroes, making open source the powerhouse that it is!  Help out and get your name added to this list! <3
+
+These folks are the real heroes, making open source the powerhouse that it is! Help out and get your name added to this list! <3
 
 #### Core Concepts
+
 - [@mvasigh](https://github.com/mvasigh) - proxy hack wizard behind itty, coding partner in crime, maker of the entire doc site, etc, etc.
 - [@hunterloftis](https://github.com/hunterloftis) - router.handle() method now accepts extra arguments and passed them to route functions
 - [@SupremeTechnopriest](https://github.com/SupremeTechnopriest) - improved TypeScript support and documentation! :D
+
 #### Code Golfing
+
 - [@taralx](https://github.com/taralx) - router internal code-golfing refactor for performance and character savings
 - [@DrLoopFall](https://github.com/DrLoopFall) - v4.x re-minification
+
 #### Fixes & Build
+
 - [@taralx](https://github.com/taralx) - QOL fixes for contributing (dev dep fix and test file consistency) <3
-- [@technoyes](https://github.com/technoyes) - three kind-of-a-big-deal errors fixed.  Imagine the look on my face... thanks man!! :)
+- [@technoyes](https://github.com/technoyes) - three kind-of-a-big-deal errors fixed. Imagine the look on my face... thanks man!! :)
 - [@roojay520](https://github.com/roojay520) - TS interface fixes
 - [@jahands](https://github.com/jahands) - v4.x TS fixes
+
 #### Documentation
+
 - [@arunsathiya](https://github.com/arunsathiya),
   [@poacher2k](https://github.com/poacher2k),
   [@ddarkr](https://github.com/ddarkr),

package/Router.d.ts

@@ -28,7 +28,7 @@ export type RouteHandler<I = IRequest, A extends any[] = any[]> = {
 export type RouteEntry = [string, RegExp, RouteHandler[], string];
 export type Route = <RequestType = IRequest, Args extends any[] = any[], RT = RouterType>(path: string, ...handlers: RouteHandler<RequestType, Args>[]) => RT;
 export type UniversalRoute<RequestType = IRequest, Args extends any[] = any[]> = (path: string, ...handlers: RouteHandler<RequestType, Args>[]) => RouterType<UniversalRoute<RequestType, Args>, Args>;
-type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
+type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
 export type CustomRoutes<R = Route> = {
     [key: string]: R;
 };

package/cjs/Router.d.ts

@@ -28,7 +28,7 @@ export type RouteHandler<I = IRequest, A extends any[] = any[]> = {
 export type RouteEntry = [string, RegExp, RouteHandler[], string];
 export type Route = <RequestType = IRequest, Args extends any[] = any[], RT = RouterType>(path: string, ...handlers: RouteHandler<RequestType, Args>[]) => RT;
 export type UniversalRoute<RequestType = IRequest, Args extends any[] = any[]> = (path: string, ...handlers: RouteHandler<RequestType, Args>[]) => RouterType<UniversalRoute<RequestType, Args>, Args>;
-type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
+type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
 export type CustomRoutes<R = Route> = {
     [key: string]: R;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "4.0.7",
+  "version": "4.0.8",
   "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.",
   "type": "module",
   "main": "./index.js",
@@ -19,14 +19,16 @@
   ],
   "scripts": {
     "dev": "yarn test",
-    "lint": "npx eslint src",
+    "lint": "yarn run eslint src",
+    "prettier": "prettier --write src test example",
+    "format": "yarn lint && yarn prettier",
     "test": "vitest --coverage --reporter verbose",
     "test:once": "vitest run",
     "coverage": "vitest run --coverage",
     "coveralls": "yarn coverage && cat ./coverage/lcov.info | coveralls",
     "verify": "echo 'verifying module...' && yarn build && yarn test:once",
     "prerelease": "yarn verify",
-    "prebuild": "rimraf dist && mkdir dist && yarn coverage && yarn lint",
+    "prebuild": "rimraf dist && mkdir dist && yarn coverage && yarn format",
     "build": "rollup -c",
     "release": "release --tag --push --patch --src=dist",
     "runtime:bun": "bun example/bun.ts",
@@ -56,6 +58,7 @@
     "@whatwg-node/server": "^0.8.1",
     "coveralls": "^3.1.1",
     "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
     "fetch-mock": "^9.11.0",
     "fs-extra": "^11.1.1",
     "globby": "^13.1.4",
@@ -65,6 +68,7 @@
     "itty-router": "^4.0.6",
     "jsdom": "^22.1.0",
     "npm-run-all": "^4.1.5",
+    "prettier": "^2.8.8",
     "rimraf": "^5.0.1",
     "rollup": "^3.23.0",
     "rollup-plugin-bundle-size": "^1.0.3",