Add --disable-minification option

GuillaumeGomez · GuillaumeGomez · commit 1ffa0a20a1e7 · 2025-06-25T17:41:09.000+02:00
diff --git a/src/cmd/build.rs b/src/cmd/build.rs
@@ -10,6 +10,7 @@ pub fn make_subcommand() -> Command {
         .about("Builds a book from its markdown files")
         .arg_dest_dir()
         .arg_root_dir()
+        .arg_disable_minification()
         .arg_open()
 }
 
@@ -21,6 +22,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
     if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {
         book.config.build.build_dir = dest_dir.into();
     }
+    if let Some(true) = args.get_one::<bool>("disable-minification") {
+        book.config.build.minification = false;
+    }
 
     book.build()?;
 
diff --git a/src/cmd/command_prelude.rs b/src/cmd/command_prelude.rs
@@ -37,6 +37,15 @@ pub trait CommandExt: Sized {
         self._arg(arg!(-o --open "Opens the compiled book in a web browser"))
     }
 
+    fn arg_disable_minification(self) -> Self {
+        self._arg(
+            Arg::new("disable-minification")
+                .long("disable-minification")
+                .action(clap::ArgAction::SetTrue)
+                .help("Disable CSS and JS minification"),
+        )
+    }
+
     #[cfg(any(feature = "watch", feature = "serve"))]
     fn arg_watcher(self) -> Self {
         #[cfg(feature = "watch")]
diff --git a/src/cmd/serve.rs b/src/cmd/serve.rs
@@ -42,6 +42,7 @@ pub fn make_subcommand() -> Command {
                 .help("Port to use for HTTP connections"),
         )
         .arg_open()
+        .arg_disable_minification()
         .arg_watcher()
 }
 
@@ -63,6 +64,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
         if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {
             book.config.build.build_dir = dest_dir.into();
         }
+        if let Some(true) = args.get_one::<bool>("disable-minification") {
+            book.config.build.minification = false;
+        }
         // Override site-url for local serving of the 404 file
         book.config.set("output.html.site-url", "/").unwrap();
     };
diff --git a/src/cmd/test.rs b/src/cmd/test.rs
@@ -32,6 +32,7 @@ pub fn make_subcommand() -> Command {
                     search path when building tests",
                 ),
         )
+        .arg_disable_minification()
 }
 
 // test command implementation
@@ -49,6 +50,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
     if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {
         book.config.build.build_dir = dest_dir.to_path_buf();
     }
+    if let Some(true) = args.get_one::<bool>("disable-minification") {
+        book.config.build.minification = false;
+    }
     match chapter {
         Some(_) => book.test_chapter(library_paths, chapter),
         None => book.test(library_paths),
diff --git a/src/cmd/watch.rs b/src/cmd/watch.rs
@@ -14,6 +14,7 @@ pub fn make_subcommand() -> Command {
         .arg_dest_dir()
         .arg_root_dir()
         .arg_open()
+        .arg_disable_minification()
         .arg_watcher()
 }
 
@@ -41,6 +42,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
         if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {
             book.config.build.build_dir = dest_dir.into();
         }
+        if let Some(true) = args.get_one::<bool>("disable-minification") {
+            book.config.build.minification = false;
+        }
     };
     update_config(&mut book);
 
diff --git a/src/config.rs b/src/config.rs
@@ -496,6 +496,8 @@ pub struct BuildConfig {
     pub use_default_preprocessors: bool,
     /// Extra directories to trigger rebuild when watching/serving
     pub extra_watch_dirs: Vec<PathBuf>,
+    /// Whether or not JS and CSS files are minified.
+    pub minification: bool,
 }
 
 impl Default for BuildConfig {
@@ -505,6 +507,7 @@ impl Default for BuildConfig {
             create_missing: true,
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
+            minification: true,
         }
     }
 }
@@ -872,6 +875,7 @@ mod tests {
             create_missing: false,
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
+            minification: true,
         };
         let rust_should_be = RustConfig { edition: None };
         let playground_should_be = Playground {
@@ -1083,6 +1087,7 @@ mod tests {
             create_missing: true,
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
+            minification: true,
         };
 
         let html_should_be = HtmlConfig {
diff --git a/src/front-end/mod.rs b/src/front-end/mod.rs
@@ -53,7 +53,12 @@ pub enum ContentToMinify<'a> {
 }
 
 impl<'a> ContentToMinify<'a> {
-    pub fn minified(self) -> Vec<u8> {
+    /// If `minification` is false, it simply returns the inner data converted into a `Vec`.
+    pub fn minified(self, minification: bool) -> Vec<u8> {
+        if !minification {
+            let (Self::CSS(data) | Self::JS(data)) = self;
+            return data.as_bytes().to_owned();
+        }
         let mut out = Vec::new();
         self.write_into(&mut out).unwrap();
         out
@@ -104,9 +109,9 @@ pub struct Theme {
 impl Theme {
     /// Creates a `Theme` from the given `theme_dir`.
     /// If a file is found in the theme dir, it will override the default version.
-    pub fn new<P: AsRef<Path>>(theme_dir: P) -> Self {
+    pub fn new<P: AsRef<Path>>(theme_dir: P, minification: bool) -> Self {
         let theme_dir = theme_dir.as_ref();
-        let mut theme = Theme::default();
+        let mut theme = Self::new_with_set_fields(minification);
 
         // If the theme directory doesn't exist there's no point continuing...
         if !theme_dir.exists() || !theme_dir.is_dir() {
@@ -202,29 +207,27 @@ impl Theme {
 
         theme
     }
-}
 
-impl Default for Theme {
-    fn default() -> Theme {
+    fn new_with_set_fields(minification: bool) -> Self {
         Theme {
             index: INDEX.to_owned(),
             head: HEAD.to_owned(),
             redirect: REDIRECT.to_owned(),
             header: HEADER.to_owned(),
             toc_js: TOC_JS.to_owned(),
             toc_html: TOC_HTML.to_owned(),
-            chrome_css: CHROME_CSS.minified(),
-            general_css: GENERAL_CSS.minified(),
-            print_css: PRINT_CSS.minified(),
-            variables_css: VARIABLES_CSS.minified(),
+            chrome_css: CHROME_CSS.minified(minification),
+            general_css: GENERAL_CSS.minified(minification),
+            print_css: PRINT_CSS.minified(minification),
+            variables_css: VARIABLES_CSS.minified(minification),
             fonts_css: None,
             font_files: Vec::new(),
             favicon_png: Some(FAVICON_PNG.to_owned()),
             favicon_svg: Some(FAVICON_SVG.to_owned()),
-            js: JS.minified(),
-            highlight_css: HIGHLIGHT_CSS.minified(),
-            tomorrow_night_css: TOMORROW_NIGHT_CSS.minified(),
-            ayu_highlight_css: AYU_HIGHLIGHT_CSS.minified(),
+            js: JS.minified(minification),
+            highlight_css: HIGHLIGHT_CSS.minified(minification),
+            tomorrow_night_css: TOMORROW_NIGHT_CSS.minified(minification),
+            ayu_highlight_css: AYU_HIGHLIGHT_CSS.minified(minification),
             highlight_js: HIGHLIGHT_JS.to_owned(),
             clipboard_js: CLIPBOARD_JS.to_owned(),
         }
@@ -258,8 +261,9 @@ mod tests {
         let non_existent = PathBuf::from("/non/existent/directory/");
         assert!(!non_existent.exists());
 
-        let should_be = Theme::default();
-        let got = Theme::new(&non_existent);
+        let minification = false;
+        let should_be = Theme::new_with_set_fields(minification);
+        let got = Theme::new(&non_existent, minification);
 
         assert_eq!(got, should_be);
     }
@@ -297,7 +301,7 @@ mod tests {
             File::create(&temp.path().join(file)).unwrap();
         }
 
-        let got = Theme::new(temp.path());
+        let got = Theme::new(temp.path(), false);
 
         let empty = Theme {
             index: Vec::new(),
@@ -329,13 +333,13 @@ mod tests {
     fn favicon_override() {
         let temp = TempFileBuilder::new().prefix("mdbook-").tempdir().unwrap();
         fs::write(temp.path().join("favicon.png"), "1234").unwrap();
-        let got = Theme::new(temp.path());
+        let got = Theme::new(temp.path(), false);
         assert_eq!(got.favicon_png.as_ref().unwrap(), b"1234");
         assert_eq!(got.favicon_svg, None);
 
         let temp = TempFileBuilder::new().prefix("mdbook-").tempdir().unwrap();
         fs::write(temp.path().join("favicon.svg"), "4567").unwrap();
-        let got = Theme::new(temp.path());
+        let got = Theme::new(temp.path(), false);
         assert_eq!(got.favicon_png, None);
         assert_eq!(got.favicon_svg.as_ref().unwrap(), b"4567");
     }
diff --git a/src/renderer/html_handlebars/hbs_renderer.rs b/src/renderer/html_handlebars/hbs_renderer.rs
@@ -330,6 +330,7 @@ impl Renderer for HtmlHandlebars {
         let destination = &ctx.destination;
         let book = &ctx.book;
         let build_dir = ctx.root.join(&ctx.config.build.build_dir);
+        let minification = ctx.config.build.minification;
 
         if destination.exists() {
             utils::fs::remove_dir_content(destination)
@@ -350,7 +351,7 @@ impl Renderer for HtmlHandlebars {
             None => ctx.root.join("theme"),
         };
 
-        let theme = theme::Theme::new(theme_dir);
+        let theme = theme::Theme::new(theme_dir, minification);
 
         debug!("Register the index handlebars template");
         handlebars.register_template_string("index", String::from_utf8(theme.index.clone())?)?;
@@ -389,15 +390,15 @@ impl Renderer for HtmlHandlebars {
             let default = crate::config::Search::default();
             let search = html_config.search.as_ref().unwrap_or(&default);
             if search.enable {
-                super::search::create_files(&search, &mut static_files, &book)?;
+                super::search::create_files(&search, &mut static_files, &book, minification)?;
             }
         }
 
         debug!("Render toc js");
         {
             let rendered_toc = handlebars.render("toc_js", &data)?;
             let rendered_toc = ContentToMinify::JS(&rendered_toc);
-            static_files.add_owned_builtin("toc.js", rendered_toc.minified());
+            static_files.add_owned_builtin("toc.js", rendered_toc.minified(minification));
             debug!("Creating toc.js ✓");
         }
 
diff --git a/src/renderer/html_handlebars/search.rs b/src/renderer/html_handlebars/search.rs
@@ -31,6 +31,7 @@ pub fn create_files(
     search_config: &Search,
     static_files: &mut StaticFiles,
     book: &Book,
+    minification: bool,
 ) -> Result<()> {
     let mut index = IndexBuilder::new()
         .add_field_with_tokenizer("title", Box::new(&tokenize))
@@ -74,7 +75,7 @@ pub fn create_files(
             )
             .as_bytes(),
         );
-        static_files.add_owned_builtin("searcher.js", searcher::JS.minified());
+        static_files.add_owned_builtin("searcher.js", searcher::JS.minified(minification));
         static_files.add_builtin("mark.min.js", searcher::MARK_JS);
         static_files.add_builtin("elasticlunr.min.js", searcher::ELASTICLUNR_JS);
         debug!("Copying search files ✓");
diff --git a/tests/testsuite/init.rs b/tests/testsuite/init.rs
@@ -185,6 +185,7 @@ src = "in"
 build-dir = "out"
 create-missing = true
 extra-watch-dirs = []
+minification = true
 use-default-preprocessors = true
 
 "#]],

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ pub fn make_subcommand() -> Command {`
`10`	`10`	`.about("Builds a book from its markdown files")`
`11`	`11`	`.arg_dest_dir()`
`12`	`12`	`.arg_root_dir()`
	`13`	`+ .arg_disable_minification()`
`13`	`14`	`.arg_open()`
`14`	`15`	`}`
`15`	`16`
`@@ -21,6 +22,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {`
`21`	`22`	`if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {`
`22`	`23`	`book.config.build.build_dir = dest_dir.into();`
`23`	`24`	`}`
	`25`	`+ if let Some(true) = args.get_one::<bool>("disable-minification") {`
	`26`	`+ book.config.build.minification = false;`
	`27`	`+ }`
`24`	`28`
`25`	`29`	`book.build()?;`
`26`	`30`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ pub fn make_subcommand() -> Command {`
`42`	`42`	`.help("Port to use for HTTP connections"),`
`43`	`43`	`)`
`44`	`44`	`.arg_open()`
	`45`	`+ .arg_disable_minification()`
`45`	`46`	`.arg_watcher()`
`46`	`47`	`}`
`47`	`48`
`@@ -63,6 +64,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {`
`63`	`64`	`if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {`
`64`	`65`	`book.config.build.build_dir = dest_dir.into();`
`65`	`66`	`}`
	`67`	`+ if let Some(true) = args.get_one::<bool>("disable-minification") {`
	`68`	`+ book.config.build.minification = false;`
	`69`	`+ }`
`66`	`70`	`// Override site-url for local serving of the 404 file`
`67`	`71`	`book.config.set("output.html.site-url", "/").unwrap();`
`68`	`72`	`};`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ pub fn make_subcommand() -> Command {`
`32`	`32`	`search path when building tests",`
`33`	`33`	`),`
`34`	`34`	`)`
	`35`	`+ .arg_disable_minification()`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`// test command implementation`
`@@ -49,6 +50,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {`
`49`	`50`	`if let Some(dest_dir) = args.get_one::<PathBuf>("dest-dir") {`
`50`	`51`	`book.config.build.build_dir = dest_dir.to_path_buf();`
`51`	`52`	`}`
	`53`	`+ if let Some(true) = args.get_one::<bool>("disable-minification") {`
	`54`	`+ book.config.build.minification = false;`
	`55`	`+ }`
`52`	`56`	`match chapter {`
`53`	`57`	`Some(_) => book.test_chapter(library_paths, chapter),`
`54`	`58`	`None => book.test(library_paths),`