public static string CreateListOfAnalyzerOptions(RoslynatorMetadata metadata)
{
IEnumerable <string> options = metadata.GetAllAnalyzers()
.SelectMany(f => f.Options)
.Select(analyzerOption =>
{
string optionKey = analyzerOption.OptionKey;
if (!optionKey.StartsWith("roslynator.", StringComparison.Ordinal))
{
optionKey = $"roslynator.{analyzerOption.ParentId}.{optionKey}";
}
return(analyzerOption, value: optionKey + " = " + (analyzerOption.OptionValue ?? "true"));
})
.OrderBy(f => f.value)
.Select(f => $"# {f.analyzerOption.Title}{NewLine}{f.value}");
MDocument document = Document(
Heading1("List of EditorConfig Options"),
FencedCodeBlock(
string.Join(NewLine + NewLine, options),
"editorconfig"));
document.AddFootnote();
var format = new MarkdownFormat(tableOptions: MarkdownFormat.Default.TableOptions | TableOptions.FormatContent);
return(document.ToString(format));
}
public static string GenerateEditorConfig(RoslynatorMetadata metadata, bool commentOut)
{
var optionMap = new Dictionary <string, HashSet <AnalyzerMetadata> >();
foreach (AnalyzerMetadata analyzer in metadata.GetAllAnalyzers())
{
foreach (ConfigOptionKeyMetadata option in analyzer.ConfigOptions)
{
if (!optionMap.TryGetValue(option.Key, out HashSet <AnalyzerMetadata> optionAnalyzers))
{
optionAnalyzers = new HashSet <AnalyzerMetadata>();
}
optionAnalyzers.Add(analyzer);
optionMap[option.Key] = optionAnalyzers;
}
}
using (var w = new EditorConfigWriter(new StringWriter()))
{
w.WriteLine();
w.WriteLine("# Options");
w.WriteLine();
var isSeparatedWithNewLine = true;
foreach (ConfigOptionMetadata option in metadata.ConfigOptions.OrderBy(f => f.Key))
{
if (optionMap.TryGetValue(option.Key, out HashSet <AnalyzerMetadata> analyzers) &&
!isSeparatedWithNewLine)
{
w.WriteLine();
}
w.WriteCommentCharIf(commentOut);
w.WriteEntry($"{option.Key}", option.DefaultValuePlaceholder);
string defaultValue = option.DefaultValue;
if (defaultValue != null)
{
w.WriteLine($"# Default: {defaultValue}");
}
if (analyzers?.Count > 0)
{
w.WriteLine("# Applicable to: " + string.Join(", ", analyzers.OrderBy(f => f.Id).Select(f => f.Id.ToLowerInvariant())));
w.WriteLine();
isSeparatedWithNewLine = true;
}
else
{
isSeparatedWithNewLine = false;
}
}
w.WriteLine();
w.WriteLine("# Analyzers");
w.WriteLine();
foreach (AnalyzerMetadata analyzer in metadata.GetAllAnalyzers()
.Where(f => !f.IsObsolete && !f.Tags.Contains("HideFromConfiguration"))
.OrderBy(f => f.Id))
{
w.WriteLine($"# {analyzer.Title.TrimEnd('.')}");
w.WriteCommentCharIf(commentOut);
w.WriteAnalyzer(
analyzer.Id.ToLowerInvariant(),
(analyzer.IsEnabledByDefault)
? ((DiagnosticSeverity)Enum.Parse(typeof(DiagnosticSeverity), analyzer.DefaultSeverity)).ToReportDiagnostic()
: ReportDiagnostic.Suppress);
if (analyzer.ConfigOptions.Count > 0)
{
w.WriteLine("# Options: "
+ string.Join(
", ",
analyzer.ConfigOptions
.OrderBy(f => f.Key)
.Select(f2 => metadata.ConfigOptions.First(f => f.Key == f2.Key).Key)));
}
w.WriteLine();
}
w.WriteLine();
w.WriteLine("# Refactorings");
w.WriteLine();
foreach (RefactoringMetadata refactoring in metadata.Refactorings
.Where(f => !f.IsObsolete)
.OrderBy(f => f.OptionKey))
{
w.WriteCommentCharIf(commentOut);
w.WriteRefactoring(refactoring.OptionKey, refactoring.IsEnabledByDefault);
}
w.WriteLine();
w.WriteLine("# Compiler diagnostic fixes");
w.WriteLine();
foreach (CompilerDiagnosticMetadata compilerDiagnostic in metadata.CompilerDiagnostics
.OrderBy(f => f.Id))
{
w.WriteCommentCharIf(commentOut);
w.WriteCompilerDiagnosticFix(compilerDiagnostic.Id.ToLowerInvariant(), true);
}
return(w.ToString());
}
}
