Registry / web-framework / rollup-plugin-external-assets

rollup-plugin-external-assets

library4.1.1jsnpmunverified

A Rollup plugin that externalizes assets (e.g., images, fonts) so they are not bundled into the JavaScript output, but are still copied to the output directory with hashed filenames. Current stable version is 4.1.1, released April 2024. The plugin uses Rollup's asset emission system to handle deduplication and hashing. Key differentiators: it avoids bundling assets inline, preserving import paths as require() or dynamic imports pointing to the emitted asset files. It supports include/exclude patterns, custom resolve base directory, and works with static and dynamic imports. TypeScript types are included. Notable breaking changes in v4: switched to named export only (no default export) and changed the function signature.

web-framework devops

npm install rollup-plugin-external-assets

github ↗package ↗

INSTALL

IMPORT

SIG · ROLLUP-PLUGIN-EXTE

rollup-plugin-external-assets

web-frameworkjavascriptv4.1.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

externalAssets

✓ import { externalAssets } from 'rollup-plugin-external-assets'

✗ import externalAssets from 'rollup-plugin-external-assets'

v4 removed the default export; only named export 'externalAssets' is available.

externalAssets

✓ const { externalAssets } = require('rollup-plugin-external-assets')

✗ const externalAssets = require('rollup-plugin-external-assets')

CommonJS users must destructure the named export.

type ExternalAssetsOptions

✓ import type { ExternalAssetsOptions } from 'rollup-plugin-external-assets'

TypeScript users can import the options type for type safety.

Configures Rollup to externalize PNG and JPG files, copying them to the output directory with hashed names.

// rollup.config.js import { externalAssets } from 'rollup-plugin-external-assets'; export default { input: 'src/index.js', output: { dir: 'dist', format: 'cjs' }, plugins: [ externalAssets([ '**/*.png', '**/*.jpg' ]) ] }; // src/index.js import logo from './assets/logo.png'; console.log(logo); // './assets/logo-abc123.png'

Debug

Known issues

breakingv4 removed the default export. Import must use named export.

fix

Use `import { externalAssets } from 'rollup-plugin-external-assets'` instead of default import.

affects: >=4.0.0

breakingv4 changed the function signature. Options are now passed as a single argument (pattern or options object) instead of (include, exclude, options).

fix

Update plugin call: `externalAssets('assets/*')` or `externalAssets({ include: 'assets/*' })`.

affects: >=4.0.0

deprecatedv2 deprecated the old `options` parameter; use the new signature.

fix

Switch to the new function signature.

affects: >=2.0.0 <4.0.0

gotchaWindows paths can cause issues with pattern matching; ensure patterns use forward slashes.

fix

Use forward slashes in include/exclude patterns (e.g., 'assets/**/*.png').

affects: >=3.0.0

gotchaEmpty source map files may be emitted (issue #75) – fixed in 4.1.1.

fix

Upgrade to version 4.1.1 or later.

affects: <4.1.1

Errors

Common errors & fixes

Error: The plugin `rollup-plugin-external-assets` has no default export.

Trying to import the default export after upgrading to v4 (named export only).

fix

Use named import: `import { externalAssets } from 'rollup-plugin-external-assets'`.

TypeError: externalAssets is not a function

Loaded a different version or wrong import style; e.g., using `const externalAssets = require(...)` without destructuring.

fix

Use `const { externalAssets } = require('rollup-plugin-external-assets')`.

ENOENT: no such file or directory, open 'path/to/non-normalized\windows\path.png'

Non-normalized Windows paths in patterns or resolve option (issue fixed in v3.0.0).

fix

Use forward slashes in all patterns and resolve paths, or upgrade to v3.0.0+.

Upgrade

Version history

4.1.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/recursive-beast/rollup-plugin-external-assets ↗

packagehttps://www.npmjs.com/package/rollup-plugin-external-assets ↗