chore: tweaks

Author: Mister-Hope

docs/plugins/development/git.md

@@ -197,27 +197,31 @@ This plugin will significantly slow down the speed of data preparation, especial
 - Type: `Record<string, GitLocaleData>`
 
   ```ts
-  export interface GitLocaleData extends LocaleData {
+  export interface GitLocaleData {
     /**
      * Contributors title
      */
     contributors: string
+
     /**
      * Changelog title
      */
     changelog: string
+
     /**
-     * Changelog on time
+     * Word to represent a commit "on" a time
      */
-    changelogOn: string
+    timeOn: string
+
     /**
      * Changelog button
      */
-    changelogButton: string
+    viewChangelog: string
+
     /**
      * Latest updated
      */
-    latestUpdated: string
+    latestUpdateAt: string
   }
   ```
 

docs/zh/plugins/development/git.md

@@ -190,7 +190,7 @@ export default {
 - 类型： `Record<string, GitLocaleData>`
 
   ```ts
-  export interface GitLocaleData extends LocaleData {
+  export interface GitLocaleData {
     /**
      * 贡献者 标题
      */
@@ -202,15 +202,15 @@ export default {
     /**
      * 更新 `于` 文本
      */
-    changelogOn: string
+    timeOn: string
     /**
      * 查看更新日志 文本
      */
-    changelogButton: string
+    viewChangelog: string
     /**
      * 最近更新 文本
      */
-    latestUpdated: string
+    latestUpdateAt: string
   }
   ```
 

plugins/development/plugin-git/src/client/components/Changelog.ts

@@ -7,7 +7,7 @@ import type {
   GitPluginFrontmatter,
   GitPluginPageData,
 } from '../../shared/index.js'
-import { useGitLocales } from '../composables/index.js'
+import { useGitLocaleConfig } from '../composables/index.js'
 import { VPHeader } from './VPHeader.js'
 
 import '../styles/vars.css'
@@ -17,25 +17,31 @@ type ResolvedChangelog = Omit<GitChangelog, 'date'> & { datetime: string }
 
 export const Changelog = defineComponent({
   name: 'Changelog',
+
   props: {
+    /** Title of changelog */
+    title: String,
+
+    /** header level of changelog */
     headerLevel: {
       type: Number,
       default: 2,
     },
-    title: String,
   },
+
   setup(props) {
+    const locale = useGitLocaleConfig()
+    const frontmatter = usePageFrontmatter<GitPluginFrontmatter>()
     const page = usePageData<GitPluginPageData>()
     const lang = usePageLang()
-    const frontmatter = usePageFrontmatter<GitPluginFrontmatter>()
-    const locale = useGitLocales()
 
     const list = computed<ResolvedChangelog[]>(() => {
       if (frontmatter.value.changelog === false) return []
 
       const formatter = new Intl.DateTimeFormat(lang.value, {
         dateStyle: 'short',
       })
+
       // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       return (page.value.git?.changelog ?? []).map(({ date, ...item }) => {
         const datetime = formatter.format(date)
@@ -63,12 +69,12 @@ export const Changelog = defineComponent({
       h('div', { class: 'changelog-header', onClick: toggle }, [
         h('div', { class: 'latest-updated' }, [
           h('span', { class: 'vpi-changelog' }),
-          h('span', [locale.value.latestUpdated || 'Latest updated:', ' ']),
-          h('span', { 'data-allow-mismatch': true }, latestUpdated.value),
+          h('span', [locale.value.latestUpdateAt, ' ']),
+          h('span', { 'data-allow-mismatch': '' }, latestUpdated.value),
         ]),
         h('div', [
           h('span', { class: 'vpi-changelog-menu' }),
-          h('span', locale.value.changelogButton || 'View All Changelog'),
+          h('span', locale.value.viewChangelog),
         ]),
       ])
 
@@ -80,8 +86,8 @@ export const Changelog = defineComponent({
         { class: 'changelog release-tag' },
         h('div', [
           h('a', { class: 'link release-tag' }, h('code', item.tag)),
-          h('span', { 'class': 'datetime', 'data-allow-mismatch': true }, [
-            locale.value.changelogOn || 'on',
+          h('span', { 'class': 'datetime', 'data-allow-mismatch': '' }, [
+            locale.value.timeOn,
             ' ',
             item.datetime,
           ]),
@@ -104,8 +110,8 @@ export const Changelog = defineComponent({
         ),
         h('span', { class: 'divider' }, '-'),
         h('span', { class: 'message', innerHTML: item.message }),
-        h('span', { 'class': 'datetime', 'data-allow-mismatch': true }, [
-          locale.value.changelogOn || 'on',
+        h('span', { 'class': 'datetime', 'data-allow-mismatch': '' }, [
+          locale.value.timeOn || 'on',
           ' ',
           item.datetime,
         ]),
@@ -117,7 +123,7 @@ export const Changelog = defineComponent({
             h(VPHeader, {
               level: props.headerLevel,
               anchor: 'doc-changelog',
-              title: props.title || locale.value.changelog || 'Changelog',
+              text: props.title || locale.value.changelog,
             }),
 
             h('div', { class: ['vp-changelog', { active: active.value }] }, [

plugins/development/plugin-git/src/client/components/Contributors.ts

@@ -6,24 +6,27 @@ import type {
   GitPluginFrontmatter,
   GitPluginPageData,
 } from '../../shared/index.js'
-import { useGitLocales } from '../composables/index.js'
+import { useGitLocaleConfig } from '../composables/index.js'
 import { VPHeader } from './VPHeader.js'
 
 import '../styles/contributors.css'
 
 export const Contributors = defineComponent({
   name: 'Contributors',
   props: {
+    /** Contributor title */
+    title: String,
+
+    /** header level of contributor title */
     headerLevel: {
       type: Number,
       default: 2,
     },
-    title: String,
   },
   setup(props) {
-    const page = usePageData<GitPluginPageData>()
+    const locale = useGitLocaleConfig()
     const frontmatter = usePageFrontmatter<GitPluginFrontmatter>()
-    const locale = useGitLocales()
+    const page = usePageData<GitPluginPageData>()
 
     const contributors = computed(() => {
       if (frontmatter.value.contributors === false) return []
@@ -56,7 +59,7 @@ export const Contributors = defineComponent({
             h(VPHeader, {
               level: props.headerLevel,
               anchor: 'doc-contributors',
-              title: props.title || locale.value.contributors || 'Contributors',
+              text: props.title || locale.value.contributors,
             }),
             h(
               'div',

plugins/development/plugin-git/src/client/components/VPHeader.ts

@@ -1,19 +1,26 @@
 import type { FunctionalComponent } from 'vue'
 import { h } from 'vue'
 
-interface VPHeaderProps {
-  level?: number
-  title: string
+export interface VPHeaderProps {
+  /** header text */
+  text: string
+  /** header anchor */
   anchor: string
+  /**
+   * header level
+   *
+   * @default 2
+   */
+  level?: number
 }
 
 export const VPHeader: FunctionalComponent<VPHeaderProps> = ({
   level = 2,
-  title,
+  text,
   anchor,
 }) =>
   h(
     `h${level || 2}`,
     { id: anchor, tabindex: '-1' },
-    h('a', { href: `#${anchor}`, class: 'header-anchor' }, h('span', title)),
+    h('a', { href: `#${anchor}`, class: 'header-anchor' }, h('span', text)),
   )

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

@@ -1,10 +1,11 @@
+import type { ExactLocaleConfig } from '@vuepress/helper/client'
 import { useLocaleConfig } from '@vuepress/helper/client'
 import type { ComputedRef } from 'vue'
-import type { GitLocaleData, GitLocales } from '../../shared/index.js'
+import type { GitLocaleData } from '../../shared/index.js'
 
-declare const __GIT_LOCALES__: GitLocales
+declare const __GIT_LOCALES__: ExactLocaleConfig<GitLocaleData>
 
 export const locales = __GIT_LOCALES__
 
-export const useGitLocales = (): ComputedRef<Partial<GitLocaleData>> =>
+export const useGitLocaleConfig = (): ComputedRef<GitLocaleData> =>
   useLocaleConfig(locales)

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

@@ -6,7 +6,7 @@ import type {
   GitPluginFrontmatter,
   GitPluginPageData,
 } from '../shared/index.js'
-import { DEFAULT_LOCALES } from './locales.js'
+import { gitLocaleInfo } from './locales.js'
 import type { GitPluginOptions } from './options.js'
 import { resolveChangelog } from './resolveChangelog.js'
 import { resolveContributors } from './resolveContributors.js'
@@ -35,7 +35,7 @@ export const gitPlugin =
         __GIT_LOCALES__: getFullLocaleConfig({
           app,
           name,
-          default: DEFAULT_LOCALES,
+          default: gitLocaleInfo,
           config: locales,
         }),
       },