cargo-rbmt: extend docs with the often use --open arg

Author: nyonson

cargo-rbmt/justfile

@@ -20,6 +20,9 @@ _default:
 @rbmt *args: toolchains
   RBMT_LOG_LEVEL=quiet cargo rbmt {{args}}
 
+# Build and open docs.
+@docs: (rbmt "docsrs --open")
+
 # Format files.
 @fmt: (rbmt "fmt")
 

cargo-rbmt/src/docs.rs

@@ -10,7 +10,7 @@ use crate::toolchain::{prepare_toolchain, Toolchain};
 ///
 /// This verifies that `cargo doc` works correctly for users with stable Rust.
 /// Uses basic rustdoc warnings to catch common documentation issues.
-pub fn run(sh: &Shell, packages: &[Package]) -> Result<(), Box<dyn std::error::Error>> {
+pub fn run(sh: &Shell, packages: &[Package], open: bool) -> Result<(), Box<dyn std::error::Error>> {
     prepare_toolchain(sh, Toolchain::Stable)?;
 
     let mut cmd = quiet_cmd!(sh, "cargo --locked doc --all-features --no-deps");
@@ -20,6 +20,10 @@ pub fn run(sh: &Shell, packages: &[Package]) -> Result<(), Box<dyn std::error::E
         cmd = cmd.args(&["-p", &package.id]);
     }
 
+    if open {
+        cmd = cmd.arg("--open");
+    }
+
     cmd.env("RUSTDOCFLAGS", "-D warnings").run()?;
 
     Ok(())
@@ -29,7 +33,11 @@ pub fn run(sh: &Shell, packages: &[Package]) -> Result<(), Box<dyn std::error::E
 ///
 /// This emulates the docs.rs build environment by using the nightly toolchain
 /// with `--cfg docsrs` enabled. This catches docs.rs-specific issues.
-pub fn run_docsrs(sh: &Shell, packages: &[Package]) -> Result<(), Box<dyn std::error::Error>> {
+pub fn run_docsrs(
+    sh: &Shell,
+    packages: &[Package],
+    open: bool,
+) -> Result<(), Box<dyn std::error::Error>> {
     prepare_toolchain(sh, Toolchain::Nightly)?;
 
     let mut cmd = quiet_cmd!(sh, "cargo --locked doc --all-features --no-deps");
@@ -39,6 +47,10 @@ pub fn run_docsrs(sh: &Shell, packages: &[Package]) -> Result<(), Box<dyn std::e
         cmd = cmd.args(&["-p", &package.id]);
     }
 
+    if open {
+        cmd = cmd.arg("--open");
+    }
+
     cmd.env("RUSTDOCFLAGS", "--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links").run()?;
 
     Ok(())

cargo-rbmt/src/main.rs

@@ -54,9 +54,17 @@ enum Commands {
     /// Run the linter (clippy) for workspace and all crates.
     Lint,
     /// Build documentation with stable toolchain.
-    Docs,
+    Docs {
+        /// Open documentation in browser after building.
+        #[arg(long)]
+        open: bool,
+    },
     /// Build documentation with nightly toolchain for docs.rs.
-    Docsrs,
+    Docsrs {
+        /// Open documentation in browser after building.
+        #[arg(long)]
+        open: bool,
+    },
     /// Run benchmark tests for all crates.
     Bench,
     /// Run tests with specified toolchain.
@@ -164,13 +172,13 @@ fn main() {
                 eprintln!("Error running lint task: {}", e);
                 process::exit(1);
             },
-        Commands::Docs =>
-            if let Err(e) = docs::run(&sh, &packages) {
+        Commands::Docs { open } =>
+            if let Err(e) = docs::run(&sh, &packages, open) {
                 eprintln!("Error building docs: {}", e);
                 process::exit(1);
             },
-        Commands::Docsrs =>
-            if let Err(e) = docs::run_docsrs(&sh, &packages) {
+        Commands::Docsrs { open } =>
+            if let Err(e) = docs::run_docsrs(&sh, &packages, open) {
                 eprintln!("Error building docs.rs docs: {}", e);
                 process::exit(1);
             },