@movk/nuxt-docs 1.3.9 → 1.3.11

package/app/components/content/CommitChangelog.vue

@@ -25,6 +25,10 @@ const props = defineProps<{
    * The name of the component or file to get the changelog for.
    */
   name?: string
+  /**
+   * The author to filter commits by.
+   */
+  author?: string
 }>()
 
 const SHA_SHORT_LENGTH = 5
@@ -50,8 +54,8 @@ const filePath = computed(() => {
 })
 
 const { data: commits } = await useLazyFetch<Commit[]>('/api/github/commits', {
-  key: `commit-changelog-${props.name ?? routeName.value}`,
-  query: { path: filePath.value }
+  key: `commit-changelog-${props.name ?? routeName.value}-${props.author ?? 'all'}`,
+  query: { path: filePath.value, author: props.author }
 })
 
 // 格式化提交消息
@@ -83,11 +87,7 @@ const formattedCommits = computed(() => {
   <div v-else class="flex flex-col gap-1.5 relative">
     <div class="bg-accented w-px h-full absolute left-[11px] z-[-1]" />
 
-    <div
-      v-for="commit of formattedCommits"
-      :key="commit.sha"
-      class="flex gap-1.5 items-center"
-    >
+    <div v-for="commit of formattedCommits" :key="commit.sha" class="flex gap-1.5 items-center">
       <div class="bg-accented ring-2 ring-bg size-1.5 mx-[8.5px] rounded-full" />
       <MDC :value="commit.formatted" class="text-sm *:py-0 *:my-0 [&_code]:text-xs" tag="div" />
     </div>

package/app/components/content/PageLastCommit.vue

@@ -0,0 +1,124 @@
+<script setup lang="ts">
+interface LastCommit {
+  sha: string
+  date: string
+  dateFormatted: string
+  message: string
+  url: string
+  author: {
+    name: string
+    login: string
+    avatar: string
+  }
+}
+
+const props = withDefaults(defineProps<{
+  /**
+   * 文件路径（不含扩展名），通常由页面自动传入
+   */
+  stem: string
+  /**
+   * 文件扩展名，通常由页面自动传入
+   */
+  extension: string
+  /**
+   * 是否显示提交信息。
+   * @defaultValue true
+   */
+  showMessage?: boolean
+  /**
+   * 是否显示作者头像。
+   * @defaultValue true
+   */
+  showAvatar?: boolean
+}>(), {
+  showMessage: true,
+  showAvatar: true
+})
+
+const { github } = useAppConfig()
+
+const filePath = computed(() => {
+  if (!props.stem || !props.extension) return ''
+
+  const rootDir = github && typeof github === 'object' ? github.rootDir : ''
+  return [rootDir, 'content', `${props.stem}.${props.extension}`].filter(Boolean).join('/')
+})
+
+const { data: commit } = await useFetch<LastCommit | null>('/api/github/last-commit', {
+  key: `last-commit-${filePath.value}`,
+  query: { path: filePath },
+  default: () => null,
+  lazy: true,
+  server: false
+})
+
+const commitUrl = computed(() => commit.value?.url ?? '')
+
+const authorUrl = computed(() => {
+  const login = commit.value?.author.login
+  return login ? `https://github.com/${login}` : ''
+})
+</script>
+
+<template>
+  <div v-if="commit" class="flex items-center flex-wrap gap-1.5 text-sm text-muted mt-2">
+    <span class="text-dimmed">最后更新于</span>
+    <time class="font-medium text-default" :datetime="commit.date">{{ commit.dateFormatted }}</time>
+    <span class="text-dimmed">由</span>
+    <ULink
+      v-if="authorUrl"
+      :to="authorUrl"
+      target="_blank"
+      class="inline-flex items-center gap-1.5 hover:opacity-80 transition-opacity"
+    >
+      <UAvatar
+        v-if="showAvatar && commit.author.avatar"
+        :src="commit.author.avatar"
+        :alt="commit.author.name"
+        size="2xs"
+      />
+      <UBadge color="neutral" variant="outline" size="sm">
+        {{ commit.author.name || commit.author.login }}
+      </UBadge>
+    </ULink>
+    <span v-else class="inline-flex items-center gap-1.5">
+      <UAvatar
+        v-if="showAvatar && commit.author.avatar"
+        :src="commit.author.avatar"
+        :alt="commit.author.name"
+        size="2xs"
+      />
+      <UBadge color="neutral" variant="outline" size="sm">
+        {{ commit.author.name || commit.author.login }}
+      </UBadge>
+    </span>
+    <template v-if="showMessage && commit.message">
+      <span class="text-dimmed">提交</span>
+      <ULink
+        v-if="commitUrl"
+        :to="commitUrl"
+        target="_blank"
+        class="hover:opacity-80 transition-opacity max-w-[250px]"
+      >
+        <UBadge
+          color="neutral"
+          variant="outline"
+          size="sm"
+          class="font-mono text-xs"
+        >
+          <span class="truncate">{{ commit.message }}</span>
+        </UBadge>
+      </ULink>
+      <UBadge
+        v-else
+        color="neutral"
+        variant="outline"
+        size="sm"
+        class="max-w-[250px] font-mono text-xs"
+      >
+        <span class="truncate">{{ commit.message }}</span>
+      </UBadge>
+    </template>
+  </div>
+</template>

package/app/pages/docs/[...slug].vue

@@ -106,6 +106,8 @@ defineOgImageComponent('Nuxt', {
           unwrap="p"
           :cache-key="`${kebabCase(route.path)}-description`"
         />
+
+        <PageLastCommit v-if="github && page?.stem && page?.extension" :stem="page.stem" :extension="page.extension" />
       </template>
 
       <template #links>

package/app/types/index.d.ts

@@ -26,12 +26,25 @@ declare module 'nuxt/schema' {
       }
     }
     github: {
+      owner: string
+      name: string
       url: string
       branch: string
       rootDir: string
       commitPath: string
       since: string
       suffix: string
+      per_page: number
+      until: string
+      author?: string
+      /**
+       * 日期格式化配置
+       * @example { locale: 'zh-CN', options: { year: 'numeric', month: '2-digit', day: '2-digit', hour: '2-digit', minute: '2-digit' } }
+       */
+      dateFormat?: {
+        locale?: string
+        options?: Intl.DateTimeFormatOptions
+      }
     } | false
   }
 }

package/content.config.ts

@@ -22,7 +22,7 @@ export default defineContentConfig({
         include: 'docs/**/*'
       }],
       schema: z.object({
-        links: property(z.object({})).inherit('@nuxt/ui/components/Button.vue'),
+        links: z.array(property(z.object({})).inherit('@nuxt/ui/components/Button.vue')),
         category: z.string().optional(),
         navigation: z.object({
           title: z.string().optional()

package/modules/config.ts

@@ -52,7 +52,9 @@ export default defineNuxtModule({
       commitPath: 'src',
       suffix: 'vue',
       since: '2025-01-31T04:00:00Z',
-      branch: getGitBranch()
+      branch: getGitBranch(),
+      per_page: 100,
+      until: new Date().toISOString()
     })
 
     const componentsPath = resolve('../app/components')
@@ -68,7 +70,7 @@ export default defineNuxtModule({
         'nuxt-og-image',
         '@nuxtjs/plausible',
         '@nuxt/ui',
-        new RegExp(`${componentsPath.replace(/[/\\]/g, '[/\\\\]')}/(?!content/(ComponentEmits|ComponentProps|ComponentSlots|ComponentExample|CommitChangelog)\\.vue$)`)
+        new RegExp(`${componentsPath.replace(/[/\\]/g, '[/\\\\]')}/(?!content/(ComponentEmits|ComponentProps|ComponentSlots|ComponentExample|CommitChangelog|PageLastCommit)\\.vue$)`)
       ],
       metaFields: {
         type: false,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@movk/nuxt-docs",
   "type": "module",
-  "version": "1.3.9",
+  "version": "1.3.11",
   "private": false,
   "description": "An elegant documentation theme for Nuxt, powered by Nuxt UI and Nuxt Content.",
   "author": "YiXuan <mhaibaraai@gmail.com>",
@@ -27,9 +27,9 @@
     "README.md"
   ],
   "dependencies": {
-    "@iconify-json/lucide": "^1.2.75",
-    "@iconify-json/simple-icons": "^1.2.60",
-    "@iconify-json/vscode-icons": "^1.2.36",
+    "@iconify-json/lucide": "^1.2.77",
+    "@iconify-json/simple-icons": "^1.2.61",
+    "@iconify-json/vscode-icons": "^1.2.37",
     "@movk/core": "^1.0.2",
     "@nuxt/content": "^3.8.2",
     "@nuxt/image": "^2.0.0",
@@ -37,18 +37,18 @@
     "@nuxt/ui": "^4.2.1",
     "@nuxtjs/seo": "^3.2.2",
     "@octokit/rest": "^22.0.1",
-    "@vueuse/core": "^14.0.0",
-    "@vueuse/nuxt": "^14.0.0",
+    "@vueuse/core": "^14.1.0",
+    "@vueuse/nuxt": "^14.1.0",
     "defu": "^6.1.4",
     "exsolve": "^1.0.8",
     "git-url-parse": "^16.1.0",
     "motion-v": "^1.7.4",
-    "nuxt-component-meta": "^0.14.2",
+    "nuxt-component-meta": "^0.15.0",
     "nuxt-llms": "^0.1.3",
     "ohash": "^2.0.11",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.0",
-    "prettier": "^3.6.2",
+    "prettier": "^3.7.3",
     "scule": "^1.3.0",
     "tailwindcss": "^4.1.17",
     "ufo": "^1.6.1"

package/server/api/github/commits.get.ts

@@ -5,7 +5,7 @@ export default defineCachedEventHandler(async (event) => {
     return []
   }
 
-  const { path } = getQuery(event) as { path: string }
+  const { path, author } = getQuery(event) as { path: string, author?: string }
   if (!path) {
     throw createError({
       statusCode: 400,
@@ -16,10 +16,14 @@ export default defineCachedEventHandler(async (event) => {
   const { github } = useAppConfig()
   const octokit = new Octokit({ auth: process.env.NUXT_GITHUB_TOKEN })
   const commits = await octokit.paginate(octokit.rest.repos.listCommits, {
+    sha: github.branch,
     owner: github.owner,
     repo: github.name,
     path,
-    since: github.since
+    since: github.since,
+    per_page: github.per_page,
+    until: github.until,
+    ...(author && { author })
   })
 
   return commits.map(commit => ({
@@ -29,5 +33,8 @@ export default defineCachedEventHandler(async (event) => {
   }))
 }, {
   maxAge: 60 * 60,
-  getKey: event => `commits-${getQuery(event).path}`
+  getKey: (event) => {
+    const { path, author } = getQuery(event)
+    return `commits-${path}${author ? `-${author}` : ''}`
+  }
 })

package/server/api/github/last-commit.get.ts

@@ -0,0 +1,98 @@
+import { Octokit } from '@octokit/rest'
+
+export default defineCachedEventHandler(async (event) => {
+  if (!process.env.NUXT_GITHUB_TOKEN) {
+    return null
+  }
+
+  const { path } = getQuery(event) as { path: string }
+  if (!path) {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'Path is required'
+    })
+  }
+
+  const { github } = useAppConfig()
+  const octokit = new Octokit({ auth: process.env.NUXT_GITHUB_TOKEN })
+
+  try {
+    const { data: commits } = await octokit.rest.repos.listCommits({
+      sha: github.branch,
+      owner: github.owner,
+      repo: github.name,
+      path,
+      per_page: 1
+    })
+
+    if (!commits.length) {
+      return null
+    }
+
+    const commit = commits[0]
+
+    // 获取提交者信息，处理 web-flow 场景（PR squash merge）
+    let authorName = commit.commit.author?.name ?? ''
+    let authorLogin = commit.author?.login ?? ''
+    let authorAvatar = commit.author?.avatar_url ?? ''
+    let commitUrl = commit.html_url
+
+    // 如果提交者是 web-flow，尝试获取实际的 PR 作者
+    if (authorLogin === 'web-flow') {
+      try {
+        // 从 squash commit message 中提取 PR 编号 (#166)
+        const prMatch = commit.commit.message.match(/#(\d+)/)
+        if (prMatch?.[1]) {
+          const { data: prData } = await octokit.rest.pulls.get({
+            owner: github.owner,
+            repo: github.name,
+            pull_number: Number.parseInt(prMatch[1])
+          })
+
+          authorLogin = prData.user?.login ?? authorLogin
+          authorAvatar = prData.user?.avatar_url ?? authorAvatar
+          authorName = prData.user?.name || authorLogin
+          commitUrl = prData.html_url
+        }
+      } catch {
+        // 获取 PR 信息失败时忽略，使用原始提交者信息
+      }
+    }
+
+    // 格式化日期
+    const date = commit.commit.author?.date ?? ''
+    const dateFormat = github.dateFormat ?? {}
+    const locale = dateFormat.locale ?? 'zh-CN'
+    const formatOptions: Intl.DateTimeFormatOptions = dateFormat.options ?? {
+      year: 'numeric',
+      month: 'numeric',
+      day: 'numeric',
+      hour: '2-digit',
+      minute: '2-digit'
+    }
+    const dateFormatted = date
+      ? new Date(date).toLocaleDateString(locale, formatOptions)
+      : ''
+
+    return {
+      sha: commit.sha,
+      date,
+      dateFormatted,
+      message: commit.commit.message?.split('\n')[0] ?? '',
+      url: commitUrl,
+      author: {
+        name: authorName,
+        login: authorLogin,
+        avatar: authorAvatar
+      }
+    }
+  } catch {
+    return null
+  }
+}, {
+  maxAge: 60 * 60, // 缓存 1 小时
+  getKey: (event) => {
+    const { path } = getQuery(event)
+    return `last-commit-${path}`
+  }
+})