chore(typescript): compatibility with nuxt 4 (keeping old tsconfig for the moment) (#1115)

Author: larbish

app/app/types/index.d.ts

@@ -0,0 +1,39 @@
+declare module 'nuxt/schema' {
+  interface AppConfig {
+    seo: {
+      titleTemplate: string
+      title: string
+      description: string
+    }
+    header: {
+      title: string
+      logo: {
+        light: string
+        dark: string
+        alt: string
+      }
+    }
+    socials: Record<string, string>
+    toc: {
+      title: string
+      bottom: {
+        title: string
+        links: {
+          icon: string
+          label: string
+          to: string
+          target: string
+        }[]
+      }
+    }
+    github: {
+      owner: string
+      name: string
+      url: string
+      branch: string
+      rootDir?: string
+    }
+  }
+}
+
+export {}

app/app/utils/git.ts

@@ -29,8 +29,10 @@ export function getGitBranch() {
     }
   }
   catch {
-    return 'main'
+    // Ignore error
   }
+
+  return 'main'
 }
 
 export async function getLocalGitInfo(rootDir: string): Promise<GitInfo | undefined> {
@@ -63,7 +65,7 @@ async function getLocalGitRemote(dir: string): Promise<string | undefined> {
   }
 }
 
-export function getGitEnv(): GitInfo | undefined {
+export function getGitEnv(): GitInfo {
   // https://github.com/unjs/std-env/issues/59
   const envInfo = {
     // Provider

app/modules/default-configs.ts

@@ -30,22 +30,25 @@ export default defineNuxtModule({
       debug: false,
     })
 
-    nuxt.options.appConfig = defu(nuxt.options.appConfig, {
-      header: {
-        title: siteName,
-      },
-      github: {
-        owner: gitInfo?.owner,
-        name: gitInfo?.name,
-        url: gitInfo?.url,
-        branch: getGitBranch(),
-      },
-      seo: {
-        titleTemplate: `%s - ${siteName}`,
-        title: siteName,
-        description: meta.description || '',
-      },
-      toc: {},
+    nuxt.options.appConfig.header = defu(nuxt.options.appConfig.header, {
+      title: siteName,
+    })
+
+    nuxt.options.appConfig.seo = defu(nuxt.options.appConfig.seo, {
+      titleTemplate: `%s - ${siteName}`,
+      title: siteName,
+      description: meta.description || '',
+    })
+
+    nuxt.options.appConfig.github = defu(nuxt.options.appConfig.github, {
+      owner: gitInfo?.owner,
+      name: gitInfo?.name,
+      url: gitInfo?.url,
+      branch: getGitBranch(),
+    })
+
+    nuxt.options.appConfig.toc = defu(nuxt.options.appConfig.toc, {
+      title: 'On this page',
     })
   },
 })

app/nuxt.schema.ts

@@ -216,41 +216,3 @@ export default defineNuxtSchema({
     }),
   },
 })
-
-declare module '@nuxt/schema' {
-  interface AppConfig {
-    seo: {
-      titleTemplate: string
-      title: string
-      description: string
-    }
-    header: {
-      title: string
-      logo: {
-        light: string
-        dark: string
-        alt: string
-      }
-    }
-    socials: Record<string, string>
-    toc: {
-      title: string
-      bottom: {
-        title: string
-        links: {
-          icon: string
-          label: string
-          to: string
-          target: string
-        }[]
-      }
-    }
-    github: {
-      owner: string
-      name: string
-      url: string
-      branch: string
-      rootDir?: string
-    }
-  }
-}

app/tsconfig.json

@@ -1,3 +1,3 @@
 {
   "extends": "./.nuxt/tsconfig.json"
-}
+}

docs/tsconfig.json

@@ -1,3 +1,3 @@
 {
   "extends": "./.nuxt/tsconfig.json"
-}
+}