Skip to content

docs: update http-proxy references to httpxy#1222

Merged
chimurai merged 1 commit intomasterfrom
docs-httpxy
May 3, 2026
Merged

docs: update http-proxy references to httpxy#1222
chimurai merged 1 commit intomasterfrom
docs-httpxy

Conversation

@chimurai
Copy link
Copy Markdown
Owner

@chimurai chimurai commented May 3, 2026

Summary by CodeRabbit

  • Documentation

    • Updated documentation to clarify event references and proxy configuration sources.
    • Corrected event subscription documentation for proxyRes and error events.
  • Chores

    • Fixed typo in bug report template.
    • Updated contributing guidelines for improved clarity.
    • Updated test descriptions for consistency.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 3, 2026

📝 Walkthrough

Walkthrough

This PR updates references to the proxy library throughout the codebase, replacing all mentions of http-proxy with httpxy. Changes span documentation files, code comments, debug messages, JSDoc, test descriptions, and issue templates—no functional logic or exported API surfaces are modified.

Changes

Attribution & Documentation Migration to httpxy

Layer / File(s) Summary
Template & Guidance Updates
.github/ISSUE_TEMPLATE/bug.yml, CONTRIBUTING.md
Bug report template example versions updated; contributing guide repoints to httpxy documentation and away from Nodejitsu's http-proxy.
Documentation References
README.md, recipes/https.md, recipes/proxy-events.md, recipes/virtual-hosts.md
All proxy option and event documentation updated to attribute functionality to httpxy instead of http-proxy; event links and section headers aligned.
Source Code Comments & Debug Messages
src/plugins/default/debug-proxy-errors-plugin.ts, src/plugins/default/proxy-events.ts, src/types.ts
JSDoc comments and debug log strings updated to reference httpxy events and internal server instance rather than http-proxy.
Test Descriptions
test/e2e/plugins.spec.ts, test/types.spec.ts
Test case and describe block labels updated to reference httpxy instead of http-proxy; test logic unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 From proxy old to httpxy new,
Each string and doc we refresh in view,
The logic stays, the heart runs true,
Just names that change in everything we do!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarizes the main change: updating documentation references from http-proxy to httpxy across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-httpxy

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 3, 2026

npm i https://pkg.pr.new/http-proxy-middleware@1222

commit: fff3c25

@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 94.07%. remained the same — docs-httpxy into master

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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/ISSUE_TEMPLATE/bug.yml:
- Around line 46-50: The description field still mentions
"http-proxy-middleware" while the PR renames http-proxy to httpxy; update the
description string (the YAML key named description that currently reads 'Paste
your http-proxy-middleware configuration here...') to reference the new library
name (e.g., 'Paste your httpxy-middleware configuration here...' or 'Paste your
httpxy configuration here...') so the file is consistent with the PR objective.
- Around line 54-58: Update the placeholder value for the "placeholder" field so
it shows realistic OS and Node versions (instead of "MacOS 26.3.1 and Node
24.15.0"); edit the placeholder string in the same YAML block (the "placeholder"
key) to an example like "ie. macOS 14.6 and Node 22.18.0" or other current LTS
versions to avoid confusing users while keeping the existing
label/description/validations unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 05819c96-57b5-4469-8f2c-bab4070f28a7

📥 Commits

Reviewing files that changed from the base of the PR and between f8ecd6d and fff3c25.

📒 Files selected for processing (11)
  • .github/ISSUE_TEMPLATE/bug.yml
  • CONTRIBUTING.md
  • README.md
  • recipes/https.md
  • recipes/proxy-events.md
  • recipes/virtual-hosts.md
  • src/plugins/default/debug-proxy-errors-plugin.ts
  • src/plugins/default/proxy-events.ts
  • src/types.ts
  • test/e2e/plugins.spec.ts
  • test/types.spec.ts

Comment thread .github/ISSUE_TEMPLATE/bug.yml
Comment thread .github/ISSUE_TEMPLATE/bug.yml
@chimurai chimurai merged commit c03926d into master May 3, 2026
24 checks passed
@chimurai chimurai deleted the docs-httpxy branch May 3, 2026 19:32
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