-
Notifications
You must be signed in to change notification settings - Fork 858
/
MarkdownValidatorBuilder.cs
281 lines (253 loc) · 8.3 KB
/
MarkdownValidatorBuilder.cs
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Immutable;
using Markdig.Syntax;
using Docfx.Common;
using Docfx.MarkdigEngine.Validators;
using Docfx.Plugins;
namespace Docfx.MarkdigEngine.Extensions;
public class MarkdownValidatorBuilder
{
private readonly List<RuleWithId<MarkdownValidationRule>> _validators =
new();
private readonly List<RuleWithId<MarkdownTagValidationRule>> _tagValidators =
new();
private readonly Dictionary<string, MarkdownValidationRule> _globalValidators =
new();
private readonly List<MarkdownValidationSetting> _settings =
new();
private List<IMarkdownObjectValidatorProvider> _validatorProviders =
new();
public const string DefaultValidatorName = "default";
public const string MarkdownValidatePhaseName = "Markdown style";
private ICompositionContainer Container { get; }
public MarkdownValidatorBuilder(ICompositionContainer container)
{
Container = container;
}
public static MarkdownValidatorBuilder Create(
MarkdownServiceParameters parameters,
ICompositionContainer container)
{
var builder = new MarkdownValidatorBuilder(container);
if (parameters != null)
{
LoadValidatorConfig(parameters.BasePath, parameters.TemplateDir, builder);
}
if (container != null)
{
builder.LoadEnabledRulesProvider();
}
return builder;
}
public IMarkdownObjectRewriter CreateRewriter(MarkdownContext context)
{
var tagValidator = new TagValidator(GetEnabledTagRules().ToImmutableList(), context);
var validators = from vp in _validatorProviders
from p in vp.GetValidators()
select p;
return MarkdownObjectRewriterFactory.FromValidators(
validators.Concat(
new[]
{
MarkdownObjectValidatorFactory.FromLambda<IMarkdownObject>(tagValidator.Validate)
}));
}
public void AddValidators(MarkdownValidationRule[] rules)
{
if (rules == null)
{
return;
}
foreach (var rule in rules)
{
if (string.IsNullOrEmpty(rule.ContractName))
{
continue;
}
_globalValidators[rule.ContractName] = rule;
}
}
public void AddValidators(string category, Dictionary<string, MarkdownValidationRule> validators)
{
if (validators == null)
{
return;
}
foreach (var pair in validators)
{
if (string.IsNullOrEmpty(pair.Value.ContractName))
{
continue;
}
_validators.Add(new RuleWithId<MarkdownValidationRule>
{
Category = category,
Id = pair.Key,
Rule = pair.Value,
});
}
}
public void AddTagValidators(MarkdownTagValidationRule[] validators)
{
if (validators == null)
{
return;
}
foreach (var item in validators)
{
_tagValidators.Add(new RuleWithId<MarkdownTagValidationRule>
{
Category = null,
Id = null,
Rule = item
});
}
}
internal void AddTagValidators(string category, Dictionary<string, MarkdownTagValidationRule> validators)
{
if (validators == null)
{
return;
}
foreach (var pair in validators)
{
_tagValidators.Add(new RuleWithId<MarkdownTagValidationRule>
{
Category = category,
Id = pair.Key,
Rule = pair.Value,
});
}
}
internal void AddSettings(MarkdownValidationSetting[] settings)
{
if (settings == null)
{
return;
}
foreach (var setting in settings)
{
_settings.Add(setting);
}
}
private void EnsureDefaultValidator()
{
if (!_globalValidators.ContainsKey(DefaultValidatorName))
{
_globalValidators[DefaultValidatorName] = new MarkdownValidationRule
{
ContractName = DefaultValidatorName
};
}
}
private static void LoadValidatorConfig(string baseDir, string templateDir, MarkdownValidatorBuilder builder)
{
if (string.IsNullOrEmpty(baseDir))
{
return;
}
if (templateDir != null)
{
var configFolder = Path.Combine(templateDir, MarkdownStyleDefinition.MarkdownStyleDefinitionFolderName);
if (Directory.Exists(configFolder))
{
LoadValidatorDefinition(configFolder, builder);
}
}
var configFile = Path.Combine(baseDir, MarkdownStyleConfig.MarkdownStyleFileName);
if (EnvironmentContext.FileAbstractLayer.Exists(configFile))
{
var config = JsonUtility.Deserialize<MarkdownStyleConfig>(configFile);
builder.AddValidators(config.Rules);
builder.AddTagValidators(config.TagRules);
builder.AddSettings(config.Settings);
}
builder.EnsureDefaultValidator();
}
private static void LoadValidatorDefinition(string mdStyleDefPath, MarkdownValidatorBuilder builder)
{
if (Directory.Exists(mdStyleDefPath))
{
foreach (var configFile in Directory.GetFiles(mdStyleDefPath, "*" + MarkdownStyleDefinition.MarkdownStyleDefinitionFilePostfix))
{
var fileName = Path.GetFileName(configFile);
var category = fileName.Remove(fileName.Length - MarkdownStyleDefinition.MarkdownStyleDefinitionFilePostfix.Length);
var config = JsonUtility.Deserialize<MarkdownStyleDefinition>(configFile);
builder.AddTagValidators(category, config.TagRules);
builder.AddValidators(category, config.Rules);
}
}
}
public void LoadEnabledRulesProvider()
{
HashSet<string> enabledContractName = new();
foreach (var item in _validators)
{
if (IsDisabledBySetting(item) ?? item.Rule.Disable)
{
enabledContractName.Remove(item.Rule.ContractName);
}
else
{
enabledContractName.Add(item.Rule.ContractName);
}
}
foreach (var pair in _globalValidators)
{
if (pair.Value.Disable)
{
enabledContractName.Remove(pair.Value.ContractName);
}
else
{
enabledContractName.Add(pair.Value.ContractName);
}
}
_validatorProviders = (from name in enabledContractName
from vp in Container?.GetExports<IMarkdownObjectValidatorProvider>(name)
select vp).ToList();
}
private IEnumerable<MarkdownTagValidationRule> GetEnabledTagRules()
{
foreach (var item in _tagValidators)
{
if (IsDisabledBySetting(item) ?? item.Rule.Disable)
{
continue;
}
yield return item.Rule;
}
}
private bool? IsDisabledBySetting<T>(RuleWithId<T> item)
{
bool? categoryDisable = null;
bool? idDisable = null;
if (item.Category != null)
{
foreach (var setting in _settings)
{
if (setting.Category == item.Category)
{
if (setting.Id == null)
{
categoryDisable = setting.Disable;
}
else if (setting.Id == item.Id)
{
idDisable = setting.Disable;
}
}
}
}
return idDisable ?? categoryDisable;
}
#region Nested Classes
private sealed class RuleWithId<T>
{
public T Rule { get; set; }
public string Category { get; set; }
public string Id { get; set; }
}
#endregion
}