npmpackage.info

Gathering detailed insights and metrics for @rollup/plugin-html

Other packages similar to @rollup/plugin-html

@web/rollup-plugin-html

2.3.0

Rollup plugin for bundling HTML files

rollup-plugin-html

0.2.1

HTML import plugin for rollup

rollup-plugin-minify-html-literals

1.2.6

Rollup plugin to minify HTML template literal strings

rollup-plugin-generate-html-template

1.7.0

Rollup plugin for automatically injecting a script tag with the final bundle into an html file.

Gathering detailed insights and metrics for @rollup/plugin-html

@rollup/plugin-html - 1.1.0 | npmpackage.info

@rollup/plugin-html

🍣 The one-stop shop for official Rollup plugins

1.1.0

3,713

MIT

JavaScript

19.17 kB

3.9

Installations

npm install @rollup/plugin-html

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=14.0.0

Node Version

20.18.1

NPM Version

10.8.2 Pull Requests

Open

9

Total

757

Closed

186

Merged

562

Issues

Open

21

Total

1,033

Closed

1,012

Releases

Unable to fetch releases

Languages

JavaScript

TypeScript

Shell

JavaScript (75.16%)

TypeScript (24.83%)

Shell (0.01%)

Developer

rollup

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

3,713 Stars

1,228 Commits

604 Forks

35 Watchers

6 Branches

270 Contributors

Updated on Jul 10, 2025

Maintainers

View All 270 Contributors

Package Meta Information

Latest Version

1.1.0

Package Id

@rollup/plugin-html@1.1.0

Unpacked Size

19.17 kB

Size

5.19 kB

File Count

NPM Version

10.8.2

Node Version

20.18.1

Published on

Dec 15, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

rollup

Dev Dependencies

@rollup/plugin-typescript postcss rollup rollup-plugin-postcss typescript

@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:

1npm install @rollup/plugin-html --save-dev

Usage

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

1const html = require('@rollup/plugin-html');
2
3module.exports = {
4  input: 'src/index.js',
5  output: {
6    dir: 'output',
7    format: 'cjs'
8  },
9  plugins: [html()]
10};

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

`addScriptsToHead`

Type: Boolean
Default: false

Place scripts in the <head> tag instead of <body>.

`attributes`

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.

`fileName`

Type: String
Default: 'index.html'

`meta`

Type: Array[...object]
Default: [{ charset: 'utf-8' }]

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

Specifies the name of the HTML to emit.

`publicPath`

Type: String
Default: ''

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

`template`

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:

1const 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:

1<!DOCTYPE html>
2<html ${attributes}>
3  <head>
4    ${metas}
5    <title>${title}</title>
6    ${links}
7  </head>
8  <body>
9    ${scripts}
10  </body>
11</html>

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

`title`

Type: String
Default: 'Rollup Bundle'

Specifies the HTML document title.

Exports

`makeHtmlAttributes(attributes)`

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.

1const { makeHtmlAttributes } = require('@rollup/plugin-html');
2
3makeHtmlAttributes({ lang: 'en', 'data-batcave': 'secret' });
4// -> '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.

`amd`

Will likely require use of RequireJS semantics, which allows only for a single entry <script> tag. If more entry chunks are emitted, these need to be loaded via a proxy file. RequireJS would also need to be a dependency and added to the build: https://requirejs.org/docs/start.html.

`system`

Would require a separate <script> tag first that adds the s.js minimal loader. Loading modules might then resemble: <script>System.import('./batman.js')</script>.

Attribution

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

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

7

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node-windows.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/node-windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node-windows.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/node-windows.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/node-windows.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/node-windows.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-title.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/pr-title.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/validate.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/validate.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/validate.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/validate.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/plugins/validate.yml/master?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.9

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More