在 NuGet 中包含控制台应用程序的最佳实践

Question

我正在开发一个开源库，它主要由一个面向 .NET Standard 2.0 的类库项目组成。最重要的是，我还实现了一个控制台应用程序，它是这个库的 CLI。控制台项目（出于历史原因）仅针对 .NET Framework 4.6.2。

现在我想知道为了让社区可以使用这个控制台应用程序，最佳做法是什么。在最广泛的层面上，我看到了两种可能性：

1. 将控制台应用程序作为单独的 NuGet 提供。
2. 在与类库相同的 NuGet 中提供控制台应用程序，因为它只是一个次要的附加组件，并不能证明自己的包是合理的。

从历史上看，我一直在使用第二种方法，但考虑到类库可以用于多目标场景，我不确定了。也许在自己的 NuGet 中分离控制台应用程序会更干净，这样它对完整 .NET 框架的依赖就很清楚了。

无论哪种方式，我都想知道控制台 exe 在 NuGet 的文件结构中属于哪个位置。从历史上看，我一直把它放在tools\net462 下，但是this page 上关于tools 文件夹的评论让我不安全：

可从包管理器控制台访问的 Powershell 脚本和程序

我不一定想象有人使用包管理器控制台中的 CLI。相反，它会在某个 shell 中用作独立的 exe。

Answer 1

随着时间的推移，其他解决方案会出现......

https://docs.microsoft.com/nl-nl/dotnet/core/tools/global-tools-how-to-create

<PackAsTool>true</PackAsTool>
<ToolCommandName>botsay</ToolCommandName>
<PackageOutputPath>./nupkg</PackageOutputPath>

Answer 2

似乎有一种解决方案可以满足您的需求。您可以为dotnet 工具创建命令行扩展。像dotnet ef 一样，您可以创建dotnet myAwesomeTool 命令。您唯一需要做的就是以下几点：

创建一个控制台应用程序并将以下代码添加到您的 .csproj

<PackageId>Company.MyAwesomeTool</PackageId>
<AssemblyName>dotnet-myAwesomeTool</AssemblyName>
<PackageType>DotnetCliTool</PackageType>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>

构建解决方案，您将在 bin 文件夹中找到一个 nuget 包。这个 nuget 包可以分发，安装后可以在安装了 nuget 的项目中运行dotnet myAwesomeTool。对我来说就像一个魅力 =)

要将其安装在其他项目上，请将其添加到 csproj：

<ItemGroup>
  <PackageReference Include="company.MyAwesomeTool" Version="1.0.0" />
</ItemGroup>
<ItemGroup>
  <DotNetCliToolReference Include="company.MyAwesomeTool" Version="1.0.0" />
</ItemGroup>

更多信息： https://blog.maartenballiauw.be/post/2017/04/10/extending-dotnet-cli-with-custom-tools.html

Answer 3

一般，NuGet is meant only for delivering class libraries（注意措辞“如果您的库......”）。

使用Chocolatey，而是将命令行和GUI应用程序部署到Windows。它具有可用于轻松安装和更新应用程序的CLI。它是 not NuGet，但使用类似的方法来打包和部署应用程序。

还有一个包管理器来定位其他平台：

1. apt-get（对于debian / ubuntu / mint）
2. Brew（对于麦斯科斯）
3. RPM（对于fedora /红色帽子）

注意：作为Martin Ullrich指出在CMET中，现在有一个way to deploy build tool CLIs with NuGet，主要用于连续集成部署方案。