|
11 | 11 | # CycloneDX BOM |
12 | 12 |
|
13 | 13 | This is a so-called **meta-package**, it does not ship any own functionality, but it is a collection of optional dependencies. |
14 | | -This package's dependencies are tools with one purpose in common: |
15 | | -generate _[CycloneDX][link_website]_ Software Bill-of-Materials (SBOM) from _node_-based projects. |
| 14 | +This package's dependencies are tools* with one purpose in common: |
| 15 | +generate _[CycloneDX][link_website]_ Software-Bill-of-Materials (SBOM) from _node_-based projects. |
16 | 16 |
|
17 | 17 | | ecosystem | actual tool | |
18 | 18 | |:---------:|:------------| |
19 | | -| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/@cyclonedx/cyclonedx-npm) | |
20 | | -| _yarn_ | to be announced, suggestions welcome <!-- maybe https://github.com/CycloneDX/cyclonedx-node-yarn --> | |
21 | | -| _pnpm_ | to be announced, suggestions welcome <!-- maybe https://github.com/CycloneDX/cyclonedx-node-pnpm --> | |
| 19 | +| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/@cyclonedx/cyclonedx-npm) | |
| 20 | +| _pnpm_ | To be announced, suggestions welcome. <br/> Candidate: [cyclonedx-node-pnpm](https://github.com/CycloneDX/cyclonedx-node-pnpm) | |
22 | 21 |
|
23 | | -You should not depend on this very meta-package, instead depend on the actual tool that fits your specific ecosystem. |
| 22 | +*) You should not depend on this very meta-package, instead depend on the actual tool that fits your specific (eco)system. |
24 | 23 |
|
25 | | -## Out of Scope |
26 | | - |
27 | | -There are ecosystems, that are not node-based, but use node as a runtime/compiler environment. |
28 | | -These ecosystems are out of scope. Therefore, the following packages are not part of this very meta-package. |
| 24 | +In addition, there are some tools to mention, that are not installable as a dependency (yet) but require other/manual methods of installation. |
29 | 25 |
|
30 | 26 | | ecosystem | actual tool | |
31 | 27 | |:---------:|:------------| |
| 28 | +| _yarn_ | [@cyclonedx/yarn-plugin-cyclonedx](https://github.com/CycloneDX/cyclonedx-node-yarn#readme) | |
| 29 | + |
| 30 | +## Out of Scope |
| 31 | + |
| 32 | +There are systems, that are not node-targeting, but use node as a runtime/compiler environment, or use node package registry as a distribution system. |
| 33 | +These systems are out of scope. Therefore, the following tools are not part of this very meta-package. |
| 34 | + |
| 35 | +| system | actual tool(s) | |
| 36 | +|:------:|:------------| |
32 | 37 | | _webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/@cyclonedx/webpack-plugin) | |
| 38 | +| _esbuild_ | To be announced, suggestions welcome. <br/> Candidate: [cyclonedx-esbuild-plugin](https://github.com/CycloneDX/cyclonedx-esbuild-plugin) | |
| 39 | +| _Rspack_/_Rsbuild_ | To be announced, suggestions welcome | |
33 | 40 | | _Angular_ | [@cyclonedx/webpack-plugin with Angular](https://www.npmjs.com/package/@cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-angular) | |
34 | | -| _React_ | [@cyclonedx/webpack-plugin with React](https://www.npmjs.com/package/@cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-react) | |
35 | | -| _Parcel_ | to be announced, suggestions welcome | |
36 | | -| _Bower_ | None. Bower is [deprecated](https://bower.io/blog/2017/how-to-migrate-away-from-bower/) | |
| 41 | +| _React_ | [@cyclonedx/webpack-plugin with React](https://www.npmjs.com/package/@cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-react) | |
| 42 | +| _Svelte_ | To be announced, suggestions welcome | |
| 43 | +| _Parcel_ | To be announced, suggestions welcome | |
| 44 | +| _Bower_ | None. (_Bower_ is [deprecated](https://bower.io/blog/2017/how-to-migrate-away-from-bower/)!) | |
37 | 45 |
|
38 | 46 | ## Library |
39 | 47 |
|
|
0 commit comments