mermaid-parser 0.1.0

Lightweight Mermaid class-diagram parser powered by pest
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

WHITESPACE = _{ " " | "\t" }
comment = {
    "%%" ~ (!NEWLINE ~ ANY)*
}
note = {
    "note" ~ quoted_text
}
quoted_text = { "\"" ~ (!"\"" ~ ANY)* ~ "\"" }
variable_identifier = @{
    (ASCII_ALPHA | "_") ~
    ((("_"|"-") ~ &ASCII_ALPHANUMERIC)
        | ASCII_ALPHANUMERIC
    )*
}

method_identifier = @{
    ASCII_ALPHA
    ~
    ((("_"|"-") ~ &ASCII_ALPHANUMERIC)
    | ASCII_ALPHANUMERIC
    )*
}

class_identifier = @{
    ASCII_ALPHA
    ~
    ((("_"|"-") ~ &ASCII_ALPHANUMERIC)
    | ASCII_ALPHANUMERIC
    )*
}

class = { "class" ~ class_identifier }

class_label = {
    class ~ "[\"" ~ (!"\"" ~ ANY)* ~ "\"]"
}
class_property = {
    class_identifier ~ ":" ~ visibility? ~ (
        class_identifier ~ variable_identifier
      | variable_identifier
    )
}
class_method = {
    class_identifier ~ ":" ~ visibility? ~ class_identifier? ~ method_identifier ~ method_parameter
}
method_parameter = {
    "(" ~ class_identifier* ~ ")"
}

file = {
   SOI
   ~ "classDiagram"
   ~ NEWLINE+
   ~ statement
   ~ EOI
}

statement = _{((class | relation_stmt | member_stmt | comment) ~ NEWLINE*)*}


relation_stmt = {
    class_identifier ~ relation ~ class_identifier
}

relation = _{ aggregation | composition | inheritance | realization | association | dependency | link }

aggregation   = { "o--" | "--o" }
composition   = { "*--" | "--*" }
inheritance   = { "<|--" | "--|>" }
realization   = { "<|.." | "..|>" }
association   = { "-->" | "<--" }
dependency    = { "..>" | "<.." }
link          = { "--" }

member_stmt = {
    class_identifier ~ ":" ~ class_identifier ~ class_identifier
}

visibility = _{public | private | protected | package}

public = { "+" }
private = { "-" }
protected = { "#" }
package = { "~" }

classifier = _{abstract | static}
abstract = { "*" }
static = { "$" }


// Tests

test_class_explicit = {
    SOI ~ class ~ EOI
}
test_class_labels = {
    SOI ~ class_label ~ EOI
}
test_class_property = {
    SOI ~ class_property ~ EOI
}
test_class_method = {
    SOI ~ class_method ~ EOI
}
test_comment = {
    SOI ~ comment ~ EOI
}
test_note = {
    SOI ~ note ~ EOI
}