feat: add prompt to update npm publish config

README.md

@@ -11,6 +11,7 @@ Forked from [`version-bump-prompt`](https://github.com/JS-DevTools/version-bump-
 - Confirmation before bumping.
 - Enable `--commit` `--tag` `--push` by default. (opt-out by `--no-push`, etc.)
 - `-r` or `--recursive` to bump all packages in the monorepo.
+- `--npm-tag` to update the npm publish tag (e.g. `latest`, `next`, `beta`) in `package.json`.
 - `--execute` to execute the command, or execute a function before committing.
 - Conventional Commits by default.
 - Ships ESM and CJS bundles.

src/cli/parse-args.ts

@@ -47,6 +47,7 @@ export async function parseArgs(): Promise<ParsedArgs> {
         printCommits: args.printCommits,
         recursive: args.recursive,
         release: args.release,
+        npmTag: args.npmTag,
         configFilePath: args.configFilePath,
       }),
     }
@@ -93,6 +94,7 @@ export function loadCliArgs(argv = process.argv) {
     .option('-q, --quiet', 'Quiet mode')
     .option('--current-version <version>', 'Current version')
     .option('--print-commits', 'Print recent commits')
+    .option('--npm-tag [tag]', 'Npm publish tag', { default: undefined })
     .option('-x, --execute <command>', 'Commands to execute after version bumps')
     .option('--release <release>', `Release type or version number (e.g. 'major', 'minor', 'patch', 'prerelease', etc. default: ${bumpConfigDefaults.release})`)
     .option('--configFilePath <configFilePath>', `Path to custom build.config file`)

src/normalize-options.ts

@@ -56,6 +56,7 @@ export interface NormalizedOptions {
   tag?: {
     name: string
   }
+  npmTag?: string | boolean
   sign?: boolean
   push: boolean
   files: string[]
@@ -102,6 +103,8 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
   else if (raw.tag)
     tag = { name: 'v' }
 
+  const npmTag = raw.npmTag
+
   // NOTE: This must come AFTER `tag` and `push`, because it relies on them
   let commit
   if (typeof raw.commit === 'string')
@@ -203,6 +206,7 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
     ignoreScripts,
     execute,
     printCommits: raw.printCommits ?? true,
+    npmTag,
     customVersion: raw.customVersion,
     currentVersion: raw.currentVersion,
   }

src/operation.ts

@@ -14,6 +14,7 @@ interface OperationState {
   newVersion: string
   commitMessage: string
   tagName: string
+  npmTag?: string
   updatedFiles: string[]
   skippedFiles: string[]
 }

src/publish-config-tag.ts

@@ -0,0 +1,42 @@
+import type { Operation } from './operation'
+import prompts from 'prompts'
+import { prerelease } from 'semver'
+
+export type PublishConfig = Partial<{
+  tag: string
+  access: string
+  provenance: boolean
+  registry: string
+}>
+
+export async function resolvePublishTag(operation: Operation) {
+  if (!operation.options.npmTag) {
+    return
+  }
+
+  if (typeof operation.options.npmTag === 'string') {
+    operation.update({
+      npmTag: operation.options.npmTag,
+    })
+    return
+  }
+
+  const { newVersion } = operation.state
+  const pre = prerelease(newVersion)
+  const defaultTag = pre ? String(pre[0]) : 'latest'
+
+  const response = await prompts({
+    type: 'text',
+    name: 'tag',
+    message: 'Publish Tag',
+    initial: defaultTag,
+  })
+
+  const { tag } = response
+
+  if (tag) {
+    operation.update({
+      npmTag: tag,
+    })
+  }
+}

src/types/version-bump-options.ts

@@ -93,6 +93,14 @@ export interface VersionBumpOptions {
    */
   confirm?: boolean
 
+  /**
+   * Indicates whether to update the publish tag in package.json.
+   * Can be set to a custom tag string or `true` to prompt user.
+   *
+   * Defaults to `undefined` (no action).
+   */
+  npmTag?: boolean | string
+
   /**
    * Indicates whether to bypass git commit hooks (`git commit --no-verify`).
    *

src/update-files.ts

@@ -1,4 +1,5 @@
 import type { Operation } from './operation'
+import type { PublishConfig } from './publish-config-tag'
 import { existsSync } from 'node:fs'
 import * as path from 'node:path'
 import { readJsoncFile, readTextFile, writeJsoncFile, writeTextFile } from './fs'
@@ -86,10 +87,34 @@ async function updateManifestFile(relPath: string, operation: Operation): Promis
     if (isPackageLockManifest(file.data))
       file.modified.push([['packages', '', 'version'], newVersion])
 
-    await writeJsoncFile(file)
     modified = true
   }
 
+  if (operation.state.npmTag) {
+    const currentTag = (file.data.publishConfig as PublishConfig)?.tag
+    const newTag = operation.state.npmTag
+
+    if (newTag === 'latest') {
+      if (currentTag) {
+        if (Object.keys((file.data as any).publishConfig).length === 1) {
+          file.modified.push([['publishConfig'], undefined])
+        }
+        else {
+          file.modified.push([['publishConfig', 'tag'], undefined])
+        }
+        modified = true
+      }
+    }
+    else if (newTag !== currentTag) {
+      file.modified.push([['publishConfig', 'tag'], newTag])
+      modified = true
+    }
+  }
+
+  if (modified) {
+    await writeJsoncFile(file)
+  }
+
   return modified
 }
 

src/version-bump.ts

@@ -12,6 +12,7 @@ import { getNewVersion } from './get-new-version'
 import { formatVersionString, gitCommit, gitPush, gitTag } from './git'
 import { Operation } from './operation'
 import { printRecentCommits } from './print-commits'
+import { resolvePublishTag } from './publish-config-tag'
 import { runNpmScript } from './run-npm-script'
 import { NpmScript } from './types/version-bump-progress'
 import { updateFiles } from './update-files'
@@ -60,6 +61,8 @@ export async function versionBump(arg: (VersionBumpOptions) | string = {}): Prom
   await getCurrentVersion(operation)
   await getNewVersion(operation, commits)
 
+  await resolvePublishTag(operation)
+
   if (arg.confirm) {
     printSummary(operation)
 
@@ -139,6 +142,8 @@ export async function versionBump(arg: (VersionBumpOptions) | string = {}): Prom
 function printSummary(operation: Operation) {
   console.log()
   console.log(`   files ${operation.options.files.map(i => c.bold(i)).join('\n         ')}`)
+  if (operation.state.npmTag)
+    console.log(` npm tag ${c.cyan.bold(operation.state.npmTag)}`)
   if (operation.options.commit)
     console.log(`  commit ${c.bold(formatVersionString(operation.options.commit.message, operation.state.newVersion))}`)
   if (operation.options.tag)

test/parse-args.test.ts

@@ -66,6 +66,30 @@ describe('loadCliArgs', async () => {
     expect(result.args.sign).toBe(true)
   })
 
+  it('sets the npmTag property to undefined if no npm-tag flag is present', () => {
+    const result = loadCliArgs([...defaultArgs])
+
+    expect(result.args.npmTag).toBe(undefined)
+  })
+
+  it('sets the npmTag property to true if `--npm-tag` is present', () => {
+    const result = loadCliArgs([...defaultArgs, '--npm-tag'])
+
+    expect(result.args.npmTag).toBe(true)
+  })
+
+  it('sets the npmTag property to "beta" if `--npm-tag beta` is present', () => {
+    const result = loadCliArgs([...defaultArgs, '--npm-tag', 'beta'])
+
+    expect(result.args.npmTag).toBe('beta')
+  })
+
+  it('sets the npmTag property to "beta" if `--npm-tag=beta` is present', () => {
+    const result = loadCliArgs([...defaultArgs, '--npm-tag=beta'])
+
+    expect(result.args.npmTag).toBe('beta')
+  })
+
   it('should have configFilePath property set to the value of the `--configFilePath` flag', () => {
     const result = loadCliArgs([...defaultArgs, '--configFilePath', 'test/fixtures/build.config.ts'])