feat(html): show method and properties of classes under classes on symbol overview pages (#635)

Author: crowlKats

src/html/comrak_adapters.rs

@@ -315,25 +315,34 @@ impl HeadingToCAdapter {
     let mut toc_content = vec!["<ul>".to_string()];
     let mut current_level = toc.iter().map(|entry| entry.level).min().unwrap();
 
+    let mut level_diff = 0;
     for entry in toc {
       match current_level.cmp(&entry.level) {
         Ordering::Equal => {}
         Ordering::Less => {
+          level_diff += 1;
           toc_content.push(r#"<li><ul>"#.to_string());
           current_level = entry.level;
         }
         Ordering::Greater => {
+          level_diff -= 1;
           toc_content.push("</ul></li>".to_string());
           current_level = entry.level;
         }
       }
 
       toc_content.push(format!(
         r##"<li><a href="#{}" title="{}">{}</a></li>"##,
-        entry.anchor, entry.content, entry.content
+        entry.anchor,
+        html_escape::encode_double_quoted_attribute(&entry.content),
+        entry.content
       ));
     }
 
+    for _ in 0..level_diff {
+      toc_content.push("</ul></li>".to_string());
+    }
+
     toc_content.push(String::from("</ul>"));
 
     Some(toc_content.join(""))

src/html/mod.rs

@@ -775,6 +775,7 @@ pub fn generate(
     }
   }
 
+  // Category pages
   if ctx.file_mode == FileMode::SingleDts {
     let categories =
       partition::partition_nodes_by_category(&all_doc_nodes, true);

src/html/pages.rs

@@ -23,6 +23,7 @@ use super::STYLESHEET_FILENAME;
 
 use crate::html::usage::UsagesCtx;
 use crate::js_doc::JsDocTag;
+use crate::node::DocNodeDef;
 use crate::DocNode;
 use crate::DocNodeKind;
 use indexmap::IndexMap;
@@ -505,11 +506,9 @@ pub fn generate_symbol_pages_for_module(
       .iter()
       .any(|node| node.kind() == DocNodeKind::Class);
     for doc_node in doc_nodes {
-      match doc_node.kind() {
-        DocNodeKind::Class => {
-          let class = doc_node.class_def().unwrap();
-
-          let method_nodes = class
+      match &doc_node.def {
+        DocNodeDef::Class { class_def } => {
+          let method_nodes = class_def
             .methods
             .iter()
             .map(|method| {
@@ -530,7 +529,7 @@ pub fn generate_symbol_pages_for_module(
           drilldown_partitions
             .extend(partition::partition_nodes_by_name(&method_nodes, false));
 
-          let property_nodes = class
+          let property_nodes = class_def
             .properties
             .iter()
             .map(|property| {
@@ -545,9 +544,8 @@ pub fn generate_symbol_pages_for_module(
             super::partition::partition_nodes_by_name(&property_nodes, false),
           );
         }
-        DocNodeKind::Interface => {
-          let interface = doc_node.interface_def().unwrap();
-          let method_nodes = interface
+        DocNodeDef::Interface { interface_def } => {
+          let method_nodes = interface_def
             .methods
             .iter()
             .filter_map(|method| {
@@ -566,7 +564,7 @@ pub fn generate_symbol_pages_for_module(
             .extend(partition::partition_nodes_by_name(&method_nodes, false));
 
           let property_nodes =
-            interface
+            interface_def
               .properties
               .iter()
               .filter_map(|property| {
@@ -584,11 +582,9 @@ pub fn generate_symbol_pages_for_module(
           drilldown_partitions
             .extend(partition::partition_nodes_by_name(&property_nodes, false));
         }
-        DocNodeKind::TypeAlias => {
-          let type_alias = doc_node.type_alias_def().unwrap();
-
+        DocNodeDef::TypeAlias { type_alias_def } => {
           if let Some(ts_type_literal) =
-            type_alias.ts_type.type_literal.as_ref()
+            type_alias_def.ts_type.type_literal.as_ref()
           {
             let method_nodes = ts_type_literal
               .methods
@@ -629,10 +625,8 @@ pub fn generate_symbol_pages_for_module(
             ));
           }
         }
-        DocNodeKind::Variable => {
-          let variable = doc_node.variable_def().unwrap();
-
-          if let Some(ts_type_literal) = variable
+        DocNodeDef::Variable { variable_def } => {
+          if let Some(ts_type_literal) = variable_def
             .ts_type
             .as_ref()
             .and_then(|ts_type| ts_type.type_literal.as_ref())

src/html/render_context.rs

@@ -4,7 +4,7 @@ use crate::html::util::NamespacedSymbols;
 use crate::html::DocNodeWithContext;
 use crate::html::GenerateCtx;
 use crate::html::UrlResolveKind;
-use crate::DocNodeKind;
+use crate::node::DocNodeDef;
 use deno_graph::ModuleSpecifier;
 use std::collections::HashMap;
 use std::collections::HashSet;
@@ -340,8 +340,7 @@ fn get_current_imports(
   let mut imports = HashMap::new();
 
   for doc_node in doc_nodes {
-    if doc_node.kind() == DocNodeKind::Import {
-      let import_def = doc_node.import_def().unwrap();
+    if let DocNodeDef::Import { import_def } = &doc_node.def {
       // TODO: handle import aliasing
       if import_def.imported.as_deref() == Some(doc_node.get_name()) {
         imports.insert(doc_node.get_name().to_string(), import_def.src.clone());

src/html/symbols/mod.rs

@@ -7,6 +7,7 @@ use crate::html::DocNodeKindWithDrilldown;
 use crate::html::DocNodeWithContext;
 use crate::html::RenderContext;
 use crate::js_doc::JsDocTag;
+use crate::node::DocNodeDef;
 use crate::DocNodeKind;
 use indexmap::IndexMap;
 use indexmap::IndexSet;
@@ -189,10 +190,8 @@ impl DocBlockSubtitleCtx {
   pub const TEMPLATE_INTERFACE: &'static str = "doc_block_subtitle_interface";
 
   fn new(ctx: &RenderContext, doc_node: &DocNodeWithContext) -> Option<Self> {
-    match doc_node.kind() {
-      DocNodeKind::Class => {
-        let class_def = doc_node.class_def().unwrap();
-
+    match &doc_node.def {
+      DocNodeDef::Class { class_def } => {
         let current_type_params = class_def
           .type_params
           .iter()
@@ -230,9 +229,7 @@ impl DocBlockSubtitleCtx {
           extends: class_extends,
         })
       }
-      DocNodeKind::Interface => {
-        let interface_def = doc_node.interface_def().unwrap();
-
+      DocNodeDef::Interface { interface_def } => {
         if interface_def.extends.is_empty() {
           return None;
         }