perf(plugin-shiki): improve logging when language is not available (#215

)
vuepress · Jul 10, 2024 · b84ce08 · b84ce08
1 parent c7c9a72
commit b84ce08
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/plugins/markdown/shiki.md b/docs/plugins/markdown/shiki.md
@@ -475,7 +475,7 @@ The following features requires additional style to work, which should be handle
 
 - Type: `string`
 
-- Default: `'plain'`
+- Default: `''`
 
 - Details: Fallback language when the specified language is not available.
 

diff --git a/docs/zh/plugins/markdown/shiki.md b/docs/zh/plugins/markdown/shiki.md
@@ -477,7 +477,7 @@ export default defineUserConfig({
 
 - 类型：`string`
 
-- 默认值：`'plain'`
+- 默认值：`''`
 
 - 详情：指定的语言不可用时所使用的备选语言。
 

diff --git a/plugins/markdown/plugin-shiki/src/node/markdown/applyHighlighter/getLanguage.ts b/plugins/markdown/plugin-shiki/src/node/markdown/applyHighlighter/getLanguage.ts
@@ -8,7 +8,7 @@ const WARNED_LANGS = new Set<string>()
 export const getLanguage = (
   lang: string,
   loadedLanguages: string[],
-  defaultLang: string,
+  defaultLang: string | undefined,
   logLevel: string,
   getMarkdownFilePath: MarkdownFilePathGetter,
 ): string => {
@@ -18,7 +18,7 @@ export const getLanguage = (
     // warn for unknown languages only once
     if (logLevel !== 'silent' && !WARNED_LANGS.has(result)) {
       logger.warn(
-        `Missing ${colors.cyan(lang)} highlighter, use ${colors.cyan(defaultLang)} to highlight instead.`,
+        `Missing ${colors.cyan(lang)} highlighter, ${defaultLang ? `use ${colors.cyan(defaultLang)} to highlight instead.` : 'skip highlighting'}`,
       )
       WARNED_LANGS.add(result)
     }
@@ -30,7 +30,7 @@ export const getLanguage = (
       )
     }
 
-    result = defaultLang
+    result = defaultLang || 'plain'
   }
 
   return result

diff --git a/plugins/markdown/plugin-shiki/src/node/markdown/applyHighlighter/index.ts b/plugins/markdown/plugin-shiki/src/node/markdown/applyHighlighter/index.ts
@@ -19,7 +19,7 @@ export const applyHighlighter = async (
   {
     langs = bundledLanguageNames,
     langAlias = {},
-    defaultLang = 'plain',
+    defaultLang,
     transformers: userTransformers = [],
     ...options
   }: ShikiHighlightOptions = {},