Add show files by default for Trunk (#13)

RustForWeb · Oct 23, 2024 · 7a05c50 · 7a05c50
1 parent 321e725
commit 7a05c50
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 4 deletions.
diff --git a/book/src/trunk.md b/book/src/trunk.md
@@ -72,6 +72,9 @@ features = ["button"]
 # Relative to the package root.
 files = ["src/button.rs"]
 
+# Whether to show files by default (optional).
+show_files = true
+
 # URL query for the iframe URL (optional).
 # The leading question mark is optional.
 url_query = "?key=value"

diff --git a/book/theme/trunk.css b/book/theme/trunk.css
@@ -15,6 +15,13 @@
     display: flex;
 }
 
+.mdbook-trunk-files-header {
+    padding: 0.5rem 1rem;
+    font-weight: bold;
+    font-size: 1.6rem;
+    line-height: 1.45em;
+}
+
 .mdbook-trunk-file {
     background-color: var(--table-alternate-bg);
     padding: 0.5rem 1rem;

diff --git a/packages/mdbook-trunk/src/config.rs b/packages/mdbook-trunk/src/config.rs
@@ -9,6 +9,7 @@ pub struct Config {
     pub package: String,
     pub features: Vec<String>,
     pub files: Option<Vec<String>>,
+    pub show_files: Option<bool>,
     pub url_query: Option<String>,
     pub url_fragment: Option<String>,
     pub attributes: Option<HashMap<String, String>>,

diff --git a/packages/mdbook-trunk/src/theme/trunk.css b/packages/mdbook-trunk/src/theme/trunk.css
@@ -15,6 +15,13 @@
     display: flex;
 }
 
+.mdbook-trunk-files-header {
+    padding: 0.5rem 1rem;
+    font-weight: bold;
+    font-size: 1.6rem;
+    line-height: 1.45em;
+}
+
 .mdbook-trunk-file {
     background-color: var(--table-alternate-bg);
     padding: 0.5rem 1rem;

diff --git a/packages/mdbook-trunk/src/trunk.rs b/packages/mdbook-trunk/src/trunk.rs
@@ -66,7 +66,7 @@ fn files(workspace: &Workspace, config: &Config) -> Result<String> {
     let mut content_elements: Vec<String> = vec![];
 
     if let Some(files) = config.files.as_ref() {
-        for file in files {
+        for (index, file) in files.iter().enumerate() {
             let file_path = package_root.join(file);
 
             info!(
@@ -78,7 +78,10 @@ fn files(workspace: &Workspace, config: &Config) -> Result<String> {
             let content = fs::read_to_string(&file_path)?;
 
             header_elements.push(format!(
-                "<button class=\"mdbook-trunk-file\" data-file=\"{}\">{}</button>",
+                "<button class=\"mdbook-trunk-file{}\" data-file=\"{}\">{}</button>",
+                (config.show_files.unwrap_or(false) && index == 0)
+                    .then_some(" active")
+                    .unwrap_or_default(),
                 file,
                 file_path
                     .file_name()
@@ -87,7 +90,8 @@ fn files(workspace: &Workspace, config: &Config) -> Result<String> {
             ));
 
             content_elements.push(format!(
-                "<div class=\"mdbook-trunk-file-content hidden\" data-file=\"{}\">\n\n```{}\n{}\n```\n\n</div>",
+                "<div class=\"mdbook-trunk-file-content{}\" data-file=\"{}\">\n\n```{}\n{}\n```\n\n</div>",
+                (!(config.show_files.unwrap_or(false) && index == 0)).then_some(" hidden").unwrap_or_default(),
                 file,
                 language,
                 content
@@ -96,7 +100,7 @@ fn files(workspace: &Workspace, config: &Config) -> Result<String> {
     }
 
     Ok(format!(
-        "<div class=\"mdbook-trunk-files-container\">\n<nav class=\"mdbook-trunk-files\">\n{}\n</nav>\n{}\n</div>",
+        "<div class=\"mdbook-trunk-files-container\">\n<nav class=\"mdbook-trunk-files\">\n<span class=\"mdbook-trunk-files-header\">Source code</span>\n{}\n</nav>\n{}\n</div>",
         header_elements.join("\n"),
         content_elements.join("\n")
     ))