feat: add new exclusive config item publish-file

Author: wraithgar

docs/lib/index.js

@@ -42,6 +42,17 @@ const getCommandByDoc = (docFile, docExt) => {
   const srcName = name === 'npx' ? 'exec' : name
   const { params, usage = [''], workspaces } = require(`../../lib/commands/${srcName}`)
   const usagePrefix = name === 'npx' ? 'npx' : `npm ${name}`
+  if (params) {
+    for (const param of params) {
+      if (definitions[param].exclusive) {
+        for (const e of definitions[param].exclusive) {
+          if (!params.includes(e)) {
+            params.splice(params.indexOf(param) + 1, 0, e)
+          }
+        }
+      }
+    }
+  }
 
   return {
     name,

lib/base-command.js

@@ -18,6 +18,7 @@ class BaseCommand {
   // this is a static so that we can read from it without instantiating a command
   // which would require loading the config
   static get describeUsage () {
+    const seenExclusive = new Set()
     const wrapWidth = 80
     const { description, usage = [''], name, params } = this
 
@@ -32,7 +33,22 @@ class BaseCommand {
       let results = ''
       let line = ''
       for (const param of params) {
-        const paramUsage = `[${definitions[param].usage}]`
+        /* istanbul ignore next */
+        if (seenExclusive.has(param)) {
+          continue
+        }
+        const { exclusive } = definitions[param]
+        let paramUsage = `${definitions[param].usage}`
+        if (exclusive) {
+          const exclusiveParams = [paramUsage]
+          seenExclusive.add(param)
+          for (const e of exclusive) {
+            seenExclusive.add(e)
+            exclusiveParams.push(definitions[e].usage)
+          }
+          paramUsage = `${exclusiveParams.join('|')}`
+        }
+        paramUsage = `[${paramUsage}]`
         if (line.length + paramUsage.length > wrapWidth) {
           results = [results, line].filter(Boolean).join('\n')
           line = ''

lib/utils/config/definition.js

@@ -13,6 +13,7 @@ const allowed = [
   'defaultDescription',
   'deprecated',
   'description',
+  'exclusive',
   'flatten',
   'hint',
   'key',
@@ -83,12 +84,15 @@ class Definition {
 This value is not exported to the environment for child processes.
 `
     const deprecated = !this.deprecated ? '' : `* DEPRECATED: ${unindent(this.deprecated)}\n`
+    /* eslint-disable-next-line max-len */
+    const exclusive = !this.exclusive ? '' : `\nThis config can not be used with: \`${this.exclusive.join('`, `')}\``
     return wrapAll(`#### \`${this.key}\`
 
 * Default: ${unindent(this.defaultDescription)}
 * Type: ${unindent(this.typeDescription)}
 ${deprecated}
 ${description}
+${exclusive}
 ${noEnvExport}`)
   }
 }

lib/utils/config/definitions.js

@@ -1635,13 +1635,25 @@ define('progress', {
 define('provenance', {
   default: false,
   type: Boolean,
+  exclusive: ['provenance-file'],
   description: `
     When publishing from a supported cloud CI/CD system, the package will be
     publicly linked to where it was built and published from.
   `,
   flatten,
 })
 
+define('provenance-file', {
+  default: null,
+  type: path,
+  hint: '<file>',
+  exclusive: ['provenance'],
+  description: `
+    When publishing, the provenance bundle at the given path will be used.
+  `,
+  flatten,
+})
+
 define('proxy', {
   default: null,
   type: [null, false, url], // allow proxy to be disabled explicitly

tap-snapshots/test/lib/commands/config.js.test.cjs

@@ -118,6 +118,7 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
   "production": null,
   "progress": true,
   "provenance": false,
+  "provenance-file": null,
   "proxy": null,
   "read-only": false,
   "rebuild-bundle": true,
@@ -274,6 +275,7 @@ preid = ""
 production = null 
 progress = true 
 provenance = false 
+provenance-file = null 
 proxy = null 
 read-only = false 
 rebuild-bundle = true 

tap-snapshots/test/lib/docs.js.test.cjs

@@ -15,6 +15,8 @@ exports[`test/lib/utils/config/definition.js TAP basic definition > description
 it should not be used ever
 
 not even once.
+
+
 `
 
 exports[`test/lib/utils/config/definition.js TAP basic definition > human-readable description 1`] = `
@@ -24,6 +26,8 @@ exports[`test/lib/utils/config/definition.js TAP basic definition > human-readab
 * Type: Number or String
 
 just a test thingie
+
+
 `
 
 exports[`test/lib/utils/config/definition.js TAP long description > cols=-1 1`] = `
@@ -93,6 +97,7 @@ with (multiple) {
 }
 \`\`\`
 
+
 `
 
 exports[`test/lib/utils/config/definition.js TAP long description > cols=0 1`] = `
@@ -162,6 +167,7 @@ with (multiple) {
 }
 \`\`\`
 
+
 `
 
 exports[`test/lib/utils/config/definition.js TAP long description > cols=40 1`] = `
@@ -201,6 +207,7 @@ with (multiple) {
 }
 \`\`\`
 
+
 `
 
 exports[`test/lib/utils/config/definition.js TAP long description > cols=9000 1`] = `
@@ -231,6 +238,7 @@ with (multiple) {
 }
 \`\`\`
 
+
 `
 
 exports[`test/lib/utils/config/definition.js TAP long description > cols=NaN 1`] = `
@@ -261,4 +269,5 @@ with (multiple) {
 }
 \`\`\`
 
+
 `

tap-snapshots/test/lib/utils/config/definition.js.test.cjs

@@ -575,6 +575,13 @@ class Config {
         const v = this.parseField(value, k)
         if (where !== 'default') {
           this.#checkDeprecated(k, where, obj, [key, value])
+          if (this.definitions[key]?.exclusive) {
+            for (const exclusive of this.definitions[key].exclusive) {
+              if (!this.isDefault(exclusive)) {
+                throw new TypeError(`--${key} can not be provided when using --${exclusive}`)
+              }
+            }
+          }
         }
         conf.data[k] = v
       }

workspaces/config/lib/index.js

@@ -2606,4 +2606,18 @@ const definitions = module.exports = {
     defaultDescription: 'false',
     typeDescription: 'Boolean',
   },
+  truth: {
+    key: 'truth',
+    default: false,
+    type: Boolean,
+    description: 'The Truth',
+    exclusive: ['lie'],
+  },
+  lie: {
+    key: 'lie',
+    default: false,
+    type: Boolean,
+    description: 'A Lie',
+    exclusive: ['truth'],
+  },
 }

workspaces/config/test/fixtures/definitions.js

@@ -239,7 +239,6 @@ loglevel = yolo
       env,
       argv,
       cwd: join(`${path}/project`),
-
       shorthands,
       definitions,
     })
@@ -1318,6 +1317,27 @@ t.test('workspaces', async (t) => {
   })
 })
 
+t.test('exclusive options conflict', async t => {
+  const path = t.testdir()
+  const config = new Config({
+    env: {},
+    npmPath: __dirname,
+    argv: [
+      process.execPath,
+      __filename,
+      '--truth=true',
+      '--lie=true',
+    ],
+    cwd: join(`${path}/project`),
+    shorthands,
+    definitions,
+    flatten,
+  })
+  await t.rejects(config.load(), {
+    name: 'TypeError',
+    message: '--lie can not be provided when using --truth',
+  })
+})
 t.test('env-replaced config from files is not clobbered when saving', async (t) => {
   const path = t.testdir()
   const opts = {