PSDocs

0.3.0

PSDocsProcessor/Markdown/Markdown.psm1

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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 #
# PSDocs Markdown processor
#

function Visit {

    param (
        $InputObject
    )

    if ($Null -eq $InputObject) {
        return;
    }

    if ($InputObject -is [String]) {
        return VisitString($InputObject);
    }

    switch ($InputObject.Type) {
        'Document' { return VisitDocument($InputObject); }
        'Code' { return VisitCode($InputObject); }
        'Section' { return VisitSection($InputObject); }
        'Title' { return VisitTitle($InputObject); }
        'List' { return VisitList($InputObject); }
        'Table' { return VisitTable($InputObject); }
        'Note' { return VisitNote($InputObject); }
        'Warning' { return VisitWarning($InputObject); }
        'Yaml' { return VisitYaml($InputObject); }

        default { return VisitString($InputObject); }
    }
}

function VisitString {

    param (
        $InputObject
    )

    Write-Verbose -Message "Visit string $InputObject";

    if ($InputObject -isnot [String]) {
        return $InputObject.ToString() -replace '\\', '\\';
    }

    return $InputObject -replace '\\', '\\';
}

function VisitSection {

    param (
        $InputObject
    )

    $section = $InputObject;

    Write-Verbose -Message "[Doc][Processor][Section] BEGIN::";

    Write-Verbose -Message "[Doc][Processor][Section] -- Writing section: $($section.Content)";

    # Generate markdown for the section name
    VisitString("`n$(''.PadLeft($section.Level, '#')) $($section.Content)");

    foreach ($n in $section.Node) {

        # Visit each node within the section
        Visit($n);
    }

    Write-Verbose -Message "[Doc][Processor][Section] END:: [$($section.Node.Length)]";
}

function VisitCode { 

    param (
        $InputObject
    )

    Write-Verbose -Message "[Doc][Processor] -- Visit code";

    if ([String]::IsNullOrEmpty($InputObject.Info)) {
        VisitString('```');
        VisitString($InputObject.Content);
        VisitString('```');
    }
    else {
        VisitString("``````$($InputObject.Info)");
        VisitString($InputObject.Content);
        VisitString('```');
    }
}

function VisitTitle {
    param ($InputObject)

    Write-Verbose -Message "[Doc][Processor] -- Visit title";

    VisitString("# $($InputObject.Title)");
}

function VisitList {
    param ($InputObject)

    Write-Verbose -Message "[Doc][Processor] -- Visit list";
    ""

    foreach ($n in $InputObject.Node) {
        [String]::Concat("- ", $This.Visit($n));
    }
}

function VisitNote {
    param ($InputObject)

    Write-Verbose -Message "[Doc][Processor] -- Visit note";
    
    VisitString('');
    VisitString('> [!NOTE]');

    foreach ($n in $InputObject.Content) {
        VisitString("> $n");
    }
}

function VisitWarning {
    param ($InputObject)

    Write-Verbose -Message "[Doc][Processor] -- Visit warning";
    
    VisitString('');
    VisitString('> [!WARNING]');

    foreach ($w in $InputObject.Content) {
        VisitString("> $w");
    }
}

function VisitYaml {
    param ($InputObject)

    Write-Verbose -Message "[Doc][Processor] -- Visit yaml";
    
    VisitString('---');

    foreach ($kv in $InputObject.Metadata.GetEnumerator()) {
        VisitString("$($kv.Key): $($kv.Value)");
    }

    VisitString('---');
}
   
function VisitTable {

    param (
        $InputObject
    )

    $table = $InputObject;

    Write-Verbose -Message "[Doc][Processor][Table] BEGIN::";

    $headerCount = $table.Header.Length;

    if ($Null -ne $table.Header -and $table.Header.Length -gt 0) {
        VisitString('');

        # Create header
        VisitString([String]::Concat('|', [String]::Join('|', $table.Header), '|'));
        VisitString([String]::Concat(''.PadLeft($headerCount, 'X').Replace('X', '| --- '), '|'));

        # Write each row
        foreach ($row in $table.Rows) {
            Write-Debug -Message "Generating row";

            VisitString([String]::Concat('|', [String]::Join('|', [String[]]$row), '|'));
        }
    }

    Write-Verbose -Message "[Doc][Processor][Table] END:: [$($table.Rows.Count)]";
}

function VisitDocument {

    param (
        $InputObject
    )

    if ($Null -ne $InputObject.Metadata -and $InputObject.Metadata.Count -gt 0) {
        VisitYaml -InputObject $InputObject;
    }

    if (![String]::IsNullOrEmpty($InputObject.Title)) {
        VisitTitle -InputObject $InputObject;
    }
}