re_dev_tools/build_search_index/ingest/
docs.rs

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
#![allow(clippy::unwrap_used)] // build tool, so okay here

use super::{Context, DocumentData, DocumentKind};
use crate::build_search_index::util::ProgressBarExt as _;
use std::path::Path;

pub fn ingest(ctx: &Context) -> anyhow::Result<()> {
    let progress = ctx.progress_bar("docs");

    let dir = ctx.workspace_root().join("docs").join("content");
    for entry in glob::glob(&format!("{dir}/**/*.md"))? {
        let entry = entry?;
        let path = entry
            .strip_prefix(&dir)?
            .with_extension("")
            .display()
            .to_string();
        progress.set(path.clone(), ctx.is_tty());
        let url = format!("https://rerun.io/docs/{path}");
        let (frontmatter, body) = parse_docs_frontmatter(&entry)?;

        ctx.push(DocumentData {
            kind: DocumentKind::Docs,
            title: frontmatter.title,
            hidden_tags: vec![],
            tags: vec![],
            content: body,
            url,
        });
    }

    ctx.finish_progress_bar(progress);

    Ok(())
}

#[derive(serde::Deserialize)]
struct DocsFrontmatter {
    title: String,
}

fn parse_docs_frontmatter<P: AsRef<Path>>(path: P) -> anyhow::Result<(DocsFrontmatter, String)> {
    const START: &str = "---";
    const END: &str = "---";

    let path = path.as_ref();
    let content = std::fs::read_to_string(path)?;

    let Some(start) = content.find(START) else {
        anyhow::bail!("{:?} is missing frontmatter", path.display())
    };
    let start = start + START.len();

    let Some(end) = content[start..].find(END) else {
        anyhow::bail!(
            "{:?} has invalid frontmatter: missing {END:?} terminator",
            path.display()
        );
    };
    let end = start + end;

    let frontmatter: DocsFrontmatter =
        serde_yaml::from_str(content[start..end].trim()).map_err(|err| {
            anyhow::anyhow!(
                "Failed to parse YAML metadata of {:?}: {err}",
                path.parent().unwrap().file_name().unwrap()
            )
        })?;

    Ok((frontmatter, content[end + END.len()..].trim().to_owned()))
}