Skip to content

Commit aaad54d

Browse files
antfuantfu
committedSep 28, 2024
feat: improve commit printing
·
v10.1.0v9.6.1
1 parent 2ff30dd commit aaad54d

File tree

3 files changed

+318
-117
lines changed

3 files changed

+318
-117
lines changed
 

‎src/get-new-version.ts

+1-117
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import * as ezSpawn from '@jsdevtools/ez-spawn'
66
import c from 'picocolors'
77
import prompts from 'prompts'
88
import semver, { clean as cleanVersion, valid as isValidVersion, SemVer } from 'semver'
9+
import { printRecentCommits } from './print-commits'
910
import { isPrerelease, releaseTypes } from './release-type'
1011

1112
/**
@@ -153,120 +154,3 @@ async function promptForNewVersion(operation: Operation): Promise<Operation> {
153154
return operation.update({ release: answers.release, newVersion })
154155
}
155156
}
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-
interface ParsedCommit {
220-
hash: string
221-
tag: string
222-
message: string
223-
color: (c: string) => string
224-
}
225-
226-
const parsed = lines.map((line): ParsedCommit => {
227-
const [hash, ...parts] = line.split(' ')
228-
const message = parts.join(' ')
229-
const match = message.match(/^(\w+)(\([^)]+\))?(!)?:(.*)$/)
230-
if (match) {
231-
let color = messageColorMap[match[1].toLowerCase()] || ((c: string) => c)
232-
if (match[3] === '!') {
233-
color = c.red
234-
}
235-
const tag = [match[1], match[2], match[3]].filter(Boolean).join('')
236-
return {
237-
hash,
238-
tag,
239-
message: match[4].trim(),
240-
color,
241-
}
242-
}
243-
return {
244-
hash,
245-
tag: '',
246-
message,
247-
color: c => c,
248-
}
249-
})
250-
const tagLength = parsed.map(({ tag }) => tag.length).reduce((a, b) => Math.max(a, b), 0)
251-
const prettified = parsed.map(({ hash, tag, message, color }) => {
252-
const paddedTag = tag.padStart(tagLength + 2, ' ')
253-
return [
254-
c.dim(hash),
255-
' ',
256-
color === c.gray ? color(paddedTag) : c.bold(color(paddedTag)),
257-
c.dim(':'),
258-
' ',
259-
color === c.gray ? color(message) : message,
260-
].join('')
261-
})
262-
263-
console.log()
264-
console.log(
265-
c.bold(
266-
`${c.green(lines.length)} Commits since ${c.gray(sha.slice(0, 7))}:`,
267-
),
268-
)
269-
console.log()
270-
console.log(prettified.reverse().join('\n'))
271-
console.log()
272-
}

‎src/print-commits.ts

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
import type { Operation } from './operation'
2+
import * as ezSpawn from '@jsdevtools/ez-spawn'
3+
import c from 'picocolors'
4+
5+
const messageColorMap: Record<string, (c: string) => string> = {
6+
chore: c.gray,
7+
fix: c.yellow,
8+
feat: c.green,
9+
refactor: c.cyan,
10+
docs: c.blue,
11+
doc: c.blue,
12+
ci: c.gray,
13+
build: c.gray,
14+
}
15+
16+
interface ParsedCommit {
17+
hash: string
18+
message: string
19+
tag: string
20+
breaking?: boolean
21+
scope: string
22+
color: (c: string) => string
23+
}
24+
25+
export function parseCommits(raw: string) {
26+
const lines = raw
27+
.toString()
28+
.trim()
29+
.split(/\n/g)
30+
31+
if (!lines.length) {
32+
return []
33+
}
34+
35+
return lines
36+
.map((line): ParsedCommit => {
37+
const [hash, ...parts] = line.split(' ')
38+
const message = parts.join(' ')
39+
const match = message.match(/^(\w+)(!)?(\([^)]+\))?:(.*)$/)
40+
if (match) {
41+
let color = messageColorMap[match[1].toLowerCase()] || ((c: string) => c)
42+
if (match[2] === '!') {
43+
color = s => c.inverse(c.red(s))
44+
}
45+
const tag = [match[1], match[2]].filter(Boolean).join('')
46+
const scope = match[3] || ''
47+
return {
48+
hash,
49+
tag,
50+
message: match[4].trim(),
51+
scope,
52+
breaking: match[2] === '!',
53+
color,
54+
}
55+
}
56+
return {
57+
hash,
58+
tag: '',
59+
message,
60+
scope: '',
61+
color: c => c,
62+
}
63+
})
64+
.reverse()
65+
}
66+
67+
export function formatParsedCommits(commits: ParsedCommit[]) {
68+
const tagLength = commits.map(({ tag }) => tag.length).reduce((a, b) => Math.max(a, b), 0)
69+
let scopeLength = commits.map(({ scope }) => scope.length).reduce((a, b) => Math.max(a, b), 0)
70+
if (scopeLength)
71+
scopeLength += 2
72+
73+
return commits.map(({ hash, tag, message, scope, color }) => {
74+
const paddedTag = tag.padStart(tagLength + 1, ' ')
75+
const paddedScope = !scope
76+
? ' '.repeat(scopeLength)
77+
: c.dim('(') + scope.slice(1, -1) + c.dim(')') + ' '.repeat(scopeLength - scope.length)
78+
79+
return [
80+
c.dim(hash),
81+
' ',
82+
color === c.gray ? color(paddedTag) : c.bold(color(paddedTag)),
83+
' ',
84+
paddedScope,
85+
c.dim(':'),
86+
' ',
87+
color === c.gray ? color(message) : message,
88+
].join('')
89+
})
90+
}
91+
92+
export async function printRecentCommits(operation: Operation): Promise<void> {
93+
let sha: string | undefined
94+
sha ||= await ezSpawn
95+
.async(
96+
'git',
97+
['rev-list', '-n', '1', `v${operation.state.currentVersion}`],
98+
{ stdio: 'pipe' },
99+
)
100+
.then(res => res.stdout.trim())
101+
.catch(() => undefined)
102+
sha ||= await ezSpawn
103+
.async(
104+
'git',
105+
['rev-list', '-n', '1', operation.state.currentVersion],
106+
{ stdio: 'pipe' },
107+
)
108+
.then(res => res.stdout.trim())
109+
.catch(() => undefined)
110+
111+
if (!sha) {
112+
console.log(
113+
c.blue(`i`)
114+
+ c.gray(` Failed to locate the previous tag ${c.yellow(`v${operation.state.currentVersion}`)}`),
115+
)
116+
return
117+
}
118+
119+
const { stdout } = await ezSpawn.async(
120+
'git',
121+
[
122+
'--no-pager',
123+
'log',
124+
`${sha}..HEAD`,
125+
'--oneline',
126+
],
127+
{ stdio: 'pipe' },
128+
)
129+
130+
const parsed = parseCommits(stdout.toString().trim())
131+
const prettified = formatParsedCommits(parsed)
132+
133+
if (!parsed.length) {
134+
console.log()
135+
console.log(c.blue(`i`) + c.gray(` No commits since ${operation.state.currentVersion}`))
136+
console.log()
137+
return
138+
}
139+
140+
console.log()
141+
console.log(
142+
c.bold(
143+
`${c.green(parsed.length)} Commits since ${c.gray(sha.slice(0, 7))}:`,
144+
),
145+
)
146+
console.log()
147+
console.log(prettified.join('\n'))
148+
console.log()
149+
}

‎test/parse-commits.test.ts

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
import { expect, it } from 'vitest'
2+
import { parseCommits } from '../src/print-commits'
3+
4+
const fixture = `
5+
3b93ca405 feat: update deps \`unconfig\` \`jiti\`
6+
568bb4fff feat(vite): apply transformers to preflights during build (#4168)
7+
65d775436 feat(svelte-scoped): optional theme() parsing (#4171)
8+
9ed349ddd feat(transformer-directive): support \`icon()\` directive (#4113)
9+
f38197553 fix(webpack): resolve config before processing (#4174)
10+
6a882da21 feat(webpack): support rspack/rsbuild (#4173)
11+
d8bf879f3 fix(preset-mini): data attributes with named groups (#4165)
12+
19bc9c7e6 fix(postcss): postcss dependency should always be added (#4161)
13+
f21efd539 fix(nuxt): resolve config in advance (#4163)
14+
320dfef4e feat(preset-web-fonts): \`fontsource\` font provider (#4156)
15+
bfad9f238 fix!(extractor-arbitrary-variants): skip extracting encoded html entities (#4162)
16+
3f2e7f631 docs: add tutorial links update contributors (#4159)
17+
31e6709c4 ci: use \`--only-templates\` (#4170)
18+
3de433122 feat(preset-mini): support \`bg-[image:*]\` (#4160)
19+
35297359b docs(rules): explain symbols.layer in symbols docs (#4145)
20+
9be7b299d feat(core): add symbols.layer (#4143)
21+
bd4d8e998 docs(config): layers using variants (#4144)
22+
`
23+
24+
it('parseCommits', async () => {
25+
const parsed = parseCommits(fixture)
26+
// console.log(formatParsedCommits(parsed).join('\n'))
27+
expect(parsed)
28+
.toMatchInlineSnapshot(`
29+
[
30+
{
31+
"breaking": false,
32+
"color": [Function],
33+
"hash": "bd4d8e998",
34+
"message": "layers using variants (#4144)",
35+
"scope": "(config)",
36+
"tag": "docs",
37+
},
38+
{
39+
"breaking": false,
40+
"color": [Function],
41+
"hash": "9be7b299d",
42+
"message": "add symbols.layer (#4143)",
43+
"scope": "(core)",
44+
"tag": "feat",
45+
},
46+
{
47+
"breaking": false,
48+
"color": [Function],
49+
"hash": "35297359b",
50+
"message": "explain symbols.layer in symbols docs (#4145)",
51+
"scope": "(rules)",
52+
"tag": "docs",
53+
},
54+
{
55+
"breaking": false,
56+
"color": [Function],
57+
"hash": "3de433122",
58+
"message": "support \`bg-[image:*]\` (#4160)",
59+
"scope": "(preset-mini)",
60+
"tag": "feat",
61+
},
62+
{
63+
"breaking": false,
64+
"color": [Function],
65+
"hash": "31e6709c4",
66+
"message": "use \`--only-templates\` (#4170)",
67+
"scope": "",
68+
"tag": "ci",
69+
},
70+
{
71+
"breaking": false,
72+
"color": [Function],
73+
"hash": "3f2e7f631",
74+
"message": "add tutorial links update contributors (#4159)",
75+
"scope": "",
76+
"tag": "docs",
77+
},
78+
{
79+
"breaking": true,
80+
"color": [Function],
81+
"hash": "bfad9f238",
82+
"message": "skip extracting encoded html entities (#4162)",
83+
"scope": "(extractor-arbitrary-variants)",
84+
"tag": "fix!",
85+
},
86+
{
87+
"breaking": false,
88+
"color": [Function],
89+
"hash": "320dfef4e",
90+
"message": "\`fontsource\` font provider (#4156)",
91+
"scope": "(preset-web-fonts)",
92+
"tag": "feat",
93+
},
94+
{
95+
"breaking": false,
96+
"color": [Function],
97+
"hash": "f21efd539",
98+
"message": "resolve config in advance (#4163)",
99+
"scope": "(nuxt)",
100+
"tag": "fix",
101+
},
102+
{
103+
"breaking": false,
104+
"color": [Function],
105+
"hash": "19bc9c7e6",
106+
"message": "postcss dependency should always be added (#4161)",
107+
"scope": "(postcss)",
108+
"tag": "fix",
109+
},
110+
{
111+
"breaking": false,
112+
"color": [Function],
113+
"hash": "d8bf879f3",
114+
"message": "data attributes with named groups (#4165)",
115+
"scope": "(preset-mini)",
116+
"tag": "fix",
117+
},
118+
{
119+
"breaking": false,
120+
"color": [Function],
121+
"hash": "6a882da21",
122+
"message": "support rspack/rsbuild (#4173)",
123+
"scope": "(webpack)",
124+
"tag": "feat",
125+
},
126+
{
127+
"breaking": false,
128+
"color": [Function],
129+
"hash": "f38197553",
130+
"message": "resolve config before processing (#4174)",
131+
"scope": "(webpack)",
132+
"tag": "fix",
133+
},
134+
{
135+
"breaking": false,
136+
"color": [Function],
137+
"hash": "9ed349ddd",
138+
"message": "support \`icon()\` directive (#4113)",
139+
"scope": "(transformer-directive)",
140+
"tag": "feat",
141+
},
142+
{
143+
"breaking": false,
144+
"color": [Function],
145+
"hash": "65d775436",
146+
"message": "optional theme() parsing (#4171)",
147+
"scope": "(svelte-scoped)",
148+
"tag": "feat",
149+
},
150+
{
151+
"breaking": false,
152+
"color": [Function],
153+
"hash": "568bb4fff",
154+
"message": "apply transformers to preflights during build (#4168)",
155+
"scope": "(vite)",
156+
"tag": "feat",
157+
},
158+
{
159+
"breaking": false,
160+
"color": [Function],
161+
"hash": "3b93ca405",
162+
"message": "update deps \`unconfig\` \`jiti\`",
163+
"scope": "",
164+
"tag": "feat",
165+
},
166+
]
167+
`)
168+
})

0 commit comments

Comments
 (0)
Please sign in to comment.