如何在 Rider 中触发文件更改的设计时构建？

Posted 2023-03-30

技术标签:

【中文标题】如何在 Rider 中触发文件更改的设计时构建？【英文标题】：How to trigger a design-time build on file change in Rider? 【发布时间】：2019-02-18 10:31:56 【问题描述】：

我创建了一个NuGet package，它在设计和构建时从 DSL 文件生成 C# 代码。它在 Visual Studio 中运行良好，但在 Rider 中存在一些问题（我将在下面描述）。

在 Visual Studio 中

该包为 DSL 文件声明 custom items，并为它们分配一个 MSBuild:Compile Generator 元数据，每次文件更改时都会在 Visual Studio 中触发 design-time build。

然后，使用BeforeTargets="CoreCompile" 将自定义目标挂钩到构建。它生成 C# 代码并将Compile 项目添加到项目中。目标在正常和设计时构建中运行，并支持incremental builds 以避免不必要的工作。

这是相关的（简化和注释的）MSBuild 代码：

props 文件：

<Project>

  <!-- Define the item type with its default metadata -->
  <ItemDefinitionGroup>
    <ZebusMessages>
      <Generator>MSBuild:Compile</Generator>
    </ZebusMessages>
  </ItemDefinitionGroup>

  <!-- Make the item type user-visible in VS -->
  <ItemGroup>
    <AvailableItemName Include="ZebusMessages" />
    <PropertyPageSchema Include="$(MSBuildThisFileDirectory)ZebusMessages.xml" />
  </ItemGroup>

  <!-- Include all .msg files by default -->
  <ItemGroup>
    <ZebusMessages Include="**\*.msg" Exclude="$(DefaultItemExcludes);$(DefaultExcludesInProjectFolder)" />
  </ItemGroup>

</Project>

targets 文件：

<Project>

  <ItemGroup>
    <!-- Add a GeneratorTargetPath metadata for the target file -->
    <ZebusMessages Update="@(ZebusMessages)" GeneratorTargetPath="$([MSBuild]::ValueOrDefault('$(IntermediateOutputPath)ZebusMessages/%(RecursiveDir)%(FileName)%(Extension).cs', '').Replace('\', '/'))" />

    <!-- Remove all None items for .msg files -->
    <None Remove="**\*.msg" />
  </ItemGroup>

  <Target Name="GenerateZebusMessages"
          BeforeTargets="CoreCompile"
          Condition="'@(ZebusMessages)' != ''"
          Inputs="@(ZebusMessages)"
          Outputs="@(ZebusMessages->'%(GeneratorTargetPath)')">

    <!-- Generate output files -->
    <GenerateZebusMessagesTask InputFiles="@(ZebusMessages)" />

    <ItemGroup>
      <!-- Add the output items -->
      <Compile Include="@(ZebusMessages->'%(GeneratorTargetPath)')" Visible="false" />
      <FileWrites Include="@(ZebusMessages->'%(GeneratorTargetPath)')" />
    </ItemGroup>
  </Target>

</Project>

完整文件为available here。

在骑士中

使用 Rider 2018.3.3 测试：

这在 Rider 中无法开箱即用，因为它似乎不会像 VS 那样触发设计时构建。

起初，Rider 完全不知道生成的 C# 文件，这导致它在引用生成的类的代码中显示错误。

我使用了 Rider 的 internal mode，它公开了对项目的“重新加载项目并显示日志”操作，这表明 Rider 在项目加载时调用 MSBuild，并具有以下目标：

GenerateAssemblyInfo;_CheckForInvalidConfigurationAndPlatform;GetFrameworkPaths;ResolvePackageDependenciesDesignTime;CollectPackageReferences;BeforeResolveReferences;ResolveAssemblyReferences;ResolveComReferences;ResolveSDKReferences;ResolveCodeAnalysisRuleSet

请注意该列表中缺少 CompileDesignTime 或 Compile。

所以我添加了以下目标来支持 Rider：

  <Target Name="GenerateZebusMessagesRiderDesignTime"
          Condition="'$(BuildingByReSharper)' == 'true'"
          AfterTargets="PrepareForBuild"
          DependsOnTargets="GenerateZebusMessages" />

它挂钩到ResolveAssemblyReferences 所依赖的PrepareForBuild，并调用GenerateZebusMessages。

这让 Rider 知道生成的文件，但我想解决一些问题：

如果我编辑 .msg 文件，生成的 C# 代码只会在项目构建时更新，而 Rider 的代码补全到那时才更新。如果我将 .msg 文件添加到项目中，我需要重新加载项目以将其考虑在内。在这里构建项目没有帮助。

问题

我想让 Rider 调用 MSBuild 目标并在编辑或添加/删除 .msg 文件时重新评估项目。

我在添加文件时只在日志中发现了以下内容，但并没有太大帮助：

10:54:05.076 |I| ProjectModel                   | RequestBuilder thread:7        | Add item ZebusMessages = 'OtherFile.msg'...
10:54:05.076 |I| ProjectModel                   | RequestBuilder thread:7        | Item matches to a wildcard pattern, mark project as dirty
10:54:05.095 |I| ProjectModel                   | RequestBuilder thread:7        | Project file content requested: ZebusMessages.csproj
10:54:08.330 |I| ProjectModel                   | RequestBuilder thread:7        | Item with EvaluatedInclude 'OtherFile.msg' was already changed. Perform project reevaluation before processing.
10:54:08.361 |I| ProjectModel                   | RequestBuilder thread:7        | Project 'ZebusMessages.csproj' was reevaluated in 22 ms, EvaluationCounter: 9

在此时间范围内，日志中没有其他内容提及 MSBuild。

当给定的文件类型发生变化时，是否可以在 Rider 中触发类似于设计时构建的东西？

或者更一般地说，Rider 在什么情况下调用 MSBuild 来重新评估项目？

【问题讨论】：

【参考方案1】：

我为你准备了两个故事——短的和长的 =)