You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,11 +53,11 @@ new CycloneDxWebpackPlugin(options?: object)
53
53
|**`includeWellknown`**|`{boolean}`|`true`| Whether to write the Wellknowns. |
54
54
|**`wellknownLocation`**|`{string}`|`"./.well-known"`| Path to write the Wellknowns to. The path is relative to _webpack_'s overall output path. |
55
55
|**`rootComponentAutodetect`**|`{boolean}`|`true`| Whether to try auto-detection of the RootComponent.<br/> Tries to find the nearest `package.json` and build a CycloneDX component from it, so it can be assigned to `bom.metadata.component`. |
56
-
|**`rootComponentType`**|`{string}`|`"application"`| Set the RootComponent's type.<br/>See [the list of valid values](https://cyclonedx.org/docs/1.4/json/#metadata_component_type). Supported values depend on [CycloneDX-javascript-library]'s enum `ComponentType`. |
56
+
|**`rootComponentType`**|`{string}`|`"application"`| Set the RootComponent's type.<br/>See [the list of valid values](https://cyclonedx.org/docs/1.6/json/#metadata_component_type). Supported values depend on [CycloneDX-javascript-library]'s enum `ComponentType`. |
57
57
|**`rootComponentName`**| optional `{string}`|`undefined`| If `rootComponentAutodetect` is disabled, then this value is assumed as the "name" of the `package.json`. |
58
58
|**`rootComponentVersion`**| optional `{string}`|`undefined`| If `rootComponentAutodetect` is disabled, then this value is assumed as the "version" of the `package.json`. |
59
-
|**`rootComponentBuildSystem`**| optional `{string}`|`undefined`| Set's the URL for the RootComponent's External References'build-system. |
60
-
|**`rootComponentVCS`**| optional `{string}`|`undefined`| If `rootComponentAutodetect` is disabled or the VCS is not defined in the package.json, then this value is used as the URL for the RootComponent's External Referencees' Version Control System. |
59
+
|**`rootComponentBuildSystem`**| optional `{string}`|`undefined`| Set's the URL for [RootComponent's External References'][docs_cdx_metadata_component_externalReferences] of type "build-system". |
60
+
|**`rootComponentVCS`**| optional `{string}`|`undefined`| If `rootComponentAutodetect` is disabled or the Version Control System is not declared in the `package.json`, then this value is used as the URL for [RootComponent's External References'][docs_cdx_metadata_component_externalReferences] of type "vcs". |
61
61
|**`collectEvidence`**|`{boolean}`|`false`| Whether to collect (license) evidence and attach them to the resulting SBOM. |
62
62
63
63
### Example
@@ -168,3 +168,5 @@ See the [LICENSE][license_file] file for the full license.
0 commit comments