clap_doc_generator 0.2.1

Automatically generate CLI documentation from clap definitions and update readme files
Documentation
use ignore::WalkBuilder;
use std::fs;
use std::path::Path;

use super::datamodel::CargoToml;
pub use super::datamodel::ScanOptions;
pub use super::datamodel::Target;

pub fn find_projects(options: &ScanOptions) -> Result<Vec<Target>, String> {
    match options.readme_name {
        Some(readme_name) => find_by_readme(options.root_dir, options.recursive, readme_name),
        None => find_by_cargo(options.root_dir, options.recursive),
    }
}

fn find_by_readme(
    root_dir: &Path,
    recursive: bool,
    readme_name: &str,
) -> Result<Vec<Target>, String> {
    let readme_name_lower = readme_name.to_lowercase();

    let walker = build_walker(root_dir, recursive);
    let mut targets = Vec::new();

    for entry in walker.flatten() {
        let path = entry.path();

        if !path.is_file() {
            continue;
        }

        let file_name = path
            .file_name()
            .and_then(|n| n.to_str())
            .unwrap_or_default();

        if file_name.to_lowercase() != readme_name_lower {
            continue;
        }

        let readme_path = path.to_path_buf();

        match resolve_clap_project_from_readme(&readme_path) {
            Some(target) => targets.push(target),
            None => {
                eprintln!(
                    "  (!) {} has no parent clap project, skipping",
                    readme_path.display()
                );
            }
        }
    }

    if targets.is_empty() {
        return Err(format!(
            "No files named '{readme_name}' with a parent clap project found"
        ));
    }

    Ok(targets)
}

fn find_by_cargo(root_dir: &Path, recursive: bool) -> Result<Vec<Target>, String> {
    let walker = build_walker(root_dir, recursive);
    let mut targets = Vec::new();

    for entry in walker.flatten() {
        let path = entry.path();

        if !path.is_file() {
            continue;
        }

        let file_name = path
            .file_name()
            .and_then(|n| n.to_str())
            .unwrap_or_default();

        if file_name != "Cargo.toml" {
            continue;
        }

        let project_dir = match path.parent() {
            Some(dir) => dir,
            None => continue,
        };

        if let Some(target) = try_as_clap_project(project_dir, None) {
            targets.push(target);
        }
    }

    if targets.is_empty() {
        return Err("No clap projects found".to_string());
    }

    Ok(targets)
}

fn build_walker(root_dir: &Path, recursive: bool) -> ignore::Walk {
    let mut builder = WalkBuilder::new(root_dir);
    builder.standard_filters(true).follow_links(true);

    if !recursive {
        builder.max_depth(Some(1));
    }

    builder.build()
}

fn resolve_clap_project_from_readme(readme_path: &Path) -> Option<Target> {
    let mut search_dir = readme_path.parent()?;

    loop {
        let cargo_path = search_dir.join("Cargo.toml");

        if cargo_path.is_file()
            && let Some(target) = try_as_clap_project(search_dir, Some(readme_path))
        {
            return Some(target);
        }

        search_dir = search_dir.parent()?;
    }
}

fn try_as_clap_project(project_dir: &Path, readme_path: Option<&Path>) -> Option<Target> {
    let cargo_path = project_dir.join("Cargo.toml");
    let content = fs::read_to_string(&cargo_path).ok()?;
    let cargo_toml: CargoToml = toml::from_str(&content).ok()?;

    let package_name = cargo_toml.package.as_ref()?.name.clone();

    let has_clap = cargo_toml
        .dependencies
        .as_ref()
        .and_then(|deps| deps.as_table())
        .is_some_and(|deps| deps.contains_key("clap"));

    if !has_clap {
        return None;
    }

    Some(Target {
        readme_path: readme_path.map(Path::to_path_buf),
        project_path: project_dir.to_path_buf(),
        name: package_name,
    })
}