Skip to content

Update Readme instructions for ReactRefreshWebpackPlugin #578

Merged
tomdracz merged 1 commit intoshakacode:mainfrom
agneym:main
Jul 21, 2025
Merged

Update Readme instructions for ReactRefreshWebpackPlugin #578
tomdracz merged 1 commit intoshakacode:mainfrom
agneym:main

Conversation

@agneym
Copy link
Copy Markdown
Contributor

@agneym agneym commented Jun 26, 2025 •
edited by coderabbitai Bot
Loading

Summary

Current Readme suggests react-refresh-webpack-plugin usage like this:

new ReactRefreshWebpackPlugin({
      overlay: {
        sockPort: webpackConfig.devServer.port,
      },
})

In v0.6.0 react refresh plugin has removed the overlay sockPort option.

It was released on 28 Apr 2025. From release notes:

It is no-longer necessary as a direct integration with WDS is now possible.

New configuration should be:

new ReactRefreshWebpackPlugin()

Pull Request checklist

  • Add/update test to cover these changes
  • Update documentation
  • Update CHANGELOG file

Other Information

Summary by CodeRabbit

  • Documentation
    • Updated React setup documentation to simplify the configuration of the ReactRefreshWebpackPlugin.

@agneym
Update instruction for ReactRefreshWebpackPlugin (#1)
0f400f2 
By v0.6.0 react refresh plugin has removed the overlay sockPort option.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 26, 2025 •
edited
Loading

Walkthrough

The documentation for configuring ReactRefreshWebpackPlugin in a webpack setup was updated. The explicit overlay configuration, which set the sockPort, was removed. Now, the plugin is instantiated without any arguments in both relevant instances within the documentation.

Changes

File(s) Change Summary
docs/react.md Removed explicit overlay configuration from ReactRefreshWebpackPlugin examples in documentation.

Poem

In docs where plugins once were set,
The overlay’s gone—no need to fret!
Simpler lines now guide the way,
For React refresh on dev display.
With every build, let changes show,
As webpack’s breeze begins to blow!
🐇✨

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

coderabbitai[bot]
coderabbitai Bot reviewed Jun 26, 2025
View reviewed changes
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

♻️ Duplicate comments (1)
docs/react.md (1)

198-201: Same clarification applies here – see previous comment.

🧹 Nitpick comments (1)
docs/react.md (1)

63-65: Mention minimum plugin version to prevent copy-paste breakage

new ReactRefreshWebpackPlugin() is valid only from @pmmmwh/[email protected] onwards.
Readers on an older codebase who blindly follow the docs will get a runtime error about the unknown overlay option being missing.

Consider adding an inline note right below this snippet – e.g.

> Requires @pmmmwh/react-refresh-webpack-plugin ≥ 0.6.0

or pinning the install command to "@pmmmwh/react-refresh-webpack-plugin": "^0.6.0".

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 83f2abc and 0f400f2.

📒 Files selected for processing (1)
  • docs/react.md (2 hunks)

tomdracz
tomdracz approved these changes Jul 21, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@tomdracz tomdracz left a comment

Choose a reason for hiding this comment

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

Thanks!

@tomdracz tomdracz merged commit 550ce21 into shakacode:main Jul 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tomdracz tomdracz tomdracz approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@agneym @tomdracz