fix: (temporary patch) lang lazy load not working with twoslash

vuejs · Nov 3, 2024 · 4dac35f · 4dac35f
1 parent dcb8450
commit 4dac35f
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 23 deletions.
diff --git a/src/node/cli.ts b/src/node/cli.ts
@@ -2,10 +2,14 @@ import minimist from 'minimist'
 import c from 'picocolors'
 import { createLogger } from 'vite'
 import { build, createServer, serve } from '.'
-import { init } from './init/init'
 import { version } from '../../package.json'
+import { init } from './init/init'
 import { bindShortcuts } from './shortcuts'
 
+if (process.env.DEBUG) {
+  Error.stackTraceLimit = Infinity
+}
+
 const argv: any = minimist(process.argv.slice(2))
 
 const logVersion = (logger = createLogger()) => {

diff --git a/src/node/markdown/plugins/highlight.ts b/src/node/markdown/plugins/highlight.ts
@@ -9,7 +9,7 @@ import {
 import { customAlphabet } from 'nanoid'
 import { createRequire } from 'node:module'
 import c from 'picocolors'
-import type { ShikiTransformer } from 'shiki'
+import type { LanguageRegistration, ShikiTransformer } from 'shiki'
 import { createHighlighter, isSpecialLang } from 'shiki'
 import { createSyncFn } from 'synckit'
 import type { Logger } from 'vite'
@@ -61,22 +61,44 @@ export async function highlight(
   logger: Pick<Logger, 'warn'> = console
 ): Promise<[(str: string, lang: string, attrs: string) => string, () => void]> {
   const {
-    defaultHighlightLang: defaultLang = '',
+    defaultHighlightLang: defaultLang = 'txt',
     codeTransformers: userTransformers = []
   } = options
 
+  const usingTwoslash = userTransformers.some(
+    ({ name }) => name === '@shikijs/vitepress-twoslash'
+  )
+
   const highlighter = await createHighlighter({
     themes:
       typeof theme === 'object' && 'light' in theme && 'dark' in theme
         ? [theme.light, theme.dark]
         : [theme],
     langs: [
       ...(options.languages || []),
-      ...Object.values(options.languageAlias || {})
+      ...Object.values(options.languageAlias || {}),
+
+      // patch for twoslash - https://github.com/vuejs/vitepress/issues/4334
+      ...(usingTwoslash
+        ? Object.keys((await import('shiki')).bundledLanguages)
+        : [])
     ],
     langAlias: options.languageAlias
   })
 
+  function loadLanguage(name: string | LanguageRegistration) {
+    const lang = typeof name === 'string' ? name : name.name
+    if (
+      !isSpecialLang(lang) &&
+      !highlighter.getLoadedLanguages().includes(lang)
+    ) {
+      const resolvedLang = resolveLangSync(lang)
+      if (resolvedLang.length) highlighter.loadLanguageSync(resolvedLang)
+      else return false
+    }
+    return true
+  }
+
   await options?.shikiSetup?.(highlighter)
 
   const transformers: ShikiTransformer[] = [
@@ -116,23 +138,13 @@ export async function highlight(
           .replace(vueRE, '')
           .toLowerCase() || defaultLang
 
-      if (lang) {
-        const langLoaded = highlighter.getLoadedLanguages().includes(lang)
-        if (!langLoaded && !isSpecialLang(lang)) {
-          const resolvedLang = resolveLangSync(lang)
-          if (!resolvedLang.length) {
-            logger.warn(
-              c.yellow(
-                `\nThe language '${lang}' is not loaded, falling back to '${
-                  defaultLang || 'txt'
-                }' for syntax highlighting.`
-              )
-            )
-            lang = defaultLang
-          } else {
-            highlighter.loadLanguageSync(resolvedLang)
-          }
-        }
+      if (!loadLanguage(lang)) {
+        logger.warn(
+          c.yellow(
+            `\nThe language '${lang}' is not loaded, falling back to '${defaultLang}' for syntax highlighting.`
+          )
+        )
+        lang = defaultLang
       }
 
       const lineOptions = attrsToLines(attrs)

diff --git a/src/node/worker_shikiResolveLang.ts b/src/node/worker_shikiResolveLang.ts
@@ -1,4 +1,8 @@
-import { bundledLanguages, type DynamicImportLanguageRegistration } from 'shiki'
+import {
+  bundledLanguages,
+  type DynamicImportLanguageRegistration,
+  type LanguageRegistration
+} from 'shiki'
 import { runAsWorker } from 'synckit'
 
 async function resolveLang(lang: string) {
@@ -10,7 +14,7 @@ async function resolveLang(lang: string) {
       >
     )
       [lang]?.()
-      .then((m) => m.default) || []
+      .then((m) => m.default) || ([] as LanguageRegistration[])
   )
 }