Add config.rust.package-dir and fix cargo output parser (maybe not for the last time)

Author: bobhy

src/book/mod.rs

@@ -306,13 +306,13 @@ impl MDBook {
 
         let color_output = std::io::stderr().is_terminal();
 
-        // get extra args we'll need for rustdoc
-        // assumes current working directory is project root, eventually
-        // pick up manifest directory from some config.
+        // get extra args we'll need for rustdoc, if config points to a cargo project.
 
         let mut extern_args = ExternArgs::new();
-        extern_args.load(&std::env::current_dir()?)?;
-
+        if let Some(package_dir) = &self.config.rust.package_dir {
+            extern_args.load(&package_dir)?;
+        }
+ 
         let mut failed = false;
         for item in book.iter() {
             if let BookItem::Chapter(ref ch) = *item {

src/config.rs

@@ -497,6 +497,8 @@ impl Default for BuildConfig {
 #[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(default, rename_all = "kebab-case")]
 pub struct RustConfig {
+    /// Path to a Cargo package
+    pub package_dir: Option<PathBuf>,
     /// Rust edition used in playground
     pub edition: Option<RustEdition>,
 }
@@ -798,6 +800,9 @@ mod tests {
         create-missing = false
         use-default-preprocessors = true
 
+        [rust]
+        package-dir = "."
+
         [output.html]
         theme = "./themedir"
         default-theme = "rust"
@@ -839,7 +844,10 @@ mod tests {
             use_default_preprocessors: true,
             extra_watch_dirs: Vec::new(),
         };
-        let rust_should_be = RustConfig { edition: None };
+        let rust_should_be = RustConfig {
+            package_dir: Some(PathBuf::from(".")),
+            edition: None,
+        };
         let playground_should_be = Playground {
             editable: true,
             copyable: true,
@@ -918,6 +926,7 @@ mod tests {
         assert_eq!(got.book, book_should_be);
 
         let rust_should_be = RustConfig {
+            package_dir: None,
             edition: Some(RustEdition::E2015),
         };
         let got = Config::from_str(src).unwrap();
@@ -937,6 +946,7 @@ mod tests {
         "#;
 
         let rust_should_be = RustConfig {
+            package_dir: None,
             edition: Some(RustEdition::E2018),
         };
 
@@ -957,6 +967,7 @@ mod tests {
         "#;
 
         let rust_should_be = RustConfig {
+            package_dir: None,
             edition: Some(RustEdition::E2021),
         };
 
@@ -1356,4 +1367,19 @@ mod tests {
             false
         );
     }
+
+
+    /* todo -- make this test fail, as it should
+    #[test]
+    #[should_panic(expected = "Invalid configuration file")]
+    // invalid key in config file should really generate an error...
+    fn invalid_rust_setting() {
+        let src = r#"
+        [rust]
+        foo = "bar"
+        "#;
+
+        Config::from_str(src).unwrap();
+    }
+    */
 }

src/utils/extern_args.rs

@@ -1,7 +1,7 @@
 //! Get "compiler" args from cargo
 
 use crate::errors::*;
-use log::info;
+use log::{info, warn};
 use std::fs::File;
 use std::path::{Path, PathBuf};
 use std::process::Command;
@@ -29,7 +29,7 @@ use std::process::Command;
 /// extern_args.load(&proj_root)?;
 ///
 /// // then, when actually invoking rustdoc or some other compiler-like tool...
-/// 
+///
 /// assert!(extern_args.get_args().iter().any(|e| e == "-L")); // args contains "-L".to_string()
 /// assert!(extern_args.get_args().iter().any(|e| e == "--extern"));
 /// # Ok(())
@@ -86,6 +86,7 @@ impl ExternArgs {
 
     /// Parse response stdout+stderr response from `cargo build`
     /// into arguments we can use to invoke rustdoc.
+    /// Stop at first line that traces a compiler invocation.
     ///
     /// >>> This parser is broken, doesn't handle arg values with embedded spaces (single quoted).
     /// Fortunately, the args we care about (so far) don't have those kinds of values.
@@ -105,9 +106,15 @@ impl ExternArgs {
                         _ => {}
                     }
                 }
+
+                return Ok(());
             };
         }
 
+        if self.suffix_args.len() < 1 {
+            warn!("Couldn't extract --extern args from Cargo, is current directory == cargo project root?");
+        }
+
         Ok(())
     }
 
@@ -123,12 +130,34 @@ mod test {
 
     #[test]
     fn parse_response_parses_string() -> Result<()> {
-        let resp = std::fs::read_to_string("tests/t1.txt")?;
+        let test_str = r###"
+        Fresh unicode-ident v1.0.14
+        Fresh cfg-if v1.0.0
+        Fresh memchr v2.7.4
+        Fresh autocfg v1.4.0
+        Fresh version_check v0.9.5
+        --- clip ---
+        Fresh bytecount v0.6.8
+        Fresh leptos_router v0.7.0
+        Fresh leptos_meta v0.7.0
+        Fresh console_error_panic_hook v0.1.7
+        Fresh mdbook-keeper v0.5.0
+        Dirty leptos-book v0.1.0 (/home/bobhy/src/localdep/book): the file `src/lib.rs` has changed (1733758773.052514835s, 10h 32m 29s after last build at 1733720824.458358565s)
+    Compiling leptos-book v0.1.0 (/home/bobhy/src/localdep/book)
+      Running `/home/bobhy/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/bin/rustc --crate-name leptos_book --edition=2021 src/lib.rs --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --crate-type cdylib --crate-type rlib --emit=dep-info,link -C embed-bitcode=no -C debuginfo=2 --check-cfg 'cfg(docsrs)' --check-cfg 'cfg(feature, values("hydrate", "ssr"))' -C metadata=2eec49d479de095c --out-dir /home/bobhy/src/localdep/book/target/debug/deps -C incremental=/home/bobhy/src/localdep/book/target/debug/incremental -L dependency=/home/bobhy/src/localdep/book/target/debug/deps --extern console_error_panic_hook=/home/bobhy/src/localdep/book/target/debug/deps/libconsole_error_panic_hook-d34cf0116774f283.rlib --extern http=/home/bobhy/src/localdep/book/target/debug/deps/libhttp-d4d503240b7a6b18.rlib --extern leptos=/home/bobhy/src/localdep/book/target/debug/deps/libleptos-1dabf2e09ca58f3d.rlib --extern leptos_meta=/home/bobhy/src/localdep/book/target/debug/deps/libleptos_meta-df8ce1704acca063.rlib --extern leptos_router=/home/bobhy/src/localdep/book/target/debug/deps/libleptos_router-df109cd2ee44b2a0.rlib --extern mdbook_keeper_lib=/home/bobhy/src/localdep/book/target/debug/deps/libmdbook_keeper_lib-f4016aaf2c5da5f2.rlib --extern thiserror=/home/bobhy/src/localdep/book/target/debug/deps/libthiserror-acc5435cdf9551fe.rlib --extern wasm_bindgen=/home/bobhy/src/localdep/book/target/debug/deps/libwasm_bindgen-89a7b1dccd9668ae.rlib`
+      Running `/home/bobhy/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/bin/rustc --crate-name leptos_book --edition=2021 src/main.rs --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --crate-type bin --emit=dep-info,link -C embed-bitcode=no -C debuginfo=2 --check-cfg 'cfg(docsrs)' --check-cfg 'cfg(feature, values("hydrate", "ssr"))' -C metadata=24fbc99376c5eff3 -C extra-filename=-24fbc99376c5eff3 --out-dir /home/bobhy/src/localdep/book/target/debug/deps -C incremental=/home/bobhy/src/localdep/book/target/debug/incremental -L dependency=/home/bobhy/src/localdep/book/target/debug/deps --extern console_error_panic_hook=/home/bobhy/src/localdep/book/target/debug/deps/libconsole_error_panic_hook-d34cf0116774f283.rlib --extern http=/home/bobhy/src/localdep/book/target/debug/deps/libhttp-d4d503240b7a6b18.rlib --extern leptos=/home/bobhy/src/localdep/book/target/debug/deps/libleptos-1dabf2e09ca58f3d.rlib --extern leptos_book=/home/bobhy/src/localdep/book/target/debug/deps/libleptos_book.rlib --extern leptos_meta=/home/bobhy/src/localdep/book/target/debug/deps/libleptos_meta-df8ce1704acca063.rlib --extern leptos_router=/home/bobhy/src/localdep/book/target/debug/deps/libleptos_router-df109cd2ee44b2a0.rlib --extern mdbook_keeper_lib=/home/bobhy/src/localdep/book/target/debug/deps/libmdbook_keeper_lib-f4016aaf2c5da5f2.rlib --extern thiserror=/home/bobhy/src/localdep/book/target/debug/deps/libthiserror-acc5435cdf9551fe.rlib --extern wasm_bindgen=/home/bobhy/src/localdep/book/target/debug/deps/libwasm_bindgen-89a7b1dccd9668ae.rlib`
+     Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.60s
+ 
+     "###;
+
         let mut ea = ExternArgs::new();
-        ea.parse_response(&resp)?;
+        ea.parse_response(&test_str)?;
+
+        let args = ea.get_args();
+        assert_eq!(18, args.len());
 
-        let sfx = ea.get_args();
-        assert!(sfx.len() > 0);
+        assert_eq!(1, args.iter().filter(|i| *i == "-L").count());
+        assert_eq!(8, args.iter().filter(|i| *i == "--extern").count());
 
         Ok(())
     }