chore: rename changeLog to changelog

Author: WRXinYue

client/composables/changelog.ts

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

node/changeLog.ts

@@ -1,10 +1,10 @@
-import type { ChangeLog } from '../types'
+import type { Changelog } from '../types'
 import { uniq } from '@vueuse/metadata'
 import { git } from '.'
 
-let cache: ChangeLog[] | undefined
+let cache: Changelog[] | undefined
 
-export async function getChangeLog(maxCount = 200, path?: string) {
+export async function getChangelog(maxCount = 200, path?: string) {
   if (cache)
     return cache
 
@@ -13,7 +13,7 @@ export async function getChangeLog(maxCount = 200, path?: string) {
       || i.message.includes('!')
       || i.message.startsWith('feat')
       || i.message.startsWith('fix')
-  }) as ChangeLog[]
+  }) as Changelog[]
 
   for (const log of logs) {
     if (log.message.includes('chore: release')) {

node/contributor.ts

@@ -28,6 +28,7 @@ export async function getContributors(filePath?: string, options?: GitLogOptions
             name: i[0],
             email: i[1],
             avatar: gravatar.url(i[1]),
+            github: null,
             hash: md5(i[1]),
           }
         }

node/index.ts

@@ -4,7 +4,7 @@ import consola from 'consola'
 import Git from 'simple-git'
 import { defineValaxyAddon } from 'valaxy'
 import pkg from '../package.json'
-import { getChangeLog } from './changeLog'
+import { getChangelog } from './changeLog'
 import { getContributors } from './contributor'
 
 export const git = Git({
@@ -39,12 +39,12 @@ export const addonGitLog = defineValaxyAddon<GitLogOptions>(options => ({
         if (!filePath.startsWith(currentWorkingDirectory))
           return
 
-        if (options?.contributor?.mode === 'log') {
+        if (options?.contributor?.mode === 'git') {
           try {
             const contributors = await getContributors(filePath, options)
             route.meta.frontmatter.git_log.contributors = contributors
 
-            const changeLog = await getChangeLog(process.env.CI ? 1000 : 100, filePath)
+            const changeLog = await getChangelog(process.env.CI ? 1000 : 100, filePath)
             route.meta.frontmatter.git_log.changeLog = changeLog
           }
           catch (error) {

plugins/changelog.ts

@@ -1,9 +1,9 @@
 import type { Plugin } from 'vite'
-import type { ChangeLog as ChangeLogType } from '../types'
+import type { Changelog as ChangelogType } from '../types'
 
 const ID = 'virtual:git-log/changelog'
 
-export function ChangeLog(data: ChangeLogType[]): Plugin {
+export function Changelog(data: ChangelogType[]): Plugin {
   return {
     name: 'git-log-changelog',
     resolveId(id) {

plugins/main.ts

@@ -1,14 +1,14 @@
 import type { Plugin } from 'vite'
 import process from 'node:process'
-import { getChangeLog } from '../node/changeLog'
+import { getChangelog } from '../node/changeLog'
 import { getContributors } from '../node/contributor'
-import { ChangeLog } from './changelog'
+import { Changelog } from './changelog'
 import { Contributors } from './contributors'
 
 // eslint-disable-next-line antfu/no-top-level-await
 const [changeLog, contributions] = await Promise.all([
-  getChangeLog(process.env.CI ? 1000 : 100),
+  getChangelog(process.env.CI ? 1000 : 100),
   getContributors(),
 ])
 
-export const GitLogVitePlugins: Plugin[] = [ChangeLog(changeLog), Contributors(contributions)]
+export const GitLogVitePlugins: Plugin[] = [Changelog(changeLog), Contributors(contributions)]

types/index.ts

@@ -3,7 +3,7 @@ import type { CommitInfo, ContributorInfo } from '@vueuse/metadata'
 export interface GitLogOptions {
   repositoryUrl?: string
   contributor?: {
-    mode?: 'log' | 'api'
+    mode?: 'git' | 'api'
     logArgs?: string
   }
 }
@@ -13,15 +13,15 @@ export interface Contributor extends ContributorInfo {
   email: string
   avatar: string
   count: number
-  github?: string | null
+  github: string | null
 }
 
-export interface ChangeLog extends CommitInfo {
+export interface Changelog extends CommitInfo {
 
 }
 
 export interface GitLog {
   contributors: Contributor[]
-  changeLog: ChangeLog[]
+  changeLog: Changelog[]
   path: string
 }

utils/render.ts

@@ -15,7 +15,7 @@ export function renderMarkdown(markdownText = '') {
   return htmlText.trim()
 }
 
-export function renderCommitMessage(msg: string) {
+export function renderCommitMessage(msg: string, repo: string) {
   return renderMarkdown(msg)
-    .replace(/#(\d+)/g, '<a href=\'https://github.com/vueuse/vueuse/issues/$1\'>#$1</a>')
+    .replace(/#(\d+)/g, `<a href=\'${repo}/issues/$1\'>#$1</a>`)
 }