为 nuget 创建自定义 powershell 脚本，将自定义目标添加到 csproj BeforeBuild 步骤

Question

我想创建一个 nuget 包，使用我创建的自定义 MSBuild 任务将 BeforeBuild 步骤添加到我的 csproj 中。理想情况下，我想要：

1. 将新目标添加到 csproj 文件 (MyCustomBeforeBuildTarget)
2. 如果尚未存在，则添加 BeforeBuild 目标
3. 编辑 BeforeBuild DependsOnTargets 属性以包含我的自定义目标

因此，安装后我的 csproj 中应包含以下内容：

<Target Name="MyCustomBeforeBuildTarget" Condition="SomeCondition">
     <MyCustomTask />
</Target>
<Target Name="BeforeBuild" DependsOnTargets="MyCustomBeforeBuildTarget">

</Target>

此外，如果我的包被删除，自定义目标也会消失，那就太好了， 尽管我添加了一个条件，如果我的自定义任务 DLL 不存在，它应该让它忽略目标。

我可以编写的最简单的 Powershell nuget 安装脚本将添加我的自定义目标是什么？我有一种感觉，PowerShell 脚本此处可能构成解决方案的一部分，但我没有足够的PowerShell 经验了解如何实际使用它们来编辑 csproj。

Answer 1

NuGetPowerTools 是一个添加了一些 PowerShell 功能的包，可以更轻松地处理项目的项目设置您正在添加一个包。要使用可用的功能，您只需使您的包依赖于 NuGetPowerTools，使用包 nuspec 文件中的依赖项标记，如下所示：

<dependencies>
  <dependency id="NuGetPowerTools" version="0.26" />
</dependencies>

这将可以获取对项目的构建项目表示的引用。

然后，您需要将 install.ps1 文件放入 NuGet 包的 tools 文件夹中，此 PowerShell 文件将在您安装包时运行，并且在安装后不再运行。

该文件应该看起来像这样：

#First some common params, delivered by the nuget package installer
param($installPath, $toolsPath, $package, $project)

# Grab a reference to the buildproject using a function from NuGetPowerTools
$buildProject = Get-MSBuildProject

# Add a target to your build project
$target = $buildProject.Xml.AddTarget("PublishWebsite")

# Make this target run before build
# You don't need to call your target from the beforebuild target,
# just state it using the BeforeTargets attribute
$target.BeforeTargets = "BeforeBuild"

# Add your task to the newly created target
$target.AddTask("MyCustomTask")

# Save the buildproject
$buildProject.Save()

# Save the project from the params
$project.Save()

应该是这样。

问候

杰斯珀·豪格

Answer 2

以下代码来自名为 CodeAssassin.WixWebProjectReferences 的包。它在安装和卸载时向项目文件添加和删除以下导入标签。该包不需要任何依赖项。

<Import Project="..\packages\CodeAssassin.WixWebProjectReferences.1.0\tools\CodeAssassin.WixWebProjectReferences.targets" />

下载该包并使用 NuGetPackageExplorer 打开它以了解它是如何完成的。

以下是 install.ps1 和 uninstall.ps1 中的代码（仅当 NuGet 包的内容文件夹非空时才会执行它们）。

（我找不到任何 powershell 突出显示，所以我使用了 php，但它并不完美。）

install.ps1

param (
    $InstallPath,
    $ToolsPath,
    $Package,
    $Project
)

$TargetsFile = 'CodeAssassin.WixWebProjectReferences.targets'
$TargetsPath = $ToolsPath | Join-Path -ChildPath $TargetsFile

Add-Type -AssemblyName 'Microsoft.Build, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'

$MSBProject = [Microsoft.Build.Evaluation.ProjectCollection]::GlobalProjectCollection.GetLoadedProjects($Project.FullName) |
    Select-Object -First 1

$ProjectUri = New-Object -TypeName Uri -ArgumentList "file://$($Project.FullName)"
$TargetUri = New-Object -TypeName Uri -ArgumentList "file://$TargetsPath"

$RelativePath = $ProjectUri.MakeRelativeUri($TargetUri) -replace '/','\'

$ExistingImports = $MSBProject.Xml.Imports |
    Where-Object { $_.Project -like "*\$TargetsFile" }
if ($ExistingImports) {
    $ExistingImports | 
        ForEach-Object {
            $MSBProject.Xml.RemoveChild($_) | Out-Null
        }
}
$MSBProject.Xml.AddImport($RelativePath) | Out-Null
$Project.Save()

uninstall.ps1

param (
    $InstallPath,
    $ToolsPath,
    $Package,
    $Project
)

$TargetsFile = 'CodeAssassin.WixWebProjectReferences.targets'

Add-Type -AssemblyName 'Microsoft.Build, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'

$MSBProject = [Microsoft.Build.Evaluation.ProjectCollection]::GlobalProjectCollection.GetLoadedProjects($Project.FullName) |
    Select-Object -First 1

$ExistingImports = $MSBProject.Xml.Imports |
    Where-Object { $_.Project -like "*\$TargetsFile" }
if ($ExistingImports) {
    $ExistingImports | 
        ForEach-Object {
            $MSBProject.Xml.RemoveChild($_) | Out-Null
        }
    $Project.Save()
}

将一些文件复制到输出路径的示例目标文件

<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
    <ItemGroup>
        <Files Include="..\packages\Insert_Path_To_Your_Package_Folder_Here\bin\*" />
    </ItemGroup>
    <Target Name="Insert_Name_of_Your_Target_Here" AfterTargets="AfterBuild">
        <Copy SourceFiles="@(Files)" DestinationFolder="$(TargetDir)\bin\" SkipUnchangedFiles="true" />
    </Target>
</Project>