From 2629d74bc27087be5450ef04a7c7f567417cbc46 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 00:54:23 +0800
Subject: [PATCH 1/9] refactor!: mv data processing to vite side

---
 docs/.vitepress/theme/index.ts                |  22 --
 docs/vite.config.ts                           |  22 ++
 .../package.json                              |   2 +-
 .../src/client/components/Contributors.vue    |  45 +--
 .../src/client/composables/author.test.ts     | 216 -----------
 .../src/client/composables/author.ts          | 168 ++------
 .../src/client/composables/commits.ts         |   4 +-
 .../src/client/types.ts                       |  74 +---
 .../src/client/virtual.d.ts                   |   6 +-
 .../src/types/index.ts                        |  74 +++-
 .../src/vite/git.ts                           |  68 ++--
 .../src/vite/helpers.test.ts                  | 363 +++++++++++++++++-
 .../src/vite/helpers.ts                       | 208 ++++++++--
 .../src/vite/types.ts                         |   5 +
 pnpm-lock.yaml                                |  17 +-
 15 files changed, 716 insertions(+), 578 deletions(-)

diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
index 588a2983..3b1a5f28 100644
--- a/docs/.vitepress/theme/index.ts
+++ b/docs/.vitepress/theme/index.ts
@@ -54,28 +54,6 @@ export default defineThemeUnconfig({
       gitChangelog: {
         enable: true,
         options: {
-          mapContributors: [
-            {
-              name: 'Neko',
-              username: 'nekomeowww',
-              mapByNameAliases: ['Neko Ayaka', 'Ayaka Neko'],
-              mapByEmailAliases: ['neko@ayaka.moe'],
-            },
-            {
-              name: 'Rizumu',
-              username: 'LittleSound',
-              mapByNameAliases: ['Rizumu Ayaka', 'Ayaka Rizumu'],
-              mapByEmailAliases: ['rizumu@ayaka.moe'],
-            },
-            {
-              name: 'Nisekoi5',
-              username: 'Nisekoi5',
-            },
-            {
-              name: 'Northword',
-              username: 'northword',
-            },
-          ],
           commitsRelativeTime: true,
         },
       },
diff --git a/docs/vite.config.ts b/docs/vite.config.ts
index 6c90f4d0..3871fd18 100644
--- a/docs/vite.config.ts
+++ b/docs/vite.config.ts
@@ -62,6 +62,28 @@ export default defineConfig({
     GitChangelog({
       maxGitLogCount: 2000,
       repoURL: () => 'https://github.com/nolebase/integrations',
+      mapAuthors: [
+        {
+          name: 'Neko',
+          username: 'nekomeowww',
+          mapByNameAliases: ['Neko Ayaka', 'Ayaka Neko'],
+          mapByEmailAliases: ['neko@ayaka.moe'],
+        },
+        {
+          name: 'Rizumu',
+          username: 'LittleSound',
+          mapByNameAliases: ['Rizumu Ayaka', 'Ayaka Rizumu'],
+          mapByEmailAliases: ['rizumu@ayaka.moe'],
+        },
+        {
+          name: 'Nisekoi5',
+          username: 'Nisekoi5',
+        },
+        {
+          name: 'Northword',
+          username: 'northword',
+        },
+      ],
     }),
     GitChangelogMarkdownSection({
       excludes: [
diff --git a/packages/vitepress-plugin-git-changelog/package.json b/packages/vitepress-plugin-git-changelog/package.json
index ee78b360..f8a40ba6 100644
--- a/packages/vitepress-plugin-git-changelog/package.json
+++ b/packages/vitepress-plugin-git-changelog/package.json
@@ -76,11 +76,11 @@
     "colorette": "^2.0.20",
     "date-fns": "^3.6.0",
     "defu": "^6.1.4",
+    "es-toolkit": "^1.13.1",
     "execa": "^8.0.1",
     "globby": "^14.0.1",
     "gray-matter": "^4.0.3",
     "less": "^4.2.0",
-    "ora": "^8.0.1",
     "uncrypto": "^0.1.3",
     "vitepress": "^1.2.3"
   },
diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue b/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
index 2668a0b7..879405ec 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
@@ -1,21 +1,19 @@
 <script setup lang="ts">
-import { inject, onMounted, onServerPrefetch, ref, watch } from 'vue'
+import { inject, onMounted } from 'vue'
 import { useData } from 'vitepress'
 import { defu } from 'defu'
 
 import { useCommits } from '../composables/commits'
 import { useI18n } from '../composables/i18n'
 import { InjectionKey, defaultOptions } from '../constants'
-import type { Commit } from '../types'
-import type { AuthorInfo } from '../composables/author'
-import { extractAuthorsWithMultiple, mapCommitAuthors } from '../composables/author'
+import { useAuthors } from '../composables/author'
 
 const options = defu(inject(InjectionKey, {}), defaultOptions)
-const contributors = ref<AuthorInfo[]>([])
 
 const { t } = useI18n()
 const { page } = useData()
 const { commits, update } = useCommits(page)
+const { authors } = useAuthors(commits)
 
 onMounted(() => {
   if (import.meta.hot) {
@@ -50,37 +48,6 @@ onMounted(() => {
     })
   }
 })
-
-async function aggregateAuthors(commits: Commit[]) {
-  const map: Record<string, AuthorInfo> = {}
-
-  if (options.mapAuthors) {
-    for (const c of commits) {
-      await mapCommitAuthors(options.mapAuthors, map, c)
-      await extractAuthorsWithMultiple(options.mapAuthors, map, c)
-    }
-  }
-  else {
-    for (const c of commits) {
-      await mapCommitAuthors(options.mapContributors, map, c)
-      await extractAuthorsWithMultiple(options.mapContributors, map, c)
-    }
-  }
-
-  return Object.values(map).sort((a, b) => b.commitsCount - a.commitsCount)
-}
-
-onServerPrefetch(async () => {
-  contributors.value = await aggregateAuthors(commits.value)
-})
-
-onMounted(async () => {
-  contributors.value = await aggregateAuthors(commits.value)
-})
-
-watch(commits, async (newCommits) => {
-  contributors.value = await aggregateAuthors(newCommits)
-})
 </script>
 
 <template>
@@ -93,7 +60,7 @@ watch(commits, async (newCommits) => {
     flex flex-wrap gap-4 pt-2
   >
     <em
-      v-if="!commits.length"
+      v-if="!authors.length"
       :class="[
         options.hideContributorsHeader && 'mt-6',
       ]"
@@ -104,13 +71,13 @@ watch(commits, async (newCommits) => {
       v-else
     >
       <template
-        v-for="c of contributors"
+        v-for="c of authors"
         :key="c.name"
       >
         <a
           v-if="(typeof c.url !== 'undefined')"
           :href="c.url"
-          class="flex items-center gap-2"
+          class="no-icon flex items-center gap-2"
         >
           <img :src="c.avatarUrl" :alt="`The avatar of contributor named as ${c.name}`" class="h-8 w-8 rounded-full">
           {{ c.name }}
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts
index d322182c..e8d2c2b2 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts
@@ -2,225 +2,9 @@ import { describe, expect, it } from 'vitest'
 import type { Commit, Contributor } from '../../types'
 import {
   extractAuthorsWithMultiple,
-  findMapAuthorByEmail,
-  findMapAuthorByName,
-  findMapAuthorLink,
   mapCommitAuthors,
-  newAvatarForAuthor,
 } from './author'
 
-describe('findMapAuthorByEmail', () => {
-  it('should return the registered creator by email', () => {
-    const creators: Contributor[] = [
-      {
-        name: 'John Doe',
-        mapByEmailAliases: ['example1@example.com'],
-      },
-    ]
-
-    const creator = findMapAuthorByEmail(creators, 'example1@example.com')
-    expect(creator).toEqual(creators[0])
-  })
-})
-
-describe('findMapAuthorByName', () => {
-  it('should return the registered creator by name', () => {
-    const creators: Contributor[] = [
-      {
-        name: 'John Doe',
-      },
-    ]
-
-    const creator = findMapAuthorByName(creators, 'John Doe')
-    expect(creator).toEqual(creators[0])
-  })
-
-  it('should return the registered creator by nameAliases', () => {
-    const creators: Contributor[] = [
-      {
-        name: 'John Doe',
-        mapByNameAliases: ['Johndoe'],
-      },
-    ]
-
-    const creator = findMapAuthorByName(creators, 'Johndoe')
-    expect(creator).toEqual(creators[0])
-  })
-})
-
-describe('findMapAuthorLink', () => {
-  it('should return the registered creator plain link', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: 'github.com/johndoe',
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual('github.com/johndoe')
-  })
-
-  it('should return the registered creator link', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: [
-        {
-          type: 'github',
-          link: 'github.com/johndoe',
-        },
-      ],
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual('github.com/johndoe')
-  })
-
-  it('should return the registered creator link follow by the priorities', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: [
-        {
-          type: 'twitter',
-          link: 'twitter.com/johndoe',
-        },
-        {
-          type: 'github',
-          link: 'github.com/johndoe',
-        },
-      ],
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual('github.com/johndoe')
-  })
-
-  it('should return the registered creator link follow by the priorities over twitter', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: [
-        {
-          type: 'twitter',
-          link: 'twitter.com/johndoe',
-        },
-      ],
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual('twitter.com/johndoe')
-  })
-
-  it('should return the registered creator link with only one link', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: [
-        {
-          type: 'personal',
-          link: 'example.com',
-        },
-        {
-          type: 'personal',
-          link: 'example2.com',
-        },
-        {
-          type: 'personal',
-          link: 'example3.com',
-        },
-      ],
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual('example.com')
-  })
-
-  it('should return the registered creator link with no links', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      username: 'johndoe',
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual('https://github.com/johndoe')
-  })
-
-  it('should return undefined when no links and username', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual(undefined)
-  })
-
-  it('should return undefined when links is empty string', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: '',
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual(undefined)
-  })
-
-  it('should return undefined when links is empty array', () => {
-    const creator: Contributor = {
-      name: 'John Doe',
-      links: [],
-    }
-
-    const link = findMapAuthorLink(creator)
-    expect(link).toEqual(undefined)
-  })
-})
-
-describe('newAvatarForAuthor', () => {
-  it('should return the mapped author avatar', async () => {
-    const mappedAuthor = {
-      avatar: 'https://example.com/avatar.png',
-    }
-
-    const avatar = await newAvatarForAuthor(mappedAuthor, {
-      author_name: 'John Doe',
-      author_email: 'user@example.com',
-      author_avatar: 'abcd',
-    })
-
-    expect(avatar).toEqual('https://example.com/avatar.png')
-  })
-
-  it('should return the mapped author avatar with username', async () => {
-    const mappedAuthor = {
-      username: 'johndoe',
-    }
-
-    const avatar = await newAvatarForAuthor(mappedAuthor, {
-      author_name: 'John Doe',
-      author_email: 'example.com',
-      author_avatar: 'abcd',
-    })
-
-    expect(avatar).toEqual('https://github.com/johndoe.png')
-  })
-
-  it('should return the commit author avatar', async () => {
-    const avatar = await newAvatarForAuthor(undefined, {
-      author_name: 'John Doe',
-      author_email: '',
-      author_avatar: 'abcd',
-    })
-
-    expect(avatar).toEqual('https://gravatar.com/avatar/abcd?d=retro')
-  })
-
-  it('should return the commit author avatar with email', async () => {
-    const avatar = await newAvatarForAuthor(undefined, {
-      author_name: 'John Doe',
-      author_email: 'user@example.com',
-      author_avatar: '',
-    })
-
-    expect(avatar).toEqual('https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro')
-  })
-})
-
 describe('mapCommitAuthors', () => {
   it('should be ok', async () => {
     const mappedCreators = {}
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts
index f4891e2b..71101ca8 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts
@@ -1,140 +1,44 @@
-import { digestStringAsSHA256 } from '../utils'
-import type { Commit, Contributor } from '../../types'
+import { type Ref, computed, ref } from 'vue'
+import Changelog from 'virtual:nolebase-git-changelog'
+import type { Commit, CommitAuthor } from '../../types'
 
-export interface AuthorInfo {
-  name: string
+export interface AuthorInfo extends CommitAuthor {
   commitsCount: number
-  avatarUrl?: string
-  url?: string
 }
 
-export function findMapAuthorByName(mapContributors: Contributor[] | undefined, author_name: string) {
-  return mapContributors?.find((item) => {
-    const res = (item.mapByNameAliases && Array.isArray(item.mapByNameAliases) && item.mapByNameAliases.includes(author_name)) || item.name === author_name
-    if (res)
-      return true
-
-    // This is a fallback for the old version of the configuration.
-    return item.nameAliases && Array.isArray(item.nameAliases) && item.nameAliases.includes(author_name)
-  })
-}
-
-export function findMapAuthorByEmail(mapContributors: Contributor[] | undefined, author_email: string) {
-  return mapContributors?.find((item) => {
-    const res = item.mapByEmailAliases && Array.isArray(item.mapByEmailAliases) && item.mapByEmailAliases.includes(author_email)
-    if (res)
-      return true
-
-    // This is a fallback for the old version of the configuration.
-    return item.emailAliases && Array.isArray(item.emailAliases) && item.emailAliases.includes(author_email)
+export function useAuthors(commits: Ref<Commit[]>) {
+  const changelog = ref<{ authors: CommitAuthor[] }>(Changelog)
+  const authors = computed(() => {
+    const uniq = new Map<string, AuthorInfo>()
+
+    commits.value.map(c => c.authors)
+      .flat()
+      .map((name) => {
+        if (!uniq.has(name)) {
+          uniq.set(name, {
+            name,
+            commitsCount: 1,
+          })
+          return true
+        }
+        else {
+          uniq.get(name)!.commitsCount++
+          return false
+        }
+      })
+
+    return Array.from(uniq.values())
+      .sort((a, b) => a.commitsCount - b.commitsCount)
+      .map((a) => {
+        return {
+          ...a,
+          ...changelog.value.authors.find(item => item.name === a.name),
+
+        }
+      })
   })
-}
-
-export function findMapAuthorLink(creator: Contributor): string | undefined {
-  if (!creator.links && !!creator.username)
-    return `https://github.com/${creator.username}`
-
-  if (typeof creator.links === 'string' && !!creator.links)
-    return creator.links
-  if (!Array.isArray(creator.links))
-    return
 
-  const priority = ['github', 'twitter']
-  for (const p of priority) {
-    const matchedEntry = creator.links?.find(l => l.type === p)
-    if (matchedEntry)
-      return matchedEntry.link
+  return {
+    authors,
   }
-
-  return creator.links?.[0]?.link
-}
-
-/**
- * This regular expression is used to match and parse commit messages that contain multiple author information.
- *
- * @see {@link https://regex101.com/r/q5YB8m/1 | Regexp demo}
- * @see {@link https://en.wikipedia.org/wiki/Email_address#Local-part | Email addres}
- * @see {@link https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors | Creating a commit with multiple authors in GitHub}
- */
-const multipleAuthorsRegex = /^ *Co-authored-by: ?([^<]*)<([^>]*)> */gim
-
-// This function handles multiple authors in a commit.
-// It uses the regular expression to extract the name and email of each author from the commit message.
-// About the docs: https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors
-export async function extractAuthorsWithMultiple(
-  mapContributors: Contributor[] | undefined,
-  authorDataMap: Record<string, AuthorInfo>,
-  c: Pick<Commit, 'body'>,
-) {
-  if (!c.body)
-    return
-  let result: RegExpExecArray | null
-  multipleAuthorsRegex.lastIndex = 0
-  // eslint-disable-next-line no-cond-assign
-  while (result = multipleAuthorsRegex.exec(c.body)) {
-    const [, name, email] = result
-    await mapCommitAuthors(mapContributors, authorDataMap, {
-      author_name: name.trim(),
-      author_email: email.trim(),
-      author_avatar: await digestStringAsSHA256(email.trim()),
-    })
-  }
-}
-
-export async function newAvatarForAuthor(mappedAuthor: Contributor | undefined, commitAuthor: Pick<Commit, 'author_name' | 'author_email' | 'author_avatar'>): Promise<string> {
-  if (mappedAuthor) {
-    if (mappedAuthor.avatar)
-      return mappedAuthor.avatar
-    if (mappedAuthor.username)
-      return `https://github.com/${mappedAuthor.username}.png`
-  }
-  if (commitAuthor.author_avatar)
-    return `https://gravatar.com/avatar/${commitAuthor.author_avatar}?d=retro`
-
-  return `https://gravatar.com/avatar/${await digestStringAsSHA256(commitAuthor.author_email)}?d=retro`
-}
-
-export async function mapCommitAuthors(
-  mapContributors: Contributor[] | undefined,
-  map: Record<string, AuthorInfo>,
-  commitAuthor: Pick<Commit, 'author_name' | 'author_email' | 'author_avatar'>,
-) {
-  const targetCreatorByName = findMapAuthorByName(mapContributors, commitAuthor.author_name)
-  const targetCreatorByEmail = findMapAuthorByEmail(mapContributors, commitAuthor.author_email)
-
-  let name = ''
-  let avatar = ''
-  let url: string | undefined
-
-  if (targetCreatorByName) {
-    name = targetCreatorByName.name || commitAuthor.author_name
-    avatar = await newAvatarForAuthor(targetCreatorByName, commitAuthor)
-
-    const foundSocialEntryUrl = findMapAuthorLink(targetCreatorByName)
-    if (foundSocialEntryUrl)
-      url = foundSocialEntryUrl
-  }
-  else if (targetCreatorByEmail) {
-    name = targetCreatorByEmail.name || commitAuthor.author_name
-    avatar = await newAvatarForAuthor(targetCreatorByEmail, commitAuthor)
-
-    const foundSocialEntryUrl = findMapAuthorLink(targetCreatorByEmail)
-    if (foundSocialEntryUrl)
-      url = foundSocialEntryUrl
-  }
-  else {
-    name = commitAuthor.author_name
-    avatar = await newAvatarForAuthor(undefined, commitAuthor)
-  }
-
-  if (!map[name]) {
-    map[name] = {
-      name,
-      commitsCount: 0,
-      avatarUrl: avatar,
-      url,
-    }
-  }
-
-  map[name].commitsCount++
 }
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
index 2699f115..8464acc3 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
@@ -13,9 +13,9 @@ export function useCommits(pageData: Ref<PageData>) {
     commits: computed<Commit[]>(() => {
       const currentPath = toValue(pageData.value.filePath)
 
-      const preCommits = gitChangelog.value.commits
+      const allCommits = gitChangelog.value.commits
       // filter the commits that either have a tag, or directly equal the current path, or renamed to the current path
-      const commits = preCommits.filter(c => c.path === currentPath) || []
+      const commits = allCommits.filter(c => c.paths.includes(currentPath)) || []
 
       return commits.filter((commit, index) => {
         if (commit.tag && (!commits[index + 1] || commits[index + 1]?.tag))
diff --git a/packages/vitepress-plugin-git-changelog/src/client/types.ts b/packages/vitepress-plugin-git-changelog/src/client/types.ts
index 20a552f3..f3f07cd0 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/types.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/types.ts
@@ -119,6 +119,10 @@ export interface Options {
    * @see mapAuthors
    */
   mapContributors?: Contributor[]
+  /**
+   * @deprecated Use `mapAuthors` in vite side
+   * @see mapAuthors
+   */
   mapAuthors?: Author[]
   /**
    * Number of commit hash letters to display
@@ -144,73 +148,3 @@ export interface Options {
    */
   hideSortBy?: boolean
 }
-
-export interface Commit {
-  /**
-   * The file path for this commit.
-   *
-   * When the file is located in `srcDir`, the path is relative to `srcDir`.
-   * Otherwise, the path is relative to cwd. Paths without `. /`.
-   */
-  path: string
-  /**
-   * The matched first tag of the commit.
-   */
-  tag?: string
-  /**
-   * The matched tags of the commit.
-   */
-  tags?: string[]
-  /**
-   * The URL of the release tag.
-   */
-  release_tag_url?: string
-  /**
-   * The URLs of the release tags.
-   */
-  release_tags_url?: string[]
-  /**
-   * The hash of the commit.
-   */
-  hash: string
-  /**
-   * The URL of the commit.
-   */
-  hash_url?: string
-  /**
-   * The date of the commit.
-   */
-  date: string
-  /**
-   * The UNIX timestamp of the commit.
-   */
-  date_timestamp: number
-  /**
-   * The message of the commit.
-   */
-  message: string
-  /**
-   * The refs of the commit.
-   */
-  refs?: string
-  /**
-   * The body of the commit.
-   */
-  body?: string
-  /**
-   * The author name of the commit.
-   */
-  author_name: string
-  /**
-   * The author email of the commit.
-   */
-  author_email: string
-  /**
-   * The author avatar of the commit.
-   */
-  author_avatar: string
-  /**
-   * The repository URL.
-   */
-  repo_url?: string
-}
diff --git a/packages/vitepress-plugin-git-changelog/src/client/virtual.d.ts b/packages/vitepress-plugin-git-changelog/src/client/virtual.d.ts
index 84098ddc..49db8eb8 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/virtual.d.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/virtual.d.ts
@@ -1,12 +1,8 @@
 declare module 'virtual:nolebase-git-changelog' {
-  import type Commit from '../types'
+  import type { Changelog, Commit } from '../types'
 
   export type { Commit }
 
-  interface Changelog {
-    commits: Commit[]
-  }
-
   const changelog: Changelog
   export default changelog
 }
diff --git a/packages/vitepress-plugin-git-changelog/src/types/index.ts b/packages/vitepress-plugin-git-changelog/src/types/index.ts
index 0f7aefe7..7cdc935b 100644
--- a/packages/vitepress-plugin-git-changelog/src/types/index.ts
+++ b/packages/vitepress-plugin-git-changelog/src/types/index.ts
@@ -1,4 +1,4 @@
-export interface Commit {
+export interface RawCommit {
   /**
    * The file path for this commit.
    *
@@ -6,6 +6,48 @@ export interface Commit {
    * Otherwise, the path is relative to cwd. Paths without `. /`.
    */
   path: string
+  /**
+   * The hash of the commit.
+   */
+  hash: string
+  /**
+   * The date of the commit.
+   */
+  date: string
+  /**
+   * The message of the commit.
+   */
+  message: string
+  /**
+   * The refs of the commit.
+   */
+  refs?: string
+  /**
+   * The body of the commit.
+   */
+  body?: string
+  /**
+   * The author name of the commit.
+   */
+  author_name: string
+  /**
+   * The author email of the commit.
+   */
+  author_email: string
+}
+
+export interface MergedRawCommit extends Omit<RawCommit, 'path'> {
+  paths: string[]
+}
+
+export interface Commit extends Omit<MergedRawCommit, 'date' | 'body' | 'refs' | 'author_name' | 'author_email'> {
+  /**
+   * The file path for this commit.
+   *
+   * When the file is located in `srcDir`, the path is relative to `srcDir`.
+   * Otherwise, the path is relative to cwd. Paths without `. /`.
+   */
+  paths: string[]
   /**
    * The matched first tag of the commit.
    */
@@ -30,10 +72,6 @@ export interface Commit {
    * The URL of the commit.
    */
   hash_url?: string
-  /**
-   * The date of the commit.
-   */
-  date: string
   /**
    * The UNIX timestamp of the commit.
    */
@@ -42,34 +80,34 @@ export interface Commit {
    * The message of the commit.
    */
   message: string
+
+  authors: string[]
+
   /**
-   * The refs of the commit.
-   */
-  refs?: string
-  /**
-   * The body of the commit.
+   * The repository URL.
    */
-  body?: string
+  repo_url?: string
+}
+
+export interface CommitAuthor {
   /**
    * The author name of the commit.
    */
-  author_name: string
+  name: string
   /**
    * The author email of the commit.
    */
-  author_email: string
+  email?: string
   /**
    * The author avatar of the commit.
    */
-  author_avatar: string
-  /**
-   * The repository URL.
-   */
-  repo_url?: string
+  avatarUrl?: string
+  url?: string
 }
 
 export interface Changelog {
   commits: Commit[]
+  authors?: CommitAuthor[]
 }
 
 export interface SocialEntry {
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/git.ts b/packages/vitepress-plugin-git-changelog/src/vite/git.ts
index 00a5d416..b32ad38e 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/git.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/git.ts
@@ -2,7 +2,6 @@ import { cwd as _cwd } from 'node:process'
 import { join } from 'node:path'
 import { type Plugin, type ResolvedConfig, normalizePath } from 'vite'
 import type { SiteConfig } from 'vitepress'
-import ora from 'ora'
 import { cyan, gray } from 'colorette'
 import { globby } from 'globby'
 import { execa } from 'execa'
@@ -17,7 +16,9 @@ import {
   defaultReleaseTagsURLHandler,
   getRawCommitLogs,
   getRelativePath,
+  mergeRawCommits,
   parseCommits,
+  parseRawCommitLogs,
   rewritePathsByRewritingExtension,
 } from './helpers'
 import type { GitChangelogOptions } from './types'
@@ -40,6 +41,7 @@ const VirtualModuleID = 'virtual:nolebase-git-changelog'
 const ResolvedVirtualModuleId = `\0${VirtualModuleID}`
 
 const logModulePrefix = `${cyan(`@nolebase/vitepress-plugin-git-changelog`)}${gray(':')}`
+const logger = console
 
 export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
   if (!options)
@@ -49,6 +51,7 @@ export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
     cwd = _cwd(),
     maxGitLogCount,
     include = ['**/*.md', '!node_modules'],
+    mapAuthors,
     repoURL = 'https://github.com/example/example',
     getReleaseTagURL = defaultReleaseTagURLHandler,
     getReleaseTagsURL = defaultReleaseTagsURLHandler,
@@ -58,23 +61,29 @@ export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
 
   const getRepoURL = typeof repoURL === 'function' ? repoURL : () => repoURL
 
-  const changelog: Changelog = { commits: [] }
-  const hotModuleReloadCachedCommits: Record<string, Commit[]> = {}
+  const changelog: Changelog = { commits: [], authors: [] }
+  const hotModuleReloadCachedCommits = new Map<string, Changelog>()
   let srcDir = ''
   let config: VitePressConfig
 
-  const commitFromPath = async (path: string) => {
-    const rawLogs = await getRawCommitLogs(path, maxGitLogCount)
-    const relativePath = getRelativePath(path, srcDir, cwd)
-    return await parseCommits(
-      relativePath,
-      rawLogs,
+  const commitFromPath = async (paths: string[]) => {
+    const rawCommits = (await Promise.all(paths.map(async (path) => {
+      const rawLogs = await getRawCommitLogs(path, maxGitLogCount)
+      const relativePath = getRelativePath(path, srcDir, cwd)
+      const rawCommits = parseRawCommitLogs(relativePath, rawLogs)
+      return rawCommits
+    }))).flat()
+    const mergedRawCommits = mergeRawCommits(rawCommits)
+    const resolvedCommits = parseCommits(
+      mergedRawCommits,
       getRepoURL,
       getCommitURL,
       getReleaseTagURL,
       getReleaseTagsURL,
+      mapAuthors,
       rewritePathsBy,
     )
+    return resolvedCommits
   }
 
   return {
@@ -105,9 +114,7 @@ export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
         return
 
       const startsAt = Date.now()
-      const spinner = ora({ discardStdin: false, isEnabled: false })
-
-      spinner.start(`${logModulePrefix} Prepare to gather git logs...`)
+      logger.info(`${logModulePrefix} Prepare to gather git logs...`)
 
       if (changelog.commits.length > 0)
         return
@@ -115,32 +122,26 @@ export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
       // configure so that the git log messages can contain correct CJK characters
       await execa('git', ['config', '--local', 'core.quotepath', 'false'])
 
-      spinner.text = `${logModulePrefix} Gathering git logs...`
-      spinner.color = 'yellow'
-
       const paths = await globby(include, {
         gitignore: true,
         cwd,
         absolute: true,
       })
 
-      changelog.commits = (await Promise.all(
-        paths.map(async path => await commitFromPath(path)),
-      ))
-        .flat()
+      Object.assign(changelog, await commitFromPath(paths))
 
       const elapsed = Date.now() - startsAt
-      spinner.succeed(`${logModulePrefix} Done. ${gray(`(${elapsed}ms)`)}`)
+      logger.info(`${logModulePrefix} Done. ${gray(`(${elapsed}ms)`)}`)
     },
-    resolveId(id) {
-      if (id === VirtualModuleID)
-        return ResolvedVirtualModuleId
+    resolveId(source) {
+      if (source.startsWith(VirtualModuleID))
+        return `\0${source}`
     },
     load(id) {
-      if (id !== ResolvedVirtualModuleId)
+      if (!id.startsWith(ResolvedVirtualModuleId))
         return null
 
-      return `export default ${JSON.stringify(changelog)}`
+      return `export default ${JSON.stringify(changelog, null, config.isProduction ? 0 : 2)}`
     },
     configureServer(server) {
       server.hot.on('nolebase-git-changelog:client-mounted', async (data) => {
@@ -149,24 +150,21 @@ export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
         if (!('page' in data && 'filePath' in data.page))
           return
 
-        let commits: Commit[] = []
-        if (hotModuleReloadCachedCommits[data.page.filePath]) {
-          commits = hotModuleReloadCachedCommits[data.page.filePath]
-        }
-        else {
+        let result = hotModuleReloadCachedCommits.get(data.page.filePath)
+        if (!result) {
           const path = normalizePath(join(srcDir, data.page.filePath))
-          commits = [...(await commitFromPath(path))]
-          hotModuleReloadCachedCommits[data.page.filePath] = commits
+          result = await commitFromPath([path])
+          Object.assign(changelog, result)
+          // hotModuleReloadCachedCommits.set(data.page.filePath, result)
         }
-        if (!commits.length)
+
+        if (!result!.commits.length)
           return
 
         const virtualModule = server.moduleGraph.getModuleById(ResolvedVirtualModuleId)
         if (!virtualModule)
           return
 
-        changelog.commits = commits
-
         server.moduleGraph.invalidateModule(virtualModule)
         server.hot.send({
           type: 'custom',
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts b/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts
index 665a4197..37a17b2f 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts
@@ -1,12 +1,19 @@
 import { describe, expect, it } from 'vitest'
 
-import type { Commit } from '../types'
+import type { Commit, Contributor } from '../types'
 import {
   defaultCommitURLHandler,
   defaultReleaseTagURLHandler,
   defaultReleaseTagsURLHandler,
+  findMapAuthorByEmail,
+  findMapAuthorByName,
+  findMapAuthorLink,
+  mergeRawCommits,
+  newAvatarForAuthor,
+  parseCommitAuthors,
   parseCommits,
   parseGitLogRefsAsTags,
+  parseRawCommitLogs,
   rewritePathsByPatterns,
   rewritePathsByRewritingExtension,
 } from './helpers'
@@ -83,12 +90,364 @@ describe('parseGitLogRefsAsTags', () => {
   })
 })
 
+describe('parseRawCommitLogs', () => {
+  it('should init commit with fields transformed', async () => {
+    const mockedCommits = ['c16db1033fce57f50b261e9944c136a26fcaccc6|First Last|user@example.com|Mon Mar 25 20:05:53 2024 +0800|release: v1.24.3| (tag: v1.24.3)|Signed-off-by: First Last <user@example.com>\n']
+
+    const commit = await parseRawCommitLogs('', mockedCommits)
+
+    expect(commit).toEqual([{
+      path: '',
+      hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+      date: 'Mon Mar 25 20:05:53 2024 +0800',
+      message: 'release: v1.24.3',
+      refs: '(tag: v1.24.3)',
+      body: 'Signed-off-by: First Last <user@example.com>',
+      author_name: 'First Last',
+      author_email: 'user@example.com',
+    }])
+  })
+
+  it('should return no commits when empty', async () => {
+    const mockedCommit = [
+      '', // empty commit, could occur when the file contains no history or git cli bugged
+    ]
+    const commit = await parseRawCommitLogs('', mockedCommit)
+
+    expect(commit).toEqual([])
+  })
+})
+
+describe('mergeRawCommits', () => {
+  it('should merge commits by path', () => {
+    const mockedCommits = [
+      {
+        path: '/fack/path/1.md',
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+      {
+        path: '/fack/path/2.md',
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+    ]
+
+    const commits = mergeRawCommits(mockedCommits)
+
+    expect(commits).toEqual([
+      {
+        paths: ['/fack/path/1.md', '/fack/path/2.md'],
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+    ])
+  })
+
+  it('should convert path to paths', () => {
+    const mockedCommits = [
+      {
+        path: '/fack/path/1.md',
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+      {
+        path: '/fack/path/1.md',
+        hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+        date: 'Wed Apr 24 14:24:44 2024 +0800',
+        message: 'docs: fix english integrations list',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+    ]
+
+    const commits = mergeRawCommits(mockedCommits)
+
+    expect(commits).toEqual([
+      {
+        paths: ['/fack/path/1.md'],
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+      {
+        paths: ['/fack/path/1.md'],
+        hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+        date: 'Wed Apr 24 14:24:44 2024 +0800',
+        message: 'docs: fix english integrations list',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+    ])
+  })
+})
+
+describe('parseCommitAuthors', () => {
+  it('should parse author from raw commit', async () => {
+    const mockedCommit = {
+      paths: ['/fack/path/1.md'],
+      hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+      date: 'Wed Apr 24 14:24:44 2024 +0800',
+      message: 'docs: fix english integrations list',
+      body: '',
+      author_name: 'First Last',
+      author_email: 'user@example.com',
+    }
+
+    const authors = await parseCommitAuthors(mockedCommit)
+    expect(authors).toEqual([{ name: 'First Last', email: 'user@example.com' }])
+  })
+
+  it('should parse co-author from body', async () => {
+    const mockedCommit = {
+      paths: ['/fack/path/1.md'],
+      hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+      date: 'Wed Apr 24 14:24:44 2024 +0800',
+      message: 'docs: fix english integrations list',
+      body: 'Co-authored-by: First Last2 <user2@example.com>',
+      author_name: 'First Last',
+      author_email: 'user@example.com',
+    }
+
+    const authors = await parseCommitAuthors(mockedCommit)
+    expect(authors).toEqual([
+      { name: 'First Last', email: 'user@example.com' },
+      { name: 'First Last2', email: 'user2@example.com' },
+    ])
+  })
+
+  it('should exclude bot user', async () => {
+    const mockedCommit = {
+      paths: ['/fack/path/1.md'],
+      hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+      date: 'Wed Apr 24 14:24:44 2024 +0800',
+      message: 'docs: fix english integrations list',
+      body: '',
+      author_name: 'renovate[bot]',
+      author_email: 'renovate[bot]@renovate.com',
+    }
+
+    const authors = await parseCommitAuthors(mockedCommit)
+    expect(authors).toEqual([])
+  })
+})
+
+describe('findMapAuthorByEmail', () => {
+  it('should return the registered creator by email', () => {
+    const creators: Contributor[] = [
+      {
+        name: 'John Doe',
+        mapByEmailAliases: ['example1@example.com'],
+      },
+    ]
+
+    const creator = findMapAuthorByEmail(creators, 'example1@example.com')
+    expect(creator).toEqual(creators[0])
+  })
+})
+
+describe('findMapAuthorByName', () => {
+  it('should return the registered creator by name', () => {
+    const creators: Contributor[] = [
+      {
+        name: 'John Doe',
+      },
+    ]
+
+    const creator = findMapAuthorByName(creators, 'John Doe')
+    expect(creator).toEqual(creators[0])
+  })
+
+  it('should return the registered creator by nameAliases', () => {
+    const creators: Contributor[] = [
+      {
+        name: 'John Doe',
+        mapByNameAliases: ['Johndoe'],
+      },
+    ]
+
+    const creator = findMapAuthorByName(creators, 'Johndoe')
+    expect(creator).toEqual(creators[0])
+  })
+})
+
+describe('findMapAuthorLink', () => {
+  it('should return the registered creator plain link', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: 'github.com/johndoe',
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual('github.com/johndoe')
+  })
+
+  it('should return the registered creator link', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: [
+        {
+          type: 'github',
+          link: 'github.com/johndoe',
+        },
+      ],
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual('github.com/johndoe')
+  })
+
+  it('should return the registered creator link follow by the priorities', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: [
+        {
+          type: 'twitter',
+          link: 'twitter.com/johndoe',
+        },
+        {
+          type: 'github',
+          link: 'github.com/johndoe',
+        },
+      ],
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual('github.com/johndoe')
+  })
+
+  it('should return the registered creator link follow by the priorities over twitter', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: [
+        {
+          type: 'twitter',
+          link: 'twitter.com/johndoe',
+        },
+      ],
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual('twitter.com/johndoe')
+  })
+
+  it('should return the registered creator link with only one link', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: [
+        {
+          type: 'personal',
+          link: 'example.com',
+        },
+        {
+          type: 'personal',
+          link: 'example2.com',
+        },
+        {
+          type: 'personal',
+          link: 'example3.com',
+        },
+      ],
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual('example.com')
+  })
+
+  it('should return the registered creator link with no links', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      username: 'johndoe',
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual('https://github.com/johndoe')
+  })
+
+  it('should return undefined when no links and username', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual(undefined)
+  })
+
+  it('should return undefined when links is empty string', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: '',
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual(undefined)
+  })
+
+  it('should return undefined when links is empty array', () => {
+    const creator: Contributor = {
+      name: 'John Doe',
+      links: [],
+    }
+
+    const link = findMapAuthorLink(creator)
+    expect(link).toEqual(undefined)
+  })
+})
+
+describe('newAvatarForAuthor', () => {
+  it('should return the mapped author avatar', async () => {
+    const mappedAuthor = {
+      avatar: 'https://example.com/avatar.png',
+    }
+
+    const avatar = await newAvatarForAuthor(mappedAuthor, 'user@example.com')
+
+    expect(avatar).toEqual('https://example.com/avatar.png')
+  })
+
+  it('should return the mapped author avatar with username', async () => {
+    const mappedAuthor = {
+      username: 'johndoe',
+    }
+
+    const avatar = await newAvatarForAuthor(mappedAuthor, 'user@example.com')
+
+    expect(avatar).toEqual('https://github.com/johndoe.png')
+  })
+
+  it('should return the commit author avatar with email', async () => {
+    const avatar = await newAvatarForAuthor(undefined, 'user@example.com')
+
+    expect(avatar).toEqual('https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro')
+  })
+})
+
 describe('parseCommits', () => {
   it('should init commit with fields transformed', async () => {
     const mockedCommits = ['c16db1033fce57f50b261e9944c136a26fcaccc6|First Last|user@example.com|Mon Mar 25 20:05:53 2024 +0800|release: v1.24.3| (tag: v1.24.3)|Signed-off-by: First Last <user@example.com>\n']
 
     const commit = await parseCommits(
-      '',
       mockedCommits,
       () => 'https://github.com/example-org/example',
       defaultCommitURLHandler,
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts b/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts
index 184e8020..50432597 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts
@@ -2,7 +2,8 @@ import { basename, dirname, extname, posix, relative, sep, win32 } from 'node:pa
 import { subtle } from 'uncrypto'
 import { normalizePath } from 'vite'
 import { execa } from 'execa'
-import type { Commit } from '../types'
+import { omit } from 'es-toolkit'
+import type { Commit, CommitAuthor, Contributor, MergedRawCommit, RawCommit } from '../types'
 
 export interface Helpers {
   /**
@@ -221,6 +222,11 @@ export function generateCommitPathsRegExp(includeDirs: string[], includeExtensio
   return new RegExp(`^${includeDirs.length > 0 ? `(${includeDirs.join('|')})${sep === win32.sep ? win32.sep : `\\${posix.sep}`}` : ''}.+${includeExtensions.length > 0 ? `(${includeExtensions.join('|')})` : '.md'}$`)
 }
 
+export function getRelativePath(file: string, srcDir: string, cwd: string) {
+  cwd = normalizePath(cwd)
+  return file.replace(srcDir, '').replace(cwd, '').replace(/^\//, '')
+}
+
 export async function getRawCommitLogs(file: string, maxGitLogCount?: number) {
   const fileDir = dirname(file)
   const fileName = basename(file)
@@ -250,63 +256,205 @@ export async function getRawCommitLogs(file: string, maxGitLogCount?: number) {
   return stdout.replace(/\[GIT_LOG_COMMIT_END\]$/, '').split('[GIT_LOG_COMMIT_END]\n')
 }
 
-export function getRelativePath(file: string, srcDir: string, cwd: string) {
-  cwd = normalizePath(cwd)
-  return file.replace(srcDir, '').replace(cwd, '').replace(/^\//, '')
+export function parseRawCommitLogs(
+  path: string,
+  rawLogs: string[],
+): RawCommit[] {
+  return rawLogs
+    .filter(log => !!log)
+    .map((raw) => {
+      const [hash, author_name, author_email, date, message, refs, body] = raw.split('|').map(v => v.trim())
+      return {
+        path,
+        hash,
+        date,
+        message,
+        body,
+        refs,
+        author_name,
+        author_email,
+      }
+    })
+}
+
+export function mergeRawCommits(rawCommits: RawCommit[]): MergedRawCommit[] {
+  const commitMap = new Map<string, MergedRawCommit>()
+
+  rawCommits.forEach((commit) => {
+    const _commit = commitMap.get(commit.hash)
+    if (_commit)
+      _commit.paths.push(commit.path)
+    else
+      commitMap.set(commit.hash, { paths: [commit.path], ...omit(commit, ['path']) })
+  })
+
+  return Array.from(commitMap.values())
 }
 
 export async function parseCommits(
-  path: string,
-  rawLogs: string[],
+  rawCommits: MergedRawCommit[],
   getRepoURL: CommitToStringHandler,
   getCommitURL: CommitToStringHandler,
   getReleaseTagURL: CommitToStringHandler,
   getReleaseTagsURL: CommitToStringsHandler,
+  mapContributors?: Contributor[],
   optsRewritePathsBy?: RewritePathsBy,
-): Promise<Commit[]> {
-  rawLogs = rawLogs.filter(log => !!log)
+): Promise<{ commits: Commit[], authors: CommitAuthor[] }> {
+  const allAuthors = new Map<string, CommitAuthor>()
+  const resolvedCommits = await Promise.all(rawCommits.map(async (rawCommit) => {
+    const { paths, hash, date, refs, message } = rawCommit
 
-  const commits = await Promise.all(rawLogs.map(async (raw) => {
-    const [hash, author_name, author_email, date, message, refs, body] = raw.split('|').map(v => v.trim())
-    const commit: Commit = {
-      path,
+    const resolvedCommit: Commit = {
+      paths,
       hash,
-      date,
-      date_timestamp: 0,
+      date_timestamp: new Date(date).getTime(),
       message,
-      body,
-      author_name,
-      author_email,
-      author_avatar: '',
+      authors: [],
     }
 
     // rewrite path
+    // Ensure that paths are processed first, as users may generate other properties based on this one.
     if (typeof optsRewritePathsBy !== 'undefined')
-      commit.path = await rewritePathsByPatterns(commit, commit.path, optsRewritePathsBy)
+      await Promise.all(rawCommit.paths.map((async p => await rewritePathsByPatterns(resolvedCommit, p, optsRewritePathsBy))))
 
     // repo url
-    commit.repo_url = (await returnOrResolvePromise(getRepoURL(commit))) ?? 'https://github.com/example/example'
+    resolvedCommit.repo_url = (await returnOrResolvePromise(getRepoURL(resolvedCommit))) ?? 'https://github.com/example/example'
     // hash url
-    commit.hash_url = (await returnOrResolvePromise(getCommitURL(commit))) ?? defaultCommitURLHandler(commit)
+    resolvedCommit.hash_url = (await returnOrResolvePromise(getCommitURL(resolvedCommit))) ?? defaultCommitURLHandler(resolvedCommit)
 
     // remove `()` in refs, e.g. ` (tag: v2.0.0-rc7)`
     const tags = parseGitLogRefsAsTags(refs?.replace(/[()]/g, ''))
 
     // release logs
     if (tags && tags.length > 0) {
-      commit.tags = tags
-      commit.tag = commit.tags?.[0] || undefined
-      commit.release_tag_url = (await returnOrResolvePromise(getReleaseTagURL(commit))) ?? defaultReleaseTagURLHandler(commit)
-      commit.release_tags_url = (await returnOrResolvePromise(getReleaseTagsURL(commit))) ?? defaultReleaseTagsURLHandler(commit)
+      resolvedCommit.tags = tags
+      resolvedCommit.tag = resolvedCommit.tags?.[0] || undefined
+      resolvedCommit.release_tag_url = (await returnOrResolvePromise(getReleaseTagURL(resolvedCommit))) ?? defaultReleaseTagURLHandler(resolvedCommit)
+      resolvedCommit.release_tags_url = (await returnOrResolvePromise(getReleaseTagsURL(resolvedCommit))) ?? defaultReleaseTagsURLHandler(resolvedCommit)
     }
 
-    // timestamp
-    commit.date_timestamp = new Date(commit.date).getTime()
+    // authors
+    const authors = await parseCommitAuthors(rawCommit, mapContributors)
+    authors.forEach(a => allAuthors.set(a.name, omit(a, ['email'])))
+    resolvedCommit.authors = authors.map(a => a.name)
+
     // generate author avatar based on md5 hash of email (gravatar style)
-    commit.author_avatar = await digestStringAsSHA256(commit.author_email)
+    // resolvedCommit.author_avatar = await digestStringAsSHA256(rawCommit.author_email)
 
-    return commit
+    return resolvedCommit
   }))
 
-  return commits
+  return { commits: resolvedCommits, authors: [...allAuthors.values()] }
+}
+
+export async function parseCommitAuthors(commit: MergedRawCommit, mapContributors?: Contributor[]): Promise<CommitAuthor[]> {
+  const { author_name, author_email, body } = commit
+
+  const commitAuthor: CommitAuthor = {
+    name: author_name,
+    email: author_email,
+  }
+  const coAthors = getCoAuthors(body)
+
+  return await Promise.all([commitAuthor, ...coAthors]
+    // exclude bot users
+    .filter(v => !(v.name.match(/\[bot\]/i) || v.email?.match(/\[bot\]/i)))
+    // map authors
+    .map(async (author) => {
+      const targetCreatorByName = findMapAuthorByName(mapContributors, author.name)
+      if (targetCreatorByName) {
+        author.name = targetCreatorByName.name ?? author.name
+        author.url = findMapAuthorLink(targetCreatorByName)
+        author.avatarUrl = await newAvatarForAuthor(targetCreatorByName, author_email)
+        return author
+      }
+      const targetCreatorByEmail = author.email && findMapAuthorByEmail(mapContributors, author.email)
+      if (targetCreatorByEmail) {
+        author.name = targetCreatorByEmail.name ?? author.name
+        author.url = findMapAuthorLink(targetCreatorByEmail)
+        author.avatarUrl = await newAvatarForAuthor(targetCreatorByEmail, author_email)
+        return author
+      }
+      author.avatarUrl = await newAvatarForAuthor(undefined, author_email)
+      return author
+    }))
+}
+
+/**
+ * This regular expression is used to match and parse commit messages that contain multiple author information.
+ *
+ * @see {@link https://regex101.com/r/q5YB8m/1 | Regexp demo}
+ * @see {@link https://en.wikipedia.org/wiki/Email_address#Local-part | Email addres}
+ * @see {@link https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors | Creating a commit with multiple authors in GitHub}
+ */
+const multipleAuthorsRegex = /^ *Co-authored-by: ?([^<]*)<([^>]*)> */gim
+
+// This function handles multiple authors in a commit.
+// It uses the regular expression to extract the name and email of each author from the commit message.
+// About the docs: https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors
+export function getCoAuthors(body?: string): CommitAuthor[] {
+  if (!body)
+    return []
+
+  return body.split('\n').map((b) => {
+    const result = multipleAuthorsRegex.exec(b)
+    if (!result)
+      return undefined
+
+    const [, name, email] = result
+    return {
+      name: name.trim(),
+      email: email.trim(),
+    }
+  }).filter(v => !!v)
+}
+
+// TODO: mapCommitAuthors
+export function findMapAuthorByName(mapContributors: Contributor[] | undefined, author_name: string) {
+  return mapContributors?.find((item) => {
+    const res = (item.mapByNameAliases && Array.isArray(item.mapByNameAliases) && item.mapByNameAliases.includes(author_name)) || item.name === author_name
+    if (res)
+      return true
+
+    // This is a fallback for the old version of the configuration.
+    return item.nameAliases && Array.isArray(item.nameAliases) && item.nameAliases.includes(author_name)
+  })
+}
+
+export function findMapAuthorByEmail(mapContributors: Contributor[] | undefined, author_email: string) {
+  return mapContributors?.find((item) => {
+    const res = item.mapByEmailAliases && Array.isArray(item.mapByEmailAliases) && item.mapByEmailAliases.includes(author_email)
+    if (res)
+      return true
+
+    // This is a fallback for the old version of the configuration.
+    return item.emailAliases && Array.isArray(item.emailAliases) && item.emailAliases.includes(author_email)
+  })
+}
+
+export function findMapAuthorLink(creator: Contributor): string | undefined {
+  if (!creator.links && !!creator.username)
+    return `https://github.com/${creator.username}`
+
+  if (typeof creator.links === 'string' && !!creator.links)
+    return creator.links
+  if (!Array.isArray(creator.links))
+    return
+
+  const priority = ['github', 'twitter']
+  for (const p of priority) {
+    const matchedEntry = creator.links?.find(l => l.type === p)
+    if (matchedEntry)
+      return matchedEntry.link
+  }
+
+  return creator.links?.[0]?.link
+}
+
+export async function newAvatarForAuthor(mappedAuthor: Contributor | undefined, email: string): Promise<string> {
+  if (mappedAuthor) {
+    if (mappedAuthor.username)
+      return `https://github.com/${mappedAuthor.username}.png`
+  }
+  return `https://gravatar.com/avatar/${await digestStringAsSHA256(email)}?d=retro`
 }
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/types.ts b/packages/vitepress-plugin-git-changelog/src/vite/types.ts
index 56eda1ea..eb74afc5 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/types.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/types.ts
@@ -1,3 +1,4 @@
+import type { Author } from 'src/types'
 import type {
   CommitToStringHandler,
   CommitToStringsHandler,
@@ -22,6 +23,10 @@ export interface GitChangelogOptions {
    * @default ['** /*.md', '!node_modules']
    */
   include?: string[]
+  /**
+   * Map authors
+   */
+  mapAuthors?: Author[]
   /**
    * When fetching git logs, what directories should be included?
    *
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 9a7adb90..49e903eb 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -14,6 +14,9 @@ importers:
       '@antfu/ni':
         specifier: ^0.21.12
         version: 0.21.12
+      '@cspell/dict-ru_ru':
+        specifier: ^2.2.1
+        version: 2.2.1
       '@types/node':
         specifier: ^20.14.8
         version: 20.14.8
@@ -38,9 +41,6 @@ importers:
       '@vueuse/core':
         specifier: ^10.11.0
         version: 10.11.0(vue@3.4.30(typescript@5.5.2))
-      '@cspell/dict-ru_ru':
-        specifier: ^2.2.1
-        version: 2.2.1
       concurrently:
         specifier: ^8.2.2
         version: 8.2.2
@@ -385,6 +385,9 @@ importers:
       defu:
         specifier: ^6.1.4
         version: 6.1.4
+      es-toolkit:
+        specifier: ^1.13.1
+        version: 1.13.1
       execa:
         specifier: ^8.0.1
         version: 8.0.1
@@ -397,9 +400,6 @@ importers:
       less:
         specifier: ^4.2.0
         version: 4.2.0
-      ora:
-        specifier: ^8.0.1
-        version: 8.0.1
       uncrypto:
         specifier: ^0.1.3
         version: 0.1.3
@@ -3128,6 +3128,9 @@ packages:
   error-stack-parser-es@0.1.1:
     resolution: {integrity: sha512-g/9rfnvnagiNf+DRMHEVGuGuIBlCIMDFoTA616HaP2l9PlCjGjVhD98PNbVSJvmK4TttqT5mV5tInMhoFgi+aA==}
 
+  es-toolkit@1.13.1:
+    resolution: {integrity: sha512-tGsgoI8DfU0yrZI7w97aYVMZJU5sjpXC+HK8aYf3pmLQRNHMleiJN5ud21dA/IHKkTDFY5jcDMQcLs0A21LtAg==}
+
   esbuild@0.19.12:
     resolution: {integrity: sha512-aARqgq8roFBj054KvQr5f1sFu0D65G+miZRCuJyJ0G13Zwx7vRar5Zhn2tkQNzIXcBrNVsv/8stehpj+GAjgbg==}
     engines: {node: '>=12'}
@@ -8449,6 +8452,8 @@ snapshots:
 
   error-stack-parser-es@0.1.1: {}
 
+  es-toolkit@1.13.1: {}
+
   esbuild@0.19.12:
     optionalDependencies:
       '@esbuild/aix-ppc64': 0.19.12

From d4b27db56470c990f60a3924d0737bb2e5d67858 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 10:57:00 +0800
Subject: [PATCH 2/9] fix: build error, clean code, tweaks

---
 .../src/plugins/nolebase/index.ts             |  1 -
 .../src/client/components/Changelog.vue       | 12 ++--
 .../src/client/components/Contributors.vue    | 14 ++--
 .../src/client/composables/author.ts          | 44 ------------
 .../src/client/composables/commits.ts         | 71 ++++++++++++++-----
 .../src/client/types.ts                       | 12 ----
 .../src/types/index.ts                        |  2 +-
 .../src/vite/git.ts                           |  5 +-
 .../src/vite/helpers.ts                       |  9 +--
 .../src/vite/types.ts                         | 23 ------
 10 files changed, 73 insertions(+), 120 deletions(-)
 delete mode 100644 packages/vitepress-plugin-git-changelog/src/client/composables/author.ts

diff --git a/packages/unconfig-vitepress/src/plugins/nolebase/index.ts b/packages/unconfig-vitepress/src/plugins/nolebase/index.ts
index 61b8a171..ae383fa5 100644
--- a/packages/unconfig-vitepress/src/plugins/nolebase/index.ts
+++ b/packages/unconfig-vitepress/src/plugins/nolebase/index.ts
@@ -98,7 +98,6 @@ const defaultOptions: NolebasePluginPresetOptions = {
   gitChangelog: {
     enable: true,
     options: {
-      mapContributors: [],
       commitsRelativeTime: true,
     },
   },
diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue b/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
index 416977cd..89ef9be6 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
@@ -6,7 +6,7 @@ import { defu } from 'defu'
 
 import { NuVerticalTransition } from '@nolebase/ui'
 
-import { useCommits } from '../composables/commits'
+import { useChangelog } from '../composables/commits'
 import { formatDistanceToNowFromValue } from '../utils'
 import { useI18n } from '../composables/i18n'
 import { InjectionKey, defaultOptions } from '../constants'
@@ -20,7 +20,7 @@ const options = defu(inject(InjectionKey, {}), defaultOptions)
 
 const { t } = useI18n()
 const { lang, page } = useData()
-const { commits, update } = useCommits(page)
+const { commits, update } = useChangelog(page)
 
 // The order of commits, defaults to true (descending order)
 const isDescending = ref(true)
@@ -71,8 +71,8 @@ onMounted(() => {
       if (!data || typeof data !== 'object')
         return
 
-      if (data.commits)
-        update(data.commits)
+      if (data)
+        update(data)
     })
 
     // HMR API | Vite
@@ -85,8 +85,8 @@ onMounted(() => {
       if (!newModule.default || typeof newModule.default !== 'object')
         return
 
-      if (newModule.default.commits)
-        update(newModule.default.commits)
+      if (newModule.default)
+        update(newModule.default)
     })
   }
 })
diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue b/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
index 879405ec..05ff7dab 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
@@ -3,17 +3,15 @@ import { inject, onMounted } from 'vue'
 import { useData } from 'vitepress'
 import { defu } from 'defu'
 
-import { useCommits } from '../composables/commits'
+import { useChangelog } from '../composables/commits'
 import { useI18n } from '../composables/i18n'
 import { InjectionKey, defaultOptions } from '../constants'
-import { useAuthors } from '../composables/author'
 
 const options = defu(inject(InjectionKey, {}), defaultOptions)
 
 const { t } = useI18n()
 const { page } = useData()
-const { commits, update } = useCommits(page)
-const { authors } = useAuthors(commits)
+const { authors, update } = useChangelog(page)
 
 onMounted(() => {
   if (import.meta.hot) {
@@ -29,8 +27,8 @@ onMounted(() => {
       if (!data || typeof data !== 'object')
         return
 
-      if (data.commits)
-        update(data.commits)
+      if (data)
+        update(data)
     })
 
     // HMR API | Vite
@@ -43,8 +41,8 @@ onMounted(() => {
       if (!newModule.default || typeof newModule.default !== 'object')
         return
 
-      if (newModule.default.commits)
-        update(newModule.default.commits)
+      if (newModule.default)
+        update(newModule.default)
     })
   }
 })
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts
deleted file mode 100644
index 71101ca8..00000000
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/author.ts
+++ /dev/null
@@ -1,44 +0,0 @@
-import { type Ref, computed, ref } from 'vue'
-import Changelog from 'virtual:nolebase-git-changelog'
-import type { Commit, CommitAuthor } from '../../types'
-
-export interface AuthorInfo extends CommitAuthor {
-  commitsCount: number
-}
-
-export function useAuthors(commits: Ref<Commit[]>) {
-  const changelog = ref<{ authors: CommitAuthor[] }>(Changelog)
-  const authors = computed(() => {
-    const uniq = new Map<string, AuthorInfo>()
-
-    commits.value.map(c => c.authors)
-      .flat()
-      .map((name) => {
-        if (!uniq.has(name)) {
-          uniq.set(name, {
-            name,
-            commitsCount: 1,
-          })
-          return true
-        }
-        else {
-          uniq.get(name)!.commitsCount++
-          return false
-        }
-      })
-
-    return Array.from(uniq.values())
-      .sort((a, b) => a.commitsCount - b.commitsCount)
-      .map((a) => {
-        return {
-          ...a,
-          ...changelog.value.authors.find(item => item.name === a.name),
-
-        }
-      })
-  })
-
-  return {
-    authors,
-  }
-}
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
index 8464acc3..ffc03cb0 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
@@ -1,31 +1,68 @@
 import { type Ref, computed, ref, toValue } from 'vue'
 
 import type { PageData } from 'vitepress'
-import Changelog from 'virtual:nolebase-git-changelog'
-import type { Commit } from '../../types'
+import changelog from 'virtual:nolebase-git-changelog'
+import type { Changelog, Commit, CommitAuthor } from '../../types'
 
-export function useCommits(pageData: Ref<PageData>) {
-  const gitChangelog = ref<{ commits: Commit[] }>(Changelog)
+export interface AuthorInfo extends CommitAuthor {
+  commitsCount: number
+}
+
+export function useChangelog(pageData: Ref<PageData>) {
+  const gitChangelog = ref<Changelog>(changelog)
   if (!gitChangelog.value)
-    gitChangelog.value = { commits: [] }
+    gitChangelog.value = { commits: [], authors: [] }
 
-  return {
-    commits: computed<Commit[]>(() => {
-      const currentPath = toValue(pageData.value.filePath)
+  const commits = computed<Commit[]>(() => {
+    const currentPath = toValue(pageData.value.filePath)
+
+    const allCommits = gitChangelog.value.commits
+    // filter the commits that either have a tag, or directly equal the current path, or renamed to the current path
+    const commits = allCommits.filter(c => c.paths.includes(currentPath)) || []
+
+    return commits.filter((commit, index) => {
+      if (commit.tag && (!commits[index + 1] || commits[index + 1]?.tag))
+        return false
 
-      const allCommits = gitChangelog.value.commits
-      // filter the commits that either have a tag, or directly equal the current path, or renamed to the current path
-      const commits = allCommits.filter(c => c.paths.includes(currentPath)) || []
+      return true
+    })
+  })
 
-      return commits.filter((commit, index) => {
-        if (commit.tag && (!commits[index + 1] || commits[index + 1]?.tag))
+  const authors = computed(() => {
+    const uniq = new Map<string, AuthorInfo>()
+
+    commits.value.map(c => c.authors)
+      .flat()
+      .map((name) => {
+        if (!uniq.has(name)) {
+          uniq.set(name, {
+            name,
+            commitsCount: 1,
+          })
+          return true
+        }
+        else {
+          uniq.get(name)!.commitsCount++
           return false
+        }
+      })
+
+    return Array.from(uniq.values())
+      .sort((a, b) => a.commitsCount - b.commitsCount)
+      .map((a) => {
+        return {
+          ...a,
+          ...gitChangelog.value.authors.find(item => item.name === a.name),
 
-        return true
+        }
       })
-    }),
-    update(data: Commit[]) {
-      gitChangelog.value = { commits: data }
+  })
+
+  return {
+    commits,
+    authors,
+    update(data: Changelog) {
+      gitChangelog.value = data
     },
   }
 }
diff --git a/packages/vitepress-plugin-git-changelog/src/client/types.ts b/packages/vitepress-plugin-git-changelog/src/client/types.ts
index f3f07cd0..e461ccc6 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/types.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/types.ts
@@ -1,5 +1,3 @@
-import type { Author, Contributor } from '../types'
-
 export interface Locale extends Record<string, any> {
   /**
    * What to display when there are no logs
@@ -114,16 +112,6 @@ export interface Options {
    * ```
    */
   locales?: Record<string, Locale>
-  /**
-   * @deprecated Use `mapAuthors` instead
-   * @see mapAuthors
-   */
-  mapContributors?: Contributor[]
-  /**
-   * @deprecated Use `mapAuthors` in vite side
-   * @see mapAuthors
-   */
-  mapAuthors?: Author[]
   /**
    * Number of commit hash letters to display
    *
diff --git a/packages/vitepress-plugin-git-changelog/src/types/index.ts b/packages/vitepress-plugin-git-changelog/src/types/index.ts
index 7cdc935b..587388a5 100644
--- a/packages/vitepress-plugin-git-changelog/src/types/index.ts
+++ b/packages/vitepress-plugin-git-changelog/src/types/index.ts
@@ -107,7 +107,7 @@ export interface CommitAuthor {
 
 export interface Changelog {
   commits: Commit[]
-  authors?: CommitAuthor[]
+  authors: CommitAuthor[]
 }
 
 export interface SocialEntry {
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/git.ts b/packages/vitepress-plugin-git-changelog/src/vite/git.ts
index b32ad38e..98b68fdb 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/git.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/git.ts
@@ -6,7 +6,7 @@ import { cyan, gray } from 'colorette'
 import { globby } from 'globby'
 import { execa } from 'execa'
 
-import type { Changelog, Commit } from '../types'
+import type { Author, Changelog } from '../types'
 import {
   type CommitToStringHandler,
   type CommitToStringsHandler,
@@ -24,6 +24,7 @@ import {
 import type { GitChangelogOptions } from './types'
 
 export type {
+  Author,
   CommitToStringHandler,
   CommitToStringsHandler,
   RewritePathsBy,
@@ -155,7 +156,7 @@ export function GitChangelog(options: GitChangelogOptions = {}): Plugin {
           const path = normalizePath(join(srcDir, data.page.filePath))
           result = await commitFromPath([path])
           Object.assign(changelog, result)
-          // hotModuleReloadCachedCommits.set(data.page.filePath, result)
+          hotModuleReloadCachedCommits.set(data.page.filePath, result)
         }
 
         if (!result!.commits.length)
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts b/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts
index 50432597..112087db 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/helpers.ts
@@ -396,11 +396,7 @@ export function getCoAuthors(body?: string): CommitAuthor[] {
   if (!body)
     return []
 
-  return body.split('\n').map((b) => {
-    const result = multipleAuthorsRegex.exec(b)
-    if (!result)
-      return undefined
-
+  return [...body.matchAll(multipleAuthorsRegex)].map((result) => {
     const [, name, email] = result
     return {
       name: name.trim(),
@@ -409,7 +405,6 @@ export function getCoAuthors(body?: string): CommitAuthor[] {
   }).filter(v => !!v)
 }
 
-// TODO: mapCommitAuthors
 export function findMapAuthorByName(mapContributors: Contributor[] | undefined, author_name: string) {
   return mapContributors?.find((item) => {
     const res = (item.mapByNameAliases && Array.isArray(item.mapByNameAliases) && item.mapByNameAliases.includes(author_name)) || item.name === author_name
@@ -453,6 +448,8 @@ export function findMapAuthorLink(creator: Contributor): string | undefined {
 
 export async function newAvatarForAuthor(mappedAuthor: Contributor | undefined, email: string): Promise<string> {
   if (mappedAuthor) {
+    if (mappedAuthor.avatar)
+      return mappedAuthor.avatar
     if (mappedAuthor.username)
       return `https://github.com/${mappedAuthor.username}.png`
   }
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/types.ts b/packages/vitepress-plugin-git-changelog/src/vite/types.ts
index eb74afc5..163f0f9c 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/types.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/types.ts
@@ -27,18 +27,6 @@ export interface GitChangelogOptions {
    * Map authors
    */
   mapAuthors?: Author[]
-  /**
-   * When fetching git logs, what directories should be included?
-   *
-   * @deprecated
-   */
-  includeDirs?: string[]
-  /**
-   * When fetching git logs, what extensions should be included?
-   *
-   * @deprecated
-   */
-  includeExtensions?: `.${string}`[]
   /**
    * Your repository URL.
    * Yes, you can dynamically generate it.
@@ -114,17 +102,6 @@ export interface GitChangelogOptions {
    * The maximum number of git logs to fetch.
    */
   maxGitLogCount?: number
-  /**
-   * digits of commit hash which will be rendered in `Changelog` section
-   * @default 7
-   */
-  commitHashDigits?: number
-  /**
-   * The maximum number of concurrent processes to fetch git logs.
-   *
-   * @deprecated
-   */
-  maxConcurrentProcesses?: number
 }
 
 export interface GitChangelogMarkdownSectionOptions {

From 08d3983044ef5968495fc761a3ee642322f7ceb3 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 10:57:22 +0800
Subject: [PATCH 3/9] test: complate test cases

---
 .../src/client/composables/author.test.ts     |  98 ------
 .../src/vite/helpers.test.ts                  | 282 +++++++++++++-----
 2 files changed, 210 insertions(+), 170 deletions(-)
 delete mode 100644 packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts

diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts
deleted file mode 100644
index e8d2c2b2..00000000
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/author.test.ts
+++ /dev/null
@@ -1,98 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import type { Commit, Contributor } from '../../types'
-import {
-  extractAuthorsWithMultiple,
-  mapCommitAuthors,
-} from './author'
-
-describe('mapCommitAuthors', () => {
-  it('should be ok', async () => {
-    const mappedCreators = {}
-    await mapCommitAuthors([], mappedCreators, {
-      author_name: 'John Doe',
-      author_email: 'user@example.com',
-      author_avatar: 'abcd',
-    })
-    expect(mappedCreators).toEqual({
-      'John Doe': {
-        name: 'John Doe',
-        avatarUrl: 'https://gravatar.com/avatar/abcd?d=retro',
-        commitsCount: 1,
-        url: undefined,
-      },
-    })
-  })
-
-  it('should map mapped author by name alias', async () => {
-    const mappedCreators = {}
-    await mapCommitAuthors([{
-      name: 'Altered name',
-      avatar: 'https://example.com/avatar.png',
-      mapByNameAliases: ['John Doe'],
-    }], mappedCreators, {
-      author_name: 'John Doe',
-      author_email: 'user@example.com',
-      author_avatar: 'abcd',
-    })
-    expect(mappedCreators).toEqual({
-      'Altered name': {
-        name: 'Altered name',
-        avatarUrl: 'https://example.com/avatar.png',
-        commitsCount: 1,
-        url: undefined,
-      },
-    })
-  })
-
-  it('should map mapped author by email alias', async () => {
-    const mappedCreators = {}
-    const mapCreatorConfig = [{
-      name: 'Altered name',
-      avatar: 'https://example.com/avatar.png',
-      mapByEmailAliases: ['user@example.com', 'user2@example.com'],
-    }]
-    await mapCommitAuthors(mapCreatorConfig, mappedCreators, {
-      author_name: 'John Doe',
-      author_email: 'user@example.com',
-      author_avatar: 'abcd',
-    })
-    await mapCommitAuthors(mapCreatorConfig, mappedCreators, {
-      author_name: 'John Doe',
-      author_email: 'user2@example.com',
-      author_avatar: 'abcd',
-    })
-    expect(mappedCreators).toEqual({
-      'Altered name': {
-        name: 'Altered name',
-        avatarUrl: 'https://example.com/avatar.png',
-        commitsCount: 2,
-        url: undefined,
-      },
-    })
-  })
-})
-
-describe('extractAuthorsWithMultiple', () => {
-  it('should match multiple authors', async () => {
-    const multipleAuthors = `
-Co-authored-by: Standard <standard@example.com>
-    Co-authored-by:         Spaced LastSpaced       <spaced@example.com>      `
-
-    const authors = {}
-    await extractAuthorsWithMultiple([], authors, { body: multipleAuthors } as Commit)
-    expect(authors).toEqual({
-      'Standard': {
-        name: 'Standard',
-        commitsCount: 1,
-        avatarUrl: 'https://gravatar.com/avatar/1f39f2ec8cfad7452e421075f63b5c70fbee98736bd91b52d20161f8148ce38d?d=retro',
-        url: undefined,
-      },
-      'Spaced LastSpaced': {
-        name: 'Spaced LastSpaced',
-        commitsCount: 1,
-        avatarUrl: 'https://gravatar.com/avatar/d2bb5cf8baea77e9c60741c9815f13128ea1928b8a5342362af99d1f6fa69e07?d=retro',
-        url: undefined,
-      },
-    })
-  })
-})
diff --git a/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts b/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts
index 37a17b2f..dbf21eff 100644
--- a/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts
+++ b/packages/vitepress-plugin-git-changelog/src/vite/helpers.test.ts
@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest'
 
-import type { Commit, Contributor } from '../types'
+import type { Commit, Contributor, MergedRawCommit } from '../types'
 import {
   defaultCommitURLHandler,
   defaultReleaseTagURLHandler,
@@ -8,6 +8,7 @@ import {
   findMapAuthorByEmail,
   findMapAuthorByName,
   findMapAuthorLink,
+  getCoAuthors,
   mergeRawCommits,
   newAvatarForAuthor,
   parseCommitAuthors,
@@ -216,7 +217,13 @@ describe('parseCommitAuthors', () => {
     }
 
     const authors = await parseCommitAuthors(mockedCommit)
-    expect(authors).toEqual([{ name: 'First Last', email: 'user@example.com' }])
+    expect(authors).toEqual([
+      {
+        name: 'First Last',
+        email: 'user@example.com',
+        avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+      },
+    ])
   })
 
   it('should parse co-author from body', async () => {
@@ -232,8 +239,16 @@ describe('parseCommitAuthors', () => {
 
     const authors = await parseCommitAuthors(mockedCommit)
     expect(authors).toEqual([
-      { name: 'First Last', email: 'user@example.com' },
-      { name: 'First Last2', email: 'user2@example.com' },
+      {
+        name: 'First Last',
+        email: 'user@example.com',
+        avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+      },
+      {
+        name: 'First Last2',
+        email: 'user2@example.com',
+        avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+      },
     ])
   })
 
@@ -251,6 +266,85 @@ describe('parseCommitAuthors', () => {
     const authors = await parseCommitAuthors(mockedCommit)
     expect(authors).toEqual([])
   })
+
+  it('should map author by name alias', async () => {
+    const mockedCommit = {
+      paths: ['/fack/path/1.md'],
+      hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+      date: 'Wed Apr 24 14:24:44 2024 +0800',
+      message: 'docs: fix english integrations list',
+      body: '',
+      author_name: 'First Last',
+      author_email: 'user@example.com',
+    }
+    const mapAuthors = [
+      { name: 'John Doe', mapByNameAliases: ['First Last', 'John Doe'] },
+    ]
+
+    const authors = await parseCommitAuthors(mockedCommit, mapAuthors)
+    expect(authors).toEqual([
+      {
+        name: 'John Doe',
+        email: 'user@example.com',
+        avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+      },
+    ])
+  })
+
+  it('should map author by email alias', async () => {
+    const mockedCommit = {
+      paths: ['/fack/path/1.md'],
+      hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
+      date: 'Wed Apr 24 14:24:44 2024 +0800',
+      message: 'docs: fix english integrations list',
+      body: '',
+      author_name: 'First Last',
+      author_email: 'user@example.com',
+    }
+    const mapAuthors = [
+      { name: 'John Doe', mapByEmailAliases: ['user@example.com'] },
+    ]
+
+    const authors = await parseCommitAuthors(mockedCommit, mapAuthors)
+    expect(authors).toEqual([
+      {
+        name: 'John Doe',
+        email: 'user@example.com',
+        avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+      },
+    ])
+  })
+})
+
+describe('getCoAuthors', () => {
+  it('should be ok', () => {
+    const modkedBody = `
+Co-authored-by: Standard <standard@example.com>
+    Co-authored-by:         Spaced LastSpaced       <spaced@example.com>      `
+    const coAuthors = getCoAuthors(modkedBody)
+    expect(coAuthors).toEqual([
+      {
+        name: 'Standard',
+        email: 'standard@example.com',
+      },
+      {
+        name: 'Spaced LastSpaced',
+        email: 'spaced@example.com',
+      },
+    ])
+  })
+
+  it('should return empty whn body is empty', () => {
+    const modkedBody = ''
+    const coAuthors = getCoAuthors(modkedBody)
+    expect(coAuthors).toEqual([])
+  })
+
+  it('should be ok when no co-authors', () => {
+    const modkedBody = 'Signed-off-by: First Last <user@example.com>'
+    const coAuthors = getCoAuthors(modkedBody)
+    expect(coAuthors).toEqual([])
+  })
 })
 
 describe('findMapAuthorByEmail', () => {
@@ -445,9 +539,19 @@ describe('newAvatarForAuthor', () => {
 
 describe('parseCommits', () => {
   it('should init commit with fields transformed', async () => {
-    const mockedCommits = ['c16db1033fce57f50b261e9944c136a26fcaccc6|First Last|user@example.com|Mon Mar 25 20:05:53 2024 +0800|release: v1.24.3| (tag: v1.24.3)|Signed-off-by: First Last <user@example.com>\n']
+    const mockedCommits = [
+      {
+        paths: ['/fack/path/1.md', '/fack/path/2.md'],
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: '',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
+    ]
 
-    const commit = await parseCommits(
+    const result = await parseCommits(
       mockedCommits,
       () => 'https://github.com/example-org/example',
       defaultCommitURLHandler,
@@ -455,93 +559,124 @@ describe('parseCommits', () => {
       defaultReleaseTagsURLHandler,
     )
 
-    expect(commit).toEqual([{
-      path: '',
-      tag: 'v1.24.3',
-      tags: ['v1.24.3'],
-      release_tag_url: 'https://github.com/example-org/example/releases/tag/v1.24.3',
-      release_tags_url: ['https://github.com/example-org/example/releases/tag/v1.24.3'],
-      hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
-      hash_url: 'https://github.com/example-org/example/commit/c16db1033fce57f50b261e9944c136a26fcaccc6',
-      date: 'Mon Mar 25 20:05:53 2024 +0800',
-      date_timestamp: 1711368353000,
-      message: 'release: v1.24.3',
-      body: 'Signed-off-by: First Last <user@example.com>',
-      author_name: 'First Last',
-      author_email: 'user@example.com',
-      author_avatar: 'b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514',
-      repo_url: 'https://github.com/example-org/example',
-    }])
+    expect(result).toEqual({
+      commits: [
+        {
+          paths: ['/fack/path/1.md', '/fack/path/2.md'],
+          hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+          hash_url: 'https://github.com/example-org/example/commit/c16db1033fce57f50b261e9944c136a26fcaccc6',
+          date_timestamp: 1711368353000,
+          message: 'release: v1.24.3',
+          authors: ['First Last'],
+          repo_url: 'https://github.com/example-org/example',
+        },
+      ],
+      authors: [
+        {
+          avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+          name: 'First Last',
+        },
+      ],
+    })
   })
 
-  it('should transform for commit contains no refs', async () => {
-    const mockedCommit = [
-      '', // empty commit, could occur when the file contains no history or git cli bugged
-      '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1|First Last|user@example.com|Wed Apr 24 14:24:44 2024 +0800|docs: fix english integrations list||Signed-off-by: First Last <user@example.com>\n',
+  it('should transform for commit contains refs', async () => {
+    const mockedCommits = [
+      {
+        paths: ['/fack/path/1.md', '/fack/path/2.md'],
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Signed-off-by: First Last <user@example.com>',
+        refs: ' (tag: v1.28.0)',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
     ]
-    const commit = await parseCommits(
-      '',
-      mockedCommit,
+
+    const result = await parseCommits(
+      mockedCommits,
       () => 'https://github.com/example-org/example',
       defaultCommitURLHandler,
       defaultReleaseTagURLHandler,
       defaultReleaseTagsURLHandler,
     )
 
-    expect(commit).toEqual([{
-      path: '',
-      hash: '62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
-      hash_url: 'https://github.com/example-org/example/commit/62ef7ed8f54ea1faeacf6f6c574df491814ec1b1',
-      date: 'Wed Apr 24 14:24:44 2024 +0800',
-      date_timestamp: 1713939884000,
-      message: 'docs: fix english integrations list',
-      body: 'Signed-off-by: First Last <user@example.com>',
-      author_name: 'First Last',
-      author_email: 'user@example.com',
-      author_avatar: 'b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514',
-      repo_url: 'https://github.com/example-org/example',
-    }])
+    expect(result).toEqual({
+      commits: [
+        {
+          paths: ['/fack/path/1.md', '/fack/path/2.md'],
+          hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+          hash_url: 'https://github.com/example-org/example/commit/c16db1033fce57f50b261e9944c136a26fcaccc6',
+          tags: ['v1.28.0'],
+          tag: 'v1.28.0',
+          release_tag_url: 'https://github.com/example-org/example/releases/tag/v1.28.0',
+          release_tags_url: ['https://github.com/example-org/example/releases/tag/v1.28.0'],
+          date_timestamp: 1711368353000,
+          message: 'release: v1.24.3',
+          authors: ['First Last'],
+          repo_url: 'https://github.com/example-org/example',
+        },
+      ],
+      authors: [
+        {
+          avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+          name: 'First Last',
+        },
+      ],
+    })
   })
 
-  it('should transform for commit contains no body', async () => {
-    const mockedCommit = [
-      '', // empty commit, could occur when the file contains no history or git cli bugged
-      'fa0fb328b988499c74983e9164f6db4e2e92afd8|First Last|user@example.com|Sun Apr 7 22:27:57 2024 +0800|release: v1.28.0| (tag: v1.28.0)|',
+  it('should transform for commit contains co-authors', async () => {
+    const mockedCommits = [
+      {
+        paths: ['/fack/path/1.md', '/fack/path/2.md'],
+        hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+        date: 'Mon Mar 25 20:05:53 2024 +0800',
+        message: 'release: v1.24.3',
+        body: 'Co-authored-by: First Last2 <user2@example.com>',
+        author_name: 'First Last',
+        author_email: 'user@example.com',
+      },
     ]
-    const commit = await parseCommits(
-      '',
-      mockedCommit,
+
+    const result = await parseCommits(
+      mockedCommits,
       () => 'https://github.com/example-org/example',
       defaultCommitURLHandler,
       defaultReleaseTagURLHandler,
       defaultReleaseTagsURLHandler,
     )
 
-    expect(commit).toEqual([{
-      path: '',
-      hash: 'fa0fb328b988499c74983e9164f6db4e2e92afd8',
-      date: 'Sun Apr 7 22:27:57 2024 +0800',
-      date_timestamp: 1712500077000,
-      message: 'release: v1.28.0',
-      body: '',
-      author_name: 'First Last',
-      author_email: 'user@example.com',
-      author_avatar: 'b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514',
-      repo_url: 'https://github.com/example-org/example',
-      hash_url: 'https://github.com/example-org/example/commit/fa0fb328b988499c74983e9164f6db4e2e92afd8',
-      tags: ['v1.28.0'],
-      tag: 'v1.28.0',
-      release_tag_url: 'https://github.com/example-org/example/releases/tag/v1.28.0',
-      release_tags_url: ['https://github.com/example-org/example/releases/tag/v1.28.0'],
-    }])
+    expect(result).toEqual({
+      commits: [
+        {
+          paths: ['/fack/path/1.md', '/fack/path/2.md'],
+          hash: 'c16db1033fce57f50b261e9944c136a26fcaccc6',
+          hash_url: 'https://github.com/example-org/example/commit/c16db1033fce57f50b261e9944c136a26fcaccc6',
+          date_timestamp: 1711368353000,
+          message: 'release: v1.24.3',
+          authors: ['First Last', 'First Last2'],
+          repo_url: 'https://github.com/example-org/example',
+        },
+      ],
+      authors: [
+        {
+          avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+          name: 'First Last',
+        },
+        {
+          avatarUrl: 'https://gravatar.com/avatar/b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514?d=retro',
+          name: 'First Last2',
+        },
+      ],
+    })
   })
 
   it('should return no commits when empty', async () => {
-    const mockedCommit = [
-      '', // empty commit, could occur when the file contains no history or git cli bugged
-    ]
+    // empty commit, could occur when the file contains no history or git cli bugged
+    const mockedCommit: MergedRawCommit[] = []
     const commit = await parseCommits(
-      '',
       mockedCommit,
       () => 'https://github.com/example-org/example',
       defaultCommitURLHandler,
@@ -549,6 +684,9 @@ describe('parseCommits', () => {
       defaultReleaseTagsURLHandler,
     )
 
-    expect(commit).toEqual([])
+    expect(commit).toEqual({
+      commits: [],
+      authors: [],
+    })
   })
 })

From 77846ba548917c3289da34aaf8b0555ffcd01696 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 10:57:40 +0800
Subject: [PATCH 4/9] docs: refresh docs

---
 .../configure-ui.md                           |  93 ++--------------
 .../configure-vite-plugins.md                 |  78 ++++++++++++--
 .../configure-ui.md                           | 100 +++---------------
 .../configure-vite-plugins.md                 |  78 ++++++++++++--
 .../getting-started.md                        |   2 +-
 .../zh-CN/releases/migrations/v2-to-v3.md     |   7 ++
 6 files changed, 167 insertions(+), 191 deletions(-)
 create mode 100644 docs/pages/zh-CN/releases/migrations/v2-to-v3.md

diff --git a/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui.md b/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui.md
index a8243346..f16b7fc7 100644
--- a/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui.md
+++ b/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui.md
@@ -1,6 +1,14 @@
 # Configuration
 
-The Git-based page histories plugin currently provides configuration options related to **Internationalization** and **Contributors** section.
+::: danger Deprecating the `mapAuthors` field for UI component options
+
+We migrated the `mapAuthors` configuration to [configure Vite plugins](./configure-vite-plugins#option-mapauthors---map-contributors-information).
+
+For specific migration information, see [Migrating from v2 to v3](/pages/en/releases/migrations/v2-to-v3).
+
+:::
+
+The Git-based page histories plugin currently provides configuration options related to **Internationalization** and **UI** section.
 
 ## Configure in VitePress
 
@@ -67,59 +75,6 @@ export const Theme: ThemeConfig = {
 }
 ```
 
-### Option `mapAuthors` - Map contributors' information
-
-The `mapAuthors` field in the configuration options is used to map the contributors' information. You can provide the `mapAuthors` field in the configuration options to map the contributors' information, including the display name, avatar, email, social links, and aliases.
-
-Let's say we have these logs:
-
-```plaintext
-commit 1
-Author: John Doe <john.doe@example.com>
-Date:   Fri Oct 1 12:00:00 2021 +0800
-
-    Add a new feature
-
-commit 2
-Author: John Doe <john.doe@anothersite.com>
-
-    Fix a bug
-```
-
-We now have two commits from the same person, with only the email address is different. By default, the plugin will treat them as two different contributors.
-Such case happens when you changed your name or email address in the past.
-
-To solve this, you can provide the `mapAuthors` field in the configuration options to map the contributors' information:
-
-```typescript twoslash
-import type { Theme as ThemeConfig } from 'vitepress'
-import DefaultTheme from 'vitepress/theme'
-
-import { InjectionKey } from '@nolebase/vitepress-plugin-git-changelog/client' // [!code focus]
-
-export const Theme: ThemeConfig = {
-  extends: DefaultTheme,
-  Layout: () => {
-    // Rest of the code...
-  },
-  enhanceApp({ app }) {
-    // Rest of the code...
-
-    app.provide(InjectionKey, { // [!code focus]
-      mapAuthors: [ // [!code focus]
-        { // [!code focus]
-          name: 'John Doe', // [!code focus]
-          username: 'john_doe', // [!code focus]
-          mapByEmailAliases: ['john.doe@anothersite.com'] // [!code focus]
-        } // [!code focus]
-      ] // [!code focus]
-    }) // [!code focus]
-
-    // Rest of the code...
-  },
-}
-```
-
 ## Options inside
 
 ::: warning Deprecating warning
@@ -224,36 +179,6 @@ export interface Options {
    * ```
    */
   locales?: Record<string, Locale>
-  mapAuthors?: Array<{
-    /**
-     * The overriding display name of the contributor
-     */
-    name?: string
-    /**
-     * The overriding GitHub, GitLab, Gitea username of the contributor
-     */
-    username?: string
-    /**
-     * The overriding avatar of the contributor
-     */
-    avatar?: string
-    /**
-     * Whether to add a link to the contributor's profile
-     */
-    links?: string | SocialEntry[]
-    /**
-     * More names to be recognized as the same contributor.
-     *
-     * Useful when you changed your name or email address in the past.
-     */
-    mapByNameAliases?: string[]
-    /**
-     * More emails to be recognized as the same contributor.
-     *
-     * Useful when you changed your email address in the past.
-     */
-    mapByEmailAliases?: string[]
-  }>
   /**
    * Number of commit hash letters to display
    *
diff --git a/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md b/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md
index 24246140..644cd5ff 100644
--- a/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md
+++ b/docs/pages/en/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md
@@ -10,11 +10,9 @@ For information, please refer to [Migrate from v1 to v2](/pages/en/releases/migr
 
 Besides the UI widget components, Git-based page histories offer another two Vite plugins for data fetching and rendering. These plugins are `GitChangelog` and `GitChangelogMarkdownSection`.
 
-### Configure Vite plugins
-
 <!--@include: @/pages/en/snippets/configure-tsconfig.md-->
 
-#### `GitChangelog` plugin
+## Configure `GitChangelog` plugin
 
 Remember this part back at the time where we first introduced the `GitChangelog` plugin?
 
@@ -42,16 +40,74 @@ export default defineConfig(() => {
 
 In the `GitChangelog` plugin, you can configure the `repoURL` option to point to your repository URL. This is the only required option for the plugin to work properly.
 
+### Option `mapAuthors` - Map contributors' information
+
+The `mapAuthors` field in the configuration options is used to map the contributors' information. You can provide the `mapAuthors` field in the configuration options to map the contributors' information, including the display name, avatar, email, social links, and aliases.
+
+Let's say we have these logs:
+
+```plaintext
+commit 1
+Author: John Doe <john.doe@example.com>
+Date:   Fri Oct 1 12:00:00 2021 +0800
+
+    Add a new feature
+
+commit 2
+Author: John Doe <john.doe@anothersite.com>
+
+    Fix a bug
+```
+
+We now have two commits from the same person, with only the email address is different. By default, the plugin will treat them as two different contributors.
+Such case happens when you changed your name or email address in the past.
+
+To solve this, you can provide the `mapAuthors` field in the configuration options to map the contributors' information:
+
+```typescript twoslash
+import { join } from 'node:path'
+import { defineConfig } from 'vite'
+import {
+  GitChangelog,
+  GitChangelogMarkdownSection,
+} from '@nolebase/vitepress-plugin-git-changelog/vite'
+
+export default defineConfig(() => {
+  return {
+    plugins: [
+      GitChangelog({ // [!code focus]
+        // Fill in your repository URL here
+        repoURL: () => 'https://github.com/nolebase/integrations',
+        mapAuthors: [ // [!code focus]
+          { // [!code focus]
+            name: 'John Doe', // [!code focus]
+            username: 'john_doe', // [!code focus]
+            mapByEmailAliases: ['john.doe@anothersite.com'] // [!code focus]
+          } // [!code focus]
+        ] // [!code focus]
+      }), // [!code focus]
+      GitChangelogMarkdownSection(),
+    ]
+    // other vite configurations...
+  }
+})
+```
+
+### All options
+
 But the options don't stop there. We have more options to configure the plugin to fit your needs.
 
 ::: details Full list of options
 
 ```typescript twoslash
 import type {
-  Commit, CommitToStringHandler, CommitToStringsHandler, RewritePathsBy
+  Author,
+  CommitToStringHandler,
+  CommitToStringsHandler,
+  RewritePathsBy
 } from '@nolebase/vitepress-plugin-git-changelog/vite'
 // ---cut---
-interface Options {
+interface GitChangelogOptions {
     /**
    * The current working directory in which to search files.
    *
@@ -64,6 +120,10 @@ interface Options {
    * @default ['** /*.md', '!node_modules']
    */
   include?: string[]
+  /**
+   * Map authors
+   */
+  mapAuthors?: Author[]
   /**
    * Your repository URL.
    * Yes, you can dynamically generate it.
@@ -144,7 +204,7 @@ interface Options {
 
 :::
 
-#### `GitChangelogMarkdownSection` plugin
+## Configure `GitChangelogMarkdownSection` plugin
 
 The `GitChangelogMarkdownSection` plugin is a plugin that helps you to inject the Markdown sections into your VitePress pages. It's a plugin that works with the `GitChangelog` plugin to provide the data for the Markdown sections.
 
@@ -205,7 +265,7 @@ interface GitChangelogMarkdownSectionOptions {
 
 :::
 
-#### Excluding a page from the transformation of `GitChangelogMarkdownSection`
+### Excluding a page from the transformation of `GitChangelogMarkdownSection`
 
 You can exclude a page from the transformation of `GitChangelogMarkdownSection` by adding the `nolebase.gitChangelog` or `gitChangelog` frontmatter to the page:
 
@@ -224,7 +284,7 @@ gitChangelog: false
 ---
 ```
 
-#### Globally exclude a page from the transformation of `GitChangelogMarkdownSection`
+### Globally exclude a page from the transformation of `GitChangelogMarkdownSection`
 
 You can globally exclude a page from the transformation of `GitChangelogMarkdownSection` by configuring the `exclude` option:
 
@@ -244,7 +304,7 @@ export default defineConfig({
 })
 ```
 
-#### Globally disable the changelog or contributors section
+### Globally disable the changelog or contributors section
 
 You can globally disable the changelog or contributors section by configuring the `sections` option:
 
diff --git a/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui.md b/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui.md
index 2ab45368..8b607edc 100644
--- a/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui.md
+++ b/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui.md
@@ -1,6 +1,14 @@
 # 配置 UI 组件
 
-基于 Git 的页面历史插件当前提供有关**国际化**和**贡献者**相关的配置选项。
+::: danger 弃用 UI 组件选项的 `mapAuthors` 字段
+
+我们将 `mapAuthors` 配置迁移到了 [配置 Vite 插件](./configure-vite-plugins#在-markdown-页面层级将页面排除在-gitchangelogmarkdownsection-的转换之外)。
+
+有关具体的迁移信息，请参阅 [自 v2 迁移至 v3](/pages/zh-CN/releases/migrations/v2-to-v3)。
+
+:::
+
+基于 Git 的页面历史插件当前提供有关**国际化**和**UI**相关的配置选项。
 
 ## 在 VitePress 项目中配置
 
@@ -65,59 +73,6 @@ export const Theme: ThemeConfig = {
 }
 ```
 
-### 选项 `mapContributors` - 为贡献者添加数据映射
-
-配置选项中的 `mapContributors` 字段用于映射贡献者信息，可以用来将获取到的 Git 的日志信息中的包括名称和邮箱的贡献者信息映射为另一个贡献者。
-
-如果我们假设有如下的 Git 日志：
-
-```plaintext
-commit 1
-Author: John Doe <john.doe@example.com>
-Date:   Fri Oct 1 12:00:00 2021 +0800
-
-    Add a new feature
-
-commit 2
-Author: John Doe <john.doe@anothersite.com>
-
-    Fix a bug
-```
-
-现在我们有两个来自同一个人的提交，只有电子邮件地址不同。在不进行任何配置的默认情况下，插件会将它们视为两个不同的贡献者。
-这种情况通常是因为你或者其他贡献者更改了自己的电子邮件地址。
-
-要解决这个问题，我们可以使用 `mapAuthors` 选项：
-
-```typescript twoslash
-import type { Theme as ThemeConfig } from 'vitepress'
-import DefaultTheme from 'vitepress/theme'
-
-import { InjectionKey } from '@nolebase/vitepress-plugin-git-changelog/client' // [!code focus]
-
-export const Theme: ThemeConfig = {
-  extends: DefaultTheme,
-  Layout: () => {
-    // Rest of the code...
-  },
-  enhanceApp({ app }) {
-    // Rest of the code...
-
-    app.provide(InjectionKey, { // [!code focus]
-      mapAuthors: [ // [!code focus]
-        { // [!code focus]
-          name: 'John Doe', // [!code focus]
-          username: 'john_doe', // [!code focus]
-          mapByEmailAliases: ['john.doe@anothersite.com'] // [!code focus]
-        } // [!code focus]
-      ] // [!code focus]
-    }) // [!code focus]
-
-    // Rest of the code...
-  },
-}
-```
-
 ## 配置选项
 
 ::: warning 废弃警告
@@ -224,36 +179,6 @@ export interface Options {
    * ```
    */
   locales?: Record<string, Locale>
-  mapAuthors?: Array<{
-    /**
-     * The overriding display name of the contributor
-     */
-    name?: string
-    /**
-     * The overriding GitHub, GitLab, Gitea username of the contributor
-     */
-    username?: string
-    /**
-     * The overriding avatar of the contributor
-     */
-    avatar?: string
-    /**
-     * Whether to add a link to the contributor's profile
-     */
-    links?: string | SocialEntry[]
-    /**
-     * More names to be recognized as the same contributor.
-     *
-     * Useful when you changed your name or email address in the past.
-     */
-    mapByNameAliases?: string[]
-    /**
-     * More emails to be recognized as the same contributor.
-     *
-     * Useful when you changed your email address in the past.
-     */
-    mapByEmailAliases?: string[]
-  }>
   /**
    * Number of commit hash letters to display
    *
@@ -285,7 +210,7 @@ export interface Options {
 ## 国际化
 
 ::: warning 注意
-基于 Git 的页面历史插件并没有使用 [vue-i18n](https://vue-i18n.intlify.dev/) 来作为国际化的工具库，因为绝大多数 VitePress 可能是直接使用的 [VitePress 自带的国际化功能](https://vitepress.dev/guide/i18n) 来进行国际化的，所以基于 Git 的页面历史插件的本地化文案并不能通过 `vue-i18n` 来覆盖文案，但是你可以通过 [配置](#配置) 中的 `locales` 字段来覆盖本地化的文案。
+基于 Git 的页面历史插件并没有使用 [vue-i18n](https://vue-i18n.intlify.dev/) 来作为国际化的工具库，因为绝大多数 VitePress 可能是直接使用的 [VitePress 自带的国际化功能](https://vitepress.dev/guide/i18n) 来进行国际化的，所以基于 Git 的页面历史插件的本地化文案并不能通过 `vue-i18n` 来覆盖文案，但是你可以通过 [配置](#配置选项) 中的 `locales` 字段来覆盖本地化的文案。
 :::
 
 基于 Git 的页面历史插件默认提供了国际化的支持，默认支持了英文和简体中文。
@@ -294,7 +219,7 @@ export interface Options {
 
 ### 如何在 VitePress 中进行配置
 
-在 [配置](#配置) 章节中，我们已经了解到了如何在 VitePress 中为基于 Git 的页面历史插件提供配置选项，我们在配置选项中添加 `locales` 字段就可以配置国际化了：
+在 [配置](#配置选项) 章节中，我们已经了解到了如何在 VitePress 中为基于 Git 的页面历史插件提供配置选项，我们在配置选项中添加 `locales` 字段就可以配置国际化了：
 
 <!--@include: @/pages/zh-CN/snippets/details-colored-diff.md-->
 
@@ -402,7 +327,7 @@ interface Locale {
 
 ## 无障碍
 
-基于 Git 的页面历史插件默认提供了无障碍的支持，你可以通过 [配置](#配置) 来对无障碍的文案进行复写，使用方法和 [国际化](#国际化) 一样，有关无障碍有哪些文案可以配置，请参阅 [国际化字段选项](#国际化字段选项)。
+基于 Git 的页面历史插件默认提供了无障碍的支持，你可以通过 [配置](#配置选项) 来对无障碍的文案进行复写，使用方法和 [国际化](#国际化) 一样，有关无障碍有哪些文案可以配置，请参阅 [国际化字段选项](#国际化字段选项)。
 
 ## 更多自定义能力？
 
@@ -487,4 +412,3 @@ import {
   NolebaseGitContributors,  // [!code focus]
 } from '@nolebase/vitepress-plugin-git-changelog/client'
 ```
-
diff --git a/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md b/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md
index 9575a36c..e53459e4 100644
--- a/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md
+++ b/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins.md
@@ -12,11 +12,9 @@
 
 除了 UI 组件，基于 Git 的页面历史记录还提供了另外两个 Vite 插件，用于数据获取和渲染。这两个插件分别是 `GitChangelog` 和 `GitChangelogMarkdownSection`。
 
-### 配置 Vite 插件
-
 <!--@include: @/pages/zh-CN/snippets/configure-tsconfig.md-->
 
-#### `GitChangelog` 插件
+## 配置 `GitChangelog` 插件
 
 还记得我们第一次介绍 `GitChangelog` 插件时的这部分内容吗？
 
@@ -44,16 +42,74 @@ export default defineConfig(() => {
 
 在 `GitChangelog` 插件中，您可以配置 `repoURL` 选项，使其指向您的 Git 仓库托管的 URL。这是插件正常工作的唯一必要选项。
 
+### 选项 `mapContributors` - 为贡献者添加数据映射
+
+配置选项中的 `mapContributors` 字段用于映射贡献者信息，可以用来将获取到的 Git 的日志信息中的包括名称和邮箱的贡献者信息映射为另一个贡献者。
+
+如果我们假设有如下的 Git 日志：
+
+```plaintext
+commit 1
+Author: John Doe <john.doe@example.com>
+Date:   Fri Oct 1 12:00:00 2021 +0800
+
+    Add a new feature
+
+commit 2
+Author: John Doe <john.doe@anothersite.com>
+
+    Fix a bug
+```
+
+现在我们有两个来自同一个人的提交，只有电子邮件地址不同。在不进行任何配置的默认情况下，插件会将它们视为两个不同的贡献者。
+这种情况通常是因为你或者其他贡献者更改了自己的电子邮件地址。
+
+要解决这个问题，我们可以使用 `mapAuthors` 选项：
+
+```typescript twoslash
+import { join } from 'node:path'
+import { defineConfig } from 'vite'
+import {
+  GitChangelog,
+  GitChangelogMarkdownSection,
+} from '@nolebase/vitepress-plugin-git-changelog/vite'
+
+export default defineConfig(() => {
+  return {
+    plugins: [
+      GitChangelog({ // [!code focus]
+        // Fill in your repository URL here
+        repoURL: () => 'https://github.com/nolebase/integrations',
+        mapAuthors: [ // [!code focus]
+          { // [!code focus]
+            name: 'John Doe', // [!code focus]
+            username: 'john_doe', // [!code focus]
+            mapByEmailAliases: ['john.doe@anothersite.com'] // [!code focus]
+          } // [!code focus]
+        ] // [!code focus]
+      }), // [!code focus]
+      GitChangelogMarkdownSection(),
+    ]
+    // other vite configurations...
+  }
+})
+```
+
+### 完整选项
+
 但选项并不止于此。我们还有更多选项来配置插件，以满足您的需求。
 
 ::: details 完整选项
 
 ```typescript twoslash
 import type {
-  Commit, CommitToStringHandler, CommitToStringsHandler, RewritePathsBy
+  Author,
+  CommitToStringHandler,
+  CommitToStringsHandler,
+  RewritePathsBy
 } from '@nolebase/vitepress-plugin-git-changelog/vite'
 // ---cut---
-interface Options {
+interface GitChangelogOptions {
     /**
    * The current working directory in which to search files.
    *
@@ -66,6 +122,10 @@ interface Options {
    * @default ['** /*.md', '!node_modules']
    */
   include?: string[]
+  /**
+   * Map authors
+   */
+  mapAuthors?: Author[]
   /**
    * Your repository URL.
    * Yes, you can dynamically generate it.
@@ -146,7 +206,7 @@ interface Options {
 
 :::
 
-#### `GitChangelogMarkdownSection` 插件
+## 配置 `GitChangelogMarkdownSection` 插件
 
 `GitChangelogMarkdownSection` 插件是一个在 Markdown 页面中注入章节的插件。可以与 `GitChangelog` 插件一起使用，以在页面中显示 Git 历史记录。
 
@@ -207,7 +267,7 @@ interface GitChangelogMarkdownSectionOptions {
 
 :::
 
-#### 在 Markdown 页面层级将页面排除在 `GitChangelogMarkdownSection` 的转换之外
+### 在 Markdown 页面层级将页面排除在 `GitChangelogMarkdownSection` 的转换之外
 
 您可以通过在页面的 frontmatter 中添加 `nolebase.gitChangelog` 或 `gitChangelog` 配置，将页面排除在 `GitChangelogMarkdownSection` 转换之外：
 
@@ -228,7 +288,7 @@ gitChangelog: false
 
 都可以。
 
-#### 全局地将某个页面排除在 `GitChangelogMarkdownSection` 的转换之外
+### 全局地将某个页面排除在 `GitChangelogMarkdownSection` 的转换之外
 
 通过配置 `exclude` 选项，可以全局地将某个页面排除在 `GitChangelogMarkdownSection` 的转换之外：
 
@@ -248,7 +308,7 @@ export default defineConfig({
 })
 ```
 
-#### 全局禁用页面历史或贡献者章节
+### 全局禁用页面历史或贡献者章节
 
 通过配置 `sections` 选项，可以在全局禁用页面历史或贡献者章节：
 
diff --git a/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/getting-started.md b/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/getting-started.md
index 2b1a82d8..afbca7d4 100644
--- a/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/getting-started.md
+++ b/docs/pages/zh-CN/integrations/vitepress-plugin-git-changelog/getting-started.md
@@ -267,4 +267,4 @@ Vercel 自带的 CI/CD 环境中是无法获取到全部 Git 日志信息的[^1]
 
 <!--@include: @/pages/zh-CN/snippets/troubleshooting-cannot-find-module.md-->
 
-[^1]: [Access git logs in build process · vercel/vercel · Discussion #4101](https://github.com/vercel/vercel/discussions/4101)
\ No newline at end of file
+[^1]: [Access git logs in build process · vercel/vercel · Discussion #4101](https://github.com/vercel/vercel/discussions/4101)
diff --git a/docs/pages/zh-CN/releases/migrations/v2-to-v3.md b/docs/pages/zh-CN/releases/migrations/v2-to-v3.md
new file mode 100644
index 00000000..f2343e03
--- /dev/null
+++ b/docs/pages/zh-CN/releases/migrations/v2-to-v3.md
@@ -0,0 +1,7 @@
+# 自 `v2` 迁移至 `v3`
+
+## 基于 Git 的页面历史
+
+### UI 配置
+
+- `mapAuthors` 已被弃用，请在 Vite 插件中配置该选项。

From 505e02d9952cf586c3d5424511269ed3aa6ed9af Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 11:17:21 +0800
Subject: [PATCH 5/9] docs: add missed pages

---
 docs/pages/en/releases/migrations/v2-to-v3.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 docs/pages/en/releases/migrations/v2-to-v3.md

diff --git a/docs/pages/en/releases/migrations/v2-to-v3.md b/docs/pages/en/releases/migrations/v2-to-v3.md
new file mode 100644
index 00000000..e76bad31
--- /dev/null
+++ b/docs/pages/en/releases/migrations/v2-to-v3.md
@@ -0,0 +1,7 @@
+# Migrating from `v2` to `v3
+
+## Git-based page history
+
+### UI configuration
+
+- `mapAuthors` is deprecated, please configure this option in the Vite plugin.

From 42d64cd0a3533199e4f36de02f8d26fe87519437 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 11:32:41 +0800
Subject: [PATCH 6/9] fix: types error

---
 .../src/client/components/CommitRegularLine.vue                | 3 ++-
 .../src/client/components/CommitTagLine.vue                    | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/CommitRegularLine.vue b/packages/vitepress-plugin-git-changelog/src/client/components/CommitRegularLine.vue
index de9d8c2f..7e3de6fe 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/CommitRegularLine.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/CommitRegularLine.vue
@@ -5,7 +5,8 @@ import { useData } from 'vitepress'
 import { defu } from 'defu'
 
 import { useI18n } from '../composables/i18n'
-import type { Commit, Locale } from '../types'
+import type { Locale } from '../types'
+import type { Commit } from '../../types'
 import { formatDistanceToNowFromValue, renderCommitMessage } from '../utils'
 import { defaultEnLocale, defaultLocales } from '../locales'
 import { InjectionKey, defaultNumCommitHashLetters, defaultOptions } from '../constants'
diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/CommitTagLine.vue b/packages/vitepress-plugin-git-changelog/src/client/components/CommitTagLine.vue
index e34e2a00..d4e79e86 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/CommitTagLine.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/CommitTagLine.vue
@@ -4,7 +4,8 @@ import { toDate } from 'date-fns'
 import { useData } from 'vitepress'
 import { defu } from 'defu'
 
-import type { Commit, Locale } from '../types'
+import type { Locale } from '../types'
+import type { Commit } from '../../types'
 import { useI18n } from '../composables/i18n'
 import { formatDistanceToNowFromValue } from '../utils'
 import { defaultEnLocale, defaultLocales } from '../locales'

From b3b76f84712feabfc096a0e26e3ca4eecd04beb9 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 11:33:34 +0800
Subject: [PATCH 7/9] refactor: mv hmr logic to composable

---
 .../src/client/components/Changelog.vue       | 36 ++--------------
 .../src/client/components/Contributors.vue    | 36 ++--------------
 .../composables/{commits.ts => changelog.ts}  | 43 +++++++++++++++++--
 3 files changed, 46 insertions(+), 69 deletions(-)
 rename packages/vitepress-plugin-git-changelog/src/client/composables/{commits.ts => changelog.ts} (63%)

diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue b/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
index 89ef9be6..d0ced6e0 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
@@ -6,7 +6,7 @@ import { defu } from 'defu'
 
 import { NuVerticalTransition } from '@nolebase/ui'
 
-import { useChangelog } from '../composables/commits'
+import { useChangelog } from '../composables/changelog'
 import { formatDistanceToNowFromValue } from '../utils'
 import { useI18n } from '../composables/i18n'
 import { InjectionKey, defaultOptions } from '../constants'
@@ -20,7 +20,7 @@ const options = defu(inject(InjectionKey, {}), defaultOptions)
 
 const { t } = useI18n()
 const { lang, page } = useData()
-const { commits, update } = useChangelog(page)
+const { commits, useHmr } = useChangelog(page)
 
 // The order of commits, defaults to true (descending order)
 const isDescending = ref(true)
@@ -58,37 +58,7 @@ watch(commits, () => {
 })
 
 onMounted(() => {
-  if (import.meta.hot) {
-    import.meta.hot.send('nolebase-git-changelog:client-mounted', {
-      page: {
-        filePath: page.value.filePath,
-      },
-    })
-
-    // Plugin API | Vite
-    // https://vitejs.dev/guide/api-plugin.html#handlehotupdate
-    import.meta.hot.on('nolebase-git-changelog:updated', (data) => {
-      if (!data || typeof data !== 'object')
-        return
-
-      if (data)
-        update(data)
-    })
-
-    // HMR API | Vite
-    // https://vitejs.dev/guide/api-hmr.html
-    import.meta.hot.accept('virtual:nolebase-git-changelog', (newModule) => {
-      if (!newModule)
-        return
-      if (!('default' in newModule))
-        return
-      if (!newModule.default || typeof newModule.default !== 'object')
-        return
-
-      if (newModule.default)
-        update(newModule.default)
-    })
-  }
+  useHmr()
 })
 </script>
 
diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue b/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
index 05ff7dab..b41ae6a3 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
+++ b/packages/vitepress-plugin-git-changelog/src/client/components/Contributors.vue
@@ -3,7 +3,7 @@ import { inject, onMounted } from 'vue'
 import { useData } from 'vitepress'
 import { defu } from 'defu'
 
-import { useChangelog } from '../composables/commits'
+import { useChangelog } from '../composables/changelog'
 import { useI18n } from '../composables/i18n'
 import { InjectionKey, defaultOptions } from '../constants'
 
@@ -11,40 +11,10 @@ const options = defu(inject(InjectionKey, {}), defaultOptions)
 
 const { t } = useI18n()
 const { page } = useData()
-const { authors, update } = useChangelog(page)
+const { authors, useHmr } = useChangelog(page)
 
 onMounted(() => {
-  if (import.meta.hot) {
-    import.meta.hot.send('nolebase-git-changelog:client-mounted', {
-      page: {
-        filePath: page.value.filePath,
-      },
-    })
-
-    // Plugin API | Vite
-    // https://vitejs.dev/guide/api-plugin.html#handlehotupdate
-    import.meta.hot.on('nolebase-git-changelog:updated', (data) => {
-      if (!data || typeof data !== 'object')
-        return
-
-      if (data)
-        update(data)
-    })
-
-    // HMR API | Vite
-    // https://vitejs.dev/guide/api-hmr.html
-    import.meta.hot.accept('virtual:nolebase-git-changelog', (newModule) => {
-      if (!newModule)
-        return
-      if (!('default' in newModule))
-        return
-      if (!newModule.default || typeof newModule.default !== 'object')
-        return
-
-      if (newModule.default)
-        update(newModule.default)
-    })
-  }
+  useHmr()
 })
 </script>
 
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts
similarity index 63%
rename from packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
rename to packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts
index ffc03cb0..03b2d42b 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/commits.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts
@@ -58,11 +58,48 @@ export function useChangelog(pageData: Ref<PageData>) {
       })
   })
 
+  const update = (data: Changelog) => {
+    gitChangelog.value = data
+  }
+
+  const useHmr = () => {
+    if (import.meta.hot) {
+      import.meta.hot.send('nolebase-git-changelog:client-mounted', {
+        page: {
+          filePath: pageData.value.filePath,
+        },
+      })
+
+      // Plugin API | Vite
+      // https://vitejs.dev/guide/api-plugin.html#handlehotupdate
+      import.meta.hot.on('nolebase-git-changelog:updated', (data) => {
+        if (!data || typeof data !== 'object')
+          return
+
+        if (data)
+          update(data)
+      })
+
+      // HMR API | Vite
+      // https://vitejs.dev/guide/api-hmr.html
+      import.meta.hot.accept('virtual:nolebase-git-changelog', (newModule) => {
+        if (!newModule)
+          return
+        if (!('default' in newModule))
+          return
+        if (!newModule.default || typeof newModule.default !== 'object')
+          return
+
+        if (newModule.default)
+          update(newModule.default)
+      })
+    }
+  }
+
   return {
     commits,
     authors,
-    update(data: Changelog) {
-      gitChangelog.value = data
-    },
+    useHmr,
+
   }
 }

From 8efb4887fd52291d7c55d6345e826962876e964a Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 11:43:20 +0800
Subject: [PATCH 8/9] style: fix lint

---
 .../src/client/types.ts                              | 12 ++++++------
 .../src/client/composables/changelog.ts              |  1 -
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/packages/vitepress-plugin-enhanced-readabilities/src/client/types.ts b/packages/vitepress-plugin-enhanced-readabilities/src/client/types.ts
index ea8c8341..fdb5fbcb 100644
--- a/packages/vitepress-plugin-enhanced-readabilities/src/client/types.ts
+++ b/packages/vitepress-plugin-enhanced-readabilities/src/client/types.ts
@@ -295,8 +295,8 @@ export interface Options {
      */
     defaultMode?: LayoutMode
     /**
-    * Disable Layout Switch animation
-    */
+     * Disable Layout Switch animation
+     */
     disableAnimation?: boolean
     /**
      * Content layout max width slider configuration
@@ -315,8 +315,8 @@ export interface Options {
        */
       defaultMaxWidth?: number
       /**
-      * Disable Layout Max Width animation
-      */
+       * Disable Layout Max Width animation
+       */
       disableAnimation?: boolean
     }
     /**
@@ -336,8 +336,8 @@ export interface Options {
        */
       defaultMaxWidth?: number
       /**
-      * Disable Layout Max Width animation
-      */
+       * Disable Layout Max Width animation
+       */
       disableAnimation?: boolean
     }
   }
diff --git a/packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts b/packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts
index 03b2d42b..7b1bd6c6 100644
--- a/packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts
+++ b/packages/vitepress-plugin-git-changelog/src/client/composables/changelog.ts
@@ -100,6 +100,5 @@ export function useChangelog(pageData: Ref<PageData>) {
     commits,
     authors,
     useHmr,
-
   }
 }

From c2dba42c18e18b310ae5c617e186d8a8912cd038 Mon Sep 17 00:00:00 2001
From: Northword <northword@outlook.com>
Date: Sun, 21 Jul 2024 11:45:01 +0800
Subject: [PATCH 9/9] docs: add v2->v3 to nav and sidebar

---
 docs/.vitepress/config.ts | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index d7f35e9d..03fd2d90 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -69,8 +69,8 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
             items: [
               { text: 'Overview', link: '/pages/en/integrations/vitepress-plugin-git-changelog/' },
               { text: 'Getting started', link: '/pages/en/integrations/vitepress-plugin-git-changelog/getting-started' },
-              { text: 'Configure UI', link: '/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui' },
               { text: 'Configure Vite Plugins', link: '/pages/en/integrations/vitepress-plugin-git-changelog/configure-vite-plugins' },
+              { text: 'Configure UI', link: '/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui' },
             ],
           },
           { text: 'Page properties', link: '/pages/en/integrations/vitepress-plugin-page-properties/' },
@@ -109,6 +109,10 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
                 text: 'Migrate from v1 to v2',
                 link: '/pages/en/releases/migrations/v1-to-v2',
               },
+              {
+                text: 'Migrate from v2 to v3',
+                link: '/pages/en/releases/migrations/v2-to-v3',
+              },
             ],
           },
         ],
@@ -193,8 +197,8 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
             items: [
               { text: '介绍', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/' },
               { text: '快速上手', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/getting-started' },
-              { text: '配置 UI 组件', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui' },
               { text: '配置 Vite 插件', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins' },
+              { text: '配置 UI 组件', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui' },
             ],
           },
           { text: '页面属性', link: '/pages/zh-CN/integrations/vitepress-plugin-page-properties/' },
@@ -227,6 +231,10 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
                 text: '自 v1 迁移至 v2',
                 link: '/pages/zh-CN/releases/migrations/v1-to-v2',
               },
+              {
+                text: '自 v2 迁移至 v3',
+                link: '/pages/zh-CN/releases/migrations/v2-to-v3',
+              },
             ],
           },
         ],
@@ -358,6 +366,10 @@ export default defineConfig({
                     text: 'Migrate from v1 to v2',
                     link: '/pages/en/releases/migrations/v1-to-v2',
                   },
+                  {
+                    text: 'Migrate from v2 to v3',
+                    link: '/pages/en/releases/migrations/v2-to-v3',
+                  },
                 ],
               },
             ],
@@ -387,6 +399,10 @@ export default defineConfig({
                     text: '自 v1 迁移至 v2',
                     link: '/pages/zh-CN/releases/migrations/v1-to-v2',
                   },
+                  {
+                    text: '自 v2 迁移至 v3',
+                    link: '/pages/zh-CN/releases/migrations/v2-to-v3',
+                  },
                 ],
               },
             ],