diff --git a/.all-contributorsrc b/.all-contributorsrc index df3a851..d517548 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,40 +1,29 @@ { - "files": [ - "README.md" - ], - "imageSize": 100, - "commit": false, - "commitType": "docs", - "commitConvention": "angular", - "contributors": [ - { - "login": "boostvolt", - "name": "Jan Kott", - "avatar_url": "https://avatars.githubusercontent.com/u/51777660?v=4", - "profile": "https://github.com/boostvolt", - "contributions": [ - "code", - "ideas", - "content" - ] - }, - { - "login": "janbiasi", - "name": "Jan R. Biasi", - "avatar_url": "https://avatars.githubusercontent.com/u/4563751?v=4", - "profile": "https://github.com/janbiasi", - "contributions": [ - "business", - "code", - "ideas", - "content" - ] - } - ], - "contributorsPerLine": 7, - "skipCi": true, - "repoType": "github", - "repoHost": "https://github.com", - "projectName": "rollup-plugin-sbom", - "projectOwner": "janbiasi" + "files": ["README.md"], + "imageSize": 100, + "commit": false, + "commitType": "docs", + "commitConvention": "angular", + "contributors": [ + { + "login": "janbiasi", + "name": "Jan R. Biasi", + "avatar_url": "https://avatars.githubusercontent.com/u/4563751?v=4", + "profile": "https://github.com/janbiasi", + "contributions": ["business", "question", "mentoring", "code"] + }, + { + "login": "boostvolt", + "name": "Jan Kott", + "avatar_url": "https://avatars.githubusercontent.com/u/51777660?v=4", + "profile": "https://github.com/boostvolt", + "contributions": ["code", "ideas", "content"] + } + ], + "contributorsPerLine": 7, + "skipCi": true, + "repoType": "github", + "repoHost": "https://github.com", + "projectName": "rollup-plugin-sbom", + "projectOwner": "janbiasi" } diff --git a/.prettierignore b/.prettierignore index b7bca6e..dda3cdd 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,2 +1,3 @@ pnpm-lock.yaml +.all-contributorsrc test diff --git a/README.md b/README.md index acc098c..139a466 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,50 @@ > This plugin is still in early development and not production ready just yet. Use with caution! > You can check the current progress via [Milestone - V1](https://github.com/janbiasi/rollup-plugin-sbom/milestone/1). -![npm](https://img.shields.io/npm/v/rollup-plugin-sbom) +[![CI](https://github.com/janbiasi/rollup-plugin-sbom/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/janbiasi/rollup-plugin-sbom/actions/workflows/ci.yml) ![npm](https://img.shields.io/npm/v/rollup-plugin-sbom) ![npm type definitions](https://img.shields.io/npm/types/rollup-plugin-sbom) ![npm peer dependency version (scoped)](https://img.shields.io/npm/dependency-version/rollup-plugin-sbom/peer/rollup?logo=rollupdotjs&color=%23EA483F) # rollup-plugin-sbom -Create SBOMs for your Vite or Rollup projects. +Create [SBOMs]() _(Software Bill of Materials)_ in [CycloneDX](https://cyclonedx.org/) format for your [Vite](https://vitejs.dev/) and [Rollup](https://rollupjs.org/) projects, including only the software you're really shipping to production. -### Compatibility +> 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)](https://www.cisa.gov) [[full article](https://www.cisa.gov/sbom)] -| Plugin | Vite | Rollup | -| ------ | ------ | ------ | -| v1 | v4, v5 | v3, v4 | +##### Content -### Installation and usage +- [Requirements and Compatibility](#requirements-and-compatibility) +- [Installation](#installation) +- [Usage](#usage) + - [Usage with Vite](#usage-with-vite) + - [Usage with Rollup](#usage-with-rollup) + - [Configuration Options](#configuration-options) +- [Contributors](#contributors) + +--- + +### Requirements and Compatibility + +| Plugin | Vite | Rollup | Node | +| ------ | ------ | ------ | ------ | +| v1 | v4, v5 | v3, v4 | 18, 20 | + +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. + +### Installation ```sh npm install --save-dev rollup-plugin-sbom +pnpm install -D rollup-plugin-sbom +yarn add --dev rollup-plugin-sbom ``` +### Usage + +#### Usage with [Vite](https://vitejs.dev/) + ```ts import { defineConfig } from "vite"; import sbom from "rollup-plugin-sbom"; @@ -31,7 +55,17 @@ export default defineConfig({ }); ``` -### Options +#### Usage with [Rollup](https://rollupjs.org/) + +```js +import sbom from "rollup-plugin-sbom"; + +export default { + plugins: [sbom()], +}; +``` + +#### Configuration Options | Name | Default | Description | | ------------------- | ----------------- | ---------------------------------------------------------- | @@ -55,8 +89,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
Jan R. Biasi ๐ผ ๐ฌ ๐งโ๐ซ ๐ป |
Jan Kott ๐ป ๐ค ๐ |
- Jan R. Biasi ๐ผ ๐ป ๐ค ๐ |