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
muslnode 18–223 runs
build_error
glibcnode 18–223 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
rollupPluginSbom
✓ import { rollupPluginSbom } from 'rollup-plugin-sbom'
✗ const rollupPluginSbom = require('rollup-plugin-sbom')
ESM-only package; CommonJS require not supported.
default export
✓ import rollupPluginSbom from 'rollup-plugin-sbom'
✗ import { default as rollupPluginSbom } from 'rollup-plugin-sbom'
Named export also works; default export is the same function.
vitePluginSbom
✓ import { vitePluginSbom } from 'rollup-plugin-sbom'
✗ import { vitePluginSbom } from 'rollup-plugin-sbom/vite'
Exported from main entry; no separate subpath.
Configures rollup-plugin-sbom in a Vite project to generate CycloneDX JSON and SPDX JSON SBOMs.
import { rollupPluginSbom } from 'rollup-plugin-sbom';
import { defineConfig } from 'vite';
export default defineConfig({
plugins: [
rollupPluginSbom({
format: ['cyclonedx-json', 'spdx-json'],
outputDir: './sbom',
encoding: 'utf-8',
includeDev: false,
globals: {
componentName: 'my-app',
componentVersion: '1.0.0',
supplier: 'Example Corp'
}
})
]
});
Errors
Common errors & fixes
ERR_REQUIRE_ESM: require() of ES Module not supported
Using CommonJS require() on an ESM-only package.
fixUse import syntax or dynamic import().
Error: The SBOM plugin requires Node.js version >=20.19.0. Current version: <...>
Node version too low.
fixUpgrade Node to 20.19.0 or later.
TypeError: rollupPluginSbom is not a function
Incorrect import (maybe default vs named) or using old version without named export.
fixEnsure import { rollupPluginSbom } from 'rollup-plugin-sbom'. Audit
Dependencies
viteoptionalPeer dependency for Vite integration
rollupoptionalPeer dependency for Rollup integration
xmlbuilder2requiredUsed for XML SBOM output format