feat: enable error overlay by default

Author: chenjiahan

e2e/cases/server/overlay/rsbuild.config.ts

@@ -3,9 +3,4 @@ import { pluginReact } from '@rsbuild/plugin-react';
 
 export default defineConfig({
   plugins: [pluginReact()],
-  dev: {
-    client: {
-      overlay: true
-    }
-  }
 });

packages/core/src/provider/config.ts

@@ -40,6 +40,9 @@ const getDefaultDevConfig = (): NormalizedDevConfig => ({
   liveReload: true,
   assetPrefix: DEFAULT_ASSET_PREFIX,
   startUrl: false,
+  client: {
+    overlay: true,
+  },
 });
 
 const getDefaultServerConfig = (): NormalizedServerConfig => ({

packages/document/docs/en/config/dev/client.mdx

@@ -16,7 +16,6 @@ type Client = {
   host?: string;
   /**
    * Shows overlay in the browser when there are compiler errors
-   *
    * This feature requires the current browser version to support [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components)
    */
   overlay?: boolean;
@@ -32,7 +31,7 @@ const defaultConfig = {
   port: '',
   host: location.hostname,
   protocol: location.protocol === 'https:' ? 'wss' : 'ws',
-  overlay: false,
+  overlay: true,
 };
 ```
 

packages/document/docs/zh/config/dev/client.mdx

@@ -16,7 +16,6 @@ type Client = {
   host?: string;
   /**
    * 当出现编译错误时，在浏览器中显示遮盖
-   *
    * 该功能需要当前浏览器版本支持 [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components)
    */
   overlay?: boolean;
@@ -32,7 +31,7 @@ const defaultConfig = {
   port: '',
   host: location.hostname,
   protocol: location.protocol === 'https:' ? 'wss' : 'ws',
-  overlay: false,
+  overlay: true,
 };
 ```