feat: refactor code & add changlog

Author: WRXinYue

README.md

@@ -67,12 +67,12 @@ const { contributors } = useAddonGitLog()
 
 Regarding the full `contributors` parameter:
 
-| Name | Type | Description |
-| ---- | ---- | ---- |
-| name | `string` | Contributor's name |
-| email | `string` | Contributor's email |
+| Name   | Type     | Description                                                        |
+| ------ | -------- | ------------------------------------------------------------------ |
+| name   | `string` | Contributor's name                                                 |
+| email  | `string` | Contributor's email                                                |
 | avatar | `string` | Contributor's avatar URL, obtained through gravatar based on email |
-| count | `number` | Number of contributions |
+| count  | `number` | Number of contributions                                            |
 
 ## Configuration / Options
 
@@ -82,7 +82,6 @@ In your project (wether theme or addon), you can write this in `valaxy.config.ts
 export default defineValaxyConfig<ThemeConfig>({
   addons: [
     addonGitLog({
-      debug: false,
       contributor: {
         mode: 'log',
         // logArgs: '--first-parent --follow',
@@ -92,12 +91,11 @@ export default defineValaxyConfig<ThemeConfig>({
 })
 ```
 
-| Name | Type | Default | Description |
-| ---- | ---- | ---- | ---- |
-| repositoryUrl | `string` | `undefined` | The URL of the repository. |
-| contributor.mode | `'api'` \| `'log'` \| `'shortLog'` | `'api'` | The method to generate Git information. |
-| contributor.logArgs | `string` | `''` | Additional arguments for `git log` command. |
-| debug | `boolean` | `undefined` | Enable debug mode. |
+| Name                | Type                               | Default     | Description                                 |
+| ------------------- | ---------------------------------- | ----------- | ------------------------------------------- |
+| repositoryUrl       | `string`                           | `undefined` | The URL of the repository.                  |
+| contributor.mode    | `'api'` \| `'log'` \| `'shortLog'` | `'api'`     | The method to generate Git information.     |
+| contributor.logArgs | `string`                           | `''`        | Additional arguments for `git log` command. |
 
 Besides the `api` method, the `mode` option also includes `log` and `shortLog` methods. These methods allow you to generate Git information during build time, with the `git log` command by default adding the `--no-merges` parameter.
 

client/composable.ts

@@ -0,0 +1,25 @@
+import type { MaybeRefOrGetter, Ref } from 'vue'
+import type { ChangeLog } from '../../types'
+import { computedAsync } from '@vueuse/core'
+import { toRef } from 'vue'
+import { useAddonGitLogConfig } from '../options'
+import { useGitLog } from './gitlog'
+
+export function useChangeLog(_path?: MaybeRefOrGetter<string>): Ref<ChangeLog[]> {
+  const gitLog = useGitLog()
+  const gitLogOptions = useAddonGitLogConfig()
+
+  if (gitLogOptions.value.contributor?.mode !== 'api')
+    return toRef([])
+
+  const contributors = computedAsync<ChangeLog[]>(
+    async () => {
+      // TODO: Complete the API-based method
+      return []
+    },
+    gitLog.value.changeLog,
+    { lazy: true },
+  )
+
+  return contributors
+}

client/composables/changelog.ts

@@ -1,75 +1,28 @@
-import type { MaybeRefOrGetter } from 'vue'
+import type { MaybeRefOrGetter, Ref } from 'vue'
 import type { Contributor } from '../../types'
-import { Octokit } from '@octokit/rest'
-import { computedAsync, isClient } from '@vueuse/core'
-import gravatar from 'gravatar'
-import { useFrontmatter } from 'valaxy'
-import { computed, toValue } from 'vue'
-import { useAddonGitLogConfig } from '..'
+import { computedAsync } from '@vueuse/core'
+import { toRef, toValue } from 'vue'
 import { parseGithubUrl } from '../../utils'
+import { useAddonGitLogConfig } from '../options'
+import { fetchContributors } from '../services'
+import { useGitLog } from './gitlog'
 
-const octokit = new Octokit()
-export function useAddonGitLogContributor(userPath?: MaybeRefOrGetter<string>) {
-  if (!isClient)
-    return
-
-  const frontmatter = useFrontmatter()
+export function useContributor(path?: MaybeRefOrGetter<string>): Ref<Contributor[]> {
+  const gitLog = useGitLog()
   const gitLogOptions = useAddonGitLogConfig()
 
-  const gitLog = computed(() => frontmatter.value.git_log || {
-    contributors: [],
-  })
-
   if (gitLogOptions.value.contributor?.mode !== 'api')
-    return
-
-  const { owner, repo } = parseGithubUrl(gitLogOptions.value.repositoryUrl!)
-
-  const autoPath = gitLog.value.path
+    return toRef([])
 
   const contributors = computedAsync<Contributor[]>(
     async () => {
-      const path = toValue(userPath || autoPath)
-      return await fetchCommits(owner, repo, path)
+      const { owner, repo } = parseGithubUrl(gitLogOptions.value.repositoryUrl!)
+      const _path = toValue(path || gitLog.value.path)
+      return await fetchContributors(owner, repo, _path)
     },
     gitLog.value.contributors,
     { lazy: true },
   )
 
   return contributors
 }
-
-async function fetchCommits(owner: string, repo: string, path: string): Promise<Contributor[]> {
-  let contributors: Contributor[] = []
-
-  try {
-    const { data } = await octokit.repos.listCommits({ owner, repo, path })
-    const contributorMap: { [key: string]: Contributor } = {}
-
-    data.forEach(({ author, commit }) => {
-      const name = author?.name || author?.login || commit.author?.name || 'Unknown Contributor'
-      const email = author?.email || commit.author?.email
-
-      if (!email)
-        return
-
-      const github = author?.login ? `https://github.com/${author?.login}` : null
-      const avatar = author?.avatar_url || gravatar.url(email, { d: 'wavatar' })
-
-      if (contributorMap[name])
-        contributorMap[name].count += 1
-      else
-        contributorMap[name] = { count: 1, name, email, avatar, github }
-    })
-
-    contributors = Object.values(contributorMap)
-
-    // sort by commit count
-    contributors.sort((a: any, b: any) => b.count - a.count)
-  }
-  catch (error) {
-    console.error(`valaxy-addon-git-log: ${error}`)
-  }
-
-  return contributors
-}

client/composables/contributor.ts

@@ -0,0 +1,22 @@
+import type { Ref } from 'vue'
+import type { GitLog } from '../../types'
+import { isClient } from '@vueuse/core'
+import { useFrontmatter } from 'valaxy'
+import { computed, toRef } from 'vue'
+
+export function useGitLog(): Ref<GitLog> {
+  const initGitLog: GitLog = {
+    contributors: [],
+    changeLog: [],
+    path: '',
+  }
+
+  if (!isClient)
+    return toRef(initGitLog)
+
+  const frontmatter = useFrontmatter()
+
+  const gitLog = computed<GitLog>(() => frontmatter.value.git_log || initGitLog)
+
+  return gitLog
+}

client/composables/gitlog.ts

@@ -1 +1,3 @@
+export * from './changelog'
 export * from './contributor'
+export * from './gitlog'

client/composables/index.ts

@@ -1,3 +1,3 @@
-export * from './composable'
 export * from './composables'
 export * from './options'
+export * from './services'

client/index.ts

@@ -1,18 +1,13 @@
-import { computed } from 'vue'
 import type { ValaxyAddon } from 'valaxy'
-import { useRuntimeConfig } from 'valaxy'
 import type { GitLogOptions } from '../types'
+import { useRuntimeConfig } from 'valaxy'
+import { computed } from 'vue'
 
 export function useAddonGitLogConfig() {
   const runtimeConfig = useRuntimeConfig()
   return computed<GitLogOptions>(() => {
     const options = (runtimeConfig.value.addons['valaxy-addon-git-log'] as ValaxyAddon<GitLogOptions>).options
 
-    return {
-      ...options,
-      contributor: {
-        mode: 'api',
-      },
-    }
+    return { ...options }
   })
 }

client/options.ts

@@ -0,0 +1,42 @@
+import type { Contributor } from '../../types'
+import { Octokit } from '@octokit/rest'
+import gravatar from 'gravatar'
+import md5 from 'md5'
+
+const octokit = new Octokit()
+
+export async function fetchContributors(owner: string, repo: string, path: string): Promise<Contributor[]> {
+  let contributors: Contributor[] = []
+
+  try {
+    const { data } = await octokit.repos.listCommits({ owner, repo, path })
+    const contributorMap: { [key: string]: Contributor } = {}
+
+    data.forEach(({ author, commit }) => {
+      const name = author?.name || author?.login || commit.author?.name || 'Unknown Contributor'
+      const email = author?.email || commit.author?.email
+
+      if (!email)
+        return
+
+      const github = author?.login ? `https://github.com/${author?.login}` : null
+      const avatar = author?.avatar_url || gravatar.url(email, { d: 'wavatar' })
+      const hash = md5(email)
+
+      if (contributorMap[name])
+        contributorMap[name].count += 1
+      else
+        contributorMap[name] = { count: 1, name, email, avatar, hash, github }
+    })
+
+    contributors = Object.values(contributorMap)
+
+    // sort by commit count
+    contributors.sort((a, b) => b.count - a.count)
+  }
+  catch (error) {
+    console.error(`valaxy-addon-git-log: ${error}`)
+  }
+
+  return contributors
+}

client/services/fetchContributors.ts

@@ -0,0 +1 @@
+export * from './fetchContributors'