rollup-plugin-external-assets

rollup-plugin-external-assets

A rollup plugin to make assets external but include them in the output.

:warning: This plugin was only tested for static imports :warning:

Installation

Via npm

npm install --save-dev rollup-plugin-external-assets

Via yarn

yarn add -D rollup-plugin-external-assets

Usage

import nodeResolve from "@rollup/plugin-node-resolve";
import externalAssets from "rollup-plugin-external-assets";

export default {
	input: "src/index.js",
	output: {
		file: "dist/index.js",
		format: "es",
		sourcemap: true,
	},
	plugins: [
		nodeResolve(),
		externalAssets("assets/*.png"),
	],
};

API

function externalAssets(pattern: string | RegExp | (string | RegExp)[]);

pattern

string | RegExp | (string | RegExp)[]

A picomatch pattern, or array of patterns, which correspond to assets the plugin should operate on.

// Process imports that reference images in the <working dir>/assets directory.
externalAssets("assets/**/*.jpg");
// Process imports that reference images in the <working dir>/assets directory, and all stylesheet files.
externalAssets(["assets/**/*.{jpg,png}", /\.(css|scss)$/])

Contributing

Prerequisites

• nodejs
• npm

Getting Started

After cloning this repo, ensure dependencies are installed by running:

npm install

Then to build the final bundle:

npm run build

Tests

:warning: This plugin was only tested for static imports :warning:

To run tests:

npm test

Note that rollup may emit warnings for unspecified options, or for some other reasons. I made sure they are ignored with the no-rollup-warnings flag in the npm test script.

If you want to see all the warnings when running tests, use this command instead:

npm run test:warn

Coverage report is located in tests/coverage. You might want to review it in your browser, and for example, write tests for non-covered blocks, or remove them if they're useless.

To run tests and update snapshots:

npm run test:update

or (with rollup warnings):

npm run test:update:warn

Commiting changes

Please follow the conventional commits specification, because semantic-release is used to automate the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.

License

MIT

Changelog

2.0.0 (2021-03-03)

Bug Fixes

• inconsistant hash in the load hook (da51590)

Features

• added support for watch mode (f080246)

BREAKING CHANGES

• The options parameter is now deprecated, the reason is that exclude and include do not make sense when importing the same asset from both excluded and included modules