Registry / web-framework / rollup-plugin-svg-sprite-deterministic

rollup-plugin-svg-sprite-deterministic

library2.0.0jsnpmunverified

A Rollup plugin that creates deterministic external SVG sprite files from imported SVG files, with optimization via SVGO. Current stable version 2.0.0 (Node >=12). This fork of rollup-plugin-svg-sprite ensures repeatable builds by fixing non-deterministic output (e.g., SVG IDs, ordering). Released as needed. Key differentiators: deterministic builds vs original plugin, optional minification, configurable output folder.

web-framework

npm install rollup-plugin-svg-sprite-deterministic

github ↗package ↗

INSTALL

IMPORT

SIG · ROLLUP-PLUGIN-SVG-

rollup-plugin-svg-sprite-deterministic

web-frameworkjavascriptv2.0.0

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.

default export

✓ import svgSprite from 'rollup-plugin-svg-sprite-deterministic'

✗ const svgSprite = require('rollup-plugin-svg-sprite-deterministic')

Plugin is ESM-only; CommonJS require() will fail unless using dynamic import or bundler that handles ESM.

named export

✓ import { svgSprite } from 'rollup-plugin-svg-sprite-deterministic'

✗ import svgSprite from 'rollup-plugin-svg-sprite-deterministic'

Version 2.0.0 exports both default and named; using named import requires destructuring correctly.

TypeScript types

✓ import type { RollupPluginSvgSpriteOptions } from 'rollup-plugin-svg-sprite-deterministic'

Types are not shipped with the package; you must install @types/rollup-plugin-svg-sprite-deterministic if available or declare manually.

Configures Rollup to create a deterministic SVG sprite from imported SVG files.

// rollup.config.js import svgSprite from 'rollup-plugin-svg-sprite-deterministic' export default { input: 'src/index.js', output: { file: 'dist/app.js', format: 'iife' }, plugins: [ svgSprite({ outputFolder: 'dist/public' }) ] } // src/index.js import './svg/trash.svg' import './svg/user.svg'

Debug

Known issues

breakingVersion 2.x changes the default output behavior: sprite file name may differ from 1.x, and options have been reorganized. See pull request #1.

fix

Review configuration options and adjust output folder accordingly. If migrating from 1.x, test output sprite names.

affects: >=2.0.0

deprecatedThe 'minify' option defaults to true but SVGO configuration is not customizable in current version. This may change in future releases.

fix

If you need custom SVGO options, consider using a separate SVGO plugin after sprite generation, or watch for future updates.

affects: <=2.0.0

gotchaPlugin is ESM-only and cannot be required() with CommonJS. Using require() in a Node.js script will throw an error.

fix

Use dynamic import: const svgSprite = (await import('rollup-plugin-svg-sprite-deterministic')).default

affects: >=2.0.0

gotchaSVG sprite output is deterministic only when the same set of SVGs is imported in the same order across builds. If file ordering changes (e.g., due to glob resolution), sprite may differ.

fix

Ensure consistent import order, e.g., by explicitly listing files or using a deterministic glob plugin.

affects: all

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module

Using CommonJS require() to import an ESM-only module.

fix

Change to dynamic import: const svgSprite = (await import('rollup-plugin-svg-sprite-deterministic')).default

TypeError: svgSprite is not a function

Incorrect import pattern (named vs default) or missing parentheses.

fix

Ensure correct import: import svgSprite from 'rollup-plugin-svg-sprite-deterministic'

Error: Could not resolve 'rollup-plugin-svg-sprite-deterministic'

Package not installed or not in node_modules.

fix

Run npm install rollup-plugin-svg-sprite-deterministic -D

Upgrade

Version history

2.0.0latest on npm

Audit

Dependencies

rolluprequiredpeer dependency - requires Rollup to function

svgooptionalused for SVG minification

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/mhassan1/rollup-plugin-svg-sprite ↗

packagehttps://www.npmjs.com/package/rollup-plugin-svg-sprite-deterministic ↗