Skip to content

Commit

Permalink
announce yarn plugin (#365)
Browse files Browse the repository at this point in the history
the already mentioned
[`yarn-plugin-cyclonedx`](https://www.npmjs.com/package/@cyclonedx/yarn-plugin-cyclonedx)
became a package.

---------

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck authored Jun 26, 2024
1 parent e76b1ea commit 2417a64
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
9 changes: 8 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
## this is a meta-package - we dont lock
/package-lock.json
/.yarn
/yarn.lock
/pnpm-lock.yaml

## pm rc
.npmrc
.yarnrc
.yarnrc.yml
pnpm-workspace.yaml
.pnpmfile.cjs


## target of JSDoc
/out/
Expand Down Expand Up @@ -148,6 +154,7 @@ dist
.vscode-test

# yarn v2
.yarn
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
Expand Down
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,34 @@ generate _[CycloneDX][link_website]_ Software-Bill-of-Materials (SBOM) from _nod

| ecosystem | actual tool |
|:---------:|:------------|
| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/@cyclonedx/cyclonedx-npm) |
| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-npm) |
| _pnpm_ | To be announced, suggestions welcome. <br/> Candidate: [cyclonedx-node-pnpm](https://github.com/CycloneDX/cyclonedx-node-pnpm) |
| _yarn_ | [@cyclonedx/yarn-plugin-cyclonedx](https://www.npmjs.com/package/%40cyclonedx/yarn-plugin-cyclonedx) |

*) You should not depend on this very meta-package, instead depend on the actual tool that fits your specific (eco)system.

In addition, there are some tools to mention, that are not installable as a dependency (yet) but require other/manual methods of installation.

| ecosystem | actual tool |
|:---------:|:------------|
| _yarn_ | [@cyclonedx/yarn-plugin-cyclonedx](https://github.com/CycloneDX/cyclonedx-node-yarn#readme) |

## Out of Scope

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.
These systems are out of scope. Therefore, the following tools are not part of this very meta-package.

| system | actual tool(s) |
|:------:|:---------------|
| _Angular_ | [@cyclonedx/webpack-plugin with _Angular_](https://www.npmjs.com/package/@cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-angular) |
| _Angular_ | [@cyclonedx/webpack-plugin with _Angular_](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-angular) |
| _Bower_ | None. (_Bower_ is [deprecated](https://bower.io/blog/2017/how-to-migrate-away-from-bower/)!) |
| _esbuild_ | To be announced, suggestions welcome. <br/> Candidate: [cyclonedx-esbuild-plugin](https://github.com/CycloneDX/cyclonedx-esbuild-plugin) |
| _Parcel_ | To be announced, suggestions welcome |
| _React_ | [@cyclonedx/webpack-plugin with _React_](https://www.npmjs.com/package/@cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-react) |
| _React_ | [@cyclonedx/webpack-plugin with _React_](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin?activeTab=readme#user-content-use-with-react) |
| _Rollup_ | [rollup-plugin-sbom](https://www.npmjs.com/package/rollup-plugin-sbom?activeTab=readme) |
| _Rspack_/_Rsbuild_ | To be announced, suggestions welcome |
| _Svelte_ | To be announced, suggestions welcome |
| _Vite_ | [rollup-plugin-sbom with _Vite_](https://www.npmjs.com/package/rollup-plugin-sbom?activeTab=readme#usage-with-vite) |
| _webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/@cyclonedx/webpack-plugin) |
| _webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |

## Library

If you are looking for a JavaScript/TypeScript library for working with CycloneDX, its data models or serialization,
then you might want to try [@cyclonedx/cyclonedx-library](https://www.npmjs.com/package/@cyclonedx/cyclonedx-library).
then you might want to try [@cyclonedx/cyclonedx-library](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-library).

## Contributing

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
},
"copyright": "Copyright OWASP Foundation",
"optionalDependencies": {
"@cyclonedx/cyclonedx-npm": "*"
"@cyclonedx/cyclonedx-npm": "*",
"@cyclonedx/yarn-plugin-cyclonedx": "*"
}
}

0 comments on commit 2417a64

Please sign in to comment.