rsbuild-plugin-rempa

A Rsbuild plugin designed to collect pages and generate a Multi-Page Application (MPA).

Installation

Install the plugin via npm:

npm install rsbuild-plugin-rempa --save-dev

Usage

Add the plugin to your rsbuild configuration file:

// rsbuild.config.ts
import { defineConfig } from '@rsbuild/core';
import { pluginReact } from '@rsbuild/plugin-react';
import { pluginRempa } from 'rsbuild-plugin-rempa';

export default defineConfig({
  plugins: [pluginReact(), pluginRempa()],
});

You can also configure the plugin with options:

// rsbuild.config.ts
import { defineConfig } from '@rsbuild/core';
import { pluginReact } from '@rsbuild/plugin-react';
import { pluginRempa } from 'rsbuild-plugin-rempa';

export default defineConfig({
  plugins: [
    pluginReact(), 
    pluginRempa({
      pagesPath: 'src/pages',
      aliasAtToSrc: true,
      locals: true,
      localsName: 'pageData'
    })
  ],
});

Plugin Options

• template (string): Specifies the HTML template file to use for the generated pages. Defaults to the Rsbuild default template.
• layout (string): Defines the default layout path for the entry page. Defaults to <>{children}</>.
• pagesPath (string): Directory to scan for generating MPA files, relative to the current working directory. Defaults to src/pages.
• aliasAtToSrc (boolean): Whether to automatically inject alias @ -> src. Defaults to true.
• locals (boolean): Whether to inject locals into template parameters.
• localsName (string): Name of the injected locals variable.

Auto-Generated MPA

The plugin automatically generates entry files for each page based on the config.json files located in the src/pages directory.

Example config.json:

{
  "title": "Index Page",
  "layout": "./layout.tsx"
}

Supported config.json options include:

• template: Path to the template file.
• layout: Path to the page layout.
• title: Title of the page.
• mountElementId: The ID of the DOM node where the page will be mounted. Defaults to root.
• Additional properties will be passed to the template as templateParameters.

Example

For a working example, see the playground.

License

MIT