fix(sidebars): support listsubpages with code

fiji-flo · fiji-flo · commit e287d44cb843 · 2024-12-03T17:29:17.000+01:00
diff --git a/crates/rari-doc/src/helpers/subpages.rs b/crates/rari-doc/src/helpers/subpages.rs
@@ -63,19 +63,24 @@ pub fn write_li_with_badges(
     out: &mut String,
     page: &Page,
     locale: Locale,
+    code: bool,
     closed: bool,
 ) -> Result<(), DocError> {
     let locale_page = if locale != Default::default() {
         &Page::from_url_with_locale_and_fallback(page.url(), locale)?
     } else {
         page
     };
-    write!(
-        out,
-        "<li><a href=\"{}\">{}</a>",
+    out.extend([
+        "<li>",
+        r#"<a href=""#,
         locale_page.url(),
-        html_escape::encode_safe(locale_page.short_title().unwrap_or(locale_page.title()))
-    )?;
+        r#"">"#,
+        if code { "<code>" } else { "" },
+        &html_escape::encode_safe(locale_page.short_title().unwrap_or(locale_page.title())),
+        if code { "</code>" } else { "" },
+        "</a>",
+    ]);
     add_inline_badges(out, page, locale)?;
     if closed {
         write!(out, "</li>")?;
@@ -110,26 +115,37 @@ pub fn list_sub_pages_reverse_internal(
     locale: Locale,
     sorter: Option<SubPagesSorter>,
     page_types: &[PageType],
+    code: bool,
 ) -> Result<(), DocError> {
     let sub_pages = get_sub_pages(url, Some(1), sorter.unwrap_or_default())?;
 
     for sub_page in sub_pages.iter().rev() {
         if !page_types.is_empty() && !page_types.contains(&sub_page.page_type()) {
             continue;
         }
-        write_li_with_badges(out, sub_page, locale, true)?;
+        write_li_with_badges(out, sub_page, locale, code, true)?;
     }
     Ok(())
 }
 
+pub struct ListSubPagesContext<'a> {
+    pub sorter: Option<SubPagesSorter>,
+    pub page_types: &'a [PageType],
+    pub code: bool,
+    pub include_parent: bool,
+}
+
 pub fn list_sub_pages_internal(
     out: &mut String,
     url: &str,
     locale: Locale,
     depth: Option<usize>,
-    sorter: Option<SubPagesSorter>,
-    page_types: &[PageType],
-    include_parent: bool,
+    ListSubPagesContext {
+        sorter,
+        page_types,
+        code,
+        include_parent,
+    }: ListSubPagesContext<'_>,
 ) -> Result<(), DocError> {
     let sub_pages = get_sub_pages(url, Some(1), sorter.unwrap_or_default())?;
     let depth = depth.map(|i| i.saturating_sub(1));
@@ -143,19 +159,22 @@ pub fn list_sub_pages_internal(
         }
         let sub_sub_pages = get_sub_pages(sub_page.url(), depth, sorter.unwrap_or_default())?;
         if sub_sub_pages.is_empty() {
-            write_li_with_badges(out, &sub_page, locale, true)?;
+            write_li_with_badges(out, &sub_page, locale, code, true)?;
         } else {
-            write_li_with_badges(out, &sub_page, locale, false)?;
+            write_li_with_badges(out, &sub_page, locale, code, false)?;
             out.push_str("<ol>");
 
             list_sub_pages_internal(
                 out,
                 sub_page.url(),
                 locale,
                 depth,
-                sorter,
-                page_types,
-                include_parent,
+                ListSubPagesContext {
+                    sorter,
+                    page_types,
+                    code,
+                    include_parent,
+                },
             )?;
             out.push_str("</ol>");
             out.push_str("</li>");
@@ -168,9 +187,12 @@ pub fn list_sub_pages_grouped_internal(
     out: &mut String,
     url: &str,
     locale: Locale,
-    sorter: Option<SubPagesSorter>,
-    page_types: &[PageType],
-    include_parent: bool,
+    ListSubPagesContext {
+        sorter,
+        page_types,
+        code,
+        include_parent,
+    }: ListSubPagesContext<'_>,
 ) -> Result<(), DocError> {
     let sub_pages = get_sub_pages(url, None, sorter.unwrap_or_default())?;
 
@@ -206,7 +228,7 @@ pub fn list_sub_pages_grouped_internal(
             out.push_str("-*</summary><ol>");
         }
         for sub_page in group {
-            write_li_with_badges(out, sub_page, locale, true)?;
+            write_li_with_badges(out, sub_page, locale, code, true)?;
         }
         if keep_group {
             out.push_str("</ol></details></li>");
diff --git a/crates/rari-doc/src/html/sidebar.rs b/crates/rari-doc/src/html/sidebar.rs
@@ -20,7 +20,9 @@ use super::rewriter::post_process_html;
 use crate::cached_readers::read_sidebar;
 use crate::error::DocError;
 use crate::helpers;
-use crate::helpers::subpages::{list_sub_pages_grouped_internal, list_sub_pages_internal};
+use crate::helpers::subpages::{
+    list_sub_pages_grouped_internal, list_sub_pages_internal, ListSubPagesContext,
+};
 use crate::pages::page::{Page, PageLike};
 use crate::pages::types::doc::Doc;
 use crate::utils::{is_default, serialize_t_or_vec, t_or_vec};
@@ -292,6 +294,8 @@ pub struct SubPageEntry {
     #[serde(default, skip_serializing_if = "details_is_none")]
     pub details: Details,
     #[serde(default, skip_serializing_if = "is_default")]
+    pub code: bool,
+    #[serde(default, skip_serializing_if = "is_default")]
     pub include_parent: bool,
 }
 
@@ -319,8 +323,13 @@ pub enum SidebarEntry {
 #[derive(Debug, Default)]
 pub enum MetaChildren {
     Children(Vec<SidebarMetaEntry>),
-    ListSubPages(String, Vec<PageType>, bool),
-    ListSubPagesGrouped(String, Vec<PageType>, bool),
+    ListSubPages(String, Vec<PageType>, bool, bool),
+    ListSubPagesGrouped {
+        path: String,
+        tags: Vec<PageType>,
+        code: bool,
+        include_parent: bool,
+    },
     WebExtApi,
     #[default]
     None,
@@ -424,13 +433,14 @@ impl TryFrom<SidebarEntry> for SidebarMetaEntry {
                 hash,
                 title,
                 path,
+                code,
                 include_parent,
             }) => SidebarMetaEntry {
                 section: false,
                 details,
                 code: false,
                 content: SidebarMetaEntryContent::from_link_title_hash(link, title, hash),
-                children: MetaChildren::ListSubPages(path, tags, include_parent),
+                children: MetaChildren::ListSubPages(path, tags, code, include_parent),
             },
             SidebarEntry::ListSubPagesGrouped(SubPageEntry {
                 details,
@@ -439,13 +449,19 @@ impl TryFrom<SidebarEntry> for SidebarMetaEntry {
                 hash,
                 title,
                 path,
+                code,
                 include_parent,
             }) => SidebarMetaEntry {
                 section: false,
                 details,
                 code: false,
                 content: SidebarMetaEntryContent::from_link_title_hash(link, title, hash),
-                children: MetaChildren::ListSubPagesGrouped(path, tags, include_parent),
+                children: MetaChildren::ListSubPagesGrouped {
+                    path,
+                    tags,
+                    code,
+                    include_parent,
+                },
             },
             SidebarEntry::Default(BasicEntry {
                 link,
@@ -565,7 +581,7 @@ impl SidebarMetaEntry {
                     child.render(out, locale, slug, l10n)?;
                 }
             }
-            MetaChildren::ListSubPages(url, page_types, include_parent) => {
+            MetaChildren::ListSubPages(url, page_types, code, include_parent) => {
                 let url = if url.starts_with(concat!("/", default_locale().as_url_str(), "/")) {
                     Cow::Borrowed(url)
                 } else {
@@ -581,29 +597,40 @@ impl SidebarMetaEntry {
                     &url,
                     locale,
                     Some(1),
-                    None,
-                    page_types,
-                    *include_parent,
+                    ListSubPagesContext {
+                        sorter: None,
+                        page_types,
+                        code: *code,
+                        include_parent: *include_parent,
+                    },
                 )?
             }
-            MetaChildren::ListSubPagesGrouped(url, page_types, include_parent) => {
-                let url = if url.starts_with(concat!("/", default_locale().as_url_str(), "/")) {
-                    Cow::Borrowed(url)
+            MetaChildren::ListSubPagesGrouped {
+                path,
+                tags,
+                code,
+                include_parent,
+            } => {
+                let url = if path.starts_with(concat!("/", default_locale().as_url_str(), "/")) {
+                    Cow::Borrowed(path)
                 } else {
                     Cow::Owned(concat_strs!(
                         "/",
                         Locale::default().as_url_str(),
                         "/docs",
-                        url
+                        path
                     ))
                 };
                 list_sub_pages_grouped_internal(
                     out,
                     &url,
                     locale,
-                    None,
-                    page_types,
-                    *include_parent,
+                    ListSubPagesContext {
+                        sorter: None,
+                        page_types: tags,
+                        code: *code,
+                        include_parent: *include_parent,
+                    },
                 )?
             }
             MetaChildren::WebExtApi => {
diff --git a/crates/rari-doc/src/templ/templs/api_list_specs.rs b/crates/rari-doc/src/templ/templs/api_list_specs.rs
@@ -22,7 +22,7 @@ pub fn api_list_specs() -> Result<String, DocError> {
                 env.locale,
             )?;
             let out = out_by_letter.entry(first_letter).or_default();
-            write_li_with_badges(out, &page, env.locale, true)?;
+            write_li_with_badges(out, &page, env.locale, false, true)?;
         }
     }
 
diff --git a/crates/rari-doc/src/templ/templs/listsubpages.rs b/crates/rari-doc/src/templ/templs/listsubpages.rs
@@ -1,11 +1,8 @@
-use std::str::FromStr;
-
 use rari_templ_func::rari_f;
-use rari_types::fm_types::PageType;
 use rari_types::AnyArg;
 
 use crate::error::DocError;
-use crate::helpers::subpages::{self, SubPagesSorter};
+use crate::helpers::subpages::{self, ListSubPagesContext, SubPagesSorter};
 
 /// List sub pages
 #[rari_f]
@@ -33,50 +30,23 @@ pub fn list_sub_pages(
             env.locale,
             Some(SubPagesSorter::TitleNatural),
             &[],
+            false,
         )?;
     } else {
         subpages::list_sub_pages_internal(
             &mut out,
             url,
             env.locale,
             Some(depth),
-            Some(SubPagesSorter::TitleNatural),
-            &[],
-            false,
+            ListSubPagesContext {
+                sorter: Some(SubPagesSorter::TitleNatural),
+                page_types: &[],
+                code: false,
+                include_parent: false,
+            },
         )?;
     }
     out.push_str(if ordered { "</ol>" } else { "</ul>" });
 
     Ok(out)
 }
-
-#[rari_f]
-pub fn list_sub_pages_grouped(
-    url: Option<String>,
-    title: Option<String>,
-    page_types: Option<String>,
-) -> Result<String, DocError> {
-    let url = url.as_deref().unwrap_or(env.url);
-    let title = title.as_deref().unwrap_or(env.title);
-    let mut out = String::new();
-    out.push_str("<details><summary>");
-    out.push_str(&html_escape::encode_safe(title));
-    out.push_str("</summary><ol>");
-    subpages::list_sub_pages_grouped_internal(
-        &mut out,
-        url,
-        env.locale,
-        None,
-        page_types
-            .map(|pt| {
-                pt.split(',')
-                    .filter_map(|pt| PageType::from_str(pt.trim()).ok())
-                    .collect::<Vec<_>>()
-            })
-            .as_deref()
-            .unwrap_or_default(),
-        false,
-    )?;
-    out.push_str("</ol></details>");
-    Ok(out)
-}
diff --git a/crates/rari-doc/src/templ/templs/mod.rs b/crates/rari-doc/src/templ/templs/mod.rs
@@ -70,7 +70,6 @@ pub fn invoke(
         "glossary" => glossary::glossary_any,
         "csssyntax" => csssyntax::csssyntax_any,
         "listsubpages" => listsubpages::list_sub_pages_any,
-        "listsubpagesgrouped" => listsubpages::list_sub_pages_grouped_any,
         "cssinfo" => cssinfo::cssinfo_any,
         "inheritancediagram" => inheritance_diagram::inheritance_diagram_any,
         "webextexamples" => web_ext_examples::web_ext_examples_any,
diff --git a/crates/rari-tools/src/sidebars.rs b/crates/rari-tools/src/sidebars.rs
@@ -206,6 +206,7 @@ fn process_entry(entry: SidebarEntry, pairs: Pairs<'_>) -> SidebarEntry {
             title,
             path,
             include_parent,
+            code,
         }) => {
             let new_path: Option<String> = replace_pairs(Some(path), pairs);
             if new_path.is_none() {
@@ -219,6 +220,7 @@ fn process_entry(entry: SidebarEntry, pairs: Pairs<'_>) -> SidebarEntry {
                 title,
                 path: new_path.unwrap(),
                 include_parent,
+                code,
             })
         }
         SidebarEntry::ListSubPagesGrouped(SubPageEntry {
@@ -229,6 +231,7 @@ fn process_entry(entry: SidebarEntry, pairs: Pairs<'_>) -> SidebarEntry {
             title,
             path,
             include_parent,
+            code,
         }) => {
             let new_path: Option<String> = replace_pairs(Some(path), pairs);
             if new_path.is_none() {
@@ -242,6 +245,7 @@ fn process_entry(entry: SidebarEntry, pairs: Pairs<'_>) -> SidebarEntry {
                 title,
                 path: new_path.unwrap(),
                 include_parent,
+                code,
             })
         }
         SidebarEntry::Default(BasicEntry {

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ pub fn api_list_specs() -> Result<String, DocError> {`
`22`	`22`	`env.locale,`
`23`	`23`	`)?;`
`24`	`24`	`let out = out_by_letter.entry(first_letter).or_default();`
`25`		`- write_li_with_badges(out, &page, env.locale, true)?;`
	`25`	`+ write_li_with_badges(out, &page, env.locale, false, true)?;`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`