8000 fix(core): lazily load metadata checker for TypeScript 7 compatibility by romhml · Pull Request #213 · romhml/compodium · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions packages/core/src/plugins/meta/checker.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { existsSync } from 'node:fs'
import { basename } from 'node:path'
import { createCheckerByJson } from 'vue-component-meta'
import type { CompodiumMeta, ComponentsDir } from '../../types'
import { inferPropTypes } from './infer'

type MetaChecker = ReturnType<typeof createCheckerByJson>
type CreateMetaChecker = (typeof import('vue-component-meta'))['createCheckerByJson']
type MetaChecker = ReturnType<CreateMetaChecker>

const checkerOptions = {
forceUseTs: true,
Expand All @@ -18,8 +18,9 @@ const checkerOptions = {
}
}

export function createChecker(dirs: ComponentsDir[], rootDir = process.cwd(), tsconfigPath?: string) {
const metaChecker = createMetaChecker(dirs, rootDir, tsconfigPath)
export async function createChecker(dirs: ComponentsDir[], rootDir = process.cwd(), tsconfigPath?: string) {
const { createCheckerByJson } = await import('vue-component-meta')
const metaChecker = createMetaChecker(createCheckerByJson, dirs, rootDir, tsconfigPath)

const checker = {
...metaChecker,
Expand All @@ -40,7 +41,7 @@ export function createChecker(dirs: ComponentsDir[], rootDir = process.cwd(), ts
return checker
}

function createMetaChecker(dirs: ComponentsDir[], rootDir: string, tsconfigPath?: string): MetaChecker {
function createMetaChecker(createCheckerByJson: CreateMetaChecker, dirs: ComponentsDir[], rootDir: string, tsconfigPath?: string): MetaChecker {
const tsconfig = `${rootDir}/tsconfig.json`
const tsconfigToExtend = tsconfigPath && existsSync(tsconfigPath) ? tsconfigPath : tsconfig

Expand Down
19 changes: 15 additions & 4 deletions packages/core/src/plugins/meta/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,23 @@ export function metaPlugin(options: PluginOptions): VitePlugin {
collections = resolveCollections(options, viteConfig)
},

configureServer(server) {
async configureServer(server) {
const checkerDirs = collections.flatMap(c => [
...c.dirs,
...c.exampleDirs
])
const checker = createChecker(checkerDirs, rootDir, options.tsconfigPath)
let checker: Awaited<ReturnType<typeof createChecker>>

try {
checker = await createChecker(checkerDirs, rootDir, options.tsconfigPath)
} catch {
server.config.logger.warn('[Compodium] Unable to parse component props. TypeScript 7 is not supported; use TypeScript 6 instead.')
server.middlewares.use('/__compodium__/api/meta', (_req, res) => {
res.statusCode = 500
res.end(JSON.stringify({ error: 'Metadata unavailable' }))
})
return
}

server.middlewares.use('/__compodium__/api/meta', async (req, res) => {
try {
Expand All @@ -68,7 +79,7 @@ export function metaPlugin(options: PluginOptions): VitePlugin {
res.end(JSON.stringify(meta))
} catch {
res.statusCode = 500
res.end(JSON.stringify({ error: 'Failed to fetch metadata' }))
res.end(JSON.stringify({ error: 'Metadata unavailable' }))
}
})

Expand All @@ -88,7 +99,7 @@ export function metaPlugin(options: PluginOptions): VitePlugin {
}
})

watcher.on('add', async () => {
watcher.on('add', () => {
checker.reload()
})

Expand Down
3 changes: 3 additions & 0 deletions packages/nuxt/test/fixtures/meta-checker-failure/app/app.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<template>
<div>metadata checker failure fixture</div>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<script setup lang="ts">
defineProps<{ label: string }>()
</script>

<template>
<div>{{ label }}</div>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { fileURLToPath } from 'node:url'

export default defineNuxtConfig({
modules: ['../../../src/module'],
alias: {
'vue-component-meta': fileURLToPath(new URL('./vue-component-meta.ts', import.meta.url))
}
})
5 changes: 5 additions & 0 deletions packages/nuxt/test/fixtures/meta-checker-failure/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"private": true,
"name": "meta-checker-failure",
"type": "module"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export function createCheckerByJson(): never {
throw new Error('Unsupported TypeScript version')
}
25 changes: 25 additions & 0 deletions packages/nuxt/test/meta-checker-failure.nuxt.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { fetch, setup } from '@nuxt/test-utils/e2e'
import { join } from 'pathe'
import { fileURLToPath } from 'node:url'
import { describe, expect, it } from 'vitest'

describe('metadata checker failure', async () => {
const rootDir = fileURLToPath(new URL('./fixtures/meta-checker-failure', import.meta.url))

await setup({
rootDir,
dev: true,
port: 4546,
setupTimeout: 30000
})

it('returns an error when component metadata initialization fails', async () => {
const query = new URLSearchParams({
component: join(rootDir, 'app/components/ExampleComponent.vue')
})
const response = await fetch(`/__compodium__/api/meta?${query}`)

expect(response.status).toBe(500)
expect(await response.json()).toEqual({ error: 'Metadata unavailable' })
})
})
Loading
0