npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cyclonedx/webpack-plugin

v3.15.0

Published

Creates CycloneDX Software Bill of Materials (SBoM) from webpack projects

Downloads

79,290

Readme

CycloneDX webpack plugin

shield_npm-version shield_gh-workflow-test shield_coverage shield_ossf-best-practices shield_license
shield_website shield_slack shield_groups shield_twitter-follow


This plugin for webpack creates a CycloneDX Software Bill of Materials (SBoM) containing an aggregate of all bundled dependencies.
This plugin uses the linkages generated by webpack to create a dependency graph which only contain the dependencies that are actually used (after tree-shaking).

Requirements

  • Node.js >= 14
  • webpack ^5

However, there are older versions of this plugin, that support

  • Node.js v8.0.0 or higher
  • webpack v4.0.0 or higher

Installing

npm i -D @cyclonedx/webpack-plugin
yarn add -D @cyclonedx/webpack-plugin

Usage

new CycloneDxWebpackPlugin(options?: object)

Options & Configuration

| Name | Type | Default | Description | |:-----|:----:|:-------:|:------------| | specVersion | {string}one of: "1.2", "1.3", "1.4", "1.5", "1.6" | "1.4" | Which version of CycloneDX-spec to use. Supported values depend on the installed dependency CycloneDX-javascript-library. | | reproducibleResults | {boolean} | false | Whether to go the extra mile and make the output reproducible. Reproducibility might result in loss of time- and random-based-values. | | validateResults | {boolean} | true | Whether to validate the BOM result.Validation is skipped, if requirements not met. Requires transitive optional dependencies. | | outputLocation | {string} | "./cyclonedx" | Path to write the output to. The path is relative to webpack's overall output path. | | includeWellknown | {boolean} | true | Whether to write the Wellknowns. | | wellknownLocation | {string} | "./.well-known" | Path to write the Wellknowns to. The path is relative to webpack's overall output path. | | rootComponentAutodetect | {boolean} | true | Whether to try auto-detection of the RootComponent. Tries to find the nearest package.json and build a CycloneDX component from it, so it can be assigned to bom.metadata.component. | | rootComponentType | {string} | "application" | Set the RootComponent's type.See the list of valid values. Supported values depend on CycloneDX-javascript-library's enum ComponentType. | | rootComponentName | optional {string} | undefined | If rootComponentAutodetect is disabled, then this value is assumed as the "name" of the package.json. | | rootComponentVersion | optional {string} | undefined | If rootComponentAutodetect is disabled, then this value is assumed as the "version" of the package.json. | | collectEvidence | {boolean} | false | Whether to collect (license) evidence and attach them to the resulting SBOM. |

Example

In your webpack config add the CycloneDX plugin:

const { CycloneDxWebpackPlugin } = require('@cyclonedx/webpack-plugin');

/** @type {import('@cyclonedx/webpack-plugin').CycloneDxWebpackPluginOptions} */
const cycloneDxWebpackPluginOptions = {
  specVersion: '1.6',
  outputLocation: './bom'
}

module.exports = {
  // ...
  plugins: [
    new CycloneDxWebpackPlugin(cycloneDxWebpackPluginOptions)
  ]
}

See extended examples.

Support for IETF /.well-known/sbom

The CycloneDX webpack plugin supports placing the CycloneDX SBOM in a pre-defined location, specifically in /.well-known/sbom. This option is enabled by default. The behavior can be changed by overriding the values of includeWellknown and wellknownLocation.
See draft-ietf-opsawg-sbom-access for more information on the specification, currently an IETF draft.

In your webpack config add the CycloneDX plugin:

const { CycloneDxWebpackPlugin } = require('@cyclonedx/webpack-plugin');

/** @type {import('@cyclonedx/webpack-plugin').CycloneDxWebpackPluginOptions} */
const cycloneDxWebpackPluginOptions = {
  includeWellknown: true,
  wellknownLocation: './.well-known'
}

module.exports = {
  // ...
  plugins: [
    new CycloneDxWebpackPlugin(cycloneDxWebpackPluginOptions)
  ]
}

Use with Angular

Angular uses webpack under the hood. Therefore, it is possible to integrate this plugin by utilizing @angular-builders/custom-webpack.
See an example here: integration with Angular17/webpack5.

Use with React

React uses webpack under the hood. Therefore, it is possible to integrate this plugin.
See an example here: integration with React18/webpack5.

Internals

This webpack plugin utilizes the CycloneDX library to generate the actual data structures.

Besides the class CycloneDxWebpackPlugin and the interface CycloneDxWebpackPluginOptions,
this webpack plugin does not expose any additional public API or classes - all code is intended to be internal and might change without any notice during version upgrades.

Development & Contributing

Feel free to open issues, bugreports or pull requests.
See the CONTRIBUTING file for details.

License

Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
See the LICENSE file for the full license.