@movk/nuxt-docs 1.5.0 → 1.5.2

package/app/app.config.ts

@@ -1,4 +1,4 @@
-import type { ButtonProps } from '@nuxt/ui'
+import type { ExtendedButtonProps } from './types'
 
 export default defineAppConfig({
   toaster: {
@@ -44,17 +44,31 @@ export default defineAppConfig({
     to: '/',
     search: true,
     colorMode: true,
-    links: [] as ButtonProps[]
+    links: [] as ExtendedButtonProps[]
   },
   footer: {
     credits: `Copyright © 2024 - ${new Date().getFullYear()}`,
-    socials: [] as ButtonProps[]
+    socials: [] as ExtendedButtonProps[]
   },
   toc: {
     title: '页面导航',
     bottom: {
       title: '社区',
-      links: [] as ButtonProps[]
+      links: [] as ExtendedButtonProps[]
+    }
+  },
+  github: {
+    rootDir: '',
+    dateFormat: {
+      locale: 'zh-CN',
+      options: {
+        year: 'numeric',
+        month: 'numeric',
+        day: 'numeric',
+        hour: '2-digit',
+        minute: '2-digit',
+        timeZone: 'Asia/Shanghai'
+      }
     }
   }
 })

package/app/components/content/CommitChangelog.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { camelCase, upperFirst } from '@movk/core'
+import { camelCase, kebabCase, upperFirst } from '@movk/core'
 
 interface Commit {
   sha: string
@@ -29,6 +29,15 @@ const props = defineProps<{
    * The author to filter commits by.
    */
   author?: string
+  /**
+   * The casing format for the file name.
+   * - 'auto': Vue files use PascalCase, others use camelCase (default)
+   * - 'kebab': Keep kebab-case (e.g., use-user.ts)
+   * - 'camel': Convert to camelCase (e.g., useUser.ts)
+   * - 'pascal': Convert to PascalCase (e.g., UseUser.ts)
+   * @defaultValue 'auto'
+   */
+  casing?: 'auto' | 'kebab' | 'camel' | 'pascal'
 }>()
 
 const SHA_SHORT_LENGTH = 5
@@ -46,11 +55,26 @@ const filePath = computed(() => {
   const fileExtension = props.suffix ?? (github && typeof github === 'object' ? github.suffix : 'vue')
   const fileName = props.name ?? routeName.value
 
-  const camelName = fileExtension === 'vue'
-    ? upperFirst(camelCase(fileName))
-    : camelCase(fileName)
+  // 根据 casing 参数转换文件名
+  const transformedName = (() => {
+    const casing = props.casing ?? (github && typeof github === 'object' ? github.casing : undefined) ?? 'auto'
+
+    switch (casing) {
+      case 'kebab':
+        return kebabCase(fileName)
+      case 'camel':
+        return camelCase(fileName)
+      case 'pascal':
+        return upperFirst(camelCase(fileName))
+      case 'auto':
+      default:
+        return fileExtension === 'vue'
+          ? upperFirst(camelCase(fileName))
+          : camelCase(fileName)
+    }
+  })()
 
-  return `${basePath}/${filePrefix}${camelName}.${fileExtension}`
+  return `${basePath}/${filePrefix}${transformedName}.${fileExtension}`
 })
 
 const { data: commits } = await useLazyFetch<Commit[]>('/api/github/commits', {

package/app/types/index.d.ts

@@ -1,5 +1,9 @@
 import type { ButtonProps } from '@nuxt/ui'
 
+export interface ExtendedButtonProps extends ButtonProps {
+  label?: string
+}
+
 declare module 'nuxt/schema' {
   interface AppConfig {
     vercelAnalytics: {
@@ -17,17 +21,17 @@ declare module 'nuxt/schema' {
       to: string
       search: boolean
       colorMode: boolean
-      links: ButtonProps[]
+      links: ExtendedButtonProps[]
     }
     footer: {
       credits: string
-      socials: ButtonProps[]
+      socials: ExtendedButtonProps[]
     }
     toc: {
       title: string
       bottom: {
         title: string
-        links: ButtonProps[]
+        links: ExtendedButtonProps[]
       }
     }
     github: {
@@ -42,6 +46,12 @@ declare module 'nuxt/schema' {
       per_page: number
       until: string
       author: string
+      /**
+       * 文件命名格式
+       * @default 'auto'
+       * @example 'kebab' | 'camel' | 'pascal' | 'auto'
+       */
+      casing: 'auto' | 'kebab' | 'camel' | 'pascal'
       /**
        * 日期格式化配置
        * @example { locale: 'zh-CN', options: { year: 'numeric', month: '2-digit', day: '2-digit', hour: '2-digit', minute: '2-digit' } }

package/content.config.ts

@@ -1,7 +1,8 @@
-import { defineCollection, defineContentConfig, z } from '@nuxt/content'
+import { defineCollection, defineContentConfig } from '@nuxt/content'
 import { useNuxt } from '@nuxt/kit'
 import { asSeoCollection } from '@nuxtjs/seo/content'
 import { joinURL } from 'ufo'
+import { z } from 'zod/v4'
 
 const { options } = useNuxt()
 const cwd = joinURL(options.rootDir, 'content')

package/modules/config.ts

@@ -70,7 +70,19 @@ export default defineNuxtModule({
         'nuxt-og-image',
         '@nuxtjs/plausible',
         '@nuxt/ui',
-        new RegExp(`${componentsPath.replace(/[/\\]/g, '[/\\\\]')}/(?!content/(ComponentEmits|ComponentProps|ComponentSlots|ComponentExample|CommitChangelog|PageLastCommit)\\.vue$)`)
+        (component: { filePath: string }) => {
+          const allowedComponents = [
+            'CommitChangelog.vue',
+            'ComponentEmits.vue',
+            'ComponentExample.vue',
+            'ComponentProps.vue',
+            'ComponentSlots.vue',
+            'PageLastCommit.vue',
+            'Motion.vue'
+          ]
+          return component.filePath.startsWith(componentsPath)
+            && !allowedComponents.some(name => component.filePath.endsWith(`/content/${name}`))
+        }
       ],
       metaFields: {
         type: false,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@movk/nuxt-docs",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "private": false,
   "description": "An elegant documentation theme for Nuxt, powered by Nuxt UI and Nuxt Content.",
   "author": "YiXuan <mhaibaraai@gmail.com>",
@@ -54,6 +54,7 @@
     "scule": "^1.3.0",
     "shiki-transformer-color-highlight": "^1.0.0",
     "tailwindcss": "^4.1.18",
-    "ufo": "^1.6.1"
+    "ufo": "^1.6.1",
+    "zod": "^4.2.1"
   }
 }