tealr_doc_gen 0.4.0

A cli tool to create online documentation for apis made with tealr
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

use std::path::Path;

use tealr::{mlu::FromToLua, NameContainer, ToTypename, TypeWalker};

use crate::{
    doc_gen::{get_type_name, type_should_be_inlined},
    render_type::type_to_link_url,
    Paths,
};

#[derive(FromToLua, ToTypename, Clone)]
/// An element in the sidebar
pub(super) struct SideBar {
    /// What url to link to
    pub(super) link_to: String,
    /// Name of the type in the sidebar
    pub(super) name: String,
    /// The members of the type
    pub(super) members: Vec<Members>,
}
#[derive(FromToLua, ToTypename, Clone)]
/// A member as shown in the sidebar
pub(super) struct Members {
    /// The name of the member
    pub(super) name: NameContainer,
}

pub fn generate_sidebar_data(
    type_defs: &TypeWalker,
    paths: &Paths,
    link_path: &Path,
) -> Vec<SideBar> {
    type_defs
        .given_types
        .iter()
        .map(|v| {
            let members = match v {
                tealr::TypeGenerator::Record(x) => x
                    .functions
                    .iter()
                    .map(|x| x.name.clone())
                    .chain(x.mut_functions.iter().map(|x| x.name.clone()))
                    .chain(x.fields.iter().map(|x| x.name.clone()))
                    .chain(x.static_fields.iter().map(|x| x.name.clone()))
                    .chain(x.methods.iter().map(|x| x.name.clone()))
                    .chain(x.mut_methods.iter().map(|x| x.name.clone()))
                    .chain(x.meta_function.iter().map(|x| x.name.clone()))
                    .chain(x.meta_function_mut.iter().map(|x| x.name.clone()))
                    .chain(x.meta_method.iter().map(|x| x.name.clone()))
                    .chain(x.meta_method_mut.iter().map(|x| x.name.clone()))
                    .map(|x| Members { name: x })
                    .collect(),
                tealr::TypeGenerator::Enum(x) => x
                    .variants
                    .iter()
                    .map(|v| Members { name: v.clone() })
                    .collect(),
            };
            let (name, link_to) = if type_should_be_inlined(v) {
                (paths.name.to_string(), link_path.join("index.html"))
            } else {
                let x = get_type_name(v).to_string();
                let url = match v.type_name() {
                    tealr::Type::Single(single_type) => type_to_link_url(
                        single_type.to_owned(),
                        &type_defs.given_types,
                        link_path.to_path_buf(),
                    ),
                    _ => None,
                }
                .unwrap_or_else(|| {
                    link_path
                        .join(sanitize_filename::sanitize(&x))
                        .with_extension("html")
                });
                (x, url)
            };
            SideBar {
                link_to: link_path.join(link_to).to_string_lossy().into_owned(),
                name,
                members,
            }
        })
        .collect()
}