feat: print recent commits since last tag

Author: antfu

src/cli/index.ts

@@ -1,7 +1,7 @@
+import type { VersionBumpProgress } from '../types/version-bump-progress'
 import process from 'node:process'
 import symbols from 'log-symbols'
 import { version as packageVersion } from '../../package.json'
-import type { VersionBumpProgress } from '../types/version-bump-progress'
 import { ProgressEvent } from '../types/version-bump-progress'
 import { versionBump } from '../version-bump'
 import { ExitCode } from './exit-code'

src/cli/parse-args.ts

@@ -1,11 +1,11 @@
+import type { VersionBumpOptions } from '../types/version-bump-options'
 import process from 'node:process'
-import { valid as isValidVersion } from 'semver'
 import cac from 'cac'
 import c from 'picocolors'
-import { isReleaseType } from '../release-type'
-import type { VersionBumpOptions } from '../types/version-bump-options'
+import { valid as isValidVersion } from 'semver'
 import { version } from '../../package.json'
 import { bumpConfigDefaults, loadBumpConfig } from '../config'
+import { isReleaseType } from '../release-type'
 import { ExitCode } from './exit-code'
 
 /**
@@ -86,6 +86,7 @@ export function loadCliArgs(argv = process.argv) {
     .option('-q, --quiet', 'Quiet mode')
     .option('-v, --version <version>', 'Target version')
     .option('--current-version <version>', 'Current version')
+    .option('--print-commits', 'Print recent commits', { default: true })
     .option('-x, --execute <command>', 'Commands to execute after version bumps')
     .help()
 

src/config.ts

@@ -1,8 +1,8 @@
-import process from 'node:process'
+import type { VersionBumpOptions } from './types/version-bump-options'
 import { dirname } from 'node:path'
+import process from 'node:process'
 import { loadConfig } from 'c12'
 import escalade from 'escalade/sync'
-import type { VersionBumpOptions } from './types/version-bump-options'
 
 export const bumpConfigDefaults: VersionBumpOptions = {
   commit: true,

src/get-current-version.ts

@@ -1,7 +1,7 @@
+import type { Operation } from './operation'
 import { valid as isValidVersion } from 'semver'
 import { readJsoncFile } from './fs'
 import { isManifest } from './manifest'
-import type { Operation } from './operation'
 
 /**
  * Finds the current version number from files such as package.json.

src/get-new-version.ts

@@ -1,10 +1,11 @@
-import process from 'node:process'
-import c from 'picocolors'
-import prompts from 'prompts'
-import semver, { SemVer, clean as cleanVersion, valid as isValidVersion } from 'semver'
 import type { BumpRelease, PromptRelease } from './normalize-options'
 import type { Operation } from './operation'
 import type { ReleaseType } from './release-type'
+import process from 'node:process'
+import * as ezSpawn from '@jsdevtools/ez-spawn'
+import c from 'picocolors'
+import prompts from 'prompts'
+import semver, { clean as cleanVersion, valid as isValidVersion, SemVer } from 'semver'
 import { isPrerelease, releaseTypes } from './release-type'
 
 /**
@@ -88,6 +89,10 @@ async function promptForNewVersion(operation: Operation): Promise<Operation> {
   const next = getNextVersions(currentVersion, release.preid)
   const configCustomVersion = await operation.options.customVersion?.(currentVersion, semver)
 
+  if (operation.options.printCommits) {
+    await printRecentCommits(operation)
+  }
+
   const PADDING = 13
   const answers = await prompts([
     {
@@ -148,3 +153,96 @@ async function promptForNewVersion(operation: Operation): Promise<Operation> {
       return operation.update({ release: answers.release, newVersion })
   }
 }
+
+const messageColorMap: Record<string, (c: string) => string> = {
+  chore: c.gray,
+  fix: c.yellow,
+  feat: c.green,
+  refactor: c.cyan,
+  docs: c.blue,
+  doc: c.blue,
+  ci: c.gray,
+  build: c.gray,
+}
+
+export async function printRecentCommits(operation: Operation): Promise<void> {
+  let sha: string | undefined
+  sha ||= await ezSpawn
+    .async(
+      'git',
+      ['rev-list', '-n', '1', `v${operation.state.currentVersion}`],
+      { stdio: 'pipe' },
+    )
+    .then(res => res.stdout.trim())
+    .catch(() => undefined)
+  sha ||= await ezSpawn
+    .async(
+      'git',
+      ['rev-list', '-n', '1', operation.state.currentVersion],
+      { stdio: 'pipe' },
+    )
+    .then(res => res.stdout.trim())
+    .catch(() => undefined)
+
+  if (!sha) {
+    console.log(
+      c.blue(`i`)
+      + c.gray(` Failed to locate the previous tag ${c.yellow(`v${operation.state.currentVersion}`)}`),
+    )
+    return
+  }
+
+  const message = await ezSpawn.async(
+    'git',
+    [
+      '--no-pager',
+      'log',
+      `${sha}..HEAD`,
+      '--oneline',
+    ],
+    { stdio: 'pipe' },
+  )
+
+  const lines = message
+    .stdout
+    .toString()
+    .trim()
+    .split(/\n/g)
+
+  if (!lines.length) {
+    console.log()
+    console.log(c.blue(`i`) + c.gray(` No commits since ${operation.state.currentVersion}`))
+    console.log()
+    return
+  }
+
+  const parsed = lines.map((line) => {
+    const [hash, ...parts] = line.split(' ')
+    const message = parts.join(' ')
+    const match = message.match(/^(\w+)(\([^)]+\))?(!)?:(.*)$/)
+    if (match) {
+      let color = messageColorMap[match[1].toLowerCase()] || ((c: string) => c)
+      if (match[3] === '!') {
+        color = c.red
+      }
+      return [
+        c.dim(hash),
+        ' ',
+        c.bold(color([match[1], match[2], match[3]].filter(Boolean).join('').padStart(7, ' '))),
+        c.dim(':'),
+        ' ',
+        color === c.gray ? color(match[4].trim()) : match[4].trim(),
+      ].join('')
+    }
+    return `${c.gray(hash)} ${message}`
+  })
+  console.log()
+  console.log(
+    c.bold(
+      `${c.green(lines.length)} Commits since ${c.gray(sha.slice(0, 7))}:`,
+    ),
+  )
+  console.log()
+  console.log(parsed.join('\n'))
+  console.log()
+}

src/git.ts

@@ -1,5 +1,5 @@
-import * as ezSpawn from '@jsdevtools/ez-spawn'
 import type { Operation } from './operation'
+import * as ezSpawn from '@jsdevtools/ez-spawn'
 import { ProgressEvent } from './types/version-bump-progress'
 
 /**

src/index.ts

@@ -1,11 +1,11 @@
 import { versionBump, versionBumpInfo } from './version-bump'
 
+export * from './config'
 export { ReleaseType } from './release-type'
 export * from './types/version-bump-options'
-export * from './types/version-bump-results'
 export * from './types/version-bump-progress'
 
-export * from './config'
+export * from './types/version-bump-results'
 
 export { versionBump, versionBumpInfo }
 export default versionBump

src/normalize-options.ts

@@ -1,11 +1,11 @@
-import process from 'node:process'
-import fs from 'node:fs/promises'
+import type { ReleaseType } from './release-type'
+import type { VersionBumpOptions } from './types/version-bump-options'
 import fsSync from 'node:fs'
+import fs from 'node:fs/promises'
+import process from 'node:process'
 import fg from 'fast-glob'
 import yaml from 'js-yaml'
-import type { ReleaseType } from './release-type'
 import { isReleaseType } from './release-type'
-import type { VersionBumpOptions } from './types/version-bump-options'
 
 interface Interface {
   input?: NodeJS.ReadableStream | NodeJS.ReadStream | false
@@ -61,6 +61,7 @@ export interface NormalizedOptions {
   interface: Interface
   ignoreScripts: boolean
   execute?: string
+  printCommits?: boolean
   customVersion?: VersionBumpOptions['customVersion']
   currentVersion?: string
 }
@@ -178,6 +179,7 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
     interface: ui,
     ignoreScripts,
     execute,
+    printCommits: raw.printCommits ?? true,
     customVersion: raw.customVersion,
     currentVersion: raw.currentVersion,
   }

src/operation.ts

@@ -1,9 +1,9 @@
 import type { NormalizedOptions } from './normalize-options'
-import { normalizeOptions } from './normalize-options'
 import type { ReleaseType } from './release-type'
 import type { VersionBumpOptions } from './types/version-bump-options'
 import type { NpmScript, ProgressEvent, VersionBumpProgress } from './types/version-bump-progress'
 import type { VersionBumpResults } from './types/version-bump-results'
+import { normalizeOptions } from './normalize-options'
 
 type ProgressCallback = (progress: VersionBumpProgress) => void
 

src/run-npm-script.ts

@@ -1,9 +1,9 @@
-import * as ezSpawn from '@jsdevtools/ez-spawn'
-import { readJsoncFile } from './fs'
 import type { Manifest } from './manifest'
-import { isManifest } from './manifest'
 import type { Operation } from './operation'
 import type { NpmScript } from './types/version-bump-progress'
+import * as ezSpawn from '@jsdevtools/ez-spawn'
+import { readJsoncFile } from './fs'
+import { isManifest } from './manifest'
 import { ProgressEvent } from './types/version-bump-progress'
 
 /**