Skip to content

Commit 0e3777d

Browse files
antfuantfu
committedSep 28, 2024
feat: print recent commits since last tag
·
v10.1.0v9.6.0
1 parent 10e4020 commit 0e3777d

13 files changed

+134
-28
lines changed
 

‎src/cli/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
import type { VersionBumpProgress } from '../types/version-bump-progress'
12
import process from 'node:process'
23
import symbols from 'log-symbols'
34
import { version as packageVersion } from '../../package.json'
4-
import type { VersionBumpProgress } from '../types/version-bump-progress'
55
import { ProgressEvent } from '../types/version-bump-progress'
66
import { versionBump } from '../version-bump'
77
import { ExitCode } from './exit-code'

‎src/cli/parse-args.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1+
import type { VersionBumpOptions } from '../types/version-bump-options'
12
import process from 'node:process'
2-
import { valid as isValidVersion } from 'semver'
33
import cac from 'cac'
44
import c from 'picocolors'
5-
import { isReleaseType } from '../release-type'
6-
import type { VersionBumpOptions } from '../types/version-bump-options'
5+
import { valid as isValidVersion } from 'semver'
76
import { version } from '../../package.json'
87
import { bumpConfigDefaults, loadBumpConfig } from '../config'
8+
import { isReleaseType } from '../release-type'
99
import { ExitCode } from './exit-code'
1010

1111
/**
@@ -86,6 +86,7 @@ export function loadCliArgs(argv = process.argv) {
8686
.option('-q, --quiet', 'Quiet mode')
8787
.option('-v, --version <version>', 'Target version')
8888
.option('--current-version <version>', 'Current version')
89+
.option('--print-commits', 'Print recent commits', { default: true })
8990
.option('-x, --execute <command>', 'Commands to execute after version bumps')
9091
.help()
9192

‎src/config.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import process from 'node:process'
1+
import type { VersionBumpOptions } from './types/version-bump-options'
22
import { dirname } from 'node:path'
3+
import process from 'node:process'
34
import { loadConfig } from 'c12'
45
import escalade from 'escalade/sync'
5-
import type { VersionBumpOptions } from './types/version-bump-options'
66

77
export const bumpConfigDefaults: VersionBumpOptions = {
88
commit: true,

‎src/get-current-version.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
import type { Operation } from './operation'
12
import { valid as isValidVersion } from 'semver'
23
import { readJsoncFile } from './fs'
34
import { isManifest } from './manifest'
4-
import type { Operation } from './operation'
55

66
/**
77
* Finds the current version number from files such as package.json.

‎src/get-new-version.ts

+102-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
import process from 'node:process'
2-
import c from 'picocolors'
3-
import prompts from 'prompts'
4-
import semver, { SemVer, clean as cleanVersion, valid as isValidVersion } from 'semver'
51
import type { BumpRelease, PromptRelease } from './normalize-options'
62
import type { Operation } from './operation'
73
import type { ReleaseType } from './release-type'
4+
import process from 'node:process'
5+
import * as ezSpawn from '@jsdevtools/ez-spawn'
6+
import c from 'picocolors'
7+
import prompts from 'prompts'
8+
import semver, { clean as cleanVersion, valid as isValidVersion, SemVer } from 'semver'
89
import { isPrerelease, releaseTypes } from './release-type'
910

1011
/**
@@ -88,6 +89,10 @@ async function promptForNewVersion(operation: Operation): Promise<Operation> {
8889
const next = getNextVersions(currentVersion, release.preid)
8990
const configCustomVersion = await operation.options.customVersion?.(currentVersion, semver)
9091

92+
if (operation.options.printCommits) {
93+
await printRecentCommits(operation)
94+
}
95+
9196
const PADDING = 13
9297
const answers = await prompts([
9398
{
@@ -148,3 +153,96 @@ async function promptForNewVersion(operation: Operation): Promise<Operation> {
148153
return operation.update({ release: answers.release, newVersion })
149154
}
150155
}
156+
157+
const messageColorMap: Record<string, (c: string) => string> = {
158+
chore: c.gray,
159+
fix: c.yellow,
160+
feat: c.green,
161+
refactor: c.cyan,
162+
docs: c.blue,
163+
doc: c.blue,
164+
ci: c.gray,
165+
build: c.gray,
166+
}
167+
168+
export async function printRecentCommits(operation: Operation): Promise<void> {
169+
let sha: string | undefined
170+
sha ||= await ezSpawn
171+
.async(
172+
'git',
173+
['rev-list', '-n', '1', `v${operation.state.currentVersion}`],
174+
{ stdio: 'pipe' },
175+
)
176+
.then(res => res.stdout.trim())
177+
.catch(() => undefined)
178+
sha ||= await ezSpawn
179+
.async(
180+
'git',
181+
['rev-list', '-n', '1', operation.state.currentVersion],
182+
{ stdio: 'pipe' },
183+
)
184+
.then(res => res.stdout.trim())
185+
.catch(() => undefined)
186+
187+
if (!sha) {
188+
console.log(
189+
c.blue(`i`)
190+
+ c.gray(` Failed to locate the previous tag ${c.yellow(`v${operation.state.currentVersion}`)}`),
191+
)
192+
return
193+
}
194+
195+
const message = await ezSpawn.async(
196+
'git',
197+
[
198+
'--no-pager',
199+
'log',
200+
`${sha}..HEAD`,
201+
'--oneline',
202+
],
203+
{ stdio: 'pipe' },
204+
)
205+
206+
const lines = message
207+
.stdout
208+
.toString()
209+
.trim()
210+
.split(/\n/g)
211+
212+
if (!lines.length) {
213+
console.log()
214+
console.log(c.blue(`i`) + c.gray(` No commits since ${operation.state.currentVersion}`))
215+
console.log()
216+
return
217+
}
218+
219+
const parsed = lines.map((line) => {
220+
const [hash, ...parts] = line.split(' ')
221+
const message = parts.join(' ')
222+
const match = message.match(/^(\w+)(\([^)]+\))?(!)?:(.*)$/)
223+
if (match) {
224+
let color = messageColorMap[match[1].toLowerCase()] || ((c: string) => c)
225+
if (match[3] === '!') {
226+
color = c.red
227+
}
228+
return [
229+
c.dim(hash),
230+
' ',
231+
c.bold(color([match[1], match[2], match[3]].filter(Boolean).join('').padStart(7, ' '))),
232+
c.dim(':'),
233+
' ',
234+
color === c.gray ? color(match[4].trim()) : match[4].trim(),
235+
].join('')
236+
}
237+
return `${c.gray(hash)} ${message}`
238+
})
239+
console.log()
240+
console.log(
241+
c.bold(
242+
`${c.green(lines.length)} Commits since ${c.gray(sha.slice(0, 7))}:`,
243+
),
244+
)
245+
console.log()
246+
console.log(parsed.join('\n'))
247+
console.log()
248+
}

‎src/git.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import * as ezSpawn from '@jsdevtools/ez-spawn'
21
import type { Operation } from './operation'
2+
import * as ezSpawn from '@jsdevtools/ez-spawn'
33
import { ProgressEvent } from './types/version-bump-progress'
44

55
/**

‎src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { versionBump, versionBumpInfo } from './version-bump'
22

3+
export * from './config'
34
export { ReleaseType } from './release-type'
45
export * from './types/version-bump-options'
5-
export * from './types/version-bump-results'
66
export * from './types/version-bump-progress'
77

8-
export * from './config'
8+
export * from './types/version-bump-results'
99

1010
export { versionBump, versionBumpInfo }
1111
export default versionBump

‎src/normalize-options.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
import process from 'node:process'
2-
import fs from 'node:fs/promises'
1+
import type { ReleaseType } from './release-type'
2+
import type { VersionBumpOptions } from './types/version-bump-options'
33
import fsSync from 'node:fs'
4+
import fs from 'node:fs/promises'
5+
import process from 'node:process'
46
import fg from 'fast-glob'
57
import yaml from 'js-yaml'
6-
import type { ReleaseType } from './release-type'
78
import { isReleaseType } from './release-type'
8-
import type { VersionBumpOptions } from './types/version-bump-options'
99

1010
interface Interface {
1111
input?: NodeJS.ReadableStream | NodeJS.ReadStream | false
@@ -61,6 +61,7 @@ export interface NormalizedOptions {
6161
interface: Interface
6262
ignoreScripts: boolean
6363
execute?: string
64+
printCommits?: boolean
6465
customVersion?: VersionBumpOptions['customVersion']
6566
currentVersion?: string
6667
}
@@ -178,6 +179,7 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
178179
interface: ui,
179180
ignoreScripts,
180181
execute,
182+
printCommits: raw.printCommits ?? true,
181183
customVersion: raw.customVersion,
182184
currentVersion: raw.currentVersion,
183185
}

‎src/operation.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import type { NormalizedOptions } from './normalize-options'
2-
import { normalizeOptions } from './normalize-options'
32
import type { ReleaseType } from './release-type'
43
import type { VersionBumpOptions } from './types/version-bump-options'
54
import type { NpmScript, ProgressEvent, VersionBumpProgress } from './types/version-bump-progress'
65
import type { VersionBumpResults } from './types/version-bump-results'
6+
import { normalizeOptions } from './normalize-options'
77

88
type ProgressCallback = (progress: VersionBumpProgress) => void
99

‎src/run-npm-script.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import * as ezSpawn from '@jsdevtools/ez-spawn'
2-
import { readJsoncFile } from './fs'
31
import type { Manifest } from './manifest'
4-
import { isManifest } from './manifest'
52
import type { Operation } from './operation'
63
import type { NpmScript } from './types/version-bump-progress'
4+
import * as ezSpawn from '@jsdevtools/ez-spawn'
5+
import { readJsoncFile } from './fs'
6+
import { isManifest } from './manifest'
77
import { ProgressEvent } from './types/version-bump-progress'
88

99
/**

‎src/types/version-bump-options.ts

+5
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,11 @@ export interface VersionBumpOptions {
130130
*/
131131
recursive?: boolean
132132

133+
/**
134+
* Print recent commits
135+
*/
136+
printCommits?: boolean
137+
133138
/**
134139
* Custom function to provide the version number
135140
*/

‎src/update-files.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import * as path from 'node:path'
1+
import type { Operation } from './operation'
22
import { existsSync } from 'node:fs'
3+
import * as path from 'node:path'
34
import { readJsoncFile, readTextFile, writeJsoncFile, writeTextFile } from './fs'
45
import { isManifest, isPackageLockManifest } from './manifest'
5-
import type { Operation } from './operation'
66
import { ProgressEvent } from './types/version-bump-progress'
77

88
/**

‎src/version-bump.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1+
import type { VersionBumpOptions } from './types/version-bump-options'
2+
import type { VersionBumpResults } from './types/version-bump-results'
13
import process from 'node:process'
24
import * as ezSpawn from '@jsdevtools/ez-spawn'
3-
import c from 'picocolors'
45
import symbols from 'log-symbols'
6+
import c from 'picocolors'
57
import prompts from 'prompts'
6-
import { getNewVersion } from './get-new-version'
78
import { getCurrentVersion } from './get-current-version'
9+
import { getNewVersion } from './get-new-version'
810
import { formatVersionString, gitCommit, gitPush, gitTag } from './git'
911
import { Operation } from './operation'
1012
import { runNpmScript } from './run-npm-script'
11-
import type { VersionBumpOptions } from './types/version-bump-options'
1213
import { NpmScript } from './types/version-bump-progress'
13-
import type { VersionBumpResults } from './types/version-bump-results'
1414
import { updateFiles } from './update-files'
1515

1616
/**

0 commit comments

Comments
 (0)
Please sign in to comment.