chore: tweak

Author: pengzhanbo

plugins/development/plugin-git/src/client/composables/useChangelog.ts

@@ -6,16 +6,23 @@ import type {
   GitPluginFrontmatter,
   GitPluginPageData,
 } from '../../shared/index.js'
+import { gitOptions } from '../options.js'
+import { resolveRepoLink } from '../utils/index.js'
 
 export interface GitChangelogItem extends GitChangelogInfo {
   date: string
 }
 
+const RE_ISSUE = /#(\d+)/g
+
 export const useChangelog = (): ComputedRef<GitChangelogItem[]> => {
   const frontmatter = usePageFrontmatter<GitPluginFrontmatter>()
   const lang = usePageLang()
   const page = usePageData<GitPluginPageData>()
 
+  const { pattern = {}, provider } = gitOptions
+  const repo = resolveRepoLink(gitOptions.repo, provider)
+
   return computed(() => {
     if (frontmatter.value.changelog === false) return []
 
@@ -24,9 +31,34 @@ export const useChangelog = (): ComputedRef<GitChangelogItem[]> => {
     })
 
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    return (page.value.git?.changelog ?? []).map((item) => ({
-      date: formatter.format(item.time),
-      ...item,
-    }))
+    return (page.value.git?.changelog ?? []).map((item) => {
+      const res: GitChangelogItem = {
+        date: formatter.format(item.time),
+        ...item,
+      }
+
+      if (pattern.issue && repo) {
+        res.message = res.message.replace(
+          RE_ISSUE,
+          (matched, issue: string) => {
+            const url = pattern
+              .issue!.replace(':issue', issue)
+              .replace(':repo', repo)
+            return `<a href="${url}" target="_blank" rel="noopener noreferrer">${matched}</a>`
+          },
+        )
+      }
+
+      if (pattern.commit && repo) {
+        res.commitUrl = pattern.commit
+          .replace(':hash', res.hash)
+          .replace(':repo', repo)
+      }
+
+      if (pattern.tag && repo && res.tag)
+        res.tagUrl = pattern.tag.replace(':tag', res.tag).replace(':repo', repo)
+
+      return res
+    })
   })
 }

plugins/development/plugin-git/src/client/composables/useGitLocales.ts

@@ -5,8 +5,7 @@ import type { GitLocaleData } from '../../shared/index.js'
 
 declare const __GIT_LOCALES__: ExactLocaleConfig<GitLocaleData>
 
-export const locales =
-  typeof __GIT_LOCALES__ === 'undefined' ? {} : __GIT_LOCALES__
+export const locales = __GIT_LOCALES__
 
 export const useGitLocaleConfig = (): ComputedRef<GitLocaleData> =>
   useLocaleConfig(locales)

plugins/development/plugin-git/src/client/options.ts

@@ -0,0 +1,5 @@
+import type { GitInjectOptions } from '../shared/index.js'
+
+declare const __GIT_OPTIONS__: GitInjectOptions
+
+export const gitOptions = __GIT_OPTIONS__

plugins/development/plugin-git/src/client/utils/index.ts

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

plugins/development/plugin-git/src/client/utils/resolveRepoLink.ts

@@ -0,0 +1,15 @@
+import { isLinkHttp } from '@vuepress/helper/client'
+import type { KnownGitProvider } from '../../shared/index.js'
+
+export const resolveRepoLink = (
+  link?: string,
+  provider?: KnownGitProvider | null,
+): string | undefined => {
+  if (!link || isLinkHttp(link)) return link
+
+  if (provider === 'github') return `https://github.com/${link}`
+
+  if (provider === 'gitee') return `https://gitee.com/${link}`
+
+  return link
+}

plugins/development/plugin-git/src/node/gitPlugin.ts

@@ -11,7 +11,12 @@ import type { GitPluginOptions } from './options.js'
 import { prepareClientConfigFile } from './prepareClientConfigFile.js'
 import { resolveChangelog } from './resolveChangelog.js'
 import { resolveContributors } from './resolveContributors.js'
-import { checkGitRepo, getCommits, inferGitProvider } from './utils/index.js'
+import {
+  checkGitRepo,
+  getCommits,
+  inferGitProvider,
+  injectGitOptions,
+} from './utils/index.js'
 
 export const gitPlugin =
   ({
@@ -39,6 +44,7 @@ export const gitPlugin =
           default: gitLocaleInfo,
           config: locales,
         }),
+        __GIT_OPTIONS__: injectGitOptions(gitProvider, changelog),
       },
 
       extendsPage: async (
@@ -109,7 +115,6 @@ export const gitPlugin =
             app,
             commits,
             changelogOptions,
-            gitProvider,
             contributorsOptions.info ?? [],
           )
         }

plugins/development/plugin-git/src/node/resolveChangelog.ts

@@ -1,57 +1,14 @@
 import type { App } from 'vuepress'
 import type { GitChangelogInfo } from '../shared/index.js'
 import type { ChangelogOptions, ContributorInfo } from './options.js'
-import type { KnownGitProvider, MergedRawCommit } from './typings.js'
+import type { MergedRawCommit } from './typings.js'
 import {
   getContributorInfo,
   getUserNameWithNoreplyEmail,
 } from './utils/index.js'
 
-interface Pattern {
-  issue?: string
-  tag?: string
-  commit?: string
-}
-
-const RE_ISSUE = /#(\d+)/g
 const RE_CLEAN_REFS = /[()]/g
 
-const patterns: Record<KnownGitProvider, Pattern> = {
-  github: {
-    issue: ':repo/issues/:issue',
-    tag: ':repo/releases/tag/:tag',
-    commit: ':repo/commit/:hash',
-  },
-  gitlab: {
-    issue: ':repo/-/issues/:issue',
-    tag: ':repo/-/releases/:tag',
-    commit: ':repo/-/commit/:hash',
-  },
-  gitee: {
-    issue: ':repo/issues/:issue',
-    tag: ':repo/releases/tag/:tag',
-    commit: ':repo/commit/:hash',
-  },
-  bitbucket: {
-    issue: ':repo/issues/:issue',
-    tag: ':repo/src/:hash',
-    commit: ':repo/commits/:hash',
-  },
-}
-
-const getPattern = (
-  { commitUrlPattern, issueUrlPattern, tagUrlPattern }: ChangelogOptions,
-  provider: KnownGitProvider | null,
-): Pattern => {
-  const fallback = provider ? patterns[provider] : {}
-
-  return {
-    commit: commitUrlPattern ?? fallback.commit,
-    issue: issueUrlPattern ?? fallback.issue,
-    tag: tagUrlPattern ?? fallback.tag,
-  }
-}
-
 const parseTagName = (refs: string): string | undefined => {
   if (!refs) return
 
@@ -67,11 +24,8 @@ export const resolveChangelog = (
   app: App,
   commits: MergedRawCommit[],
   options: ChangelogOptions,
-  gitProvider: KnownGitProvider | null,
   contributors: ContributorInfo[],
 ): GitChangelogInfo[] => {
-  const pattern = getPattern(options, gitProvider)
-  const repo = options.repoUrl
   const result: GitChangelogInfo[] = []
 
   const sliceCommits = options.maxCount
@@ -95,28 +49,8 @@ export const resolveChangelog = (
 
     if (coAuthors.length) resolved.coAuthors = coAuthors
 
-    if (pattern.issue && repo) {
-      resolved.message = resolved.message.replace(
-        RE_ISSUE,
-        (matched, issue: string) => {
-          const url = pattern
-            .issue!.replace(':issue', issue)
-            .replace(':repo', repo)
-          return `<a href="${url}" target="_blank" rel="noopener noreferrer">${matched}</a>`
-        },
-      )
-    }
-
-    if (pattern.commit && repo)
-      resolved.commitUrl = pattern.commit
-        .replace(':hash', hash)
-        .replace(':repo', repo)
-
     if (tag) resolved.tag = tag
 
-    if (pattern.tag && repo && tag)
-      resolved.tagUrl = pattern.tag.replace(':tag', tag).replace(':repo', repo)
-
     result.push(resolved)
   }
 

plugins/development/plugin-git/src/node/resolveContributors.ts

@@ -1,6 +1,6 @@
-import type { GitContributorInfo } from '../shared/index.js'
+import type { GitContributorInfo, KnownGitProvider } from '../shared/index.js'
 import type { ContributorsOptions } from './options.js'
-import type { KnownGitProvider, MergedRawCommit } from './typings.js'
+import type { MergedRawCommit } from './typings.js'
 import {
   digestSHA256,
   getContributorInfo,

plugins/development/plugin-git/src/node/typings.ts

@@ -1,8 +1,4 @@
 import type { CoAuthorInfo } from '../shared/index.js'
-/**
- * Git provider
- */
-export type KnownGitProvider = 'bitbucket' | 'gitee' | 'github' | 'gitlab'
 
 export interface RawCommit {
   /**

plugins/development/plugin-git/src/node/utils/index.ts

@@ -4,3 +4,4 @@ export * from './getCommits.js'
 export * from './getContributorInfo.js'
 export * from './getUserNameWithNoreplyEmail.js'
 export * from './inferGitProvider.js'
+export * from './injectGitOptions.js'

plugins/development/plugin-git/src/node/utils/inferGitProvider.ts

@@ -1,5 +1,5 @@
 import { execaCommandSync } from 'execa'
-import type { KnownGitProvider } from '../typings.js'
+import type { KnownGitProvider } from '../../shared/index.js'
 
 export const getRemoteUrl = (cwd: string): string => {
   try {

plugins/development/plugin-git/src/node/utils/injectGitOptions.ts

@@ -0,0 +1,59 @@
+import { isPlainObject } from 'vuepress/shared'
+import type {
+  GitInjectOptions,
+  GitUrlPattern,
+  KnownGitProvider,
+} from '../../shared/index.js'
+import type { ChangelogOptions } from '../options.js'
+
+const PATTERN_PRESET: Record<KnownGitProvider, GitUrlPattern> = {
+  github: {
+    issue: ':repo/issues/:issue',
+    tag: ':repo/releases/tag/:tag',
+    commit: ':repo/commit/:hash',
+  },
+  gitlab: {
+    issue: ':repo/-/issues/:issue',
+    tag: ':repo/-/releases/:tag',
+    commit: ':repo/-/commit/:hash',
+  },
+  gitee: {
+    issue: ':repo/issues/:issue',
+    tag: ':repo/releases/tag/:tag',
+    commit: ':repo/commit/:hash',
+  },
+  bitbucket: {
+    issue: ':repo/issues/:issue',
+    tag: ':repo/src/:hash',
+    commit: ':repo/commits/:hash',
+  },
+}
+
+const getPattern = (
+  { commitUrlPattern, issueUrlPattern, tagUrlPattern }: ChangelogOptions,
+  provider: KnownGitProvider | null,
+): GitUrlPattern => {
+  const fallback = provider ? PATTERN_PRESET[provider] : {}
+
+  return {
+    commit: commitUrlPattern ?? fallback.commit,
+    issue: issueUrlPattern ?? fallback.issue,
+    tag: tagUrlPattern ?? fallback.tag,
+  }
+}
+
+export const injectGitOptions = (
+  provider: KnownGitProvider | null,
+  changelog: ChangelogOptions | boolean,
+): GitInjectOptions => {
+  const data: GitInjectOptions = {
+    provider,
+  }
+  if (changelog) {
+    const changelogOptions = isPlainObject(changelog) ? changelog : {}
+    data.pattern = getPattern(changelogOptions, provider)
+    data.repo = changelogOptions.repoUrl
+  }
+
+  return data
+}

plugins/development/plugin-git/src/shared/index.ts

@@ -1,5 +1,10 @@
 import type { PageFrontmatter } from 'vuepress/shared'
 
+/**
+ * Git provider
+ */
+export type KnownGitProvider = 'bitbucket' | 'gitee' | 'github' | 'gitlab'
+
 /**
  * Co-author information
  */
@@ -145,3 +150,17 @@ export interface GitLocaleData {
    */
   latestUpdateAt: string
 }
+
+/* @internal */
+export interface GitUrlPattern {
+  issue?: string
+  tag?: string
+  commit?: string
+}
+
+/* @internal */
+export interface GitInjectOptions {
+  provider?: KnownGitProvider | null
+  repo?: string
+  pattern?: GitUrlPattern
+}