chore: resolve type / lint errors

Author: harlan-zw

.github/workflows/test.yml

@@ -32,5 +32,11 @@ jobs:
       - name: Build
         run: pnpm run build
 
+      - name: Lint
+        run: pnpm run lint
+
+      - name: Typecheck
+        run: pnpm run typecheck
+
       - name: Test
         run: pnpm run test

build.config.ts

@@ -24,5 +24,6 @@ export default defineBuildConfig({
     'unstorage',
     'unstorage/drivers/fs',
     'consola/utils',
+    '#nitro-internal-virtual/storage',
   ],
 })

client/composables/fetch.ts

@@ -1,10 +1,12 @@
 import type { VueHeadClient } from '@unhead/vue'
 import type { OgImageComponent, OgImageOptions, OgImageRuntimeConfig } from '../../src/runtime/types'
-import { appFetch, devtoolsClient, useAsyncData } from '#imports'
+import { useAsyncData } from '#imports'
 import { joinURL } from 'ufo'
-import { globalRefreshTime, optionsOverrides, path, refreshTime } from '~/util/logic'
+import { globalRefreshTime, optionsOverrides, path, refreshTime } from '../util/logic'
+import { appFetch, devtoolsClient } from './rpc'
 
 export function fetchPathDebug() {
+  // @ts-expect-error untyped
   return useAsyncData<{ siteConfig: { url?: string }, options: OgImageOptions, vnodes: Record<string, any> }>(async () => {
     if (!appFetch.value)
       return { siteCofig: {}, options: {}, vnodes: {} }
@@ -42,6 +44,7 @@ export function fetchPathDebug() {
 }
 
 export function fetchGlobalDebug() {
+  // @ts-expect-error untyped
   return useAsyncData<{ runtimeConfig: OgImageRuntimeConfig, componentNames: OgImageComponent[] }>('global-debug', () => {
     if (!appFetch.value)
       return { runtimeConfig: {} }

client/composables/rpc.ts

@@ -4,7 +4,7 @@ import type { $Fetch } from 'nitropack'
 import type { ClientFunctions, ServerFunctions } from '../../src/rpc-types'
 import { onDevtoolsClientConnected } from '@nuxt/devtools-kit/iframe-client'
 import { ref, watchEffect } from 'vue'
-import { globalRefreshTime, path, query, refreshSources } from '~/util/logic'
+import { globalRefreshTime, path, query, refreshSources } from '../util/logic'
 
 export const appFetch = ref<$Fetch>()
 
@@ -17,23 +17,26 @@ export const colorMode = ref<'dark' | 'light'>('dark')
 export const ogImageRpc = ref<BirpcReturn<ServerFunctions>>()
 
 onDevtoolsClientConnected(async (client) => {
+  // @ts-expect-error untyped
   appFetch.value = client.host.app.$fetch
   watchEffect(() => {
     colorMode.value = client.host.app.colorMode.value
   })
   const $route = client.host.nuxt.vueApp.config.globalProperties?.$route
   query.value = $route.query
   path.value = $route.path || '/'
-  client.host.nuxt.$router.afterEach((route) => {
+  client.host.nuxt.$router.afterEach((route: any) => {
     query.value = route.query
     path.value = route.path
     refreshSources()
   })
   devtools.value = client.devtools
   devtoolsClient.value = client
+  // @ts-expect-error untyped
   ogImageRpc.value = client.devtools.extendClientRpc<ServerFunctions, ClientFunctions>('nuxt-og-image', {
     refreshRouteData(path) {
       // if path matches
+      // @ts-expect-error untyped
       if (devtoolsClient.value?.host.nuxt.vueApp.config?.globalProperties?.$route.matched[0].components?.default.__file.includes(path) || path.endsWith('.md'))
         refreshSources()
     },

docs/content/7.releases/3.v5.md

@@ -18,6 +18,6 @@ To avoid hoisting issues with the new Unhead v2, the Nuxt OG Image v5 requires N
 
 Please upgrade your Nuxt to continue using OG Image.
 
-```ts
+```bash
 nuxi upgrade --force
 ```

package.json

@@ -39,7 +39,7 @@
   },
   "files": [
     "dist",
-    "virtual.d.ts"
+    "types/virtual.d.ts"
   ],
   "engines": {
     "node": ">=18.0.0"
@@ -50,7 +50,8 @@
     "build:client": "nuxi generate client",
     "build:module": "nuxt-build-module build",
     "client:dev": "nuxi dev client --port 3030",
-    "lint": "eslint . --fix",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground && nuxi prepare client",

playground/server/plugins/hooks.ts

@@ -1,11 +1,12 @@
+// @ts-expect-error untyped
 import { defineNitroPlugin } from '#imports'
 
-export default defineNitroPlugin((nitroApp) => {
-  nitroApp.hooks.hook('nuxt-og-image:context', async (ctx) => {
+export default defineNitroPlugin((nitroApp: any) => {
+  nitroApp.hooks.hook('nuxt-og-image:context', async (ctx: any) => {
     // eslint-disable-next-line no-console
     console.log('Nitro hook ctx', !!ctx)
   })
-  nitroApp.hooks.hook('nuxt-og-image:satori:vnodes', async (vnodes) => {
+  nitroApp.hooks.hook('nuxt-og-image:satori:vnodes', async (vnodes: any) => {
     // eslint-disable-next-line no-console
     console.log('Nitro hook vnodes', !!vnodes)
   })

src/build/build.ts

@@ -74,7 +74,7 @@ export async function setupBuildHandler(config: ModuleOptions, resolve: Resolver
 
 async function resolveFilePathSha1(path: string) {
   const _path = await resolvePath(path)
-  return sha1(existsSync(_path) ? await readFile(_path) : path)
+  return sha1(existsSync(_path) ? await readFile(_path) : Buffer.from(path))
 }
 
 function sha1(source: Buffer) {

src/build/tree-shake-plugin.ts

@@ -56,7 +56,9 @@ export const TreeShakeComposablesPlugin = createUnplugin(() => {
   ]
 
   const regexp = `(^\\s*)(${composableNames.join('|')})(?=\\((?!\\) \\{))`
+  // eslint-disable-next-line regexp/no-unused-capturing-group
   const COMPOSABLE_RE = new RegExp(regexp, 'm')
+
   const COMPOSABLE_RE_GLOBAL = new RegExp(regexp, 'gm')
 
   return {

src/compatibility.ts

@@ -76,6 +76,7 @@ export const RuntimeCompatibility: Record<string, RuntimeCompatibilitySchema> =
     'satori': 'node',
     'sharp': false,
     'wasm': {
+      // @ts-expect-error untyped
       rollup: {
         targetEnv: 'auto-inline',
         sync: ['@resvg/resvg-wasm/index_bg.wasm'],