revisit CLI options

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

README.md

@@ -57,13 +57,14 @@ $ yarn CycloneDX make-sbom
 
 ━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  --spec-version #0      Which version of CycloneDX spec to use.
+  --spec-version #0      Which version of CycloneDX to use.
       (choices: "1.2", "1.3", "1.4", "1.5", default: "1.5")
   --output-format #0     Which output format to use.
       (choices: "JSON", "XML", default: "JSON")
   --output-file #0       Path to the output file. Set to "-" to write to STDOUT.
       (default: write to STDOUT)
   --production,--prod    Exclude development dependencies.
+    (defaults to 'true' if the environment variable "NODE_ENV" is set to "production"')
   --component-type #0    Type of component described by the generated SBOM. (choices: "application", "framework", "library", "container", "platform", "device-driver")
       Default: application
   --licenses             Include license information for components in generated SBOM. License information will always be absent for components that don't specify licenses unambigously.

sources/index.ts

@@ -29,6 +29,7 @@ import {
 import { PortablePath, ppath } from "@yarnpkg/fslib";
 import { Command, Option, Usage } from "clipanion";
 import { OutputOptions, generateSBOM, stdOutOutput } from "./sbom";
+import * as process from "process";
 
 class SBOMCommand extends BaseCommand {
   static readonly paths = [
@@ -43,7 +44,7 @@ class SBOMCommand extends BaseCommand {
   });
 
   specVersion = Option.String("--spec-version", {
-    description: `Which version of CycloneDX spec to use.
+    description: `Which version of CycloneDX to use.
 
       (choices: "1.2", "1.3", "1.4", "1.5", default: "1.5")`,
   });
@@ -60,8 +61,14 @@ class SBOMCommand extends BaseCommand {
       (default: write to STDOUT)`,
   });
 
-  production = Option.Boolean(`--production,--prod`, false, {
-    description: `Exclude development dependencies.`,
+  /* mimic option from yarn.
+    - see  https://classic.yarnpkg.com/lang/en/docs/cli/install/#toc-yarn-install-production-true-false
+    - see https://yarnpkg.com/cli/workspaces/focus
+   */
+  production = Option.Boolean(`--production,--prod`, process.env.NODE_ENV=='production', {
+    description: `Exclude development dependencies.
+
+    (defaults to 'true' if the environment variable "NODE_ENV" is set to "production"')`,
   });
 
   componentType = Option.String("--component-type", {