feat: added init-private option

owlstronaut · wraithgar · commit a0e60fb1893a · 2025-05-15T08:41:53.000-07:00
diff --git a/docs/lib/content/commands/npm-init.md b/docs/lib/content/commands/npm-init.md
@@ -87,6 +87,11 @@ Generate it without having it ask any questions:
 $ npm init -y
 ```
 
+Set the private flag to `true` in package.json:
+```bash
+$ npm init --init-private -y
+```
+
 ### Workspaces support
 
 It's possible to create a new workspace within your project by using the
diff --git a/lib/commands/init.js b/lib/commands/init.js
@@ -21,6 +21,7 @@ class Init extends BaseCommand {
     'init-module',
     'init-type',
     'init-version',
+    'init-private',
     'yes',
     'force',
     'scope',
@@ -133,8 +134,14 @@ class Init extends BaseCommand {
     const scriptShell = this.npm.config.get('script-shell') || undefined
     const yes = this.npm.config.get('yes')
 
+    // only send the init-private flag if it is set
+    const opts = { ...flatOptions }
+    if (this.npm.config.isDefault('init-private')) {
+      delete opts.initPrivate
+    }
+
     await libexec({
-      ...flatOptions,
+      ...opts,
       args: newArgs,
       localBin,
       globalBin,
diff --git a/tap-snapshots/test/lib/commands/config.js.test.cjs b/tap-snapshots/test/lib/commands/config.js.test.cjs
@@ -76,6 +76,7 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
   "init-module": "{CWD}/home/.npm-init.js",
   "init-type": "commonjs",
   "init-version": "1.0.0",
+  "init-private": false,
   "init.author.email": "",
   "init.author.name": "",
   "init.author.url": "",
@@ -239,6 +240,7 @@ init-author-name = ""
 init-author-url = ""
 init-license = "ISC"
 init-module = "{CWD}/home/.npm-init.js"
+init-private = false
 init-type = "commonjs"
 init-version = "1.0.0"
 init.author.email = ""
diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs
@@ -854,6 +854,15 @@ more information, or [npm init](/commands/npm-init).
 
 
 
+#### \`init-private\`
+
+* Default: false
+* Type: Boolean
+
+The value \`npm init\` should use by default for the package's private flag.
+
+
+
 #### \`init-type\`
 
 * Default: "commonjs"
@@ -2148,6 +2157,7 @@ Array [
   "init-module",
   "init-type",
   "init-version",
+  "init-private",
   "init.author.email",
   "init.author.name",
   "init.author.url",
@@ -2301,6 +2311,7 @@ Array [
   "include",
   "include-staged",
   "include-workspace-root",
+  "init-private",
   "install-links",
   "install-strategy",
   "json",
@@ -2456,6 +2467,7 @@ Object {
   "ignoreScripts": false,
   "includeStaged": false,
   "includeWorkspaceRoot": false,
+  "initPrivate": false,
   "installLinks": false,
   "installStrategy": "hoisted",
   "json": false,
@@ -3245,7 +3257,7 @@ npm init <@scope> (same as \`npx <@scope>/create\`)
 Options:
 [--init-author-name <name>] [--init-author-url <url>] [--init-license <license>]
 [--init-module <module>] [--init-type <type>] [--init-version <version>]
-[-y|--yes] [-f|--force] [--scope <@scope>]
+[--init-private] [-y|--yes] [-f|--force] [--scope <@scope>]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [--workspaces] [--no-workspaces-update] [--include-workspace-root]
 
@@ -3266,6 +3278,7 @@ aliases: create, innit
 #### \`init-module\`
 #### \`init-type\`
 #### \`init-version\`
+#### \`init-private\`
 #### \`yes\`
 #### \`force\`
 #### \`scope\`
diff --git a/test/lib/commands/init.js b/test/lib/commands/init.js
@@ -459,3 +459,125 @@ t.test('workspaces', async t => {
     t.ok(exists.isFile(), 'bin ran, creating file inside workspace')
   })
 })
+
+t.test('npm init with init-private config set', async t => {
+  const { npm, prefix } = await mockNpm(t, {
+    config: { yes: true, 'init-private': true },
+    noLog: true,
+  })
+
+  await npm.exec('init', [])
+
+  const pkg = require(resolve(prefix, 'package.json'))
+  t.equal(pkg.private, true, 'should set private to true when init-private is set')
+})
+
+t.test('npm init does not set private by default', async t => {
+  const { npm, prefix } = await mockNpm(t, {
+    config: { yes: true },
+    noLog: true,
+  })
+
+  await npm.exec('init', [])
+
+  const pkg = require(resolve(prefix, 'package.json'))
+  t.strictSame(pkg.private, undefined, 'should not set private by default')
+})
+
+t.test('user‑set init-private IS forwarded', async t => {
+  const { npm, prefix } = await mockNpm(t, {
+    config: { yes: true, 'init-private': true },
+    noLog: true,
+  })
+
+  await npm.exec('init', [])
+
+  const pkg = require(resolve(prefix, 'package.json'))
+  t.strictSame(pkg.private, true, 'should set private to true when init-private is set')
+})
+
+t.test('user‑set init-private IS forwarded when false', async t => {
+  const { npm, prefix } = await mockNpm(t, {
+    config: { yes: true, 'init-private': false },
+    noLog: true,
+  })
+
+  await npm.exec('init', [])
+
+  const pkg = require(resolve(prefix, 'package.json'))
+  t.strictSame(pkg.private, false, 'should set private to false when init-private is false')
+})
+
+t.test('No init-private is respected in workspaces', async t => {
+  const { npm, prefix } = await mockNpm(t, {
+    prefixDir: {
+      'package.json': JSON.stringify({
+        name: 'top-level',
+      }),
+    },
+    config: { workspace: 'a', yes: true },
+    noLog: true,
+  })
+
+  await npm.exec('init', [])
+
+  const pkg = require(resolve(prefix, 'a/package.json'))
+  t.strictSame(pkg.private, undefined, 'workspace package.json has no private field set')
+})
+
+t.test('init-private is respected in workspaces', async t => {
+  const { npm, prefix } = await mockNpm(t, {
+    prefixDir: {
+      'package.json': JSON.stringify({
+        name: 'top-level',
+      }),
+    },
+    config: { workspace: 'a', yes: true, 'init-private': true },
+    noLog: true,
+  })
+
+  await npm.exec('init', [])
+
+  const pkg = require(resolve(prefix, 'a/package.json'))
+  t.equal(pkg.private, true, 'workspace package.json has private field set')
+})
+
+t.test('create‑initializer path: init-private flag is forwarded via args', async t => {
+  const calls = []
+  const libexecStub = async opts => calls.push(opts)
+
+  const { npm } = await mockNpm(t, {
+    libnpmexec: libexecStub,
+    // user set the flag in their config
+    config: { yes: true, 'init-private': true },
+    noLog: true,
+  })
+
+  await npm.exec('init', ['create-bar'])
+
+  t.ok(calls[0].initPrivate, 'init-private included in options')
+
+  // Also verify the test for when isDefault returns true
+  calls.length = 0
+  npm.config.isDefault = () => true
+
+  await npm.exec('init', ['create-bar'])
+
+  t.equal(calls[0].initPrivate, undefined, 'init-private not included when using default')
+})
+
+t.test('create‑initializer path: false init-private is forwarded', async t => {
+  const calls = []
+  const libexecStub = async opts => calls.push(opts)
+
+  const { npm } = await mockNpm(t, {
+    libnpmexec: libexecStub,
+    // explicitly set to false
+    config: { yes: true, 'init-private': false },
+    noLog: true,
+  })
+
+  await npm.exec('init', ['create-baz'])
+
+  t.equal(calls[0].initPrivate, false, 'false init-private value is properly forwarded')
+})
diff --git a/workspaces/config/lib/definitions/definitions.js b/workspaces/config/lib/definitions/definitions.js
@@ -971,6 +971,14 @@ const definitions = {
       version number, if not already set in package.json.
     `,
   }),
+  'init-private': new Definition('init-private', {
+    default: false,
+    type: Boolean,
+    description: `
+      The value \`npm init\` should use by default for the package's private flag.
+    `,
+    flatten,
+  }),
   // these "aliases" are historically supported in .npmrc files, unfortunately
   // They should be removed in a future npm version.
   'init.author.email': new Definition('init.author.email', {
diff --git a/workspaces/config/tap-snapshots/test/type-description.js.test.cjs b/workspaces/config/tap-snapshots/test/type-description.js.test.cjs
@@ -231,6 +231,9 @@ Object {
   "init-module": Array [
     "valid filesystem path",
   ],
+  "init-private": Array [
+    "boolean value (true or false)",
+  ],
   "init-type": Array [
     Function String(),
   ],
