refactor: streamline anchorization (#766)

Author: crowlKats

js/html_types.d.ts

@@ -61,6 +61,7 @@ export interface AllSymbolsCtx {
 export interface AllSymbolsItemCtx {
   name: string;
   href: string;
+  anchor: AnchorCtx;
   module_doc: ModuleDocCtx;
 }
 

src/html/jsdoc.rs

@@ -149,7 +149,7 @@ pub struct MarkdownToHTMLOptions {
   pub no_toc: bool,
 }
 
-pub type MarkdownStripper = std::rc::Rc<dyn Fn(&str) -> String>;
+pub type MarkdownStripper = Rc<dyn Fn(&str) -> String>;
 
 pub fn strip(render_ctx: &RenderContext, md: &str) -> String {
   let md = parse_links(md, render_ctx, true);
@@ -284,7 +284,6 @@ pub(crate) fn jsdoc_examples(
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct ExampleCtx {
   pub anchor: AnchorCtx,
-  pub id: Id,
   pub title: String,
   pub markdown_title: String,
   markdown_body: String,
@@ -294,7 +293,7 @@ impl ExampleCtx {
   pub const TEMPLATE: &'static str = "example";
 
   pub fn new(render_ctx: &RenderContext, example: &str, i: usize) -> Self {
-    let id = IdBuilder::new(render_ctx.ctx)
+    let id = IdBuilder::new(render_ctx)
       .kind(IdKind::Example)
       .index(i)
       .build();
@@ -311,8 +310,7 @@ impl ExampleCtx {
       render_markdown(render_ctx, body.unwrap_or_default(), true);
 
     ExampleCtx {
-      anchor: AnchorCtx { id: id.clone() },
-      id,
+      anchor: AnchorCtx::new(id),
       title,
       markdown_title,
       markdown_body,
@@ -375,13 +373,18 @@ impl ModuleDocCtx {
 
       sections.extend(super::namespace::render_namespace(
         partitions_by_kind.into_iter().map(|(title, nodes)| {
+          let id = IdBuilder::new(render_ctx)
+            .name(short_path.display_name())
+            .name(&title)
+            .build();
+
+          render_ctx.toc.add_entry(1, &title, &id);
+
           (
             render_ctx.clone(),
             Some(SectionHeaderCtx {
               title: title.clone(),
-              anchor: AnchorCtx {
-                id: super::util::Id::new(title),
-              },
+              anchor: AnchorCtx::new(id),
               href: None,
               doc: None,
             }),
@@ -394,7 +397,7 @@ impl ModuleDocCtx {
     Self {
       deprecated,
       sections: super::SymbolContentCtx {
-        id: Id::new("module_doc"),
+        id: render_ctx.toc.anchorize("module_doc"),
         docs: html,
         sections,
       },

src/html/mod.rs

@@ -34,7 +34,7 @@ pub use pages::generate_symbol_pages_for_module;
 pub use render_context::RenderContext;
 pub use search::generate_search_index;
 pub use symbols::AllSymbolsCtx;
-pub use symbols::AllSymbolsItemCtx;
+pub use symbols::AllSymbolsEntrypointCtx;
 pub use symbols::SymbolContentCtx;
 pub use symbols::SymbolGroupCtx;
 pub use symbols::namespace;

src/html/pages.rs

@@ -277,8 +277,8 @@ impl IndexCtx {
 
             let title = short_path.display_name();
 
-            let anchor = render_ctx.toc.anchorize(title);
-            render_ctx.toc.add_entry(1, title, &anchor);
+            let id = render_ctx.toc.anchorize(title);
+            render_ctx.toc.add_entry(1, title, &id);
 
             util::SectionCtx {
               header: Some(SectionHeaderCtx {
@@ -287,9 +287,7 @@ impl IndexCtx {
                   short_path.as_resolve_kind(),
                 )),
                 title: title.to_string(),
-                anchor: AnchorCtx {
-                  id: util::Id::new(anchor),
-                },
+                anchor: AnchorCtx::new(id),
                 doc,
               }),
               content: util::SectionContentCtx::Empty,
@@ -307,8 +305,8 @@ impl IndexCtx {
         let sections = partitions
           .into_keys()
           .map(|title| {
-            let anchor = render_ctx.toc.anchorize(&title);
-            render_ctx.toc.add_entry(1, &title, &anchor);
+            let id = render_ctx.toc.anchorize(&title);
+            render_ctx.toc.add_entry(1, &title, &id);
 
             let doc = ctx
               .category_docs
@@ -334,9 +332,7 @@ impl IndexCtx {
                   UrlResolveKind::Category { category: &title },
                 )),
                 title,
-                anchor: AnchorCtx {
-                  id: util::Id::new(anchor),
-                },
+                anchor: AnchorCtx::new(id),
                 doc,
               }),
               content: util::SectionContentCtx::Empty,
@@ -401,12 +397,12 @@ impl IndexCtx {
           category_docs.get(&title).cloned().flatten()
         });
 
+        let id = render_ctx.toc.anchorize(&title);
+
         (
           render_ctx.clone(),
           Some(SectionHeaderCtx {
-            anchor: AnchorCtx {
-              id: util::Id::new(title.clone()),
-            },
+            anchor: AnchorCtx::new(id),
             title,
             href: None,
             doc,

src/html/render_context.rs

@@ -351,12 +351,21 @@ lazy_static! {
 }
 
 impl HeadingToCAdapter {
-  pub fn anchorize(&self, content: &str) -> String {
+  pub fn anchorize(&self, content: &str) -> super::util::Id {
     let mut anchorizer = self.anchorizer.lock().unwrap();
-    anchorizer.anchorize(content)
+    super::util::Id::from_raw(anchorizer.anchorize(content))
   }
 
-  pub fn add_entry(&self, level: u8, content: &str, anchor: &str) {
+  /// Apply the same GFM sanitization as anchorize but without registering
+  /// in the deduplication map. Use for IDs referencing anchors on other pages.
+  pub fn sanitize(&self, content: &str) -> super::util::Id {
+    let s = REJECTED_CHARS
+      .replace_all(&content.to_lowercase(), "")
+      .replace(' ', "-");
+    super::util::Id::from_raw(s)
+  }
+
+  pub fn add_entry(&self, level: u8, content: &str, anchor: &super::util::Id) {
     let mut toc = self.toc.lock().unwrap();
     let mut offset = self.offset.lock().unwrap();
 
@@ -366,7 +375,7 @@ impl HeadingToCAdapter {
       toc.push(ToCEntry {
         level,
         content: content.to_owned(),
-        anchor: anchor.to_owned(),
+        anchor: anchor.as_str().to_owned(),
       });
     }
   }

src/html/search.rs

@@ -86,10 +86,10 @@ pub fn doc_nodes_into_search_index_node(
     .unwrap_or_default();
 
   let id = parent_id.unwrap_or_else(|| {
-    IdBuilder::new(ctx.ctx)
+    IdBuilder::new(ctx)
       .kind(IdKind::Namespace)
       .name(&name)
-      .build()
+      .build_unregistered()
   });
 
   let mut out = vec![SearchIndexNode {

src/html/symbols/class.rs

@@ -125,7 +125,7 @@ fn render_constructors(
     })
     .enumerate()
     .map(|(i, constructor)| {
-      let id = IdBuilder::new(ctx.ctx)
+      let id = IdBuilder::new(ctx)
         .kind(IdKind::Constructor)
         .index(i)
         .build();
@@ -160,7 +160,6 @@ fn render_constructors(
 
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct IndexSignatureCtx {
-  pub id: Id,
   pub anchor: AnchorCtx,
   pub readonly: bool,
   pub params: String,
@@ -307,7 +306,7 @@ fn render_class_accessor(
   let getter_or_setter = getter.or(setter).unwrap();
 
   let name = &getter_or_setter.name;
-  let id = IdBuilder::new(ctx.ctx)
+  let id = IdBuilder::new(ctx)
     .kind(IdKind::Accessor)
     .name(name)
     .build();
@@ -364,7 +363,7 @@ fn render_class_method(
     return None;
   }
 
-  let id = IdBuilder::new(ctx.ctx)
+  let id = IdBuilder::new(ctx)
     .kind(IdKind::Method)
     .name(&method.name)
     .index(i)
@@ -402,7 +401,7 @@ fn render_class_property(
   class_name: &str,
   property: &ClassPropertyDef,
 ) -> DocEntryCtx {
-  let id = IdBuilder::new(ctx.ctx)
+  let id = IdBuilder::new(ctx)
     .kind(IdKind::Property)
     .name(&property.name)
     .build();

src/html/symbols/enum.rs

@@ -27,10 +27,10 @@ pub(crate) fn render_enum(
   let items = members
     .into_iter()
     .map(|member| {
-      let id = IdBuilder::new(render_ctx.ctx)
+      let id = IdBuilder::new(render_ctx)
         .kind(IdKind::Enum)
         .name(doc_node.get_name())
-        .component(&member.name)
+        .name(&member.name)
         .build();
 
       let tags = Tag::from_js_doc(&member.js_doc);

src/html/symbols/function.rs

@@ -17,7 +17,6 @@ use std::ops::Deref;
 
 #[derive(Debug, Serialize, Deserialize, Clone)]
 struct OverloadRenderCtx {
-  id: Id,
   anchor: AnchorCtx,
   name: String,
   summary: String,
@@ -69,29 +68,24 @@ impl FunctionCtx {
         }
       });
 
-      let overload_id = IdBuilder::new(ctx.ctx)
+      let overload_id = IdBuilder::new(ctx)
         .kind(IdKind::Function)
         .name(doc_node.get_name())
         .index(i)
         .build();
 
       if overloads_count > 1 {
-        ctx.toc.add_entry(
-          0,
-          &format!("Overload {}", i + 1),
-          overload_id.as_str(),
-        );
+        ctx
+          .toc
+          .add_entry(0, &format!("Overload {}", i + 1), &overload_id);
       }
 
       functions_content.push(OverloadRenderCtx {
-        id: overload_id.clone(),
-        anchor: AnchorCtx {
-          id: overload_id.clone(),
-        },
+        anchor: AnchorCtx::new(overload_id.clone()),
         name: doc_node.get_name().to_string(),
         summary: render_function_summary(function_def, ctx),
         deprecated,
-        content: render_single_function(ctx, doc_node, overload_id.clone()),
+        content: render_single_function(ctx, doc_node, overload_id),
       });
     }
 
@@ -161,8 +155,7 @@ fn render_single_function(
     .enumerate()
     .map(|(i, param)| {
       let (name, str_name) = crate::html::parameters::param_name(param, i);
-      let id = IdBuilder::new(ctx.ctx)
-        .component(&overload_id)
+      let id = IdBuilder::new_with_parent(ctx, &overload_id)
         .kind(IdKind::Parameter)
         .name(&str_name)
         .build();
@@ -334,8 +327,7 @@ fn render_function_return_type(
 ) -> Option<DocEntryCtx> {
   let return_type = def.return_type.as_ref()?;
 
-  let id = IdBuilder::new(render_ctx.ctx)
-    .component(overload_id.as_str())
+  let id = IdBuilder::new_with_parent(render_ctx, &overload_id)
     .kind(IdKind::Return)
     .build();
 
@@ -367,8 +359,7 @@ fn render_function_throws(
   overload_id: Id,
   throws_id: usize,
 ) -> DocEntryCtx {
-  let id = IdBuilder::new(render_ctx.ctx)
-    .component(overload_id.as_str())
+  let id = IdBuilder::new_with_parent(render_ctx, &overload_id)
     .kind(IdKind::Throws)
     .index(throws_id)
     .build();

src/html/symbols/interface.rs

@@ -67,7 +67,7 @@ pub(crate) fn render_index_signatures(
   let mut items = Vec::with_capacity(index_signatures.len());
 
   for (i, index_signature) in index_signatures.iter().enumerate() {
-    let id = IdBuilder::new(ctx.ctx)
+    let id = IdBuilder::new(ctx)
       .kind(IdKind::IndexSignature)
       .index(i)
       .build();
@@ -79,8 +79,7 @@ pub(crate) fn render_index_signatures(
       .unwrap_or_default();
 
     items.push(IndexSignatureCtx {
-      id: id.clone(),
-      anchor: AnchorCtx { id },
+      anchor: AnchorCtx::new(id),
       readonly: index_signature.readonly,
       params: render_params(ctx, &index_signature.params),
       ts_type,
@@ -110,7 +109,7 @@ pub(crate) fn render_call_signatures(
     .iter()
     .enumerate()
     .map(|(i, call_signature)| {
-      let id = IdBuilder::new(ctx.ctx)
+      let id = IdBuilder::new(ctx)
         .kind(IdKind::CallSignature)
         .index(i)
         .build();
@@ -159,7 +158,7 @@ pub(crate) fn render_properties(
   let items = properties
     .iter()
     .map(|property| {
-      let id = IdBuilder::new(ctx.ctx)
+      let id = IdBuilder::new(ctx)
         .kind(IdKind::Property)
         .name(&property.name)
         .build();
@@ -234,7 +233,7 @@ pub(crate) fn render_methods(
     .iter()
     .enumerate()
     .map(|(i, method)| {
-      let id = IdBuilder::new(ctx.ctx)
+      let id = IdBuilder::new(ctx)
         .kind(IdKind::Method)
         .name(&method.name)
         .index(i)