feat: inline contributors

src/config.ts

@@ -18,7 +18,6 @@ export async function resolveConfig(options: ChangelogOptions) {
       },
       titles: {
         breakingChanges: '🚨 Breaking Changes',
-        contributors: '❤️ Contributors',
       },
       contributors: true,
       capitalize: true,

src/generate.ts

@@ -1,16 +1,17 @@
 import { getGitDiff, parseCommits } from 'changelogen'
 import type { ChangelogOptions } from './types'
 import { generateMarkdown } from './markdown'
-import { getContributors } from './github'
+import { resolveAuthors } from './github'
 import { resolveConfig } from './config'
 
 export async function generate(options: ChangelogOptions) {
   const resolved = await resolveConfig(options)
 
   const rawCommits = await getGitDiff(resolved.from, resolved.to)
   const commits = parseCommits(rawCommits, resolved)
-  const contributors = resolved.contributors ? await getContributors(commits, resolved) : undefined
-  const md = generateMarkdown(commits, resolved, contributors)
+  if (resolved.contributors)
+    await resolveAuthors(commits, resolved)
+  const md = generateMarkdown(commits, resolved)
 
   return { config: resolved, md, commits }
 }

src/github.ts

@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
 import { $fetch } from 'ohmyfetch'
 import { cyan, green } from 'kolorist'
-import type { GitCommit } from 'changelogen'
-import type { AuthorInfo, ChangelogOptions } from './types'
+import { notNullish } from '@antfu/utils'
+import type { AuthorInfo, ChangelogOptions, Commit } from './types'
 
 export async function sendRelease(
   options: ChangelogOptions,
@@ -79,21 +79,23 @@ export async function resolveAuthorInfo(options: ChangelogOptions, info: AuthorI
   return info
 }
 
-export async function getContributors(commits: GitCommit[], options: ChangelogOptions) {
+export async function resolveAuthors(commits: Commit[], options: ChangelogOptions) {
   const map = new Map<string, AuthorInfo>()
-  commits.forEach(({ authors, shortHash }) => {
-    authors.forEach((a) => {
+  commits.forEach((commit) => {
+    commit.resolvedAuthors = commit.authors.map((a) => {
       if (!a.email || !a.name)
-        return
+        return null
       if (!map.has(a.email)) {
         map.set(a.email, {
           commits: [],
           name: a.name,
           email: a.email,
         })
       }
-      map.get(a.email)!.commits.push(shortHash)
-    })
+      const info = map.get(a.email)!
+      info.commits.push(commit.shortHash)
+      return info
+    }).filter(notNullish)
   })
   const authors = Array.from(map.values())
   const resolved = await Promise.all(authors.map(info => resolveAuthorInfo(options, info)))

src/markdown.ts

@@ -1,8 +1,7 @@
-import type { GitCommit } from 'changelogen'
 import { partition } from '@antfu/utils'
-import type { AuthorInfo, ResolvedChangelogOptions } from './types'
+import type { Commit, ResolvedChangelogOptions } from './types'
 
-function formatLine(commit: GitCommit, options: ResolvedChangelogOptions) {
+function formatLine(commit: Commit, options: ResolvedChangelogOptions) {
   const refs = commit.references.map((r) => {
     if (!options.github)
       return `\`${r}\``
@@ -12,16 +11,20 @@ function formatLine(commit: GitCommit, options: ResolvedChangelogOptions) {
     return `[\`${r}\`](${url})`
   }).join(' ')
 
-  return options.capitalize
-    ? `${capitalize(commit.description)} ${refs}`
-    : `${commit.description} ${refs}`
+  let authors = commit.resolvedAuthors?.map(i => i.login ? `@${i.login}` : i.name).join(' ').trim()
+  if (authors)
+    authors = `by ${authors}`
+
+  const description = options.capitalize ? capitalize(commit.description) : commit.description
+
+  return [description, refs, authors].filter(i => i?.trim()).join(' ')
 }
 
 function formatTitle(name: string) {
   return `###    ${name}`
 }
 
-function formatSection(commits: GitCommit[], sectionName: string, options: ResolvedChangelogOptions) {
+function formatSection(commits: Commit[], sectionName: string, options: ResolvedChangelogOptions) {
   if (!commits.length)
     return []
 
@@ -53,7 +56,7 @@ function formatSection(commits: GitCommit[], sectionName: string, options: Resol
   return lines
 }
 
-export function generateMarkdown(commits: GitCommit[], options: ResolvedChangelogOptions, contributors?: AuthorInfo[]) {
+export function generateMarkdown(commits: Commit[], options: ResolvedChangelogOptions) {
   const lines: string[] = []
 
   const [breaking, changes] = partition(commits, c => c.isBreaking)
@@ -74,15 +77,6 @@ export function generateMarkdown(commits: GitCommit[], options: ResolvedChangelo
   if (!lines.length)
     lines.push('*No significant changes*')
 
-  if (contributors?.length) {
-    lines.push(
-      '',
-      formatTitle(options.titles.contributors!),
-      '',
-      `   Thanks to ${contributors.map(i => i.login ? `@${i.login}` : i.name).join(' | ')}`,
-    )
-  }
-
   const url = `https://github.com/${options.github}/compare/${options.from}...${options.to}`
 
   lines.push('', `#####     [View changes on GitHub](${url})`)

src/types.ts

@@ -1,3 +1,5 @@
+import type { GitCommit } from 'changelogen'
+
 export interface GitHubRepo {
   owner: string
   repo: string
@@ -16,6 +18,10 @@ export interface ChangelogenOptions {
   to: string
 }
 
+export interface Commit extends GitCommit {
+  resolvedAuthors?: AuthorInfo[]
+}
+
 export interface ChangelogOptions extends Partial<ChangelogenOptions> {
   /**
    * Dry run. Skip releasing to GitHub.
@@ -48,7 +54,6 @@ export interface ChangelogOptions extends Partial<ChangelogenOptions> {
    */
   titles?: {
     breakingChanges?: string
-    contributors?: string
   }
   /**
    * Capitalize commit messages