rollup-plugin-sbom weekly downloads statistics

rollup-plugin-sbom

Create SBOMs _(Software Bill of Materials)_ in CycloneDX format for your Vite and Rollup projects, including only the software you're really shipping to production.

A “software bill of materials” (SBOM) has emerged as a key building block in software security and software supply chain risk management. A SBOM is a nested inventory, a list of ingredients that make up software components.

– CISA (.gov) [full article]

Documentation

• Requirements and compatibility • Installation • Usage guide • Usage with Vite • Usage with Rollup • Usage with Rolldown • Configuration options and defaults • Debugging • Sequence chart • Contributing • Contribution workflow • Make your first contribution • Contributors

Requirements and Compatibility

| Plugin | Vite | Rollup | Rolldown | Node (latest LTS) | CDX Spec |

| v1 | 4, 5 | 3, 4 | - | 18, 20 | 1.5 | | v2 | 4, 5, 6 | 3, 4 | - | 18, 20, 22 | 1.6 | | v3 | 5, 6, 7, 8 | 4 | 1 | 20, 22, 24 | 1.6 | | v4 | 6, 7, 8 | 4 | 1 | 22, 24, 26 | 1.7 |

We're always supporting LTS Node.js versions and versions which still have security support. Plugin support will be dropped once a Node.js version reaches its final EOL.

[!NOTE] We currently support both CommonJS and ESM formats for now. We strongly recommend using the ESM format instead of CommonJS. The ESM format is compatible with modern platforms and runtimes, and most new libraries are now distributed only in ESM format. Learn more at https://nodejs.org/en/learn/modules/publishing-a-package#how-did-we-get-here

Installation

You can install the plugin via NPM with your favorite package manager:

Usage

Usage with Vite

Usage with Rollup

Usage with Rolldown

Configuration Options

| Name | Default | Description |

| specVersion | 1.7 | The CycloneDX specification version to use | | rootComponentType | application | The root component type, can be library or application | | outDir | cyclonedx | The output directory where the BOM file will be saved. | | outFilename | bom | The base filename for the SBOM files. | | outFormats | ['json'] | The formats to output. Can be any of json and xml (note: xml requires xmlbuilder2). | | saveTimestamp | true | Whether to save the timestamp in the BOM metadata. | | autodetect | true | Whether to get the root package registered automatically. | | generateSerial | false | Whether to generate a serial number for the BOM. | | includeWellKnown | true | Whether to generate a SBOM in the well-known directory. | | supplier | - | Provide organizational entity information | | beforeCollect | - | Enhance the BOM before before collecting dependencies | | afterCollect | - | Transform the BOM before after collecting dependencies |

Optional Peer Dependencies

Some features require optional peer dependencies — see package.json for version details.

• Serialization to XML on Node.js requires any of: • xmlbuilder2

Debugging

This plugin added debug logs to gather information about how your SBOM is built so you can understand why which dependency was added to the graph. To enable debugging, you can set the logLevel option to "debug".

Example output from our test fixture "resolution"

General advice on when and how to read the debug information:

• Find out which tools are registered (Registering tool ) • Find out which generated bundles are analyzed (Processing generated module ) • Check analyzed third party modules and their tree (Processing (imported by - depends on ))

Sequence chart

Contributing

The main purpose of this repository is to continue evolving the plugin, making it faster and easier to use. We are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving the plugin.

Workflow

1. Fork the repository to your personal account 2. Ensure that all tests succeed (pnpm build-fixtures & pnpm test) 3. Propose changes within a PR to the original repository and write down the information required by the pull request template 4. Wait for an approval for running the required workflow checks and a code-review from one of the maintainers

Good First Issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.

Contributors

Thanks goes to these wonderful people (emoji key):

Jan R. Biasi 💼 💬 🧑‍🏫 💻 Jan Kott 💻 🤔 🖋 xenobytezero 🐛 💻 DesselBane 🐛 Vinícius Goulart 🚧 PrettyCoffee 🚇

Sponsors

License

The plugin is licensed under MIT License

Description from the npm listing.