Skip to content

docs: remove undefined createMiddleware in Hono integration#394

Merged
dinwwwh merged 1 commit intomiddleapi:mainfrom
johnpyp:docs/hono-integration-fix
Apr 12, 2025
Merged

docs: remove undefined createMiddleware in Hono integration#394
dinwwwh merged 1 commit intomiddleapi:mainfrom
johnpyp:docs/hono-integration-fix

Conversation

@johnpyp
Copy link
Copy Markdown
Contributor

@johnpyp johnpyp commented Apr 11, 2025

Removes the unused (and also undefined) createMiddleware function from the Hono integration docs.

Summary by CodeRabbit

  • Documentation
    • Updated the integration guide’s code example for clearer, up-to-date usage instructions.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 11, 2025 11:28pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 11, 2025

Walkthrough

The change updates the integration documentation for the Hono application. The modification involves removing the createMiddleware import from the @orpc/server/fetch module, retaining only the RPCHandler import in the TypeScript code snippet. The rest of the code remains unchanged.

Changes

File(s) Change Summary
apps/.../hono.md Removed createMiddleware import; now only RPCHandler is imported in the code snippet.

Poem

In the code garden, I hop with delight,
Trimming imports to keep everything light.
No extra middleware to munch or chew,
Just pure RPC magic, simple and true.
A rabbit's cheer for changes anew!
🐰🥕

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/content/docs/integrations/hono.md (1)

16-19: Optional: Clarify the router Reference

The code snippet instantiates RPCHandler with a router (i.e., new RPCHandler(router)) but does not show its definition. To help users understand that router represents an existing or user-defined routing mechanism, consider adding a brief inline comment or note indicating that router should be defined or imported for a complete setup.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 08f0a9e and a81d32b.

📒 Files selected for processing (1)
  • apps/content/docs/integrations/hono.md (1 hunks)
🔇 Additional comments (1)
apps/content/docs/integrations/hono.md (1)

13-14: Refined Import Statement Improves Clarity

The revised import now only includes RPCHandler from @orpc/server/fetch, effectively removing the unused and undefined createMiddleware function. This aligns perfectly with the PR objectives and enhances the clarity of the documentation by reducing potential confusion.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 12, 2025

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@394

@orpc/client

npm i https://pkg.pr.new/@orpc/client@394

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@394

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@394

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@394

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@394

@orpc/react

npm i https://pkg.pr.new/@orpc/react@394

@orpc/server

npm i https://pkg.pr.new/@orpc/server@394

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@394

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@394

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@394

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@394

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@394

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@394

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@394

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@394

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@394

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@394

commit: a81d32b

@dinwwwh dinwwwh changed the title docs: remove unused and undefined createHandler in Hono integration… docs: remove undefined createMiddleware in Hono integration Apr 12, 2025
@dinwwwh dinwwwh merged commit 01b4184 into middleapi:main Apr 12, 2025
8 checks passed
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.

2 participants