feat: Optional dependencies

HISTORY.md

@@ -4,10 +4,17 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Added
+  * SBOM result might have `component.scope=optional` populated for OptionalDependencies ([#645] via [#657])  
+* Fixed
+  * DevDependencies that are also required by OptionalDependencies correctly have the property [`cdx:npm:package:development`](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/npm.md) populated in SBOM results ([#645] via [#657])
+  * DevDependencies that are also required by OptionalDependencies are correctly omitted from SBOM results, when the CLI switch for omitting "dev" and "optional" are set ([#645] via [#657])
 * Docs
   * Describe internal `npm` executable detection in README (via [#647])
 
+[#645]: https://github.com/CycloneDX/cyclonedx-node-npm/issues/645
 [#647]: https://github.com/CycloneDX/cyclonedx-node-npm/pull/647
+[#657]: https://github.com/CycloneDX/cyclonedx-node-npm/pull/657
 
 ## 1.9.2 - 2023-03-30
 

demo/dev-dependencies/README.md

@@ -10,9 +10,13 @@ and see how they behave different from
 
 ## remarks
 
+* The `optional` is `true` for optionalDependencies.
+* The `optional` is absent for non-optionalDependencies.
 * The `dev` is `true` for devDependencies.
 * The `dev` is absent for non-devDependencies.
+* The `devOptional` is `true` for devDependencies that are also transitive dependencies from optionalDependencies.
 * npm6: `_development` instead of `dev`.
+* npm6: `_optional` instead of `optional`.
 
 ## output
 
@@ -24,17 +28,46 @@ Output of `npm ls --json -a -l` look like this:
 {
   "name": "demo-dev-dependencies",
   "description": "demo: demo-dev-dependencies -- showcase how workspaces look like",
+  "optionalDependencies": {
+    "uuidv4": "^6.2.13"
+  },
   "devDependencies": {
-    "@types/node": ">=16"
+    "@types/node": ">=16",
+    "@types/uuid": "^8",
+    "uuid": "^8"
   },
-  "path": "/home/flow/Documents/Coding/node/cyclonedx-node-npm/demo/dev-dependencies/project",
+  "path": ".../cyclonedx-node-npm/demo/dev-dependencies/project",
   // other properties
   "dependencies": {
     "@types/node": {
       "name": "@types/node",
       "dev": true,
-      "path": "/home/flow/Documents/Coding/node/cyclonedx-node-npm/demo/dev-dependencies/project/node_modules/@types/node",
+      "path": ".../demo/dev-dependencies/project/node_modules/@types/node",
+      // other properties
+    },
+    "@types/uuid": {
+      // ...
+    },
+    "uuid": {
+      "name": "uuid",
+      "devOptional": true,
+      "path": ".../demo/dev-dependencies/project/node_modules/uuid",
+      // other properties
+    },
+    "uuidv4": {
+      "name": "uuidv4",
+      "optional": true,
+      "path": ".../demo/dev-dependencies/project/node_modules/uuidv4",
       // other properties
+      "dependencies": {
+        "uuid": {
+          "name": "uuid",
+          "devOptional": true,
+          "path": ".../demo/dev-dependencies/project/node_modules/uuid",
+          // other properties
+        },
+        // ...
+      }
     }
   }
 }