如何在NuGet包中为Roslyn分析器提供自定义输入？

可行性确认 #

完全可行。Roslyn分析器原生支持读取外部配置文件，不少成熟的第三方分析器都采用类似机制实现自定义规则，你的需求属于Roslyn分析器的常规扩展场景。

核心实现步骤 #

1. 配置文件的识别与读取 #

• 要求使用团队将自定义的names.json放在项目根目录或指定子目录（如Properties），同时在项目文件中添加配置，将该文件标记为AdditionalFile，让Roslyn追踪文件变更：

  <ItemGroup>
    <AdditionalFiles Include="names.json" />
  </ItemGroup>
  

• 在分析器的Initialize方法中，注册配置文件的处理逻辑，读取并解析JSON内容为字典：

  public override void Initialize(AnalysisContext context)
  {
      context.RegisterAdditionalFileAction(ctx =>
      {
          var filePath = ctx.AdditionalFile.Path;
          if (Path.GetFileName(filePath).Equals("names.json", StringComparison.OrdinalIgnoreCase))
          {
              var jsonContent = File.ReadAllText(filePath);
              var nameMappings = JsonSerializer.Deserialize<Dictionary<string, string>>(jsonContent);
              // 将解析后的字典存入缓存，供后续分析使用
          }
      });
  }
  

2. 配置缓存与更新 #

• 基于文件哈希值实现缓存逻辑：当配置文件内容变更时，重新解析并更新缓存；否则直接复用已解析的字典，避免重复IO操作。
• 可借助CompilationAnalysisContext的Options或自定义静态缓存容器，确保同一编译周期内配置仅加载一次。

3. NuGet包打包配置 #

• 在分析器项目的.csproj文件中，指定分析器的输出目录，确保DLL被正确打包到NuGet的分析器目录：

  <PropertyGroup>
    <AnalyzerLanguage>cs</AnalyzerLanguage>
    <IncludeBuildOutput>false</IncludeBuildOutput>
  </PropertyGroup>
  <ItemGroup>
    <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" />
  </ItemGroup>
  

• 可选：在包中包含示例names.json，通过contentFiles目录打包，方便用户快速参考：

  <ItemGroup>
    <ContentFiles Include="names.json" BuildAction="Content" CopyToOutputDirectory="PreserveNewest" PackagePath="contentFiles/any/any" />
  </ItemGroup>
  

4. 测试与验证 #

• 针对不同项目结构（如嵌套文件夹、不同项目类型）测试配置文件的读取逻辑，确保兼容性；
• 验证配置文件修改后，分析器能触发重新分析并应用新的命名规则。

内容的提问来源于stack exchange，提问作者CaseyHofland