simplify modulespecifier and shortpath usages

Author: crowlKats

examples/ddoc/main.rs

@@ -224,7 +224,7 @@ fn generate_docs_directory(
     href_resolver: Rc::new(EmptyResolver()),
     usage_composer: None,
     rewrite_map: Some(index_map),
-    composable_output: true,
+    composable_output: false,
   };
   let html = deno_doc::html::generate(options, doc_nodes_by_url)?;
 

src/html/jsdoc.rs

@@ -556,9 +556,9 @@ impl ModuleDocCtx {
   pub fn new(
     render_ctx: &RenderContext,
     short_path: &ShortPath,
-    doc_nodes_by_url: &super::ContextDocNodesByUrl,
+    doc_nodes_by_url: &super::ContextDocNodesByShortPath,
   ) -> Self {
-    let module_doc_nodes = doc_nodes_by_url.get(&short_path.specifier).unwrap();
+    let module_doc_nodes = doc_nodes_by_url.get(short_path).unwrap();
 
     let mut sections = Vec::with_capacity(7);
 

src/html/mod.rs

@@ -25,6 +25,7 @@ mod usage;
 mod util;
 
 use crate::html::pages::SymbolPage;
+use crate::html::partition::get_partitions_for_file;
 pub use pages::generate_symbol_pages_for_module;
 pub use render_context::RenderContext;
 pub use search::generate_search_index;
@@ -106,11 +107,11 @@ impl<'ctx> GenerateCtx<'ctx> {
   pub fn doc_nodes_by_url_add_context(
     &self,
     doc_nodes_by_url: IndexMap<ModuleSpecifier, Vec<DocNode>>,
-  ) -> ContextDocNodesByUrl {
+  ) -> ContextDocNodesByShortPath {
     doc_nodes_by_url
       .into_iter()
       .map(|(specifier, nodes)| {
-        let short_path = Rc::new(ShortPath::new(self, specifier.clone()));
+        let short_path = Rc::new(ShortPath::new(self, specifier));
 
         let nodes = nodes
           .into_iter()
@@ -123,7 +124,7 @@ impl<'ctx> GenerateCtx<'ctx> {
           })
           .collect::<Vec<_>>();
 
-        (specifier, nodes)
+        (short_path, nodes)
       })
       .collect::<IndexMap<_, _>>()
   }
@@ -137,8 +138,8 @@ impl<'ctx> GenerateCtx<'ctx> {
   }
 }
 
-pub type ContextDocNodesByUrl =
-  IndexMap<ModuleSpecifier, Vec<DocNodeWithContext>>;
+pub type ContextDocNodesByShortPath =
+  IndexMap<Rc<ShortPath>, Vec<DocNodeWithContext>>;
 
 #[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
 pub struct ShortPath {
@@ -488,19 +489,27 @@ pub fn generate(
   };
   let mut files = HashMap::new();
 
-  let doc_nodes_by_url = ctx.doc_nodes_by_url_add_context(doc_nodes_by_url);
+  let doc_nodes_by_short_path =
+    ctx.doc_nodes_by_url_add_context(doc_nodes_by_url);
 
   // Index page
   {
+    let main_entrypoint = doc_nodes_by_short_path
+      .iter()
+      .find(|(short_path, _)| short_path.is_main);
+
     let partitions_for_entrypoint_nodes =
-      partition::get_partitions_for_main_entrypoint(&ctx, &doc_nodes_by_url);
+      if let Some((_, doc_nodes)) = main_entrypoint {
+        get_partitions_for_file(&ctx, doc_nodes)
+      } else {
+        Default::default()
+      };
 
     let index = pages::IndexCtx::new(
       &ctx,
-      ctx.main_entrypoint.as_ref(),
-      &doc_nodes_by_url,
+      main_entrypoint.map(|(short_path, _)| short_path.clone()),
+      &doc_nodes_by_short_path,
       partitions_for_entrypoint_nodes,
-      None,
     );
 
     if options.composable_output {
@@ -540,7 +549,7 @@ pub fn generate(
 
   // All symbols (list of all symbols in all files)
   if ctx.file_mode != FileMode::SingleDts {
-    let all_doc_nodes = doc_nodes_by_url
+    let all_doc_nodes = doc_nodes_by_short_path
       .values()
       .flatten()
       .cloned()
@@ -549,8 +558,11 @@ pub fn generate(
     let partitions_by_kind =
       partition::partition_nodes_by_entrypoint(&all_doc_nodes, true);
 
-    let all_symbols =
-      pages::AllSymbolsCtx::new(&ctx, partitions_by_kind, &doc_nodes_by_url);
+    let all_symbols = pages::AllSymbolsCtx::new(
+      &ctx,
+      partitions_by_kind,
+      &doc_nodes_by_short_path,
+    );
 
     if options.composable_output {
       files.insert(
@@ -573,15 +585,13 @@ pub fn generate(
 
   // Pages for all discovered symbols
   {
-    for (specifier, doc_nodes) in &doc_nodes_by_url {
-      let short_path = ShortPath::new(&ctx, specifier.clone());
-
+    for (short_path, doc_nodes) in &doc_nodes_by_short_path {
       let partitions_for_nodes =
         partition::get_partitions_for_file(&ctx, doc_nodes);
 
       let symbol_pages = generate_symbol_pages_for_module(
         &ctx,
-        &short_path,
+        short_path,
         &partitions_for_nodes,
         doc_nodes,
       );
@@ -605,7 +615,7 @@ pub fn generate(
               &root,
               &symbol_group_ctx.name,
               ctx.package_name.as_ref(),
-              Some(short_path.clone()),
+              Some(short_path),
             );
 
             if options.composable_output {
@@ -669,10 +679,9 @@ pub fn generate(
 
       let index = pages::IndexCtx::new(
         &ctx,
-        Some(specifier),
-        &doc_nodes_by_url,
-        partitions_for_nodes,
         Some(short_path.clone()),
+        &doc_nodes_by_short_path,
+        partitions_for_nodes,
       );
 
       if options.composable_output {
@@ -717,7 +726,7 @@ pub fn generate(
   files.insert(STYLESHEET_FILENAME.into(), STYLESHEET.into());
   files.insert(
     SEARCH_INDEX_FILENAME.into(),
-    search::get_search_index_file(&ctx, &doc_nodes_by_url)?,
+    search::get_search_index_file(&ctx, &doc_nodes_by_short_path)?,
   );
   files.insert(SCRIPT_FILENAME.into(), SCRIPT_JS.into());
 

src/html/pages.rs

@@ -3,7 +3,6 @@ use super::sidepanels::SidepanelCtx;
 use super::symbols::SymbolContentCtx;
 use super::util::qualify_drilldown_name;
 use super::util::BreadcrumbsCtx;
-use super::util::SectionHeaderCtx;
 use super::DocNodeKindWithDrilldown;
 use super::DocNodeWithContext;
 use super::FileMode;
@@ -28,7 +27,6 @@ use crate::html::partition::Partition;
 use crate::variable::VariableDef;
 use crate::DocNode;
 use crate::DocNodeKind;
-use deno_ast::ModuleSpecifier;
 use indexmap::IndexMap;
 use serde::Serialize;
 
@@ -51,7 +49,7 @@ impl HtmlHeadCtx {
     root: &str,
     page: &str,
     package_name: Option<&String>,
-    current_file: Option<ShortPath>,
+    current_file: Option<&ShortPath>,
   ) -> Self {
     Self {
       title: format!(
@@ -61,7 +59,6 @@ impl HtmlHeadCtx {
           .unwrap_or_default()
       ),
       current_file: current_file
-        .as_ref()
         .map(|current_file| &*current_file.path)
         .unwrap_or_default()
         .to_string(),
@@ -87,40 +84,36 @@ pub struct IndexCtx {
 impl IndexCtx {
   pub const TEMPLATE: &'static str = "pages/index";
 
+  /// short_path is None in case there this is a root index page but there is no main entrypoint
   pub fn new(
     ctx: &GenerateCtx,
-    specifier: Option<&ModuleSpecifier>,
-    doc_nodes_by_url: &super::ContextDocNodesByUrl,
+    short_path: Option<std::rc::Rc<ShortPath>>,
+    doc_nodes_by_url: &super::ContextDocNodesByShortPath,
     partitions: Partition,
-    file: Option<ShortPath>,
   ) -> Self {
-    let short_path = specifier
-      .cloned()
-      .map(|specifier| ShortPath::new(ctx, specifier));
-
     // will be default on index page with no main entrypoint
     let default = vec![];
-    let doc_nodes = specifier
-      .or(ctx.main_entrypoint.as_ref())
-      .and_then(|specifier| doc_nodes_by_url.get(specifier))
+    let doc_nodes = short_path
+      .as_ref()
+      .and_then(|short_path| doc_nodes_by_url.get(short_path))
       .unwrap_or(&default);
 
     let render_ctx = RenderContext::new(
       ctx,
       doc_nodes,
       short_path
-        .as_ref()
-        .map_or(UrlResolveKind::Root, UrlResolveKind::File),
+        .as_deref()
+        .map_or(UrlResolveKind::Root, ShortPath::as_resolve_kind),
     );
 
     let module_doc = short_path.as_ref().map(|short_path| {
       super::jsdoc::ModuleDocCtx::new(&render_ctx, short_path, doc_nodes_by_url)
     });
 
     let root = ctx.href_resolver.resolve_path(
-      file
-        .as_ref()
-        .map_or(UrlResolveKind::Root, UrlResolveKind::File),
+      short_path
+        .as_deref()
+        .map_or(UrlResolveKind::Root, ShortPath::as_resolve_kind),
       UrlResolveKind::Root,
     );
 
@@ -135,7 +128,7 @@ impl IndexCtx {
           .into_iter()
           .map(|(title, nodes)| {
             (
-              SectionHeaderCtx {
+              crate::html::util::SectionHeaderCtx {
                 title,
                 href: None,
                 doc: None,
@@ -157,10 +150,9 @@ impl IndexCtx {
 
     let sidepanel_ctx = sidepanels::IndexSidepanelCtx::new(
       ctx,
-      specifier,
+      short_path.clone(),
       doc_nodes_by_url,
       partitions,
-      file.as_ref(),
     );
 
     IndexCtx {
@@ -186,7 +178,7 @@ impl AllSymbolsCtx {
   pub fn new(
     ctx: &GenerateCtx,
     partitions: crate::html::partition::EntrypointPartition,
-    doc_nodes_by_url: &super::ContextDocNodesByUrl,
+    doc_nodes_by_url: &super::ContextDocNodesByShortPath,
   ) -> Self {
     // TODO(@crowlKats): handle doc_nodes in all symbols page for each symbol
     let render_ctx = RenderContext::new(ctx, &[], UrlResolveKind::AllSymbols);
@@ -196,7 +188,7 @@ impl AllSymbolsCtx {
       partitions
         .into_iter()
         .map(|(path, nodes)| {
-          let module_doc_nodes = doc_nodes_by_url.get(&path.specifier).unwrap();
+          let module_doc_nodes = doc_nodes_by_url.get(&path).unwrap();
 
           let doc = module_doc_nodes
             .iter()

src/html/partition.rs

@@ -318,19 +318,3 @@ pub fn get_partitions_for_file(
     categories
   }
 }
-
-pub fn get_partitions_for_main_entrypoint(
-  ctx: &GenerateCtx,
-  doc_nodes_by_url: &super::ContextDocNodesByUrl,
-) -> Partition {
-  let doc_nodes = ctx
-    .main_entrypoint
-    .as_ref()
-    .and_then(|main_entrypoint| doc_nodes_by_url.get(main_entrypoint));
-
-  if let Some(doc_nodes) = doc_nodes {
-    get_partitions_for_file(ctx, doc_nodes)
-  } else {
-    Default::default()
-  }
-}

src/html/search.rs

@@ -1,6 +1,7 @@
+use super::ContextDocNodesByShortPath;
 use super::DocNodeWithContext;
 use super::GenerateCtx;
-use super::{ContextDocNodesByUrl, ShortPath};
+use super::ShortPath;
 use crate::node::Location;
 use crate::DocNodeKind;
 use deno_ast::ModuleSpecifier;
@@ -184,7 +185,7 @@ fn doc_node_into_search_index_nodes(
 
 pub fn generate_search_index(
   ctx: &GenerateCtx,
-  doc_nodes_by_url: &ContextDocNodesByUrl,
+  doc_nodes_by_url: &ContextDocNodesByShortPath,
 ) -> serde_json::Value {
   let doc_nodes = doc_nodes_by_url.values().flatten().collect::<Vec<_>>();
 
@@ -225,7 +226,7 @@ pub fn generate_search_index(
 
 pub(crate) fn get_search_index_file(
   ctx: &GenerateCtx,
-  doc_nodes_by_url: &ContextDocNodesByUrl,
+  doc_nodes_by_url: &ContextDocNodesByShortPath,
 ) -> Result<String, anyhow::Error> {
   let search_index = generate_search_index(ctx, doc_nodes_by_url);
   let search_index_str = serde_json::to_string(&search_index)?;