@fer0x/rollup-plugin-fill-html

v1.2.2

Published

2 years ago

fill html with the bundle file

Downloads

0High
0Medium
0Low

fer0x

rollup rollup-plugin html fill-html

rollup-plugin-fill-html

Fill the html template with the bundle js..

Note

Rollup >= 0.48 has been supported since v1.0.6. So if you use rollup < 0.48, please choose the older version.

The 1.0.3 version has support to insert css file and external url, you should know that rollup-plugin-fill-html will scan the dest directory and find out all the js and css files, and then insert these files into the result html. So you'd better to clean the dest directory before rebuilding, and I think you may need this .

Installation

yarn add --dev rollup-plugin-fill-html

npm install -D rollup-plugin-fill-html

Usage

In the rollup.config.js:

import html from 'rollup-plugin-fill-html';

export default {
  entry: 'src/index.js',
  dest: 'dist/bundle.js',
  plugins: [
    html({
      template: 'src/index.html',
      filename: 'index.html'
    })
  ]
};

and then a index.html file will be created in the dest directory(where the bundle file will be).

Hash

With rollup-plugin-fill-html, you can set a format string which with '[hash]' for the dest in rollup.config.js, just like:

export default {
  entry: 'src/index.js',
  dest: 'dist/bundle-[hash].js',
  plugins: [
    ...
  ]
};

and then, you will get bundle-a3965c0c77a63d7c74b57222e2f74028.js in your dist directory.

Externals

Since v1.0.3, rollup-plugin-fill-html has support to include external files. You can set an externals option to list your files which you want to include.

Options

You can pass an option to the html() just like above, and there are some options:

template: Required. the path of the template file, it should be a html file.
filename: Optional. the name of the result html file, if omitted, the template name will be used.
externals: Optional. a list of files which will be insert into the resule html. The file should be a valid url.
inject: Optional. indicate where to insert files， it can be 'head' or 'body'. For default, the css files will be inserted into <head> and the js files will be inserted into <body>.
defaultmode: Optional. specify a value to use in the script type attribute. If no mode is specified, the type attribute is omitted. Externals can optionally override this per file.

demo:

// rollup.config.js
import html from 'rollup-plugin-fill-html';

export default {
  entry: 'src/index.js',
  dest: 'dist/bundle.js',,
  plugins: [
    html({
      template: 'src/index.html',
      filename: 'index.html',
      externals: [
        // the type can be 'js' or 'css',
        // and you can pass a pos field to control the the position in which the file will be inserted.
        // the xxxx1.js will be inserted before the bundle,
        // and the xxxx2.js will be inserted after the bundle as default
        // you can set an `inject` field here to cover the outer `inject`
        { type: 'js', file: '//xxxx1.js', pos: 'before' },
        { type: 'js', file: '//xxxx2.js', mode: 'module' }
      ]
    })
  ]
};

then the dist/bundle.js will be inserted into the result file.

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme