Add error_on_missing_preprocessor flag

Author: Pierre Gradot

examples/nop-preprocessor.rs

@@ -57,7 +57,7 @@ fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
     let renderer = sub_args
         .get_one::<String>("renderer")
         .expect("Required argument");
-    let supported = pre.supports_renderer(renderer);
+    let supported = pre.supports_renderer(renderer, false);
 
     // Signal whether the renderer is supported by exiting with 1 or 0.
     if supported {
@@ -99,7 +99,7 @@ mod nop_lib {
             Ok(book)
         }
 
-        fn supports_renderer(&self, renderer: &str) -> bool {
+        fn supports_renderer(&self, renderer: &str, _error_on_missing_preprocessor: bool) -> bool {
             renderer != "not-supported"
         }
     }

src/book/mod.rs

@@ -606,7 +606,8 @@ fn preprocessor_should_run(
 ) -> bool {
     // default preprocessors should be run by default (if supported)
     if cfg.build.use_default_preprocessors && is_default_preprocessor(preprocessor) {
-        return preprocessor.supports_renderer(renderer.name());
+        return preprocessor
+            .supports_renderer(renderer.name(), cfg.build.error_on_missing_preprocessor);
     }
 
     let key = format!("preprocessor.{}.renderers", preprocessor.name());
@@ -619,7 +620,7 @@ fn preprocessor_should_run(
             .any(|name| name == renderer_name);
     }
 
-    preprocessor.supports_renderer(renderer_name)
+    preprocessor.supports_renderer(renderer_name, cfg.build.error_on_missing_preprocessor)
 }
 
 #[cfg(test)]
@@ -877,7 +878,7 @@ mod tests {
             unimplemented!()
         }
 
-        fn supports_renderer(&self, _renderer: &str) -> bool {
+        fn supports_renderer(&self, _renderer: &str, _error_on_missing_preprocessor: bool) -> bool {
             self.0
         }
     }

src/config.rs

@@ -480,6 +480,11 @@ pub struct BuildConfig {
     pub use_default_preprocessors: bool,
     /// Extra directories to trigger rebuild when watching/serving
     pub extra_watch_dirs: Vec<PathBuf>,
+    /// Should missing a preprocessor be considered an error?
+    /// By default, the application exits if a preprocessor is missing.
+    /// Set this flag to  ̀false` to raise a warning instead and continue generation,
+    /// even if the book may be generated incorrectly.
+    pub error_on_missing_preprocessor: bool,
 }
 
 impl Default for BuildConfig {
@@ -489,6 +494,7 @@ impl Default for BuildConfig {
             create_missing: true,
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
+            error_on_missing_preprocessor: true,
         }
     }
 }
@@ -815,6 +821,7 @@ mod tests {
         build-dir = "outputs"
         create-missing = false
         use-default-preprocessors = true
+        error-on-missing-preprocessor = false
 
         [output.html]
         theme = "./themedir"
@@ -856,6 +863,7 @@ mod tests {
             create_missing: false,
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
+            error_on_missing_preprocessor: false,
         };
         let rust_should_be = RustConfig { edition: None };
         let playground_should_be = Playground {
@@ -1067,6 +1075,7 @@ mod tests {
             create_missing: true,
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
+            error_on_missing_preprocessor: true,
         };
 
         let html_should_be = HtmlConfig {

src/preprocess/cmd.rs

@@ -134,7 +134,7 @@ impl Preprocessor for CmdPreprocessor {
         })
     }
 
-    fn supports_renderer(&self, renderer: &str) -> bool {
+    fn supports_renderer(&self, renderer: &str, error_on_missing_preprocessor: bool) -> bool {
         debug!(
             "Checking if the \"{}\" preprocessor supports \"{}\"",
             self.name(),
@@ -164,11 +164,17 @@ impl Preprocessor for CmdPreprocessor {
 
         if let Err(ref e) = outcome {
             if e.kind() == io::ErrorKind::NotFound {
-                error!(
-                    "The command {} wasn't found, is the \"{}\" preprocessor installed?",
+                let message = format!(
+                    "The command \"{}\" wasn't found, is the \"{}\" preprocessor installed?",
                     self.cmd, self.name
                 );
-                std::process::exit(1);
+
+                if error_on_missing_preprocessor {
+                    error!("{message}");
+                    std::process::exit(1);
+                } else {
+                    warn!("{message}");
+                }
             }
         }
 

src/preprocess/mod.rs

@@ -63,7 +63,9 @@ pub trait Preprocessor {
     /// particular renderer.
     ///
     /// By default, always returns `true`.
-    fn supports_renderer(&self, _renderer: &str) -> bool {
+    /// Set `error_on_missing_preprocessor` to `true` to exit the application is a preprocessor is missing,
+    /// or to `false` to simply raise a warning and continue generation.
+    fn supports_renderer(&self, _renderer: &str, _error_on_missing_preprocessor: bool) -> bool {
         true
     }
 }

tests/custom_preprocessors.rs

@@ -15,7 +15,7 @@ fn example() -> CmdPreprocessor {
 fn example_supports_whatever() {
     let cmd = example();
 
-    let got = cmd.supports_renderer("whatever");
+    let got = cmd.supports_renderer("whatever", false);
 
     assert_eq!(got, true);
 }
@@ -24,7 +24,7 @@ fn example_supports_whatever() {
 fn example_doesnt_support_not_supported() {
     let cmd = example();
 
-    let got = cmd.supports_renderer("not-supported");
+    let got = cmd.supports_renderer("not-supported", false);
 
     assert_eq!(got, false);
 }

tests/init.rs

@@ -94,7 +94,7 @@ fn run_mdbook_init_with_custom_book_and_src_locations() {
     let contents = fs::read_to_string(temp.path().join("book.toml")).unwrap();
     assert_eq!(
         contents,
-        "[book]\nauthors = []\nlanguage = \"en\"\nmultilingual = false\nsrc = \"in\"\n\n[build]\nbuild-dir = \"out\"\ncreate-missing = true\nextra-watch-dirs = []\nuse-default-preprocessors = true\n"
+        "[book]\nauthors = []\nlanguage = \"en\"\nmultilingual = false\nsrc = \"in\"\n\n[build]\nbuild-dir = \"out\"\ncreate-missing = true\nerror-on-missing-preprocessor = true\nextra-watch-dirs = []\nuse-default-preprocessors = true\n"
     );
 }