feat(rspeedy): apply dev.hmr and dev.liveReload config to Rsbuild config

[luhc228]

Related PR: #458

If we set dev.hmr or dev.liveReload to false in lynx.config.js:

import { defineConfig } from '@lynx-js/rspeedy'

export default defineConfig({
  dev: {
    hmr: false,
    liveReload: false,
  }
})

Now we will get different value of dev.hmr and dev.liveReload in rsbuild plugin:

function myRsbuildPlugin(api) {
  // first way
  // this config is user config
  const { config } = api.useExposed(Symbol.for('rspeedy.api'))!
  console.log(config.dev.hmr, config.dev.liveReload) // false false

  // second way
  // from environment config
  api.modifyBundlerChain((chain, { environment }) => {
    const { config } = environment
    console.log(config.dev.hmr, config.dev.liveReload) // true true
  })
}

We can also set these two config in environment config and above can't read the real value by the first way above:

import { defineConfig } from '@lynx-js/rspeedy'

export default defineConfig({
  environment: {
    lynx: {
      hmr: false,
      liveReload: false,
    }
  }
})

I think Rspeedy should apply the two configs to rsbuild config and other plugins should read the config from environment.config first.

Summary by CodeRabbit

• New Features
  • Development builds now default to Hot Module Replacement (HMR) and Live Reload enabled when not explicitly configured; these flags honor environment-specific overrides.
• Tests
  • Expanded coverage to verify dev.hmr and dev.liveReload behavior, including environment-specific override cases.
• Chores
  • Added a changeset to publish a patch release reflecting the default dev.hmr and dev.liveReload settings.

Checklist

• Tests updated (or not required).
• Documentation updated (or not required).
• Changeset added, and when a BREAKING CHANGE occurs, it needs to be clearly marked (or not required).

[changeset-bot]

🦋 Changeset detected

Latest commit: 8bb39c3

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

This PR includes changesets to release 3 packages

Name	Type
@lynx-js/rspeedy	Patch
create-rspeedy	Patch
upgrade-rspeedy	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

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Reads HMR and live-reload settings from environment-specific config (defaulting to true), adds defaults for dev.hmr and dev.liveReload in RSBuild config generation, adds tests covering environment-derived overrides, and introduces a patch changeset for @lynx-js/rspeedy. No public API changes.

Changes

Cohort / File(s)	Summary
Release metadata \.changeset/dull-kiwis-like.md	Adds a patch-level changeset for @lynx-js/rspeedy documenting the dev.hmr/dev.liveReload patch.
RSBuild config defaults packages/rspeedy/core/src/config/rsbuild/index.ts	Ensure dev.hmr and dev.liveReload default to true when not provided in generated rsbuild config.
Dev plugin behavior packages/rspeedy/core/src/plugins/dev.plugin.ts	Switch source of HMR/liveReload flags to environment-scoped config (environment.config.dev?.hmr / environment.config.dev?.liveReload) when building dev server search params; values still emitted as "true"/"false" strings.
Tests: dev plugin env overrides packages/rspeedy/core/test/plugins/dev.plugin.test.ts	Add tests asserting the dev transport alias/searchParam reflects environment-driven hmr and liveReload (true/false cases).
Tests: rsbuild snapshot packages/rspeedy/core/test/config/rsbuild.test.ts	Update snapshot/expectation: when dev is undefined, emitted rsbuildConfig.dev now contains hmr: true and liveReload: true.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• fix(rspeedy/core): make rspeedy dev --mode production work #1310 — Modifies packages/rspeedy/core/src/plugins/dev.plugin.ts; overlaps with dev plugin config sourcing changes.
• fix(rspeedy): disable lazyCompilation by default #1647 — Adjusts default dev configuration generation in packages/rspeedy/core/src/config/rsbuild/index.ts; related to added rsbuild defaults.

Suggested reviewers

• upupming
• gaoachao

Poem

A rabbit hops through lines of code,
Tucks HMR and reload in a cozy node.
Env flags twinkle, tests give a cheer,
Patch in the burrow — release is near! 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly captures the primary change by indicating that the dev.hmr and dev.liveReload settings are now applied to the Rsbuild configuration, accurately reflecting the core intent of the pull request.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06899f5 and 8bb39c3.

📒 Files selected for processing (1)

• packages/rspeedy/core/src/config/rsbuild/index.ts (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.changeset/dull-kiwis-like.md (1)

5-5: Consider expanding the changeset description.

The current description is concise but could be more informative for users reviewing release notes. Consider adding context about what this fixes or why it matters.

For example:

-Should apply `dev.hmr` and `dev.liveReload` to Rsbuild config.
+Fix inconsistency where `dev.hmr` and `dev.liveReload` config values differ when accessed via the exposed user config versus environment config in Rsbuild plugins. These settings now default to `true` in the Rsbuild config, ensuring consistent behavior across plugin access methods.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85a8b58 and e14b458.

📒 Files selected for processing (3)

• .changeset/dull-kiwis-like.md (1 hunks)
• packages/rspeedy/core/src/config/rsbuild/index.ts (1 hunks)
• packages/rspeedy/core/test/plugins/dev.plugin.test.ts (5 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

.changeset/*.md

📄 CodeRabbit inference engine (AGENTS.md)

For contributions, generate and commit a Changeset describing your changes

Files:

• .changeset/dull-kiwis-like.md

🧠 Learnings (1)

📚 Learning: 2025-09-12T09:43:04.847Z

Learnt from: gaoachao
PR: lynx-family/lynx-stack#1736
File: .changeset/spotty-experts-smoke.md:1-3
Timestamp: 2025-09-12T09:43:04.847Z
Learning: In the lynx-family/lynx-stack repository, empty changeset files (containing only `---\n\n---`) are used for internal changes that modify src/** files but don't require meaningful release notes, such as private package changes or testing-only modifications. This satisfies CI requirements without generating user-facing release notes.

Applied to files:

• .changeset/dull-kiwis-like.md

🧬 Code graph analysis (1)

packages/rspeedy/core/test/plugins/dev.plugin.test.ts (1)

packages/rspeedy/core/test/createStubRspeedy.ts (1)

• createStubRspeedy (20-64)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build / Build (Ubuntu)
• GitHub Check: build / Build (Windows)
• GitHub Check: test-rust / Test (Ubuntu)
• GitHub Check: zizmor

🔇 Additional comments (7)

packages/rspeedy/core/src/config/rsbuild/index.ts (1)

27-28: LGTM!

The addition of default values for hmr and liveReload correctly addresses the inconsistency described in the PR objectives. Defaulting both to true aligns with standard development server expectations and ensures these values are consistently available in the Rsbuild config for other plugins to read from environment.config.

packages/rspeedy/core/test/plugins/dev.plugin.test.ts (6)

433-433: LGTM!

Good addition to verify the default hmr value is accessible via the public getRsbuildConfig() API, addressing the inconsistency noted in the PR objectives.

Also applies to: 439-439

---

450-450: LGTM!

Correctly verifies that explicitly setting hmr: false is reflected in the public Rsbuild config.

Also applies to: 456-456

---

467-467: LGTM!

Properly tests explicit hmr: true configuration through the public API.

Also applies to: 473-473

---

480-480: LGTM!

Good coverage for the default liveReload behavior via getRsbuildConfig().

Also applies to: 486-486

---

497-497: LGTM!

Correctly validates that liveReload: false is accessible through the public config API.

Also applies to: 503-503

---

514-514: LGTM!

Appropriate test coverage for explicit liveReload: true configuration.

Also applies to: 520-520

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[relativeci]

React Example

#5879 Bundle Size — 237.56KiB (0%).

8bb39c3(current) vs dd7c14a main#5878(baseline)

Bundle metrics  no changes

	Current #5879	Baseline #5878
Initial JS	0B	0B
Initial CSS	0B	0B
Cache Invalidation	0%	0%
Chunks	0	0
Assets	4	4
Modules	166	166
Duplicate Modules	68	68
Duplicate Code	46.82%	46.82%
Packages	2	2
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #5879	Baseline #5878
IMG	145.76KiB	145.76KiB
Other	91.8KiB	91.8KiB

Bundle analysis report Branch luhc228:feat/apply-hmr-liveReloa... Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}

[relativeci]

Web Explorer

#5874 Bundle Size — 364.46KiB (0%).

8bb39c3(current) vs dd7c14a main#5873(baseline)

Bundle metrics   1 change

	Current #5874	Baseline #5873
Initial JS	144.52KiB	144.52KiB
Initial CSS	32KiB	32KiB
Cache Invalidation	0%	0%
Chunks	8	8
Assets	8	8
Modules	220(+0.46%)	219
Duplicate Modules	16	16
Duplicate Code	3.23%	3.23%
Packages	4	4
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #5874	Baseline #5873
JS	238.66KiB	238.66KiB
Other	93.8KiB	93.8KiB
CSS	32KiB	32KiB

Bundle analysis report Branch luhc228:feat/apply-hmr-liveReloa... Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}

[codspeed-hq]

CodSpeed Performance Report

Merging #1882 will degrade performances by 6.35%

_{Comparing luhc228:feat/apply-hmr-liveReload-to-rsbuild-config (8bb39c3) with main (820b3f9)}

Summary

❌ 2 regressions
✅ 51 untouched
⏩ 3 skipped¹

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	BASE	HEAD	Change
❌	basic-performance-image-100	9.8 ms	10.4 ms	-6.35%
❌	basic-performance-small-css	6.9 ms	7.3 ms	-5.39%

Footnotes

1. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/rspeedy/core/test/plugins/dev.plugin.test.ts (1)

489-506: Standardize test naming for consistency.

The test names have minor inconsistencies:

• Line 455 uses "environment.dev.hmr: false" (with dot)
• Line 489 uses "environment dev.hmr: true" (without dot)
• Line 534 uses "environment dev.liveReload: false" (without dot)
• Line 568 uses "environments dev.liveReload: true" (plural, without dot)

The test logic is correct, but for consistency, consider standardizing the naming convention. Either use "environment.dev" with a dot throughout, or "environment dev" without a dot, and keep "environment" singular.

Apply this diff to standardize the naming:

-  test('environment dev.hmr: true', async () => {
+  test('environment.dev.hmr: true', async () => {
     const rsbuild = await createStubRspeedy({
       environments: {
         lynx: {
           dev: {
             hmr: true,
           },
         },
       },
     })

     const config = await rsbuild.unwrapConfig()

     expect(config.resolve?.alias).toHaveProperty(
       '@lynx-js/webpack-dev-transport/client',
       expect.stringContaining('hot=true'),
     )
   })

-  test('environment dev.liveReload: false', async () => {
+  test('environment.dev.liveReload: false', async () => {
     const rsbuild = await createStubRspeedy({
       environments: {
         lynx: {
           dev: {
             liveReload: false,
           },
         },
       },
     })

     const config = await rsbuild.unwrapConfig()

     expect(config.resolve?.alias).toHaveProperty(
       '@lynx-js/webpack-dev-transport/client',
       expect.stringContaining('live-reload=false'),
     )
   })

-  test('environments dev.liveReload: true', async () => {
+  test('environment.dev.liveReload: true', async () => {
     const rsbuild = await createStubRspeedy({
       environments: {
         lynx: {
           dev: {
             liveReload: true,
           },
         },
       },
     })

     const config = await rsbuild.unwrapConfig()

     expect(config.resolve?.alias).toHaveProperty(
       '@lynx-js/webpack-dev-transport/client',
       expect.stringContaining('live-reload=true'),
     )
   })

Also applies to: 534-551, 568-585

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0911c3f and 06899f5.

📒 Files selected for processing (5)

• .changeset/dull-kiwis-like.md (1 hunks)
• packages/rspeedy/core/src/config/rsbuild/index.ts (1 hunks)
• packages/rspeedy/core/src/plugins/dev.plugin.ts (1 hunks)
• packages/rspeedy/core/test/config/rsbuild.test.ts (1 hunks)
• packages/rspeedy/core/test/plugins/dev.plugin.test.ts (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• packages/rspeedy/core/src/plugins/dev.plugin.ts
• packages/rspeedy/core/src/config/rsbuild/index.ts
• .changeset/dull-kiwis-like.md

🧰 Additional context used

🧬 Code graph analysis (1)

packages/rspeedy/core/test/plugins/dev.plugin.test.ts (1)

packages/rspeedy/core/test/createStubRspeedy.ts (1)

• createStubRspeedy (20-64)

🔇 Additional comments (2)

packages/rspeedy/core/test/config/rsbuild.test.ts (1)

19-21: LGTM!

The snapshot correctly reflects the new default values for hmr and liveReload when the dev config is undefined. This aligns with the PR objective of ensuring these flags are properly applied to the rsbuild configuration.

packages/rspeedy/core/test/plugins/dev.plugin.test.ts (1)

455-472: LGTM!

The test correctly verifies that when hmr is set to false in environment-specific config, the transport client alias reflects this with hot=false. This aligns with the PR objective of ensuring environment config is properly propagated.

[colinaaa]

LGTM!

[colinaaa]

nitpick: we should sort in alphabetical order