monorepo for Hono third-party middleware/helpers/wrappers
 
 
Go to file
github-actions[bot] fc30bf65cb
Version Packages (#28)
2023-02-01 06:55:41 +09:00
.changeset Version Packages (#28) 2023-02-01 06:55:41 +09:00
.github/workflows ci: fixed ci name 2023-01-02 00:11:13 +09:00
.vscode chore: add vscode settings 2023-01-18 21:30:32 +09:00
packages Version Packages (#28) 2023-02-01 06:55:41 +09:00
.eslintrc.js initial commit 2022-10-16 17:52:21 +09:00
.gitignore initial commit 2022-10-16 17:52:21 +09:00
.prettierrc initial commit 2022-10-16 17:52:21 +09:00
README.md docs(readme): `@honojs` to `@hono` 2022-12-24 21:21:32 +09:00
jest.config.js initial commit 2022-10-16 17:52:21 +09:00
package.json feat: add qwik-city middleware (#22) 2023-01-13 09:07:41 +09:00
tsconfig.json chore: remove unnecessary settings 2023-01-18 21:06:55 +09:00
yarn.lock fix(zod-validator): bump up Hono to v3.0.0-rc.9 (#27) 2023-02-01 06:53:53 +09:00

README.md

monorepo for Hono third-party middleware

This repository is monorepo for third-party middleware of Hono. We develop middleware in this repository and manage the issues and pull requests.

What is third-party middleware?

Hono has three types of middleware.

  1. Custom middleware - Created by users themselves.
  2. Built-in middleware - Included in the Hono core package. It does not depend on any other external libraries.
  3. Third-party middleware - Created outside of the core package. It can depend on the external libraries.

Third-party middleware is maintained in this github.com/honojs/middleware repository and published to npm in the @hono namespace. For example, a third-party middleware called hello is hosted at github.com/honojs/middleware/packages/hello and distributed under the name @hono/hello. You can install with the following command.

npm install @hono/hello

For Deno, the modules, we do not publish them on deno.land/x, but distribute them via CDNs such as Skypack and esm.sh. We will also use the npm: that will be introduced in the Deno itself in the future.

import { hello } from 'npm:@hono/hello'

How to contribute

Anyone can propose third-party Middleware. The Hono maintainers and other contributors will discuss to whether we accept the middleware or not. If it's OK, it will be maintained in this repository. Basically, the proposer maintains it.

The specific flow is as follows

  1. Clone this repository
  2. Write your middleware. Refer to hello Middleware.
  3. Create the pull request.

We use changesets to manage releases and CHANGELOG. Run the following command at the top level to describe any changes.

yarn changeset

When merged into main, a pull request for release is created. The Hono maintainers will merge it to release the package at the appropriate time.

Migration from the repository

If possible, please migrate middleware previously managed in an independent repository to this one. Create the pull request with the content in the middleware repository. Perhaps git-subtree might be useful.

Author & License

The Author of this repository is Yusuke Wada <https://github.com/yusukebe>. However, the code under the packges/* is in each Middleware author. Basically, distribute under the MIT license.