doc-sync 0.1.2

A CLI to convert rust documentation to markdown files and then back to rust 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use std::error::Error;
use std::path::PathBuf;

use rustdoc_types::{Crate, Id, ItemEnum, VariantKind};
use tracing::trace;
use xshell::Shell;

use super::handle_item::handle_item;
use super::item_enum_ext::ItemEnumExt;

pub fn iterate_children<'rustdoc>(
    sh: &Shell,
    json: &'rustdoc Crate,
    output_dir: &PathBuf,
    handled_ids: &mut Vec<&'rustdoc String>,
    parent_path: &Vec<String>,
    item: &'rustdoc ItemEnum,
) -> Result<(), Box<dyn Error>> {
    match item {
        ItemEnum::Module(item) => iterate_ids(
            sh,
            json,
            output_dir,
            handled_ids,
            parent_path,
            item.items.iter(),
        ),
        ItemEnum::ExternCrate { .. } => Ok(()),
        ItemEnum::Import(_) => Ok(()),

        ItemEnum::Union(item) => {
            iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                item.fields.iter(),
            )?;
            iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                item.impls.iter(),
            )
        }
        ItemEnum::Struct(item) => iterate_ids(
            sh,
            json,
            output_dir,
            handled_ids,
            parent_path,
            item.impls.iter(),
        ),
        ItemEnum::StructField(_) => Ok(()),
        ItemEnum::Enum(item) => {
            iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                item.variants.iter(),
            )?;
            iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                item.impls.iter(),
            )
        }
        ItemEnum::Variant(item) => match &item.kind {
            VariantKind::Plain => Ok(()),
            VariantKind::Tuple(fields) => iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                fields.iter().filter_map(|f| f.as_ref()),
            ),
            VariantKind::Struct { fields, .. } => iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                fields.iter(),
            ),
        },

        ItemEnum::Function(_) => Ok(()),

        ItemEnum::Trait(item) => {
            iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                item.items.iter(),
            )?;
            iterate_ids(
                sh,
                json,
                output_dir,
                handled_ids,
                parent_path,
                item.implementations.iter(),
            )
        }
        ItemEnum::TraitAlias(_) => Ok(()),
        ItemEnum::Impl(item) => iterate_ids(
            sh,
            json,
            output_dir,
            handled_ids,
            parent_path,
            item.items.iter(),
        ),

        ItemEnum::Typedef(_) => Ok(()),
        ItemEnum::OpaqueTy(_) => Ok(()),
        ItemEnum::Constant(_) => Ok(()),

        ItemEnum::Static(_) => Ok(()),

        ItemEnum::ForeignType => Ok(()),

        ItemEnum::Macro(_) => Ok(()),
        ItemEnum::ProcMacro(_) => Ok(()),

        ItemEnum::Primitive(_) => Ok(()),

        ItemEnum::AssocConst { .. } => Ok(()),
        ItemEnum::AssocType { .. } => Ok(()),
    }
}

fn iterate_ids<'rustdoc>(
    sh: &Shell,
    json: &'rustdoc Crate,
    output_dir: &PathBuf,
    handled_ids: &mut Vec<&'rustdoc String>,
    parent_path: &Vec<String>,
    ids: impl Iterator<Item = &'rustdoc Id>,
) -> Result<(), Box<dyn Error>> {
    for id in ids {
        let item = json.index.get(id).expect("rustdoc JSON output is invalid?");
        let kind = item.inner.to_item_kind();
        let Some(name) = item.name.to_owned() else {
            trace!(
                item_kind = debug(kind),
                span = debug(&item.span),
                parent = debug(parent_path),
                id = &id.0,
                "Skipping child item because it doesn't have a name"
            );
            continue;
        };
        let mut path = parent_path.clone();
        path.push(name);

        handle_item(sh, json, output_dir, handled_ids, id, item, &path, &kind)?;
    }

    Ok(())
}