Guide
Config
Plugin
API
Community
Guide
Config
Plugin
API
Community

source.entry

  • Type:
type Entry = Record<string, string | string[] | EntryDescription> | Function;
  • Default:
const defaultEntry = {
  // default support for other suffixes such as ts, tsx, jsx, mjs, cjs
  index: 'src/index.js',
};

Used to set the entry modules for building.

The usage of source.entry is similar to the entry option in Rspack. The main difference is that Rsbuild will register html-webpack-plugin for each entry in source.entry to generate the corresponding HTML files.

  • Example:
rsbuild.config.ts
export default {
  source: {
    entry: {
      foo: './src/pages/foo/index.ts',
      bar: './src/pages/bar/index.ts',
    },
  },
};

The generated directory structure is as follows:

.
├── foo.html
├── bar.html
└── static
    ├── css
    │   ├── foo.css
    │   └── bar.css
    └── js
        ├── foo.js
        └── bar.js

If you do not need to generate HTML files, you can set tools.htmlPlugin to false to disable this behavior.

Description Object

source.entry also supports Rspack's entry description object. For example:

rsbuild.config.ts
export default {
  source: {
    entry: {
      foo: {
        import: './src/foo.js',
        runtime: 'foo',
      },
      bar: {
        import: './src/bar.js',
        runtime: 'bar',
      },
    },
  },
};

For the complete usage of the description object, please refer to Rspack - Entry Description Object.

Function Usage

source.entry supports setting as a function, which is commonly used to set different entry objects for different build target.

For example, set entry for web target and node target separately:

rsbuild.config.ts
export default {
  source: {
    entry({ target }) {
      if (target === 'web') {
        return {
          index: './src/index.client.js',
        };
      }
      if (target === 'node') {
        return {
          index: './src/index.server.js',
        };
      }
    },
  },
  output: {
    targets: ['web', 'node'],
  },
};