mdstore 1.2.0

A file-based storage engine that stores structured data as Markdown files with YAML frontmatter
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

//! Discover all item types in a directory.
//!
//! Demonstrates using `discover_types` to scan a base directory and
//! return the `TypeConfig` for every subdirectory that contains a
//! valid `config.yaml`.
//!
//! Run with: cargo run --example discover_types

use mdstore::config::{write_type_config, CustomFieldDef, IdStrategy};
use mdstore::{discover_types, TypeConfig, TypeFeatures};
use std::path::Path;

fn issue_config() -> TypeConfig {
    TypeConfig {
        name: "Issue".to_string(),
        identifier: IdStrategy::Uuid,
        features: TypeFeatures {
            display_number: true,
            status: true,
            priority: true,
            ..TypeFeatures::default()
        },
        statuses: vec![
            "open".to_string(),
            "in-progress".to_string(),
            "closed".to_string(),
        ],
        default_status: Some("open".to_string()),
        priority_levels: Some(3),
        custom_fields: Vec::new(),
    }
}

fn doc_config() -> TypeConfig {
    TypeConfig {
        name: "Doc".to_string(),
        identifier: IdStrategy::Slug,
        features: TypeFeatures::default(),
        statuses: Vec::new(),
        default_status: None,
        priority_levels: None,
        custom_fields: Vec::new(),
    }
}

fn epic_config() -> TypeConfig {
    TypeConfig {
        name: "Epic".to_string(),
        identifier: IdStrategy::Slug,
        features: TypeFeatures {
            display_number: true,
            status: true,
            ..TypeFeatures::default()
        },
        statuses: vec![
            "draft".to_string(),
            "active".to_string(),
            "completed".to_string(),
        ],
        default_status: Some("draft".to_string()),
        priority_levels: None,
        custom_fields: Vec::new(),
    }
}

fn task_config() -> TypeConfig {
    TypeConfig {
        name: "Task".to_string(),
        identifier: IdStrategy::Uuid,
        features: TypeFeatures {
            display_number: true,
            status: true,
            priority: true,
            move_item: true,
            duplicate: true,
            ..TypeFeatures::default()
        },
        statuses: vec![
            "todo".to_string(),
            "in-progress".to_string(),
            "review".to_string(),
            "done".to_string(),
        ],
        default_status: Some("todo".to_string()),
        priority_levels: Some(3),
        custom_fields: vec![CustomFieldDef {
            name: "assignee".to_string(),
            field_type: "string".to_string(),
            required: false,
            default_value: None,
            enum_values: Vec::new(),
        }],
    }
}

fn rfc_config() -> TypeConfig {
    TypeConfig {
        name: "RFC".to_string(),
        identifier: IdStrategy::Slug,
        features: TypeFeatures {
            display_number: true,
            status: true,
            ..TypeFeatures::default()
        },
        statuses: vec![
            "proposed".to_string(),
            "accepted".to_string(),
            "rejected".to_string(),
            "superseded".to_string(),
        ],
        default_status: Some("proposed".to_string()),
        priority_levels: None,
        custom_fields: Vec::new(),
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let base_dir = Path::new(env!("CARGO_MANIFEST_DIR")).join("examples/output/discover_types");
    if base_dir.exists() {
        tokio::fs::remove_dir_all(&base_dir).await?;
    }

    // Seed type directories
    write_type_config(&base_dir.join("issues"), &issue_config()).await?;
    write_type_config(&base_dir.join("docs"), &doc_config()).await?;
    write_type_config(&base_dir.join("epics"), &epic_config()).await?;
    write_type_config(&base_dir.join("tasks"), &task_config()).await?;
    write_type_config(&base_dir.join("rfcs"), &rfc_config()).await?;

    // A directory without config.yaml -- will be skipped
    tokio::fs::create_dir_all(base_dir.join("assets")).await?;

    // Discover all types
    let types = discover_types(&base_dir).await?;

    println!(
        "Discovered {} type(s) in {}:",
        types.len(),
        base_dir.display()
    );
    for t in &types {
        println!(
            "  - {} (identifier: {}, statuses: {:?})",
            t.name, t.identifier, t.statuses
        );
    }

    Ok(())
}