【问题标题】:Is there a .NET Core CLI pre before build task?在构建任务之前是否有 .NET Core CLI pre?
【发布时间】:2017-12-02 18:38:51
【问题描述】:

问题

我假设当msbuild 即将编译源代码文件时,它会根据项目的Include 和Exclude 规则生成要构建的文件列表。

有没有办法在评估要编译的文件列表之前执行任务?

这是为了能够生成源代码文件并将其用于构建。

目前的研究和试验

我正在制作一个 .NET Core CLI 工具,该工具必须在构建使用它的项目之前运行,因为它(CLI 工具)会生成一个必须包含在构建中的文件。

该项目是使用新的.csproj 系统创建的,而不是旧的project.json 系统。

连同我的 .NET Core CLI 工具项目,我创建了一个用于测试目的的库项目。

如果我在测试库的.csproj 中添加这个:

<ItemGroup>
    <DotNetCliToolReference Include="MyCliTool" Version="x.x.x" />
    <!-- here x.x.x is just a placeholder -->
</ItemGroup>

<Target Name="MyCliToolTarget" AfterTargets="Restore" BeforeTargets="BeforeBuild">
    <Exec Command="dotnet my-cli-tool" />
</Target>

如果 CLI 工具生成的文件以前不存在,则编译时不会将其考虑在内。这意味着当文件存在时,它是可以的,但这也意味着第一次构建(在克隆、清理或其他之后)总是会失败。

我为BeforeTargets 尝试了几个不同的目标,但我找不到让它工作的方法。我试图在Project 节点的InitialTargets 中设置我的目标,但它也不起作用。我尝试将Target节点的Outputs属性设置为CLI工具生成的文件名,但同样失败。

我发现唯一可行的解​​决方案是手动添加Compile 指令,如下所示:

<ItemGroup>
    <Compile Include="MyGeneratedFile.cs" />
</ItemGroup>

这个解决方案目前还不错,但文件名可能会根据 CLI 工具选项而更改,这会导致两个地方的文件名必须在更改时更新,如下所示:

<ItemGroup>
    <Compile Include="PATH\TO\CUSTOM_FILENAME_HERE.CS" />
    <DotNetCliToolReference Include="MyCliTool" Version="x.x.x" />
</ItemGroup>

<Target Name="MyCliToolTarget" AfterTargets="Restore" BeforeTargets="BeforeBuild">
    <Exec Command="dotnet my-cli-tool --output PATH\TO\CUSTOM_FILENAME_HERE.CS" />
</Target>

(请参阅 CUSTOM_FILENAME_HERE.CS 出现两次)

我知道我可以使用一个常量,如下所示:

<PropertyGroup>
    <MyFilename>PATH\TO\CUSTOM_FILENAME_HERE.CS</MyFilename>
</PropertyGroup>

<ItemGroup>
    <Compile Condition="!Exists('$(MyFilename)')" Include="$(MyFilename)" />
    <DotNetCliToolReference Include="MyCliTool" Version="x.x.x" />
</ItemGroup>

<Target Name="MyCliToolTarget" AfterTargets="Restore" BeforeTargets="BeforeBuild">
    <Exec Command="dotnet my-cli-tool --output $(MyFilename)" />
</Target>

但我对这种方法不满意,假设这仍然是一个简化版本,它使 lambda 用户无法集成,因为 CLI 工具可以采用其他几个选项,这意味着有其他变量,呜呜呜。

我正在使用 .NET Core SDK 1.0.1。

很抱歉这个冗长的问题和我对 msbuild 的菜鸟。

提前感谢您的时间和帮助。




旁注:在预构建事件中调用dotnet my-cli-tool,如:

<PropertyGroup>
    <PreBuildEvent>dotnet my-cli-tool</PreBuildEvent>
</PropertyGroup>

根本不起作用,我收到以下错误:

代码:MSB3073 说明:命令“dotnet my-cli-tool”以代码 1 退出。 项目:测试库项目,而不是工具一 文件:C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\Microsoft.Common.CurrentVersion.targets 线路:4935

虽然,以下工作正常:

<PropertyGroup>
    <PreBuildEvent>echo meh</PreBuildEvent>
</PropertyGroup>

所以这不是预构建事件的错误。

无论如何,这是另一个我暂时不太关心的故事。

【问题讨论】:

    标签: .net msbuild task visual-studio-2017 dotnet-cli


    【解决方案1】:

    如果您的自定义工具只创建一个文件,您可以直接在中间输出路径中创建它并将其包含在您的编译中:

      <Target Name="GenerateSomeFiles" BeforeTargets="CoreCompile" DependsOnTargets="PrepareForBuild">
        <Exec Command="dotnet my-tool $(MSBuildProjectDirectory)\$(IntermediateOutputPath)\my-output.cs" />
      </Target>
    
      <ItemGroup>
        <Compile Include="$(MSBuildProjectDirectory)\$(IntermediateOutputPath)\my-output.cs" />
      </ItemGroup>
    

    【讨论】:

    • 感谢您的提示,我会在接下来的几周内看看。
    【解决方案2】:

    .NET SDK 所称的“默认项”是项目文件静态评估的一部分 - 在运行任何目标之前。因此,您需要一个在需要 @(Compile) 项目之前运行的目标。

    诀窍是在自定义工具运行后包含添加到文件系统的文件。这可以通过重新扫描所有文件并在构建之前运行的目标中排除那些已经是项目的一部分来完成:

      <Target Name="GenerateSomeFiles" BeforeTargets="BeforeBuild">
        <Exec Command="dotnet my-tool" />
        <ItemGroup>
          <Compile Include="**/*$(DefaultLanguageSourceExtension)"
                   Exclude="$(DefaultItemExcludes);$(DefaultExcludesInProjectFolder);$(BaseIntermediateOutputPath)**;$(BaseOutputPath)**;@(Compile)" />
        </ItemGroup>
      </Target>
    

    【讨论】:

    • 这个解决方案效果很好!非常感谢。如果我以后发现一些故障,我会更新这篇文章,而不仅仅是简单的集成测试。
    • 顺便说一句,我使用$(DefaultExcludesInProjectFolder) 遇到了一些问题,所以我提交了issue on GitHub on it。 sn-p 已经包含了我的解决方法。
    猜你喜欢
    • 2016-11-08
    • 1970-01-01
    • 1970-01-01
    • 2013-09-03
    • 1970-01-01
    • 2023-01-30
    • 2019-10-03
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多