#Dev server

Rsbuild includes a built-in dev server that enhances the development experience. When you run rsbuild dev or rsbuild preview, the server starts and provides features like page preview, routing, and hot module replacement.

#Base path

By default, the Rsbuild server's base path is /. You can access output files like index.html and public folder assets at http://localhost:3000/.

To change the server's base path, use server.base. For example, to access files at http://localhost:3000/foo/:

export default {
  server: {
    base: '/foo',
  },
};

#View static assets

After starting the dev server, visit /rsbuild-dev-server to view all static assets generated during the current build.

For example, open http://localhost:3000/rsbuild-dev-server in your browser:

#Page routing

The Rsbuild server provides default routing conventions and allows customization through configuration.

#Default behavior

The Rsbuild server generates page routes based on the server.base and source.entry configurations.

When the entry is index, access the page at /. When the entry is foo, access the page at /foo.

When server.base is /base, access the index page at /base, and the foo page at /base/foo.

export default {
  source: {
    entry: {
      index: './src/index.ts',
      foo: './src/pages/foo/index.ts',
    },
  },
};

#Fallback behavior

If a request meets the following conditions but no corresponding static asset exists, server.htmlFallback triggers and falls back to index.html by default:

• The request method is GET or HEAD
• The Accept header contains text/html (for example, text/html or */*)

#Custom fallback behavior

If Rsbuild's default server.htmlFallback configuration doesn't meet your needs (for example, serving main.html when accessing /), use server.historyApiFallback instead.

export default {
  source: {
    entry: {
      main: './src/index.ts',
    },
  },
  server: {
    historyApiFallback: {
      index: '/main.html',
    },
  },
};

#HTML output path

Normally, / points to the dist root directory, and HTML files are output there. In this case, access HTML pages at /some-path.

If you output HTML files to other subdirectories using output.distPath.html, access HTML pages at /[htmlPath]/some-path instead.

For example, if you set HTML files to output to the HTML directory, access index.html at /html/, and foo.html at /html/foo.

export default {
  source: {
    entry: {
      index: './src/index.ts',
      foo: './src/pages/foo/index.ts',
    },
  },
  output: {
    distPath: {
      html: 'html',
    },
  },
};

#Rspack dev server

Rsbuild has a built-in lightweight dev server that differs from the dev servers in Rspack CLI or webpack CLI, with different configuration options.

#Comparison

Compared to the dev server in Rspack CLI, Rsbuild's dev server has the following differences:

• Configuration: Rsbuild provides richer server configuration options.
• Log Format: The log format of Rspack CLI is largely consistent with webpack CLI, while Rsbuild's logs are clearer and more readable.
• Dependencies: Rsbuild is built on lightweight libraries like connect, which has fewer dependencies and faster startup than express used by @rspack/dev-server.

#Configuration

Rsbuild doesn't support Rspack's devServer config. Use Rsbuild's dev and server configs instead.

In Rsbuild, the dev config contains settings that only apply in development mode, while the server config applies to both dev and preview servers.

Below are the Rsbuild configuration options that correspond to Rspack CLI's devServer config:

For more configurations, refer to Config Overview.

#Middleware

Rsbuild's middleware implementation is built on connect, a lightweight HTTP server framework, and uses the standard Node.js request and response objects for handling HTTP interactions.

#Register middleware

Rsbuild provides three ways to register middleware:

1. Use the dev.setupMiddlewares configuration.

export default {
  dev: {
    setupMiddlewares: (middlewares) => {
      middlewares.push((req, res, next) => {
        next();
      });
    },
  },
};

2. In the Rsbuild plugin, you can register middleware through the onBeforeStartDevServer hook.

const myPlugin = () => ({
  setup(api) {
    api.onBeforeStartDevServer(({ server }) => {
      server.middlewares.use((req, res, next) => {
        next();
      });
    });
  },
});

3. When using the Rsbuild JavaScript API, you can create a dev server instance through the rsbuild.createDevServer method and use the use method to register middleware.

const server = await rsbuild.createDevServer();

server.middlewares.use((req, res, next) => {
  next();
});

#Integrate third-party server frameworks

When migrating from other server frameworks like Express, the original middleware may not work directly in Rsbuild. For example, Express-specific properties like req.params, req.path, req.search, and req.query aren't available in Rsbuild middleware.

To reuse existing middleware in Rsbuild, integrate your entire server application as middleware:

import express from 'express';
import expressMiddleware from 'my-express-middleware';

// Initialize Express app
const app = express();

app.use(expressMiddleware);

export default {
  dev: {
    setupMiddlewares: (middlewares) => {
      middlewares.unshift(app);
    },
  },
};

#Custom server

To integrate Rsbuild's dev server into a custom server, use the createDevServer method to get the Rsbuild dev server instance and call its methods as needed.

For details, refer to Rsbuild - createDevServer.