fix: add validation to highlightTheme option

TypeStrong · Jan 29, 2021 · 7723ddf · 7723ddf
1 parent 4a6df9a
commit 7723ddf
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/src/lib/utils/highlighter.ts b/src/lib/utils/highlighter.ts
@@ -1,6 +1,6 @@
 import { ok as assert } from "assert";
 import * as shiki from "shiki";
-import { Theme } from "shiki-themes";
+import { Theme as ShikiTheme } from "shiki-themes";
 import { Highlighter } from "shiki/dist/highlighter";
 import { unique } from "./array";
 
@@ -23,10 +23,10 @@ const supportedLanguages = unique([
 
 let highlighter: Highlighter | undefined;
 
-export async function loadHighlighter(theme: Theme) {
+export async function loadHighlighter(theme: ShikiTheme) {
     if (highlighter) return;
     highlighter = await shiki.getHighlighter({
-        theme: theme || "light-plus",
+        theme,
     });
 }
 

diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
@@ -1,4 +1,5 @@
 import { LogLevel } from "../loggers";
+import { Theme as ShikiTheme } from "shiki-themes";
 
 /**
  * An interface describing all TypeDoc specific options. Generated from a
@@ -80,7 +81,7 @@ export interface TypeDocOptionMap {
     listInvalidSymbolLinks: boolean;
     markedOptions: unknown;
 
-    highlightTheme: string;
+    highlightTheme: ShikiTheme;
 }
 
 /**

diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
@@ -1,6 +1,7 @@
 import { Options } from "..";
 import { LogLevel } from "../../loggers";
 import { ParameterType, ParameterHint } from "../declaration";
+import { BUNDLED_THEMES as ShikiThemes } from "shiki-themes";
 
 export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
     options.addDeclaration({
@@ -244,9 +245,20 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
             "Specify the options passed to Marked, the Markdown parser used by TypeDoc",
         type: ParameterType.Mixed,
     });
+
     options.addDeclaration({
         name: "highlightTheme",
         help: "Specifies the code highlighting theme.",
         type: ParameterType.String,
+        defaultValue: "light-plus",
+        validate: (value: string): void => {
+            if (!ShikiThemes.includes(value)) {
+                throw new Error(
+                    `Highlight Theme must be one of the following: ${ShikiThemes.join(
+                        ", "
+                    )}`
+                );
+            }
+        },
     });
 }