Skip to content

chore: mark @hono/bun-compress as deprecated#1809

Merged
yusukebe merged 2 commits intomainfrom
unknown repository
Mar 22, 2026
Merged

chore: mark @hono/bun-compress as deprecated#1809
yusukebe merged 2 commits intomainfrom
unknown repository

Conversation

@ghost
Copy link
Copy Markdown

@ghost ghost commented Mar 20, 2026

Summary

Marks @hono/bun-compress as deprecated now that Bun supports CompressionStream natively.

The README already stated: "This middleware will be deprecated once Bun adds support for CompressionStream." Bun resolved oven-sh/bun#1723, so hono/compress now works on Bun without any polyfill.

Changes

  • Add deprecated field to package.json (shows warning on npm install)
  • Update description to indicate deprecation
  • Rewrite README with deprecation notice and migration guide

Migration for users

- import { compress } from '@hono/bun-compress'
+ import { compress } from 'hono/compress'

Closes #1807

Bun now supports CompressionStream natively, making this middleware
unnecessary. The README already stated it would be deprecated once
Bun added support.

- Add deprecated field to package.json
- Update README with deprecation notice and migration guide
- Point users to the built-in hono/compress middleware

Closes #1807
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 20, 2026

🦋 Changeset detected

Latest commit: 1ec73c2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@hono/bun-compress Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@yusukebe
Copy link
Copy Markdown
Member

yusukebe commented Mar 21, 2026

Hey @ctonneslan

Thank you for the PR. Can you add a changeset by running the yarn changeset command at the top of the project? I think making the change patch is better.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.73%. Comparing base (af99687) to head (1ec73c2).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1809   +/-   ##
=======================================
  Coverage   91.73%   91.73%           
=======================================
  Files         113      113           
  Lines        3785     3785           
  Branches      957      957           
=======================================
  Hits         3472     3472           
  Misses        281      281           
  Partials       32       32           
Flag Coverage Δ
bun-compress 78.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ghost
Copy link
Copy Markdown
Author

ghost commented Mar 21, 2026

Added a patch changeset for @hono/bun-compress. Thanks for the review!

Copy link
Copy Markdown
Member

@yusukebe yusukebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@yusukebe
Copy link
Copy Markdown
Member

@ctonneslan

Good job! Thank you for your contribution!

@yusukebe yusukebe merged commit ee082b6 into honojs:main Mar 22, 2026
55 checks passed
@github-actions github-actions bot mentioned this pull request Mar 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@hono/bun-compress should be marked as derecated Add CompressionStream

1 participant