feat: added init-private option

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

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['init-private']
+    }
+
     await libexec({
-      ...flatOptions,
+      ...opts,
       args: newArgs,
       localBin,
       globalBin,

node_modules/init-package-json/lib/default-input.js

@@ -8,7 +8,17 @@ const npa = require('npm-package-arg')
 const semver = require('semver')
 
 // more popular packages should go here, maybe?
-const isTestPkg = (p) => !!p.match(/^(expresso|mocha|tap|coffee-script|coco|streamline)$/)
+const testPkgs = [
+  'coco',
+  'coffee-script',
+  'expresso',
+  'jasmine',
+  'jest',
+  'mocha',
+  'streamline',
+  'tap',
+]
+const isTestPkg = p => testPkgs.includes(p)
 
 const invalid = (msg) => Object.assign(new Error(msg), { notValid: true })
 
@@ -266,3 +276,9 @@ const type = package.type || getConfig('type') || 'commonjs'
 exports.type = yes ? type : prompt('type', type, (data) => {
   return data
 })
+
+// Only include private field if it already exists or if explicitly set in config
+const configPrivate = getConfig('private')
+if (package.private !== undefined || configPrivate !== undefined) {
+  exports.private = package.private !== undefined ? package.private : configPrivate
+}

node_modules/init-package-json/package.json

@@ -1,6 +1,6 @@
 {
   "name": "init-package-json",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "main": "lib/init-package-json.js",
   "scripts": {
     "test": "tap",
@@ -29,7 +29,7 @@
     "validate-npm-package-name": "^6.0.0"
   },
   "devDependencies": {
-    "@npmcli/config": "^9.0.0",
+    "@npmcli/config": "^10.0.0",
     "@npmcli/eslint-config": "^5.0.0",
     "@npmcli/template-oss": "4.23.4",
     "tap": "^16.0.1"

package-lock.json

@@ -106,7 +106,7 @@
         "graceful-fs": "^4.2.11",
         "hosted-git-info": "^8.1.0",
         "ini": "^5.0.0",
-        "init-package-json": "^8.0.0",
+        "init-package-json": "^8.2.0",
         "is-cidr": "^5.1.1",
         "json-parse-even-better-errors": "^4.0.0",
         "libnpmaccess": "^10.0.0",
@@ -9493,9 +9493,9 @@
       }
     },
     "node_modules/init-package-json": {
-      "version": "8.0.0",
-      "resolved": "https://registry.npmjs.org/init-package-json/-/init-package-json-8.0.0.tgz",
-      "integrity": "sha512-zKgxfaGt6Zzi8VBSInOK0CYDigA9gzDCWPnSzGIoUlTU/5w7qIyi+6MyJYX96mMlxDGrIR85FhQszVyodYfB9g==",
+      "version": "8.2.0",
+      "resolved": "https://registry.npmjs.org/init-package-json/-/init-package-json-8.2.0.tgz",
+      "integrity": "sha512-eG4WzSLsMMoESLm5y5X1M7EVm1EGNOnL2T4BZ5YPN/Rw91ZxmxqGAqeh07p3Y056pklqnLA5Pks5+2TCB2jpZA==",
       "inBundle": true,
       "license": "ISC",
       "dependencies": {

package.json

@@ -73,7 +73,7 @@
     "graceful-fs": "^4.2.11",
     "hosted-git-info": "^8.1.0",
     "ini": "^5.0.0",
-    "init-package-json": "^8.0.0",
+    "init-package-json": "^8.2.0",
     "is-cidr": "^5.1.1",
     "json-parse-even-better-errors": "^4.0.0",
     "libnpmaccess": "^10.0.0",

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 = ""

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",
@@ -2385,6 +2395,7 @@ Array [
   "init-module",
   "init-type",
   "init-version",
+  "init-private",
   "init.author.email",
   "init.author.name",
   "init.author.url",
@@ -3245,7 +3256,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 +3277,7 @@ aliases: create, innit
 #### \`init-module\`
 #### \`init-type\`
 #### \`init-version\`
+#### \`init-private\`
 #### \`yes\`
 #### \`force\`
 #### \`scope\`

test/lib/commands/init.js

@@ -459,3 +459,58 @@
     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(Object.prototype.hasOwnProperty.call(pkg, 'private'), false, 'should not set private by default')
+})
+
+t.test('create‑initializer path: default init-private is NOT forwarded', async t => {
+  const calls = []
+  const libexecStub = async opts => calls.push(opts)
+
+  const { npm } = await mockNpm(t, {
+    libnpmexec: libexecStub,
+    config: { yes: true },
+    noLog: true,
+  })
+
+  await npm.exec('init', ['foo'])
+
+  t.notOk(Object.prototype.hasOwnProperty.call(calls[0], 'init-private'), 'flag not present')
+})
+
+t.test('create‑initializer path: user‑set init-private IS forwarded', 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', ['bar'])
+
+  t.equal(calls[0]['init-private'], true, 'flag forwarded with true value')
+})

workspaces/config/lib/definitions/definitions.js

@@ -971,6 +971,13 @@ 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.
+    `,
+  }),
   // 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', {

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(),
   ],