denoland · crowlKats · Oct 16, 2024 · Oct 16, 2024 · Oct 16, 2024
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -41,6 +41,14 @@ termcolor = "1.4.1"
 html-escape = { version = "0.2.13", optional = true }
 comrak = { version = "0.28.0", optional = true, default-features = false }
 handlebars = { version = "6.1", optional = true, features = ["string_helpers"] }
+syntect = { version = "5.2.0", optional = true, default-features = false, features = [
+  "parsing",
+  "default-syntaxes",
+  "default-themes",
+  "html",
+  "dump-load",
+  "regex-onig",
+] }
 ammonia = { version = "4.0.0", optional = true }
 
 tree-sitter-highlight = { version = "0.22.6", optional = true }
@@ -67,13 +75,10 @@ pretty_assertions = "1.4.0"
 insta = { version = "1.39.0", features = ["json"] }
 
 [features]
-default = ["html", "rust"]
+default = ["html", "rust", "ammonia", "tree-sitter"]
 rust = []
-ammonia = ["dep:ammonia"]
-html = [
-  "html-escape",
-  "comrak",
-  "handlebars",
+html = ["html-escape", "comrak", "handlebars"]
+tree-sitter = [
   "tree-sitter-highlight",
   "tree-sitter-javascript",
   "tree-sitter-typescript",

diff --git a/src/html/comrak_adapters.rs b/src/html/comrak_adapters.rs
@@ -1,5 +1,17 @@
+// Copied and modified from https://github.com/kivikakk/comrak/blob/main/src/plugins/syntect.rs
+
+//! Adapter for the Syntect syntax highlighter plugin.
+
 #![allow(clippy::print_stderr)]
 
+#[cfg(any(
+  not(any(feature = "syntect", feature = "tree-sitter")),
+  all(feature = "syntect", feature = "tree-sitter")
+))]
+compile_error!(
+  "Either feature \"syntect\" or \"tree-sitter\" must be enabled, not both or neither."
+);
+
 use comrak::adapters::HeadingAdapter;
 use comrak::adapters::HeadingMeta;
 use comrak::adapters::SyntaxHighlighterAdapter;
@@ -11,7 +23,13 @@ use std::sync::Arc;
 use std::sync::Mutex;
 
 #[derive(Debug)]
+/// Syntect syntax highlighter plugin.
 pub struct HighlightAdapter {
+  #[cfg(feature = "syntect")]
+  pub syntax_set: syntect::parsing::SyntaxSet,
+  #[cfg(feature = "syntect")]
+  pub theme_set: syntect::highlighting::ThemeSet,
+  #[cfg(feature = "tree-sitter")]
   pub language_cb:
     fn(&str) -> Option<&'static tree_sitter_highlight::HighlightConfiguration>,
   pub show_line_numbers: bool,
@@ -76,6 +94,54 @@ impl HighlightAdapter {
 }
 
 impl SyntaxHighlighterAdapter for HighlightAdapter {
+  #[cfg(all(feature = "syntect", not(feature = "tree-sitter")))]
+  fn write_highlighted(
+    &self,
+    output: &mut dyn Write,
+    lang: Option<&str>,
+    code: &str,
+  ) -> std::io::Result<()> {
+    let lang = match lang {
+      Some(l) if !l.is_empty() => l,
+      _ => "Plain Text",
+    };
+
+    let syntax =
+      self
+        .syntax_set
+        .find_syntax_by_token(lang)
+        .unwrap_or_else(|| {
+          self
+            .syntax_set
+            .find_syntax_by_first_line(code)
+            .unwrap_or_else(|| self.syntax_set.find_syntax_plain_text())
+        });
+
+    let theme = &self.theme_set.themes["InspiredGitHub"];
+    let mut highlighter = syntect::easy::HighlightLines::new(syntax, theme);
+
+    match self.highlight_html(
+      syntect::util::LinesWithEndings::from(code),
+      |lines, line| {
+        let regions = highlighter.highlight_line(line, &self.syntax_set)?;
+
+        syntect::html::append_highlighted_html_for_styled_line(
+          &regions,
+          syntect::html::IncludeBackground::No,
+          lines,
+        )?;
+
+        Ok(())
+      },
+    ) {
+      Ok(highlighted_code) => output.write_all(highlighted_code.as_bytes())?,
+      Err(_) => output.write_all(code.as_bytes())?,
+    }
+
+    self.write_button(output, code)
+  }
+
+  #[cfg(all(feature = "tree-sitter", not(feature = "syntect")))]
   fn write_highlighted(
     &self,
     output: &mut dyn Write,

diff --git a/src/html/jsdoc.rs b/src/html/jsdoc.rs
@@ -84,6 +84,10 @@ lazy_static! {
         AmmoniaRelativeUrlEvaluator(),
       )));
 
+    #[cfg(feature = "syntect")]
+    ammonia_builder.add_tag_attributes("span", ["style"]);
+
+    #[cfg(feature = "tree-sitter")]
     ammonia_builder.add_allowed_classes("span", super::tree_sitter::CLASSES);
 
     ammonia_builder

diff --git a/src/html/mod.rs b/src/html/mod.rs
@@ -18,6 +18,7 @@ pub mod partition;
 mod render_context;
 mod search;
 mod symbols;
+#[cfg(feature = "tree-sitter")]
 pub mod tree_sitter;
 mod types;
 mod usage;
@@ -794,6 +795,14 @@ pub fn setup_highlighter(
   show_line_numbers: bool,
 ) -> comrak_adapters::HighlightAdapter {
   comrak_adapters::HighlightAdapter {
+    #[cfg(feature = "syntect")]
+    syntax_set: syntect::dumps::from_uncompressed_data(include_bytes!(
+      "./default_newlines.packdump"
+    ))
+    .unwrap(),
+    #[cfg(feature = "syntect")]
+    theme_set: syntect::highlighting::ThemeSet::load_defaults(),
+    #[cfg(feature = "tree-sitter")]
     language_cb: tree_sitter::tree_sitter_language_cb,
     show_line_numbers,
   }

diff --git a/tests/html_test.rs b/tests/html_test.rs
@@ -182,6 +182,7 @@ async fn html_doc_files() {
     ]
   );
 
+  #[cfg(feature = "tree-sitter")]
   {
     insta::assert_snapshot!(files.get("./all_symbols.html").unwrap());
     insta::assert_snapshot!(files.get("./index.html").unwrap());
@@ -272,6 +273,7 @@ async fn html_doc_files_rewrite() {
     ]
   );
 
+  #[cfg(feature = "tree-sitter")]
   {
     insta::assert_snapshot!(files.get("./all_symbols.html").unwrap());
     insta::assert_snapshot!(files.get("./index.html").unwrap());
@@ -385,6 +387,7 @@ async fn symbol_group() {
     }
   }
 
+  #[cfg(feature = "tree-sitter")]
   insta::assert_json_snapshot!(files);
 }
 
@@ -483,5 +486,6 @@ async fn module_doc() {
     module_docs.push(module_doc);
   }
 
+  #[cfg(feature = "tree-sitter")]
   insta::assert_json_snapshot!(module_docs);
 }
diff --git a/tests/snapshots/html_test__html_doc_files-3.snap b/tests/snapshots/html_test__html_doc_files-3.snap
@@ -52,12 +52,12 @@ expression: "files.get(\"./~/Bar.html\").unwrap()"
     </article></main>
 <div class="toc">
     <div><div class="usageContent">
-    <h3>Usage</h3><div class="markdown"><pre class=" highlight"><code class="language-typescript"><span class="pl-k">import</span> { <span class="pl-smi">Bar</span> } <span class="pl-k">from</span> <span class="pl-s">&quot;.&quot;</span>;
+    <h3>Usage</h3><div class="markdown"><pre class="highlight"><code><span class="pl-k">import</span> { <span class="pl-smi">Bar</span> } <span class="pl-k">from</span> <span class="pl-s">"."</span>;
 </code><button class="context_button" data-copy="import { Bar } from &quot;.&quot;;
 "><svg width="15" height="15" viewBox="0 0 15 15" fill="none" xmlns="http://www.w3.org/2000/svg">
-<rect x="2" y="2" width="7" height="7" fill="none"/>
-<rect x="6" y="6" width="7" height="7" fill="none"/>
-<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"/>
+<rect x="2" y="2" width="7" height="7" fill="none"></rect>
+<rect x="6" y="6" width="7" height="7" fill="none"></rect>
+<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"></path>
 </svg>
 </button><code></code></pre>
 </div></div></div>

diff --git a/tests/snapshots/html_test__html_doc_files-5.snap b/tests/snapshots/html_test__html_doc_files-5.snap
@@ -45,25 +45,25 @@ expression: "files.get(\"./~/Foo.html\").unwrap()"
         <div>
           <div class="text-2xl leading-none break-all">
             <span class="text-Class">class</span>&nbsp;<span class="font-bold">Foo</span>
-          </div><div class="symbolSubtitle"></div></div></div><div><div class="space-y-7" id=""><div class="markdown"><pre class=" highlight"><code class="language-ts">using time <span class="pl-c1">=</span> <span class="pl-k">new</span> <span class="pl-smi">FakeTime</span>();
+          </div><div class="symbolSubtitle"></div></div></div><div><div class="space-y-7" id=""><div class="markdown"><pre class="highlight"><code>using time <span class="pl-c1">=</span> <span class="pl-k">new</span> <span class="pl-smi">FakeTime</span>();
 </code><button class="context_button" data-copy="using time = new FakeTime();
 "><svg width="15" height="15" viewBox="0 0 15 15" fill="none" xmlns="http://www.w3.org/2000/svg">
-<rect x="2" y="2" width="7" height="7" fill="none"/>
-<rect x="6" y="6" width="7" height="7" fill="none"/>
-<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"/>
+<rect x="2" y="2" width="7" height="7" fill="none"></rect>
+<rect x="6" y="6" width="7" height="7" fill="none"></rect>
+<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"></path>
 </svg>
 </button><code></code></pre>
 </div></div>
 </div>
     </article></main>
 <div class="toc">
     <div><div class="usageContent">
-    <h3>Usage</h3><div class="markdown"><pre class=" highlight"><code class="language-typescript"><span class="pl-k">import</span> { <span class="pl-smi">Foo</span> } <span class="pl-k">from</span> <span class="pl-s">&quot;.&quot;</span>;
+    <h3>Usage</h3><div class="markdown"><pre class="highlight"><code><span class="pl-k">import</span> { <span class="pl-smi">Foo</span> } <span class="pl-k">from</span> <span class="pl-s">"."</span>;
 </code><button class="context_button" data-copy="import { Foo } from &quot;.&quot;;
 "><svg width="15" height="15" viewBox="0 0 15 15" fill="none" xmlns="http://www.w3.org/2000/svg">
-<rect x="2" y="2" width="7" height="7" fill="none"/>
-<rect x="6" y="6" width="7" height="7" fill="none"/>
-<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"/>
+<rect x="2" y="2" width="7" height="7" fill="none"></rect>
+<rect x="6" y="6" width="7" height="7" fill="none"></rect>
+<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"></path>
 </svg>
 </button><code></code></pre>
 </div></div></div>

diff --git a/tests/snapshots/html_test__html_doc_files-7.snap b/tests/snapshots/html_test__html_doc_files-7.snap
@@ -50,12 +50,12 @@ expression: "files.get(\"./~/Foobar.html\").unwrap()"
     </article></main>
 <div class="toc">
     <div><div class="usageContent">
-    <h3>Usage</h3><div class="markdown"><pre class=" highlight"><code class="language-typescript"><span class="pl-k">import</span> <span class="pl-smi">Foobar</span> <span class="pl-k">from</span> <span class="pl-s">&quot;.&quot;</span>;
+    <h3>Usage</h3><div class="markdown"><pre class="highlight"><code><span class="pl-k">import</span> <span class="pl-smi">Foobar</span> <span class="pl-k">from</span> <span class="pl-s">"."</span>;
 </code><button class="context_button" data-copy="import Foobar from &quot;.&quot;;
 "><svg width="15" height="15" viewBox="0 0 15 15" fill="none" xmlns="http://www.w3.org/2000/svg">
-<rect x="2" y="2" width="7" height="7" fill="none"/>
-<rect x="6" y="6" width="7" height="7" fill="none"/>
-<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"/>
+<rect x="2" y="2" width="7" height="7" fill="none"></rect>
+<rect x="6" y="6" width="7" height="7" fill="none"></rect>
+<path d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z" fill="#232323"></path>
 </svg>
 </button><code></code></pre>
 </div></div></div>