Skip to content

Commit 2417a64

Browse files
authored
announce yarn plugin (#365)
the already mentioned [`yarn-plugin-cyclonedx`](https://www.npmjs.com/package/@cyclonedx/yarn-plugin-cyclonedx) became a package. --------- Signed-off-by: Jan Kowalleck <[email protected]>
1 parent e76b1ea commit 2417a64

File tree

3 files changed

+16
-13
lines changed

3 files changed

+16
-13
lines changed

.gitignore

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
## this is a meta-package - we dont lock
22
/package-lock.json
3-
/.yarn
43
/yarn.lock
54
/pnpm-lock.yaml
65

6+
## pm rc
7+
.npmrc
8+
.yarnrc
9+
.yarnrc.yml
10+
pnpm-workspace.yaml
11+
.pnpmfile.cjs
12+
713

814
## target of JSDoc
915
/out/
@@ -148,6 +154,7 @@ dist
148154
.vscode-test
149155

150156
# yarn v2
157+
.yarn
151158
.yarn/cache
152159
.yarn/unplugged
153160
.yarn/build-state.yml

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,34 @@ generate _[CycloneDX][link_website]_ Software-Bill-of-Materials (SBOM) from _nod
1616

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

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

24-
In addition, there are some tools to mention, that are not installable as a dependency (yet) but require other/manual methods of installation.
25-
26-
| ecosystem | actual tool |
27-
|:---------:|:------------|
28-
| _yarn_ | [@cyclonedx/yarn-plugin-cyclonedx](https://github.com/CycloneDX/cyclonedx-node-yarn#readme) |
29-
3025
## Out of Scope
3126

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

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

4843
## Library
4944

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

5348
## Contributing
5449

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
},
1414
"copyright": "Copyright OWASP Foundation",
1515
"optionalDependencies": {
16-
"@cyclonedx/cyclonedx-npm": "*"
16+
"@cyclonedx/cyclonedx-npm": "*",
17+
"@cyclonedx/yarn-plugin-cyclonedx": "*"
1718
}
1819
}

0 commit comments

Comments
 (0)