itty-router 4.0.6 → 4.0.7

package/README.md

@@ -13,8 +13,8 @@
   <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" />
   </a>
-  <a href="https://bundlephobia.com/result?p=itty-router" target="_blank">
-    <img src="https://img.shields.io/bundlephobia/minzip/itty-router?style=flat-square" alt="bundle size" />
+  <a href="https://deno.bundlejs.com/?q=itty-router/Router" target="_blank">
+    <img src="https://deno.bundlejs.com/?q=itty-router/Router&badge&badge-style=flat-square" alt="bundle size" />
   </a>
   <a href="https://github.com/kwhitley/itty-router/actions/workflows/verify.yml" target="_blank">
     <img src="https://img.shields.io/github/actions/workflow/status/kwhitley/itty-router/verify.yml?branch=v4.x&style=flat-square" alt="build status" />
@@ -53,17 +53,33 @@
 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:
-- [fully typed/TypeScript support](https://itty.dev/itty-router/typescript)
-- [route params](https://itty.dev/itty-router/route-patterns#params) (including [optional params](https://itty.dev/itty-router/route-patterns#optional))
-- [wildcards](https://itty.dev/itty-router/route-patterns#wildcards) and [greedy params](https://itty.dev/itty-router/route-patterns#greedy)
-- [query parsing](https://itty.dev/itty-router/route-patterns#query)
-- [middleware](https://itty.dev/itty-router/middleware)
-- [router nesting](https://itty.dev/itty-router/nesting)
-- lightweight, easy-to-understand route code
-- works in virtually [*any* runtime/environment](https://itty.dev/itty-router/runtimes) (including the browser)
+- 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), 
+  [optional params](https://itty.dev/itty-router/route-patterns#optional),
+  [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), 
+  [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:
+  - [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`.
+  - [CORS](https://itty.dev/itty-router/cors) - because we love you.
+- Fully readable regex... yeah right! 😆
 
 ## [Full Documentation](https://itty.dev/itty-router)
-Complete docs/API are available at [itty.dev](https://itty.dev/itty-router), or join our [Discord](https://discord.com/channels/832353585802903572) channel to chat!
+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
 ```
@@ -108,7 +124,7 @@ export default {
 ```
 
 ## Join the Discussion!
-Have a question? Suggestion? Complaint? Want to send me a gift basket?
+Have a question? Suggestion? Complaint? Want to send a gift basket?
 
 Join us on [Discord](https://discord.com/channels/832353585802903572)!
 
@@ -117,9 +133,8 @@ Join us on [Discord](https://discord.com/channels/832353585802903572)!
 1. Install dev dependencies via `yarn`
 1. Start test runner/dev mode `yarn dev`
 1. Add your code and tests if needed - do NOT remove/alter existing tests
-1. Verify that tests pass once minified `yarn verify`
 1. Commit files
-1. Submit PR with a detailed description of what you're doing
+1. Submit PR (and fill out the template)
 1. I'll add you to the credits! :)
 
 ## Special Thanks: Contributors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "4.0.6",
+  "version": "4.0.7",
   "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.",
   "type": "module",
   "main": "./index.js",
@@ -18,17 +18,15 @@
     "nested"
   ],
   "scripts": {
+    "dev": "yarn test",
     "lint": "npx eslint src",
     "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",
-    "dev": "yarn test",
     "prerelease": "yarn verify",
-    "prebuild": "rimraf dist && mkdir dist",
-    "build:core": "rollup -c",
-    "build:extras": "rollup --config rollup.config.extras.mjs",
+    "prebuild": "rimraf dist && mkdir dist && yarn coverage && yarn lint",
     "build": "rollup -c",
     "release": "release --tag --push --patch --src=dist",
     "runtime:bun": "bun example/bun.ts",
@@ -51,19 +49,20 @@
     "@rollup/plugin-typescript": "^11.1.1",
     "@skypack/package-check": "^0.2.2",
     "@types/node": "^20.2.5",
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/parser": "^5.59.8",
     "@vitejs/plugin-vue": "^4.2.3",
-    "@vitest/coverage-c8": "^0.31.1",
-    "@whatwg-node/server": "^0.8.0",
+    "@vitest/coverage-c8": "^0.31.3",
+    "@whatwg-node/server": "^0.8.1",
     "coveralls": "^3.1.1",
     "eslint": "^8.41.0",
-    "eslint-plugin-jest": "^27.2.1",
     "fetch-mock": "^9.11.0",
     "fs-extra": "^11.1.1",
     "globby": "^13.1.4",
     "gzip-size": "^7.0.0",
     "http": "^0.0.1-security",
     "isomorphic-fetch": "^3.0.0",
-    "itty-router": "^4.0.2",
+    "itty-router": "^4.0.6",
     "jsdom": "^22.1.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^5.0.1",
@@ -74,7 +73,7 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4",
     "vite": "^4.3.9",
-    "vitest": "^0.31.1",
+    "vitest": "^0.31.3",
     "yarn": "^1.22.19",
     "yarn-release": "^1.10.5"
   }

package/CODE-OF-CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-krwhitley@gmail.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.