@rsbuild/core 0.5.8 → 0.6.0

package/dist/rspack/InlineChunkHtmlPlugin.js

@@ -28,7 +28,7 @@ __export(InlineChunkHtmlPlugin_exports, {
 module.exports = __toCommonJS(InlineChunkHtmlPlugin_exports);
 var import_node_path = require("node:path");
 var import_shared = require("@rsbuild/shared");
-var import_htmlPluginUtil = require("../provider/htmlPluginUtil");
+var import_htmlUtils = require("../htmlUtils");
 class InlineChunkHtmlPlugin {
   constructor({
     styleTests,
@@ -160,7 +160,7 @@ class InlineChunkHtmlPlugin {
     compiler.hooks.compilation.tap(this.name, (compilation) => {
       const publicPath = (0, import_shared.getPublicPathFromCompiler)(compiler);
       const tagFunction = (tag) => this.getInlinedTag(publicPath, tag, compilation);
-      const hooks = (0, import_htmlPluginUtil.getHTMLPlugin)().getHooks(compilation);
+      const hooks = (0, import_htmlUtils.getHTMLPlugin)().getHooks(compilation);
       hooks.alterAssetTagGroups.tap(this.name, (assets) => {
         assets.headTags = assets.headTags.map(tagFunction);
         assets.bodyTags = assets.bodyTags.map(tagFunction);

package/dist/rspack/preload/HtmlPreloadOrPrefetchPlugin.js

@@ -28,7 +28,7 @@ __export(HtmlPreloadOrPrefetchPlugin_exports, {
 module.exports = __toCommonJS(HtmlPreloadOrPrefetchPlugin_exports);
 var import_shared = require("@rsbuild/shared");
 var import_helpers = require("./helpers");
-var import_htmlPluginUtil = require("../../provider/htmlPluginUtil");
+var import_htmlUtils = require("../../htmlUtils");
 /**
  * @license
  * Copyright 2018 Google Inc.
@@ -137,7 +137,7 @@ class HtmlPreloadOrPrefetchPlugin {
   }
   apply(compiler) {
     compiler.hooks.compilation.tap(this.constructor.name, (compilation) => {
-      (0, import_htmlPluginUtil.getHTMLPlugin)().getHooks(compilation).beforeAssetTagGeneration.tap(
+      (0, import_htmlUtils.getHTMLPlugin)().getHooks(compilation).beforeAssetTagGeneration.tap(
         `HTML${(0, import_shared.upperFirst)(this.type)}Plugin`,
         (htmlPluginData) => {
           this.resourceHints = generateLinks(
@@ -150,7 +150,7 @@ class HtmlPreloadOrPrefetchPlugin {
           return htmlPluginData;
         }
       );
-      (0, import_htmlPluginUtil.getHTMLPlugin)().getHooks(compilation).alterAssetTags.tap(
+      (0, import_htmlUtils.getHTMLPlugin)().getHooks(compilation).alterAssetTags.tap(
         `HTML${(0, import_shared.upperFirst)(this.type)}Plugin`,
         (htmlPluginData) => {
           if (this.resourceHints) {

package/dist/server/compilerDevMiddleware.d.ts

@@ -16,8 +16,8 @@ type Options = {
  */
 export declare class CompilerDevMiddleware {
     middleware: DevMiddlewareAPI;
-    private devOptions;
-    private serverOptions;
+    private devConfig;
+    private serverConfig;
     private devMiddleware;
     private publicPaths;
     private socketServer;

package/dist/server/compilerDevMiddleware.js

@@ -39,23 +39,27 @@ module.exports = __toCommonJS(compilerDevMiddleware_exports);
 var import_socketServer = require("./socketServer");
 const noop = () => {
 };
-function getHMRClientPath(client = {}) {
-  const params = Object.entries(client).reduce((query, [key, value]) => {
-    return value ? `${query}&${key}=${value}` : `${query}`;
-  }, "");
-  const clientEntry = `${require.resolve("@rsbuild/core/client/hmr")}?${params}`;
-  return clientEntry;
+function getClientPaths(devConfig) {
+  const clientPaths = [];
+  if (!devConfig.hmr && !devConfig.liveReload) {
+    return clientPaths;
+  }
+  clientPaths.push(require.resolve("@rsbuild/core/client/hmr"));
+  if (devConfig.client?.overlay) {
+    clientPaths.push(`${require.resolve("@rsbuild/core/client/overlay")}`);
+  }
+  return clientPaths;
 }
 class CompilerDevMiddleware {
   constructor({ dev, server, devMiddleware, publicPaths }) {
     __publicField(this, "middleware");
-    __publicField(this, "devOptions");
-    __publicField(this, "serverOptions");
+    __publicField(this, "devConfig");
+    __publicField(this, "serverConfig");
     __publicField(this, "devMiddleware");
     __publicField(this, "publicPaths");
     __publicField(this, "socketServer");
-    this.devOptions = dev;
-    this.serverOptions = server;
+    this.devConfig = dev;
+    this.serverConfig = server;
     this.publicPaths = publicPaths;
     this.socketServer = new import_socketServer.SocketServer(dev);
     this.devMiddleware = devMiddleware;
@@ -78,7 +82,7 @@ class CompilerDevMiddleware {
     this.socketServer.sockWrite(type, data);
   }
   setupDevMiddleware(devMiddleware, publicPaths) {
-    const { devOptions, serverOptions } = this;
+    const { devConfig, serverConfig } = this;
     const callbacks = {
       onInvalid: () => {
         this.socketServer.sockWrite("invalid");
@@ -87,15 +91,19 @@ class CompilerDevMiddleware {
         this.socketServer.updateStats(stats);
       }
     };
-    const injectClient = this.devOptions.hmr || this.devOptions.liveReload;
+    const clientPaths = getClientPaths(devConfig);
     const middleware = devMiddleware({
-      headers: serverOptions.headers,
+      headers: serverConfig.headers,
       publicPath: "/",
       stats: false,
       callbacks,
-      hmrClientPath: injectClient ? getHMRClientPath(devOptions.client) : void 0,
+      clientPaths,
+      clientConfig: devConfig.client,
+      writeToDisk: devConfig.writeToDisk,
       serverSideRender: true,
-      writeToDisk: devOptions.writeToDisk
+      // weak is enough in dev
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests#weak_validation
+      etag: "weak"
     });
     const warp = async (req, res, next) => {
       const { url } = req;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/core",
-  "version": "0.5.8",
+  "version": "0.6.0",
   "description": "The Rspack-based build tool.",
   "homepage": "https://rsbuild.dev",
   "bugs": {
@@ -18,21 +18,17 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./server": {
-      "types": "./dist/server/index.d.ts",
-      "default": "./dist/server/index.js"
-    },
     "./client/hmr": {
       "types": "./dist/client/hmr/index.d.ts",
       "default": "./dist/client/hmr.mjs"
     },
-    "./plugins/*": {
-      "types": "./dist/plugins/*.d.ts",
-      "default": "./dist/plugins/*.js"
+    "./client/overlay": {
+      "types": "./dist/client/overlay.d.ts",
+      "default": "./dist/client/overlay.mjs"
     },
-    "./provider": {
-      "types": "./dist/provider/index.d.ts",
-      "default": "./dist/provider/index.js"
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "default": "./dist/internal.js"
     },
     "./types": {
       "types": "./types.d.ts"
@@ -52,12 +48,12 @@
     "types.d.ts"
   ],
   "dependencies": {
-    "@rspack/core": "0.5.9-canary-8778e17-20240403045016",
+    "@rspack/core": "0.6.0",
     "@swc/helpers": "0.5.3",
     "core-js": "~3.36.0",
     "html-webpack-plugin": "npm:html-rspack-plugin@5.6.2",
     "postcss": "^8.4.38",
-    "@rsbuild/shared": "0.5.8"
+    "@rsbuild/shared": "0.6.0"
   },
   "devDependencies": {
     "@types/node": "16.x",

package/dist/client/hmr/overlay.d.ts

@@ -1,2 +0,0 @@
-export declare function createOverlay(err: string[]): void;
-export declare function clearOverlay(): void;

package/dist/provider/config.d.ts

@@ -1,8 +0,0 @@
-import type { RsbuildConfig, NormalizedConfig } from '@rsbuild/shared';
-export declare const withDefaultConfig: (rootPath: string, config: RsbuildConfig) => Promise<RsbuildConfig>;
-/** #__PURE__
- * 1. May used by multiple plugins.
- * 2. Object value that should not be empty.
- * 3. Meaningful and can be filled by constant value.
- */
-export declare const normalizeConfig: (config: RsbuildConfig) => NormalizedConfig;

package/dist/provider/config.js

@@ -1,175 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var config_exports = {};
-__export(config_exports, {
-  normalizeConfig: () => normalizeConfig,
-  withDefaultConfig: () => withDefaultConfig
-});
-module.exports = __toCommonJS(config_exports);
-var import_node_path = require("node:path");
-var import_shared = require("@rsbuild/shared");
-var import_mergeConfig = require("../mergeConfig");
-const getDefaultDevConfig = () => ({
-  hmr: true,
-  liveReload: true,
-  assetPrefix: import_shared.DEFAULT_ASSET_PREFIX,
-  startUrl: false
-});
-const getDefaultServerConfig = () => ({
-  port: import_shared.DEFAULT_PORT,
-  host: import_shared.DEFAULT_DEV_HOST,
-  htmlFallback: "index",
-  compress: true,
-  printUrls: true,
-  strictPort: false,
-  publicDir: {
-    name: "public",
-    copyOnBuild: true
-  }
-});
-const getDefaultSourceConfig = () => ({
-  alias: {},
-  define: {},
-  aliasStrategy: "prefer-tsconfig",
-  preEntry: [],
-  decorators: {
-    version: "legacy"
-  }
-});
-const getDefaultHtmlConfig = () => ({
-  meta: {
-    charset: { charset: "UTF-8" },
-    viewport: "width=device-width, initial-scale=1.0"
-  },
-  title: "Rsbuild App",
-  inject: "head",
-  mountId: import_shared.DEFAULT_MOUNT_ID,
-  crossorigin: false,
-  outputStructure: "flat",
-  scriptLoading: "defer"
-});
-const getDefaultSecurityConfig = () => ({
-  nonce: ""
-});
-const getDefaultToolsConfig = () => ({
-  cssExtract: {
-    loaderOptions: {},
-    pluginOptions: {}
-  }
-});
-const getDefaultPerformanceConfig = () => ({
-  profile: false,
-  buildCache: true,
-  printFileSize: true,
-  removeConsole: false,
-  removeMomentLocale: false,
-  chunkSplit: {
-    strategy: "split-by-experience"
-  }
-});
-const getDefaultOutputConfig = () => ({
-  targets: ["web"],
-  distPath: {
-    root: import_shared.ROOT_DIST_DIR,
-    js: import_shared.JS_DIST_DIR,
-    css: import_shared.CSS_DIST_DIR,
-    svg: import_shared.SVG_DIST_DIR,
-    font: import_shared.FONT_DIST_DIR,
-    html: import_shared.HTML_DIST_DIR,
-    wasm: import_shared.WASM_DIST_DIR,
-    image: import_shared.IMAGE_DIST_DIR,
-    media: import_shared.MEDIA_DIST_DIR,
-    server: import_shared.SERVER_DIST_DIR,
-    worker: import_shared.SERVICE_WORKER_DIST_DIR
-  },
-  assetPrefix: import_shared.DEFAULT_ASSET_PREFIX,
-  filename: {},
-  charset: "ascii",
-  polyfill: "usage",
-  dataUriLimit: {
-    svg: import_shared.DEFAULT_DATA_URL_SIZE,
-    font: import_shared.DEFAULT_DATA_URL_SIZE,
-    image: import_shared.DEFAULT_DATA_URL_SIZE,
-    media: import_shared.DEFAULT_DATA_URL_SIZE
-  },
-  legalComments: "linked",
-  injectStyles: false,
-  minify: true,
-  sourceMap: {
-    js: void 0,
-    css: false
-  },
-  filenameHash: true,
-  enableCssModuleTSDeclaration: false,
-  inlineScripts: false,
-  inlineStyles: false,
-  cssModules: {
-    auto: true,
-    exportLocalsConvention: "camelCase"
-  }
-});
-const createDefaultConfig = () => ({
-  dev: getDefaultDevConfig(),
-  server: getDefaultServerConfig(),
-  html: getDefaultHtmlConfig(),
-  source: getDefaultSourceConfig(),
-  output: getDefaultOutputConfig(),
-  tools: getDefaultToolsConfig(),
-  security: getDefaultSecurityConfig(),
-  performance: getDefaultPerformanceConfig()
-});
-function getDefaultEntry(root) {
-  const files = [
-    // Most projects are using typescript now.
-    // So we put `.ts` as the first one to improve performance.
-    "ts",
-    "js",
-    "tsx",
-    "jsx",
-    ".mjs",
-    ".cjs"
-  ].map((ext) => (0, import_node_path.join)(root, `src/index.${ext}`));
-  const entryFile = (0, import_shared.findExists)(files);
-  if (entryFile) {
-    return {
-      index: entryFile
-    };
-  }
-  return {};
-}
-const withDefaultConfig = async (rootPath, config) => {
-  const merged = (0, import_mergeConfig.mergeRsbuildConfig)(createDefaultConfig(), config);
-  merged.source || (merged.source = {});
-  if (!merged.source.entry) {
-    merged.source.entry = getDefaultEntry(rootPath);
-  }
-  if (!merged.source.tsconfigPath) {
-    const tsconfigPath = (0, import_node_path.join)(rootPath, import_shared.TS_CONFIG_FILE);
-    if (await (0, import_shared.isFileExists)(tsconfigPath)) {
-      merged.source.tsconfigPath = tsconfigPath;
-    }
-  }
-  return merged;
-};
-const normalizeConfig = (config) => (0, import_mergeConfig.mergeRsbuildConfig)(createDefaultConfig(), config);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  normalizeConfig,
-  withDefaultConfig
-});

package/dist/provider/index.d.ts

@@ -1,14 +0,0 @@
-export { rspackProvider } from './provider';
-export type { Rspack, RspackConfig } from '@rsbuild/shared';
-export { createContext, createPublicContext } from './createContext';
-export { initPlugins, createPluginManager } from '../pluginManager';
-export { initHooks, type Hooks } from '../initHooks';
-export { initRsbuildConfig } from './initConfigs';
-export { getPluginAPI } from './initPlugins';
-export { applyBaseCSSRule, applyCSSModuleRule } from './plugins/css';
-export type { InternalContext } from '../types';
-export { setHTMLPlugin, getHTMLPlugin } from './htmlPluginUtil';
-export { formatStats } from './shared';
-export { getChainUtils } from './rspackConfig';
-export { applySwcDecoratorConfig } from './plugins/swc';
-export { getDevMiddleware } from './devMiddleware';