public static string CreateAnalyzersByCategoryMarkdown(IEnumerable <AnalyzerDescriptor> analyzers, IComparer <string> comparer)
{
MDocument document = Document(
Heading2("Roslynator Analyzers by Category"),
Table(
TableRow("Category", "Title", "Id", TableColumn(HorizontalAlignment.Center, "Enabled by Default")),
GetRows()));
document.AddFootnote();
return(document.ToString());
IEnumerable <MTableRow> GetRows()
{
foreach (IGrouping <string, AnalyzerDescriptor> grouping in analyzers
.GroupBy(f => MarkdownEscaper.Escape(f.Category))
.OrderBy(f => f.Key, comparer))
{
foreach (AnalyzerDescriptor analyzer in grouping.OrderBy(f => f.Title, comparer))
{
yield return(TableRow(
grouping.Key,
Link(analyzer.Title.TrimEnd('.'), $"../../docs/analyzers/{analyzer.Id}.md"),
analyzer.Id,
CheckboxOrHyphen(analyzer.IsEnabledByDefault)));
}
}
}
}
public static string CreateAnalyzersByCategoryMarkdown(IEnumerable <AnalyzerDescriptor> analyzers, IComparer <string> comparer)
{
var mb = new MarkdownBuilder();
mb.AppendHeader2("Roslynator Analyzers by Category");
Table table = Table("Category", "Title", "Id", TableHeader("Enabled by Default", Alignment.Center));
foreach (IGrouping <string, AnalyzerDescriptor> grouping in analyzers
.GroupBy(f => MarkdownEscaper.Escape(f.Category, mb.Settings.ShouldBeEscaped))
.OrderBy(f => f.Key, comparer))
{
foreach (AnalyzerDescriptor analyzer in grouping.OrderBy(f => f.Title, comparer))
{
table.AddRow(
grouping.Key,
Link(analyzer.Title.TrimEnd('.'), $"../../docs/analyzers/{analyzer.Id}.md"),
analyzer.Id,
RawText((analyzer.IsEnabledByDefault) ? "✓" : ""));
}
}
mb.Append(table);
return(mb.ToString());
}
public static void MarkdownEscaper_ShouldBeEscaped(char ch, bool shouldBeEscaped)
{
Assert.Equal(MarkdownEscaper.ShouldBeEscaped(ch), shouldBeEscaped);
}
public static void MarkdownEscaper_Escape_NoEscape(string value, bool shouldBeEscaped)
{
Assert.Equal(
(shouldBeEscaped) ? "\\" + value : value,
MarkdownEscaper.Escape(value, shouldBeEscaped: ch => false, escapingChar: '\\'));
}
public static void MarkdownEscaper_Escape_SingleChar(string value, bool shouldBeEscaped)
{
Assert.Equal((shouldBeEscaped) ? "\\" + value : value, MarkdownEscaper.Escape(value));
}
public static void MarkdownEscaper_Escape_Chars()
{
Assert.Equal(CharsEscaped, MarkdownEscaper.Escape(Chars));
Assert.Equal(CharsEscaped + NewLine + CharsEscaped, MarkdownEscaper.Escape(Chars + NewLine + Chars));
}
