如何通过NuGet包自动添加Source Generator配置文件及ItemGroup

针对你的需求，以下是基于MSBuild的可靠解决方案，完全适配.NET 6消费项目与netstandard2.0源生成器的组合场景：

核心思路 #

通过NuGet包的build目录注入MSBuild配置，实现两个目标：

1. 自动向项目注入AdditionalFiles项，确保源生成器能识别配置文件
2. 在用户首次构建时，将配置文件模板复制到项目根目录（仅当文件不存在时），允许用户编辑

步骤1：调整NuGet包结构 #

你的包需要包含以下目录和文件：

YourSourceGeneratorPackage.nupkg
├── build
│   ├── YourSourceGeneratorPackage.props
│   └── YourSourceGeneratorPackage.targets
└── templates
    └── generator.config

步骤2：编写.props文件（注入MSBuild项） #

build/YourSourceGeneratorPackage.props内容：

<Project>
  <!-- 仅当项目目录存在generator.config时，注入AdditionalFiles项 -->
  <ItemGroup>
    <AdditionalFiles Include="generator.config" Condition="Exists('$(MSBuildProjectDirectory)\generator.config')" />
  </ItemGroup>
</Project>

该文件会在项目加载时自动导入，确保源生成器能找到配置文件，且不会因文件不存在导致构建错误。

步骤3：编写.targets文件（复制配置模板） #

build/YourSourceGeneratorPackage.targets内容：

<Project>
  <!-- 构建前检查并复制配置文件模板 -->
  <Target Name="EnsureGeneratorConfigExists" BeforeTargets="BeforeBuild">
    <PropertyGroup>
      <!-- 包内模板文件的路径 -->
      <TemplateConfigPath>$(MSBuildThisFileDirectory)..\templates\generator.config</TemplateConfigPath>
      <!-- 项目根目录的目标路径 -->
      <ProjectConfigPath>$(MSBuildProjectDirectory)\generator.config</ProjectConfigPath>
    </PropertyGroup>

    <!-- 仅当项目目录无配置文件时复制 -->
    <Copy
      SourceFiles="$(TemplateConfigPath)"
      DestinationFiles="$(ProjectConfigPath)"
      Condition="!Exists('$(ProjectConfigPath)')"
      OverwriteReadOnlyFiles="false"
    />

    <!-- 首次复制时提示用户 -->
    <Message Text="已添加生成器配置文件：$(ProjectConfigPath)，可编辑该文件自定义输出。" Importance="High" Condition="!Exists('$(ProjectConfigPath)')" />
  </Target>
</Project>

这个目标会在每次构建前执行，自动将模板文件复制到用户项目目录，且不会覆盖已存在的自定义配置。

步骤4：配置源生成器项目的.csproj #

修改你的源生成器项目文件，确保上述文件被正确打包：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <PackageId>YourSourceGeneratorPackage</PackageId>
    <!-- 其他包元数据（版本、作者等） -->
  </PropertyGroup>

  <!-- 将build目录的配置文件打包到NuGet的build目录 -->
  <ItemGroup>
    <None Include="build\**" Pack="true" PackagePath="build" />
  </ItemGroup>

  <!-- 将templates目录的配置模板打包到NuGet的templates目录 -->
  <ItemGroup>
    <None Include="templates\generator.config" Pack="true" PackagePath="templates" />
  </ItemGroup>

  <!-- 确保源生成器能访问AdditionalFiles属性 -->
  <ItemGroup>
    <CompilerVisibleProperty Include="AdditionalFiles" />
  </ItemGroup>
</Project>

关键说明 #

• 此方案完全基于MSBuild，不依赖已弃用的PowerShell脚本，兼容所有支持PackageReference的项目（包括.NET 6）
• 用户项目目录下的generator.config是可编辑的，修改后会被源生成器实时读取
• 首次构建后，用户可能需要在VS中右键项目选择「刷新」才能看到新增的配置文件，这是VS的UI限制，无法自动规避

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