For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /config/output/inline-scripts.md.
close
  • English

      • output.inlineScripts

      • Type:
      type InlineChunkTestFunction = (params: {
  size: number;
  name: string;
}) => boolean;

type InlineChunkTest = RegExp | InlineChunkTestFunction;

type InlineChunkConfig =
  | boolean
  | InlineChunkTest
  | { enable?: boolean | 'auto'; test: InlineChunkTest };
      • Default: false

      Whether to inline output scripts files (.js files) into HTML with <script> tags.

      Note that, with this option enabled, the script files will no longer be written to the dist directory, they will only exist inside the HTML file instead.

      Example

      By default, we have the following output files:

      dist/html/main/index.html
dist/static/css/style.css
dist/static/js/main.js

      After turning on the output.inlineScripts option:

      rsbuild.config.ts
      export default {
  output: {
    inlineScripts: true,
  },
};

      The output files of production build will become:

      dist/html/main/index.html
dist/static/css/style.css

      And dist/static/js/main.js will be inlined in index.html:

      <html>
  <head>
    <script>
      // content of dist/static/js/main.js
    </script>
  </head>
</html>
      Tip

      Setting inlineScripts: true is equivalent to setting inlineScripts.enable to 'auto'. This indicates that inline scripts will only be enabled in production mode.

      Script tag position

      When using output.inlineScripts, we recommend setting html.inject to 'body'.

      As the default injection position of the script tag is the <head> tag, changing the injection position to the <body> tag can ensure that the inlined script can access the DOM elements in <body>.

      rsbuild.config.ts
      export default {
  html: {
    inject: 'body',
  },
  output: {
    inlineScripts: true,
  },
};

      Using RegExp

      To inline part of the JS files, set inlineScripts to a regular expression that matches the URL of the JS file that needs to be inlined.

      For example, to inline main.js into HTML, add the following configuration:

      rsbuild.config.ts
      export default {
  output: {
    inlineScripts: /[\\/]main\.\w+\.js$/,
  },
};
      Tip

      Production filenames include a hash value by default, such as static/js/main.18a568e5ab.js. In regular expressions, use \w+ to match the hash.

      Using function

      You can also set output.inlineScripts to a function that accepts the following parameters:

      • name: The filename, such as static/js/main.18a568e5ab.js.
      • size: The file size in bytes.

      For example, if we want to inline assets that are smaller than 10 kB, we can add the following configuration:

      rsbuild.config.ts
      export default {
  output: {
    inlineScripts({ size }) {
      return size < 10 * 1000;
    },
  },
};

      Async chunks

      When you use dynamic import in JavaScript, Rspack will generate an async chunk. By default, output.inlineScripts will not inline async chunks into the HTML.

      To inline async chunks into the HTML, change Rspack's default behavior using the tools.rspack config by setting module.parser.javascript.dynamicImportMode to 'eager'. In this case, Rspack will not generate separate JS files for dynamic imports.

      rsbuild.config.ts
      export default {
  output: {
    inlineScripts: true,
  },
  tools: {
    rspack: {
      module: {
        parser: {
          javascript: {
            dynamicImportMode: 'eager',
          },
        },
      },
    },
  },
};

      Options

      enable

      • Type: boolean | 'auto'
      • Default: false

      Whether to enable the inline scripts feature. If set to 'auto', it will be enabled when the mode is 'production'.

      rsbuild.config.ts
      export default {
  output: {
    inlineScripts: {
      enable: 'auto',
      test: /[\\/]main\.\w+\.js$/,
    },
  },
};

      test

      • Type: RegExp | ((params: { size: number; name: string }) => boolean)

      The regular expression or function to match the files that need to be inlined.

      rsbuild.config.ts
      export default {
  output: {
    inlineScripts: {
      enable: true,
      test: /[\\/]main\.\w+\.js$/,
    },
  },
};

      Using with ESM output

      When output.module is enabled, initial JavaScript chunks can reference the runtime or shared chunks through static ESM imports. After inlineScripts moves these chunks into HTML and removes the corresponding files, those imports can no longer be resolved.

      Therefore, each HTML entry should have only one initial JavaScript chunk. Keep the runtime in the entry and limit splitChunks to async chunks:

      rsbuild.config.ts
      export default {
  output: {
    module: true,
    inlineScripts: true,
  },
  splitChunks: {
    // Only split async chunks
    chunks: 'async',
  },
  tools: {
    rspack: {
      optimization: {
        // Keep the runtime in the entry chunk
        runtimeChunk: false,
      },
    },
  },
};

      Async chunks created by dynamic imports are still supported. They are not inlined by default and continue to load on demand. If your application requires a separate runtime chunk or shared initial chunks, do not enable inlineScripts.