cargo-rdme 1.5.1

Cargo command to create your `README.md` from your crate's documentation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use std::path::{Path, PathBuf};
use syn::Ident;
use syn::Item;
use thiserror::Error;

use super::ItemPath;

#[derive(Error, Debug)]
pub enum ModuleWalkError {
    #[error("IO error: {0}")]
    IOError(std::io::Error),
    #[error("failed to parse rust file: {0}")]
    ParseError(syn::Error),
}

impl From<std::io::Error> for ModuleWalkError {
    fn from(err: std::io::Error) -> Self {
        ModuleWalkError::IOError(err)
    }
}

impl From<syn::Error> for ModuleWalkError {
    fn from(err: syn::Error) -> Self {
        ModuleWalkError::ParseError(err)
    }
}

fn file_ast<P: AsRef<Path>>(filepath: P) -> Result<syn::File, ModuleWalkError> {
    let src = std::fs::read_to_string(filepath)?;

    Ok(syn::parse_file(&src)?)
}

/// Determines the module filename, which can be `<module>.rs` or `<module>/mod.rs`.
fn module_filename(dir: &Path, module: &Ident) -> Option<PathBuf> {
    let mod_file = dir.join(format!("{module}.rs"));

    if mod_file.is_file() {
        return Some(mod_file);
    }

    let mod_file = dir.join(module.to_string()).join("mod.rs");

    if mod_file.is_file() {
        return Some(mod_file);
    }

    None
}

pub(super) fn walk_module_items(
    ast: &[Item],
    dir: &Path,
    mod_symbol: &ItemPath,
    visit: &mut impl FnMut(&ItemPath, &Item),
    explore_module: &mut impl FnMut(&ItemPath, &syn::ItemMod) -> bool,
    emit_warning: &impl Fn(&str),
) -> Result<(), ModuleWalkError> {
    for item in ast {
        visit(mod_symbol, item);

        if let Item::Mod(module) = item {
            let child_module_symbol: ItemPath = mod_symbol.clone().join(&module.ident.to_string());

            if explore_module(&child_module_symbol, module) {
                match &module.content {
                    Some((_, items)) => {
                        walk_module_items(
                            items,
                            dir,
                            &child_module_symbol,
                            visit,
                            explore_module,
                            emit_warning,
                        )?;
                    }
                    None => match module_filename(dir, &module.ident) {
                        None => emit_warning(&format!(
                            "Unable to find module file for module {} in directory \"{}\"",
                            child_module_symbol,
                            dir.display()
                        )),
                        Some(mod_filename) => walk_module_file(
                            mod_filename,
                            &child_module_symbol,
                            visit,
                            explore_module,
                            emit_warning,
                        )?,
                    },
                }
            }
        }
    }

    Ok(())
}

pub(super) fn walk_module_file<P: AsRef<Path>>(
    file: P,
    mod_symbol: &ItemPath,
    visit: &mut impl FnMut(&ItemPath, &Item),
    explore_module: &mut impl FnMut(&ItemPath, &syn::ItemMod) -> bool,
    emit_warning: &impl Fn(&str),
) -> Result<(), ModuleWalkError> {
    let dir: &Path = file
        .as_ref()
        .parent()
        .unwrap_or_else(|| panic!("failed to get directory of \"{}\"", file.as_ref().display()));
    let ast: syn::File = file_ast(&file)?;

    walk_module_items(&ast.items, dir, mod_symbol, visit, explore_module, emit_warning)
}