katana-markdown-engine 0.1.0

Renderer-neutral Markdown document model for the KatanA ecosystem
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

use crate::{ByteRange, KmeDocument, KmeNodeId, LineColumnRange, TextFingerprint};
use serde::{Deserialize, Serialize};
use std::path::PathBuf;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataDocument {
    pub markdown_path: PathBuf,
    pub entries: Vec<MetadataEntry>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataEntry {
    pub key: String,
    pub target: MetadataTarget,
    pub payload: serde_json::Value,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataTarget {
    pub file_path: PathBuf,
    pub node_id: KmeNodeId,
    pub byte_range: ByteRange,
    pub line_column_range: LineColumnRange,
    pub text_fingerprint: TextFingerprint,
    pub context: ContextAnchor,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ContextAnchor {
    pub before: String,
    pub after: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct TargetResolution {
    pub key: String,
    pub kind: TargetResolutionKind,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataReconcileRequest {
    pub old_document: KmeDocument,
    pub new_document: KmeDocument,
    pub metadata: MetadataDocument,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataReconcileResult {
    pub metadata: MetadataDocument,
    pub resolutions: Vec<TargetResolution>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum TargetResolutionKind {
    Resolved {
        node_id: KmeNodeId,
    },
    Moved {
        previous_node_id: KmeNodeId,
        node_id: KmeNodeId,
    },
    Conflict(ConflictedTarget),
    Unresolved(UnresolvedTarget),
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ConflictedTarget {
    pub previous_node_id: KmeNodeId,
    pub candidate_node_ids: Vec<KmeNodeId>,
    pub reason: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UnresolvedTarget {
    pub node_id: KmeNodeId,
    pub reason: String,
}