EditorConfig

Question

我想知道是否有本地方法来存储和访问自定义 roslyn 分析器的其他设置。假设我有诊断 ID 'XA0001' 的规则，在编辑器配置中我将设置

dotnet_diagnostic.XA0001.severity = error

到目前为止，一切正常。现在我想添加类似这样的内容来为该新规则创建设置：

dotnet_diagnostic.XA0001.scope = class, enum, interface
dotnet_diagnostic.XA0001.level = toplevel

其中 scope 和 level 是我需要配置的规则的附加属性（通常是字符串或某种枚举），因为它们可以变化。每次都会有该规则的默认设置，可被 editorconfig 覆盖。

是否可能，如果可能，是否有任何超短示例 ev。 link 到 post 如何访问分析器 class 中的其他编辑器配置设置或仅从该项目级别访问？

[DiagnosticAnalyzer(LanguageNames.CSharp)]
    public class RuleXA0001Analyzer : DiagnosticAnalyzer
    {
        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(RuleXA0001.Descriptor);

        public override void Initialize(AnalysisContext context)
        {
            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
            context.EnableConcurrentExecution();

            //TODO access editorconfig settings for this rule
            //Perform analysis & report diagnostics
        }
    }   
}

不需要访问其他规则设置，即使它在其他情况下可能是有益的。

谢谢

Answer 1

AnalyzerOptions class 有一个属性 AnalyzerConfigOptionsProvider，可用于访问 .editorconfig 设置。

例如，如果您正在分析一个代码块，您可以这样做：

public override void Initialize(AnalysisContext context)
{
    context.RegisterCompilationStartAction(RegisterCompilationStart);
}

private static void RegisterCompilationStart(CompilationStartAnalysisContext startContext)
{
    var optionsProvider = startContext.Options.AnalyzerConfigOptionsProvider;
    startContext.RegisterCodeBlockAction(actionContext => AnalyzeCodeBlock(actionContext, optionsProvider));
}

private static void AnalyzeCodeBlock(CodeBlockAnalysisContext context, AnalyzerConfigOptionsProvider optionsProvider)
{
    // The options contains the .editorconfig settings
    var options = optionsProvider.GetOptions(context.CodeBlock.SyntaxTree);
    var isFound = options.TryGetValue("dotnet_diagnostic.XA0001.level", out var value);
}

EditorConfig - 如何访问自定义分析器中的 editorconfig 规则设置

EditorConfig - how to access editorconfig rule settings in custom analyzer

c#

roslyn

visual-studio-2019

roslyn-code-analysis