skip build flag for quicker iteration

Author: matcool

src/analyze.rs

@@ -84,26 +84,20 @@ async fn analyze_with_clang(config: Arc<Config>, args: &[String]) -> Result<(),
     Ok(())
 }
 
-async fn analyze_with_cmake(config: Arc<Config>) -> Result<(), String> {
+async fn analyze_with_cmake(config: Arc<Config>, skip_build: bool) -> Result<(), String> {
     // Configure the cmake project
-    cmake::cmake_configure(
-        &config.cmake.as_ref().unwrap().build_dir,
-        &config
-            .cmake
-            .as_ref()
-            .unwrap()
-            .config_args,
-    )?;
+    if !skip_build {
+        cmake::cmake_configure(
+            &config.cmake.as_ref().unwrap().build_dir,
+            &config.cmake.as_ref().unwrap().config_args,
+        )?;
+    }
 
     // Build the cmake project
-    if config.cmake.as_ref().unwrap().build {
+    if !skip_build && config.cmake.as_ref().unwrap().build {
         cmake::cmake_build(
             &config.cmake.as_ref().unwrap().build_dir,
-            &config
-                .cmake
-                .as_ref()
-                .unwrap()
-                .build_args,
+            &config.cmake.as_ref().unwrap().build_args,
         )?;
     }
 
@@ -116,7 +110,7 @@ async fn analyze_with_cmake(config: Arc<Config>) -> Result<(), String> {
     Ok(())
 }
 
-pub async fn create_docs(config: Arc<Config>) -> Result<(), String> {
+pub async fn create_docs(config: Arc<Config>, skip_build: bool) -> Result<(), String> {
     // Execute prebuild commands
     if let Some(cmds) = config.run.as_ref().map(|c| &c.prebuild) {
         for cmd in cmds {
@@ -126,7 +120,7 @@ pub async fn create_docs(config: Arc<Config>) -> Result<(), String> {
 
     // Build based on mode
     if config.cmake.is_some() {
-        analyze_with_cmake(config).await
+        analyze_with_cmake(config, skip_build).await
     }
     // Build with extra compile args only
     else {

src/cmake.rs

@@ -38,6 +38,8 @@ impl CompileCommand {
             .chain(vec![format!("-working-directory={}", self.directory.to_str().unwrap())])
             // Add extra compile args
             .chain(config.analysis.compile_args.clone())
+            // Retain comments from external libraries that might be included in the docs
+            .chain(vec!["-fretain-comments-from-system-headers".into()])
             .collect();
 
         // Passing -c crashes LibClang

src/main.rs

@@ -2,20 +2,26 @@
 #![feature(iter_advance_by)]
 #![feature(iter_intersperse)]
 
-use crate::{analyze::create_docs, url::UrlPath, normalize::Normalize};
+use crate::{analyze::create_docs, normalize::Normalize, url::UrlPath};
 use clap::Parser;
 use config::Config;
-use std::{fs, path::{PathBuf, Path}, process::exit, io, time::Instant};
+use std::{
+    error::Error,
+    fs, io,
+    path::{Path, PathBuf},
+    process::exit,
+    time::Instant,
+};
 
 mod analyze;
+mod annotation;
 mod builder;
 mod cmake;
 mod config;
 mod html;
-mod url;
-mod normalize;
-mod annotation;
 mod lookahead;
+mod normalize;
+mod url;
 
 #[derive(Parser, Debug)]
 #[command(name("Flash"), version, about)]
@@ -31,6 +37,10 @@ struct Args {
     /// Whether to overwrite output directory if it already exists
     #[arg(long, default_value_t = false)]
     overwrite: bool,
+
+    /// Whether to skip invoking CMake entirely, relies on existing build dir.
+    #[arg(long, default_value_t = false, hide = true)]
+    skip_build: bool,
 }
 
 fn remove_dir_contents<P: AsRef<Path>>(path: P) -> io::Result<()> {
@@ -49,7 +59,7 @@ fn remove_dir_contents<P: AsRef<Path>>(path: P) -> io::Result<()> {
 }
 
 #[tokio::main]
-async fn main() -> Result<(), String> {
+async fn main() -> Result<(), Box<dyn Error>> {
     let args = Args::parse();
 
     // Check if output dir exists
@@ -59,19 +69,15 @@ async fn main() -> Result<(), String> {
         // Then overwrite must be specified
         && !args.overwrite
     {
-        println!(
+        eprintln!(
             "Output directory {} already exists and no --overwrite option was specified, aborting",
-            args.output.to_str().unwrap()
+            args.output.to_string_lossy()
         );
         exit(1);
     }
 
-    // Clear output dir if it exists
-    if args.output.exists() {
-        remove_dir_contents(&args.output).unwrap();
-    }
-    else {
-        fs::create_dir_all(&args.output).unwrap();
+    if !args.output.exists() {
+        fs::create_dir_all(&args.output)?;
     }
 
     let relative_output = if args.output.is_relative() {
@@ -86,12 +92,12 @@ async fn main() -> Result<(), String> {
     let full_output = if args.output.is_absolute() {
         args.output
     } else {
-        std::env::current_dir().unwrap().join(args.output).normalize()
+        std::env::current_dir()?.join(args.output).normalize()
     };
     let full_input = if args.input.is_absolute() {
         args.input
     } else {
-        std::env::current_dir().unwrap().join(args.input).normalize()
+        std::env::current_dir()?.join(args.input).normalize()
     };
     std::env::set_current_dir(&full_input).expect(
         "Unable to set input dir as working directory \
@@ -107,8 +113,12 @@ async fn main() -> Result<(), String> {
         conf.project.name, conf.project.version
     );
     let now = Instant::now();
-    create_docs(conf.clone()).await?;
-    println!("Docs built for {} in {}s", conf.project.name, now.elapsed().as_secs());
+    create_docs(conf.clone(), args.skip_build).await?;
+    println!(
+        "Docs built for {} in {}s",
+        conf.project.name,
+        now.elapsed().as_secs()
+    );
 
     Ok(())
 }