【问题标题】:How to create a Nuget Tools package who installs an executable in a fixed location如何创建在固定位置安装可执行文件的 Nuget 工具包
【发布时间】:2018-06-27 18:03:30
【问题描述】:

我正在使用命令行工具开发控制台 .Net471 项目 (csproj)。

.csproj 有相应的行:

<IsTool>true</IsTool>
<PackAsTool>true</PackAsTool>

nuget 包安装在:

<solution>/packages/<idpackage>/tools

因此,它不能作为任何解决方案项目下的命令行工具访问。

我希望将包输出重定向到%userprofile%/.nuget/tools/ 或类似的位置,以便为我的工具提供一个固定位置。

但我没有找到任何有关安装 MSBUILD 15.0+ 工具或有关重定向安装路径的文档。

【问题讨论】:

  • 我相信你不能在任何你想要的地方安装 nuget 包。什么会阻止您将其安装在 C:\windows 目录下...
  • 没关系...但是在这种情况下...有“itool”或“PackAsTool”标签的原因是什么?无法在修复位置安装工具(ej:解决方案根目录)?
  • .NET Core 有全局工具的概念——docs.microsoft.com/en-us/dotnet/core/tools/global-tools NuGet 本身没有这个概念。 PackAsTool 是生成 .NET Core 全局工具时使用的属性。

标签: c# msbuild nuget csproj


【解决方案1】:

作为 NuGet 包提供的命令行工具不需要安装到固定位置。

其实有一个简单的方法,所以我以Obfuscar为例。

第一步

准备一个道具文件,

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="12.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <Obfuscar>$(MSBuildThisFileDirectory)..\tools\obfuscar.console.exe</Obfuscar>
  </PropertyGroup>
</Project> 

第 2 步

在你的包中使用这个道具文件,

    <files>
        <file src="bin\release\obfuscar.console.exe" target="tools" />
        <file src="build\obfuscar.props" target="build" />
    </files>
</package>

现在你已经完成了。

此 NuGet 包的所有使用者只需使用 "$(Obfuscar)" 来引用该控制台应用程序(无论实际物理路径如何)。

【讨论】:

  • 是的,我打算将此添加到下面的答案中(但只是链接到 FluentMigrator.Console 的打包方式)。您在这里所做的正是我在 build.targets 文件中为 net461 msbuild 资产所做的。但是,我有一个初始步骤是定义 &lt;Project InitialTargets="InstallToolsIfNotInstalled"&gt; docs.microsoft.com/en-us/visualstudio/msbuild/…
  • 顺便说一句,@LexLi,如果可以的话,请对我的回答提供反馈。它基于我在过去 4 年中积累的使用 .NET Core 的原始经验。这是在任何地方都没有真正记录的东西——只是自学成才。希望您和其他人觉得它有用!
【解决方案2】:

对于 .NET Framework 4.8 及更低版本,无法使用 IsTool 或 PackAsTool。从根本上说,打包 nuget 包存在三个主要“世界”:

  1. *.csproj 使用 .NET Core SDK 项目格式(带有NuGet 4.0+ PackageReference support instead of packages.config and MSBuild 15.1+ first-class support for NuGet pack and restore as well-known MSBuild targets)。
  2. *.csproj 使用旧版 .NET Framework SDK 项目格式
  3. *.csproj 使用旧版 .NET Framework ToolsVersion 项目格式

对于简单的场景,*.csproj using Legacy .NET Framework SDK project format 有效。然而,有很多事情你不能用这个组合做。这是我试图分解它的尝试:

| | | ------------------ MSBuild 功能的横截面 ------------------ | | | | | | | | | | MSBuild 项目类型 | .NET 运行时 |命令行工具 |包参考 |框架参考 | COM参考 |维克斯 | | -------------------- | --------------------- | -------- | ---------------- | ------------------ | ------------ | ------ | |工具版本 |旧版 .NET 框架 |没有 |没有 |没有 |是* |是** | | .NET SDK |旧版 .NET 框架 |没有 |是 |没有 |没有*** |没有 | | .NET SDK | .NET 核心 |是**** |是 | .NET Core 3.0+ |没有*** |没有 |

1 * MSBuild 首席开发人员 Rainer Sigwald 说“COMReference 预计不会工作”https://github.com/dotnet/installer/issues/1690#issuecomment-485913274
2 ** WiX 需要旧的 ToolsVersion 项目参考,以便为您正确构建 WiX 项目,通过计算它需要发布的所有依赖项。
3 *** 特别是,您不应该期望 .NET Core 支持 COM ,因为 cmets Jan Kotas 引用了 Mono Runtime 团队支持 COM 的经验。特别是,Linux 不支持 Windows 结构化异常处理,因为 Linux 的基本应用程序二进制接口是 C。有关更多信息,请参阅以下示例,了解为什么 .NET Core 支持 COM 会不稳定:https://monoinfinito.wordpress.com/series/exception-handling-in-c/
4 **** .NET Core 在.NET Core 2.1 SDK 中引入了 CLI 工具

这涵盖了用于包装应用的相当大的表面积。请注意,COM 的缺失也解释了为什么 WiX 几乎是一种死技术:WiX 主要是通过 *.wixproj 将 MsiExec 集成到 C# 项目中的一种方式,而 MsiExec 是 COM:每个 MsiExec包与它的元数据一起存储在 COM 相关文件夹下的 Windows 注册表中。

现在,这不可能的后果是什么?

  1. 您不能使用 .NET Core 3.0 工具清单文件来描述此类工具。
  2. 您需要在“发布者”端(工具)和“消费者”端(使用工具的客户端)编写额外的管道代码。

如需了解真实世界的示例,您可以查看我们的项目FluentMigrator。值得注意的是,看看FluentMigrator.Console.csproj 和FluentMigrator.Console.nuspec,然后看看我们如何构建我们的整个解决方案,然后为FluentMigrator.Console.csproj 执行一个特殊的打包/发布步骤。我正在研究一种方法来简化这一点,但它现在可能适合你。

还有什么要考虑的吗?

另外,你可能想看看开源项目,MSBuild.Sdk.Extras

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2015-11-16
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-10-22
    • 1970-01-01
    • 1970-01-01
    • 2019-03-31
    相关资源
    最近更新 更多