changelog-entry

1import type { EngineInterface, Register } from 'claude-code'
2
3import { STRINGS } from './strings'
4
5// cockpit: the language set in /cockpit (English when the hub is not installed)
6const LANG = { plugin: 'cockpit', key: 'lang' } as const
7
8const strings = async ($: EngineInterface) => STRINGS[(await $.state.get(LANG)).value ?? 'en']
9
10const git = ($: EngineInterface, args: readonly string[]) =>
11  $.process.run(['git', '--no-pager', ...args], { timeoutMs: 15000 }).catch(() => undefined)
12
13const SEMVER = /^v?(\d+)\.(\d+)\.(\d+)$/
14const VERSION = /^v?(\d+\.\d+\.\d+[\w.-]*)$/
15const CONVENTIONAL = /^(\w+)(\([^)]*\))?(!)?:\s*(.+)$/
16const MAX_SHOWN = 12
17
18// The sections follow keepachangelog.com, so they stay in English in every language.
19const group = (subject: string): { section: string; text: string; breaking: boolean } => {
20  const found = CONVENTIONAL.exec(subject)
21  const type = found?.[1]?.toLowerCase()
22  const text = found?.[4] ?? subject
23  const breaking = found?.[3] === '!' || /BREAKING/.test(subject)
24
25  return { section: type === 'feat' ? 'Added' : type === 'fix' ? 'Fixed' : 'Changed', text, breaking }
26}
27
28const nextVersion = (latest: string | undefined, entries: ReturnType<typeof group>[]): string => {
29  const found = latest === undefined ? null : SEMVER.exec(latest)
30
31  if (found === null) {
32    return '0.1.0'
33  }
34
35  const [major = 0, minor = 0, patch = 0] = found.slice(1).map(Number)
36
37  if (entries.some(entry => entry.breaking)) {
38    return `${major + 1}.0.0`
39  }
40
41  return entries.some(entry => entry.section === 'Added') ? `${major}.${minor + 1}.0` : `${major}.${minor}.${patch + 1}`
42}
43
44const writing = async ($: EngineInterface, typed: string): Promise<{ text: string }> => {
45  const s = await strings($)
46  const typedVersion = VERSION.exec(typed)
47
48  if (typed !== '' && typedVersion === null) {
49    return { text: s.usage }
50  }
51
52  const head = await git($, ['rev-parse', '--short', 'HEAD'])
53
54  if (head === undefined || head.exitCode !== 0) {
55    return { text: s.noGit }
56  }
57
58  const described = await git($, ['describe', '--tags', '--abbrev=0'])
59  const latest = described?.exitCode === 0 ? described.stdout.trim() : undefined
60  const log = await git($, ['log', '--no-merges', '--format=%s', ...(latest === undefined ? ['-n', '30'] : [`${latest}..HEAD`])])
61  const entries = (log?.exitCode === 0 ? log.stdout.split('\n') : []).filter(line => line.trim() !== '').map(group)
62
63  if (entries.length === 0) {
64    return { text: s.nothing(latest ?? 'HEAD') }
65  }
66
67  const version = typedVersion?.[1] ?? nextVersion(latest, entries)
68  const root = await $.session.root()
69  const path = `${root}/CHANGELOG.md`
70  const current = await $.fs.read(path).catch(() => undefined)
71  const file = typeof current === 'string' ? current : ''
72
73  if (file.includes(`## [${version}]`)) {
74    return { text: s.exists(version) }
75  }
76
77  const date = new Date(await $.clock.now()).toISOString().slice(0, 10)
78  const sections = ['Added', 'Fixed', 'Changed']
79    .map(section => ({ section, items: entries.filter(entry => entry.section === section) }))
80    .filter(found => found.items.length > 0)
81    .map(found => `### ${found.section}\n\n${found.items.map(entry => `- ${entry.text}`).join('\n')}\n`)
82  const entry = `## [${version}] - ${date}\n\n${sections.join('\n')}`
83  const shown = entry.split('\n').filter(line => line.trim() !== '')
84  const preview = [...shown.slice(0, MAX_SHOWN), ...(shown.length > MAX_SHOWN ? ['…'] : [])].map(line => `  ${line}`).join('\n')
85  const answer = await $.ui.ask(s.confirm(preview), [s.yes, s.no]).catch(() => s.no)
86
87  if (answer !== s.yes) {
88    return { text: s.cancelled }
89  }
90
91  // New entries go above the newest existing one, or after the title of a file that has none.
92  const at = file.search(/^## /m)
93  const next =
94    file === ''
95      ? `# Changelog\n\n${entry}`
96      : at >= 0
97        ? `${file.slice(0, at)}${entry}\n${file.slice(at)}`
98        : `${file.trimEnd()}\n\n${entry}`
99  const saved = await $.fs.write(path, next).then(
100    () => true,
101    () => false,
102  )
103
104  return { text: saved ? s.added(version) : s.failed }
105}
106
107export const register: Register = on => {
108  on('session.start', async ($, e, next) => {
109    const s = await strings($)
110    await $.command.register({ name: 'changelog', description: s.command, argumentHint: s.hint })
111
112    return next(e)
113  })
114
115  on('command.run', { command: 'changelog' }, ($, e) => writing($, e.args.trim()))
116}
117

1const en = {
2  command: 'Write the entry for the next version into CHANGELOG.md from the commits since the last tag, after asking',
3  hint: '[version]',
4  usage: 'Usage: /changelog [version]',
5  noGit: 'Not a git repository (or git is not available).',
6  nothing: (tag: string) => `No commits since ${tag}: nothing to add.`,
7  exists: (version: string) => `CHANGELOG.md already has an entry for ${version}.`,
8  confirm: (entry: string) => `Add to CHANGELOG.md?\n${entry}`,
9  yes: 'yes',
10  no: 'no',
11  cancelled: 'Cancelled.',
12  added: (version: string) => `CHANGELOG.md now has the entry for ${version}.`,
13  failed: 'Could not write CHANGELOG.md.',
14}
15
16type Strings = typeof en
17
18const pt: Strings = {
19  command: 'Escreve no CHANGELOG.md a entrada da próxima versão a partir dos commits desde a última tag, depois de perguntar',
20  hint: '[versão]',
21  usage: 'Uso: /changelog [versão]',
22  noGit: 'Não é um repositório git (ou o git não está disponível).',
23  nothing: tag => `Nenhum commit desde ${tag}: nada para adicionar.`,
24  exists: version => `O CHANGELOG.md já tem uma entrada para ${version}.`,
25  confirm: entry => `Adicionar ao CHANGELOG.md?\n${entry}`,
26  yes: 'sim',
27  no: 'não',
28  cancelled: 'Cancelado.',
29  added: version => `O CHANGELOG.md agora tem a entrada de ${version}.`,
30  failed: 'Não foi possível escrever o CHANGELOG.md.',
31}
32
33const es: Strings = {
34  command: 'Escribe en CHANGELOG.md la entrada de la próxima versión a partir de los commits desde la última tag, tras preguntar',
35  hint: '[versión]',
36  usage: 'Uso: /changelog [versión]',
37  noGit: 'No es un repositorio git (o git no está disponible).',
38  nothing: tag => `Ningún commit desde ${tag}: nada que agregar.`,
39  exists: version => `CHANGELOG.md ya tiene una entrada para ${version}.`,
40  confirm: entry => `¿Agregar a CHANGELOG.md?\n${entry}`,
41  yes: 'sí',
42  no: 'no',
43  cancelled: 'Cancelado.',
44  added: version => `CHANGELOG.md ahora tiene la entrada de ${version}.`,
45  failed: 'No se pudo escribir CHANGELOG.md.',
46}
47
48export const STRINGS = { en, pt, es }
49