close
Guide
Config
Plugin
API
Community
Guide
Config
Plugin
API
Community

output.inlineScripts

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

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

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

Note that, with this option on, the scripts files will no longer be written in dist directory, they will only exist inside the HTML file instead.

Example

By default, we have following output files:

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

After turn on the output.inlineScripts option:

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 output.inlineScripts is used, it is recommended to set 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>.

export default {
+  html: {
+    inject: 'body',
+  },
   output: {
     inlineScripts: true,
   },
};

Using RegExp

If you need to inline part of the JS files, you can 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, you can add the following configuration:

export default {
  output: {
    inlineScripts: /[\\/]main\.\w+\.js$/,
  },
};
TIP

The production filename includes a hash value by default, such as static/js/main.18a568e5.js. Therefore, in regular expressions, \w+ is used 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.18a568e5.js.
  • size: The file size in bytes.

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

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

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'.

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.

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