add os option

npm · Sep 1, 2023 · 12b892f · 12b892f
1 parent 0220186
commit 12b892f
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 2 deletions.
diff --git a/lib/commands/install.js b/lib/commands/install.js
@@ -35,6 +35,7 @@ class Install extends ArboristWorkspaceCmd {
     'fund',
     'dry-run',
     'cpu',
+    'os',
     ...super.params,
   ]
 

diff --git a/tap-snapshots/test/lib/commands/config.js.test.cjs b/tap-snapshots/test/lib/commands/config.js.test.cjs
@@ -34,6 +34,7 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
   "color": true,
   "commit-hooks": true,
   "cpu": null,
+  "os": null,
   "depth": null,
   "description": true,
   "dev": false,
@@ -260,6 +261,7 @@ omit = []
 omit-lockfile-registry-resolved = false 
 only = null 
 optional = null 
+os = null 
 otp = null 
 pack-destination = "." 
 package = [] 

diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs
@@ -1095,6 +1095,16 @@ time.
 
 
 
+#### \`os\`
+
+* Default: null
+* Type: null or String
+
+Override OS of native modules to install. Acceptable values are same as \`os\`
+field of package.json, which comes from \`process.platform\`.
+
+
+
 #### \`otp\`
 
 * Default: null
@@ -2017,6 +2027,7 @@ Array [
   "color",
   "commit-hooks",
   "cpu",
+  "os",
   "depth",
   "description",
   "dev",
@@ -2171,6 +2182,7 @@ Array [
   "color",
   "commit-hooks",
   "cpu",
+  "os",
   "depth",
   "description",
   "dev",
@@ -2374,6 +2386,7 @@ Object {
   "offline": false,
   "omit": Array [],
   "omitLockfileRegistryResolved": false,
+  "os": null,
   "otp": null,
   "package": Array [],
   "packageLock": true,
@@ -3183,7 +3196,7 @@ Options:
 [--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
 [--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only]
 [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links]
-[--no-fund] [--dry-run] [--cpu <cpu>]
+[--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root] [--install-links]
 
@@ -3215,6 +3228,7 @@ aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
 #### \`fund\`
 #### \`dry-run\`
 #### \`cpu\`
+#### \`os\`
 #### \`workspace\`
 #### \`workspaces\`
 #### \`include-workspace-root\`
@@ -3275,7 +3289,7 @@ Options:
 [--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
 [--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only]
 [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links]
-[--no-fund] [--dry-run] [--cpu <cpu>]
+[--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root] [--install-links]
 
@@ -3307,6 +3321,7 @@ alias: it
 #### \`fund\`
 #### \`dry-run\`
 #### \`cpu\`
+#### \`os\`
 #### \`workspace\`
 #### \`workspaces\`
 #### \`include-workspace-root\`

diff --git a/workspaces/config/lib/definitions/definitions.js b/workspaces/config/lib/definitions/definitions.js
@@ -483,6 +483,17 @@ define('cpu', {
   flatten,
 })
 
+define('os', {
+  default: null,
+  type: [null, String],
+  description: `
+    Override OS of native modules to install.
+    Acceptable values are same as \`os\` field of package.json,
+    which comes from \`process.platform\`.
+  `,
+  flatten,
+})
+
 define('depth', {
   default: null,
   defaultDescription: `

diff --git a/workspaces/config/tap-snapshots/test/type-description.js.test.cjs b/workspaces/config/tap-snapshots/test/type-description.js.test.cjs
@@ -339,6 +339,10 @@ Object {
     null,
     "boolean value (true or false)",
   ],
+  "os": Array [
+    null,
+    Function String(),
+  ],
   "otp": Array [
     null,
     Function String(),