Skip to content

Commit c3adf7e

Browse files
authored
add docs for yarn, esbuild, Rspack/Rsbuild, Svelte (#359)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent ae90199 commit c3adf7e

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,37 @@
1111
# CycloneDX BOM
1212

1313
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.
1616

1717
| ecosystem | actual tool |
1818
|:---------:|:------------|
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) |
2221

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.
2423

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.
2925

3026
| ecosystem | actual tool |
3127
|:---------:|:------------|
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+
|:------:|:------------|
3237
| _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 |
3340
| _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/)!) |
3745

3846
## Library
3947

0 commit comments

Comments
 (0)