feat: add highlight theme option

TypeStrong · Jan 29, 2021 · 4a6df9a · 4a6df9a
1 parent 73071b5
commit 4a6df9a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/src/lib/output/renderer.ts b/src/lib/output/renderer.ts
@@ -9,6 +9,7 @@
 
 import * as Path from "path";
 import * as FS from "fs-extra";
+import { Theme as ShikiTheme } from "shiki-themes";
 // eslint-disable-next-line
 const ProgressBar = require("progress");
 
@@ -83,6 +84,9 @@ export class Renderer extends ChildableComponent<
     @BindOption("toc")
     toc!: string[];
 
+    @BindOption("highlightTheme")
+    highlightTheme!: ShikiTheme;
+
     /**
      * Render the given project reflection to the specified output directory.
      *
@@ -93,7 +97,7 @@ export class Renderer extends ChildableComponent<
         project: ProjectReflection,
         outputDirectory: string
     ): Promise<void> {
-        await loadHighlighter();
+        await loadHighlighter(this.highlightTheme);
         if (
             !this.prepareTheme() ||
             !this.prepareOutputDirectory(outputDirectory)

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

diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
@@ -79,6 +79,8 @@ export interface TypeDocOptionMap {
     logLevel: typeof LogLevel;
     listInvalidSymbolLinks: boolean;
     markedOptions: unknown;
+
+    highlightTheme: string;
 }
 
 /**

diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
@@ -120,6 +120,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         type: ParameterType.String,
         defaultValue: "default",
     });
+
     options.addDeclaration({
         name: "name",
         help:
@@ -243,4 +244,9 @@ 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,
+    });
 }