mdbook-utils 0.1.3

Tools to manage links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.
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

//! Locate Markdown files within a directory

use std::path::Path;
use std::path::PathBuf;

use anyhow::Result;
use tracing::warn;
use walkdir::DirEntry;
use walkdir::WalkDir;

/// Returns `true`` if the directory entry is hidden (starts with a `.`).
fn is_hidden(entry: &DirEntry) -> bool {
    entry
        .file_name()
        .to_str()
        .map(|s| s.starts_with('.'))
        .unwrap_or(false)
}

/// Locate Markdown files within a directory
///
/// If root_dir_path is a file, then it is the first and only item
/// yielded
pub(crate) fn find_markdown_files_in<P>(root_dir_path: P) -> Result<Vec<PathBuf>>
where
    P: AsRef<Path>,
{
    let mut paths = Vec::new();

    let walker = WalkDir::new(root_dir_path)
        .sort_by_file_name()
        .into_iter()
        // Skip hidden files and directories efficiently on unix systems
        .filter_entry(|e| !is_hidden(e));

    for entry in walker
        // Yields only the values for which the supplied closure returns Some(value)
        // Ignores WalkDir errors
        .filter_map(|res| res.ok())
        .filter(|de| de.file_type().is_file())
    {
        match entry.path().extension() {
            Some(extension) => {
                if extension == "md" {
                    // debug: println!("{}", entry.path().display());
                    paths.push(entry.into_path());
                } else {
                    warn!("Not a Markdown file: {}", entry.path().display());
                }
            }
            None => {
                warn!("Could not extract extension for {}", entry.path().display());
            }
        }
    }
    Ok(paths)
}