rollup-plugin-dep-inject
v0.2.6
Published
A rollup plugin that uses your externally defined modules and injects their unpkg cdn equivalent into an index entry file.
Downloads
22
Maintainers
sisselReadme
rollup-plugin-dep-inject
A rollup plugin that will use your external defined modules and inject their unpkg CDN equivalents as script tags into a custom defined entry index file. The benifits here are that Rollup will skip bundling heavy dependencies that you might be using, which in turn will speed up your bundle times.
Why not just code split?
You can, but even with code splitting, Rollup is still processing your dependencies. This plugin will be exceptionally helpful when you're working on a web project that uses a large amount of external depenedencies.
Install
yarn add rollup-plugin-dep-inject --dev
Example
import depInject from 'rollup-plugin-dep-inject'
export default {
input: 'src/app.js',
external: ['lodash', 'bss', 'mithril', 'turbolinks'],
output: [
{
file: 'dist/app.bundle.js',
format: 'iife',
name: 'App',
sourcemap: true,
globals: {
lodash: '_',
bss: 'b',
mithril: 'm',
turbolinks: 'Turbolinks'
}
}
],
plugins: [
depInject({
index: 'dist/index.html'
})
]
}
Options
| Option | Type | Description |
|--|--|--|
| index | String | Relative path to the projects entry index file. |
| attrs | String | Attributes apply to <script> tags. |
| ignore | Array | External listed module IDs to ignore. |
| remove | Boolean | When set to true will remove any injected dependencies in file |
| unpkg | Object | Retrieve specific reference using a unpkg-uri pattern. |
| custom | Object | Use a custom url reference to a module. |
Both the
unpkgandcustomoptions accept a comma-separate list ofmoduleID:Referencepairs.
unpkg-uri
The plugin leverages unpkg-uri when generating the unpkg CDN module equivalents. The unpkg option accepts unpkg-uri pattern values which allows you to retrieve specified references within a modules package.
| Value | Returns |
|--|--|
| [min.js] | https://unpkg.com/[email protected]/lib/index.min.js
| |file.json | https://unpkg.com/[email protected]/lib/file.json
| /package.json | https://unpkg.com/[email protected]/package.json
| @1.2.3 | https://unpkg.com/[email protected]/lib/index.js
| @prefix/ | https://unpkg.com/@prefix/[email protected]/lib/index.js
Usage
By default all external modules listed in rollup.config.js files will be injected and use the version numbers sourced from your projects package.json file. The unpkg uri will be generated automatically.
Below is a usage example with custom configuration:
depInject({
index: 'dist/index.html', // inject modules into this file
attrs: 'defer', // add a 'defer' attribute to each generated script tag
ignore: ['lodash'], // do not inject the 'lodash' module
unpkg: {
// leverage unpkg-uri pattern and retrive the minified version of bss
bss: '[min.js]'
},
custom: {
// use a custom CDN reference for the 'mithril' module external
mithril:
'https://cdnjs.cloudflare.com/ajax/libs/mithril/1.1.6/mithril.min.js'
}
})
The above configuration would write the following to the entry index defined file:
<!-- dist/index.html -->
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
<!--dep-inject-->
<script src="https://unpkg.com/[email protected]/bss.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mithril/1.1.6/mithril.min.js" defer></script>
<script src="https://unpkg.com/[email protected]/dist/turbolinks.js" defer></script>
<!--dep-inject-->
<script src="bundle.test.js"></script>
</head>
<body>
<div class="test">
<h1>Hello World</h1>
</div>
</body>
</html>
The injectected dependencies in this example reflect the options defined within the plugin configuration:
- The script tags contain
deferattributes - Lodash was ignored
- BSS uses the minified version
- Mithril is using the custom CDN address.
Removing injections
You can remove injections by passing a truthy to the remove option which will detect and remove any injected <script> dependencies from the index file. This is helpful when you are building in different environments and may want development or production version scripts, where in development you inject but in production you bundle.
How it works?
The plugin uses your bundles external: [] modules and cross-references them with your projects package.json dependencies. The name and version number is used to generate <script src=""> tags that reference the modules unpkg uri equivalent cdn address. The generated script tag modules are then injected into the entry index file that was defined in the plugin options.
Changelog
Please see changelog for more information what has changed recently.
License
The MIT License (MIT). Please see License File for more information.