[npm]: https://img.shields.io/npm/v/@rollup/plugin-html
[npm-url]: https://www.npmjs.com/package/@rollup/plugin-html
[size]: https://packagephobia.now.sh/badge?p=@rollup/plugin-html
[size-url]: https://packagephobia.now.sh/result?p=@rollup/plugin-html

[![npm][npm]][npm-url]
[![size][size]][size-url]

@rollup/plugin-html

🍣 A Rollup plugin which creates HTML files to serve Rollup bundles.

Please see Supported Output Formats for information about using this plugin with output formats other than esm (es), iife, and umd.

Requirements

This plugin requires an LTS Node version (v14.0.0+) and Rollup v1.20.0+.

Install

Using npm:

``console
npm install @rollup/plugin-html --save-dev
`

Usage

Create a rollup.config.js configuration file and import the plugin:

`js
const html = require('@rollup/plugin-html');

module.exports = {
input: 'src/index.js',
output: {
dir: 'output',
format: 'cjs'
},
plugins: [html()]
};
`

Then call rollup either via the CLI or the API.

Once run successfully, an HTML file should be written to the bundle output destination.

Options

$3

Type: Boolean

Default: false

Place scripts in the tag instead of .

$3

Type: Object

Default: { html: { lang: 'en' }, link: null, script: null }

Specifies additional attributes for html, link, and script elements. For each property, provide an object with key-value pairs that represent an HTML element attribute name and value. By default, the html element is rendered with an attribute of lang="en".

_Note: If using the es / esm output format, { type: 'module'} is automatically added to attributes.script._

$3

Type: String

Default: 'index.html'

$3

Type: Array[...object]

Default: [{ charset: 'utf-8' }]

Specifies attributes used to create elements. For each array item, provide an object with key-value pairs that represent element attribute names and values.

Specifies the name of the HTML to emit.

$3

Type: String

Default: ''

Specifies a path to prepend to all bundle assets (files) in the HTML output.

$3

Type: Function

Default: internal function
Returns: String

Specifies a function that provides the rendered source for the HTML output. The function should be in the form of:

`js
const template = ({ attributes, bundle, files, publicPath, title }) => { ... }
`

- attributes: Corresponds to the attributes option passed to the plugin
- bundle: An Object containing key-value pairs of AssetInfo or ChunkInfo
- files: An Array of AssetInfo or ChunkInfo containing any entry (isEntry: true) files, and any asset (isAsset: true) files in the bundle that will be emitted
- publicPath: Corresponds to the publicPath option passed to the plugin
- title: Corresponds to the title option passed to the plugin

By default this is handled internally and produces HTML in the following format:

`html



${metas}

${links}


${scripts}


`

Where ${links} represents all tags for CSS and ${scripts} represents all tags for JavaScript files.

$3

Type: String

Default: 'Rollup Bundle'

Specifies the HTML document title.

Exports

$3

Parameters: attributes, Type: Object

Returns: String

Consumes an object with key-value pairs that represent an HTML element attribute name and value. The function returns all pairs as a space-separated string of valid HTML element attributes. e.g.

`js
const { makeHtmlAttributes } = require('@rollup/plugin-html');

makeHtmlAttributes({ lang: 'en', 'data-batcave': 'secret' });
// -> 'lang="en" data-batcave="secret"'
`

Supported Output Formats

By default, this plugin supports the esm (es), iife, and umd output formats, as those are most commonly used as browser bundles. Other formats can be used, but will require using the template option to specify a custom template function which renders the unique requirements of other formats.

$3

Will likely require use of RequireJS semantics, which allows only for a single entry `.

Attribution

This plugin was inspired by and is based upon mini-html-webpack-plugin by Juho Vepsäläinen and Artem Sapegin, with permission.

Meta

CONTRIBUTING

LICENSE (MIT)