feat: allow pass custom tag (#63)

Author: croatialu

cli.mjs

@@ -1,11 +1,11 @@
 import type { ChangelogOptions, ResolvedChangelogOptions } from './types'
-import { getCurrentGitBranch, getFirstGitCommit, getGitHubRepo, getLastMatchingTag, isPrerelease } from './git'
+import { getCurrentGitBranch, getFirstGitCommit, getGitHubRepo, getLastMatchingTag, getSafeTagTemplate, isPrerelease } from './git'
 
 export function defineConfig(config: ChangelogOptions) {
   return config
 }
 
-const defaultConfig: ChangelogOptions = {
+const defaultConfig = {
   scopeMap: {},
   types: {
     feat: { title: '🚀 Features' },
@@ -18,7 +18,8 @@ const defaultConfig: ChangelogOptions = {
   contributors: true,
   capitalize: true,
   group: true,
-}
+  tag: 'v%s',
+} satisfies ChangelogOptions
 
 export async function resolveConfig(options: ChangelogOptions) {
   const { loadConfig } = await import('c12')
@@ -33,7 +34,12 @@ export async function resolveConfig(options: ChangelogOptions) {
   config.baseUrlApi = config.baseUrlApi ?? 'api.github.com'
   config.to = config.to || await getCurrentGitBranch()
   config.tagFilter = config.tagFilter ?? (() => true)
-  config.from = config.from || await getLastMatchingTag(config.to, config.tagFilter) || await getFirstGitCommit()
+  config.tag = getSafeTagTemplate(config.tag ?? defaultConfig.tag)
+  config.from = config.from || await getLastMatchingTag(
+    config.to,
+    config.tagFilter,
+    config.tag,
+  ) || await getFirstGitCommit()
   // @ts-expect-error backward compatibility
   config.repo = config.repo || config.github || await getGitHubRepo(config.baseUrl)
   // @ts-expect-error backward compatibility

src/config.ts

@@ -18,37 +18,64 @@ export async function isRepoShallow() {
   return (await execCommand('git', ['rev-parse', '--is-shallow-repository'])).trim() === 'true'
 }
 
-export async function getGitTags() {
-  return (await execCommand('git', ['--no-pager', 'tag', '-l', '--sort=creatordate']).then(r => r.split('\n')))
-    .reverse()
+export function getSafeTagTemplate(template: string) {
+  return template.includes('%s') ? template : `${template}%s`
 }
 
-function getTagWithoutPrefix(tag: string) {
-  return tag.replace(/^v/, '')
+function getVersionString(template: string, tag: string) {
+  const pattern = template.replace(/%s/g, '(.+)')
+  const regex = new RegExp(`^${pattern}$`)
+  const match = regex.exec(tag)
+  return match ? match[1] : tag
 }
 
-export async function getLastMatchingTag(inputTag: string, tagFilter: (tag: string) => boolean) {
-  const inputTagWithoutPrefix = getTagWithoutPrefix(inputTag)
-  const isVersion = semver.valid(inputTagWithoutPrefix) !== null
-  const isPrerelease = semver.prerelease(inputTag) !== null
+export async function getGitTags() {
+  const output = await execCommand('git', [
+    'log',
+    '--simplify-by-decoration',
+    '--pretty=format:"%d"',
+  ])
+
+  const tagRegex = /tag: ([^,)]+)/g
+  const tagList: string[] = []
+  let match
+
+  while (match !== null) {
+    const tag = match?.[1].trim()
+    if (tag) {
+      tagList.push(tag)
+    }
+    match = tagRegex.exec(output)
+  }
+
+  return tagList
+}
+
+export async function getLastMatchingTag(
+  inputTag: string,
+  tagFilter: (tag: string) => boolean,
+  tagTemplate: string,
+) {
+  const inputVersionString = getVersionString(tagTemplate, inputTag)
+  const isVersion = semver.valid(inputVersionString) !== null
+  const isPrerelease = semver.prerelease(inputVersionString) !== null
   const tags = await getGitTags()
   const filteredTags = tags.filter(tagFilter)
 
   let tag: string | undefined
   // Doing a stable release, find the last stable release to compare with
   if (!isPrerelease && isVersion) {
     tag = filteredTags.find((tag) => {
-      const tagWithoutPrefix = getTagWithoutPrefix(tag)
+      const versionString = getVersionString(tagTemplate, tag)
 
-      return tagWithoutPrefix !== inputTagWithoutPrefix
-        && semver.valid(tagWithoutPrefix) !== null
-        && semver.prerelease(tagWithoutPrefix) === null
+      return versionString !== inputVersionString
+        && semver.valid(versionString) !== null
+        && semver.prerelease(versionString) === null
     })
   }
 
   // Fallback to the last tag, that are not the input tag
   tag ||= filteredTags.find(tag => tag !== inputTag)
-
   return tag
 }
 

src/git.ts

@@ -84,6 +84,16 @@ export interface ChangelogOptions extends Partial<ChangelogenOptions> {
    * Release repository, defaults to `repo`
    */
   releaseRepo?: RepoConfig | string
+
+  /**
+   * Can be set to a custom tag string
+   * Any `%s` placeholders in the tag string will be replaced
+   * If the tag string does _not_ contain any `%s` placeholders,
+   * then the version number will be appended to the tag.
+   *
+   * @default `v%s`.
+   */
+  tag?: string
 }
 
 export type ResolvedChangelogOptions = Required<ChangelogOptions>