https://github.com/leogr/rollup-plugin-html-entry

Use HTML files as entry points in your rollup bundle.
https://github.com/leogr/rollup-plugin-html-entry

bundle html-imports rollup-plugin webcomponents

Last synced: 25 days ago
JSON representation

Use HTML files as entry points in your rollup bundle.

• Host: GitHub
• URL: https://github.com/leogr/rollup-plugin-html-entry
• Owner: leogr
• License: mit
• Archived: true
• Created: 2017-03-09T18:49:22.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T21:54:10.000Z (almost 3 years ago)
• Last Synced: 2024-11-07T12:53:25.165Z (about 1 month ago)
• Topics: bundle, html-imports, rollup-plugin, webcomponents
• Language: JavaScript
• Homepage:
• Size: 655 KB
• Stars: 13
• Watchers: 4
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - html-entry

README

        
[![Build Status](https://img.shields.io/travis/leogr/rollup-plugin-html-entry.svg?style=flat-square)](https://travis-ci.org/leogr/rollup-plugin-html-entry)

# rollup-plugin-html-entry

Use HTML files as entry points in your [rollup](https://github.com/rollup/rollup) bundle.

HTML files and [HTML imports](https://www.w3.org/TR/html-imports/) will be traversed, then all scripts found will be combined.

Optionally, write HTML files cleaned of ``s.

This is particularly useful for [web components](https://www.webcomponents.org/introduction) and web applications in general.

```html

<!-- 0.html -->

<script>export const zero = 0;

```

```html

export const one = 1;

```

```html

```

```js

// 2.js

export const two = 2;

```

```html

```

Using `all-imports.html` as entry point will yield a bundle with exports for `zero`, `one`, and `two`.

So, this plugin works like [rollup-plugin-multi-entry](https://github.com/rollup/rollup-plugin-multi-entry) does, but using ``s contained in HTML files as entry points.

## Install

```

$ npm install [--save-dev] rollup-plugin-html-entry

```

## Usage

This plugin requires at least v0.48.0 of rollup. In `rollup.config.js`:

```js

import htmlEntry from 'rollup-plugin-html-entry';

export default {

  input: 'test/**/*.html',

  plugins: [htmlEntry()]

};

```

The `input` above is the simplest form which simply takes a glob string.

You may pass an array of glob strings or an object with one or more of the following options:

```js

export default {

  input: {

    // Arrays of globs to include

    include: ['index.html', 'and/globs/**/*.html'],

    // Arrays of globs to exclude

    exclude: ['excluded-file.html', 'and/globs/*.to.be.excluded.html'],

    // Arrays of globs that should remain external to the bundle

    external: ['lazy-imports.html', 'and/globs/*.to.be.omitted.html']

  }

  // ...

};

```

By default HTML files will be not written. If `output` option is present, HTML files stripped of `<script>`s will be written into specified path.

```js

export default {

  input: 'index.html',

  plugins: [htmlEntry({ output: "build" })]

  // ...

};

```

Finally, you may not need to export anything from the rolled-up bundle for web applications. In

such cases, use the `exports: false` option like so:

```js

export default {

  input: 'index.html',

  plugins: [htmlEntry({ exports: false })]

};

```

## License

MIT