source.entry#

• Type:

type Entry = Record<
  string,
  string | string[] | (Rspack.EntryDescription & { html?: boolean })
>;

• 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-rspack-plugin for each entry in source.entry to generate the corresponding HTML files.

• Example:

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:

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

Rsbuild has added an html attribute for the description object, which is used to control whether an HTML file is generated.

For example, the bar entry does not generate an HTML file:

export default {
  source: {
    entry: {
      foo: './src/foo.js',
      bar: {
        import: './src/bar.js',
        html: false,
      },
    },
  },
};

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

Set by environment#

When you build for multiple environments, you can set different entry for each environment:

For example, set different entry for web and node environments:

export default {
  environments: {
    web: {
      source: {
        entry: {
          index: './src/index.client.js',
        },
      },
      output: {
        target: 'web',
      },
    },
    node: {
      source: {
        entry: {
          index: './src/index.server.js',
        },
      },
      output: {
        target: 'node',
      },
    },
  },
};