Nuget

dotnet-outdated

这是 Jerrie Pelser 创建的原始 dotnet-outdated 工具的延续版本。

如果你已经安装了原始的 dotnet-outdated 工具，在安装此版本之前需要运行 dotnet tool uninstall --global dotnet-outdated。

概述

使用像 Visual Studio 这样的 IDE 时，通过使用 NuGet 包管理器，很容易发现项目中使用的 NuGet 包是否有新版本可用。然而，.NET Core 命令行工具并没有提供内置方式来报告过时的 NuGet 包。

dotnet-outdated 是一个 .NET Core 全局工具，可以让你快速报告 .NET Core 和 .NET Standard 项目中任何过时的 NuGet 包。

dotnet-outdated

安装

下载并安装当前支持的 .NET SDK 之一。安装完成后，运行以下命令：

dotnet tool install --global dotnet-outdated-tool

如果你已经安装了 dotnet-outdated 的旧版本，可以使用以下命令升级到最新版本：


```bash
dotnet tool update --global dotnet-outdated-tool

使用

用法: dotnet outdated [选项] <路径>

参数:
  路径                                       .sln、.slnf、.csproj 或 .fsproj 文件的路径，或包含 .NET Core 解决方案/项目的目录路径。如果未指定，将使用当前目录。

选项:
  --version                                  显示版本信息。
  -?|-h|--help                               显示帮助信息。
  -i|--include-auto-references               指定是否包括自动引用的包。
  -pre|--pre-release <预发布>                 指定是否查找包的预发布版本。可能的值：Auto（默认）、Always 或 Never。
                                             允许的值为：Auto、Always、Never。
                                             默认值为：Auto。
  -vl|--version-lock <版本锁定>               指定包是否应锁定到当前主要或次要版本。可能的值：None（默认）、Major 或 Minor。
                                             允许的值为：None、Major、Minor。
                                             默认值为：None。
  -t|--transitive                            指定是否应检测传递依赖。
  -td|--transitive-depth <传递深度>           定义应分析传递依赖的深度级别。整数值（默认 = 1）
                                             默认值为：1。
  -u|--upgrade[:<类型>]                      指定是否应升级过时的包。<类型> 的可能值为 Auto（默认）或 Prompt。
                                             允许的值为：Auto、Prompt。
  -f|--fail-on-updates                       指定在发现更新时是否应返回非零退出代码。
  -inc|--include <包含过滤器>                 指定仅查看名称包含提供字符串的包。不区分文化和大小写。如果多次提供，单个匹配就足以包含一个包。
  -exc|--exclude <排除过滤器>                 指定仅查看名称不包含提供字符串的包。不区分文化和大小写。如果多次提供，单个匹配就足以排除一个包。
  -o|--output <输出文件名>                    指定生成报告的文件名。（使用 -of|--output-format 选项指定格式。默认为 JSON。）
  -of|--output-format <输出文件格式>          指定生成报告的输出格式。可能的值：json（默认）或 csv。
                                             允许的值为：Json、Csv、Markdown。
                                             默认值为：Json。
  -ot|--older-than <早于天数>                 仅包含早于指定天数的包版本。
                                             默认值为：0。
  -n|--no-restore                            添加引用而不执行还原预览和兼容性检查。
  -r|--recursive                             递归搜索提供目录中的所有项目。
  -ifs|--ignore-failed-sources               将包源失败视为警告。
  -utd|--include-up-to-date                  在报告中包含所有依赖项，即使是未过时的。

dotnet-outdated 的截图

指定路径

你可以在不指定 路径 参数的情况下运行 dotnet-outdated。在这种情况下，它将在当前目录中查找解决方案（.sln），如果找到一个，它将分析该解决方案。如果没有找到解决方案，它将查找项目（.csproj 或 .fsproj），如果找到一个，它将分析该项目。如果在当前文件夹中找到多个解决方案或项目，dotnet-outdated 将报告错误。

你还可以在 路径 参数中传递一个目录，在这种情况下，将使用上述相同的逻辑，但在指定的目录中。

最后，你可以指定 dotnet-outdated 必须分析的解决方案（.sln）或项目（.csproj 或 .fsproj）的路径。

升级包

dotnet-outdated 可以通过传递 -u|--upgrade 选项自动尝试将任何过时的包升级到最新版本。你可以使用 -u:prompt 选项让 dotnet-outdated 为每个过时的包提示你。

使用安全源

dotnet-outdated 支持安全的 NuGet 源，例如 MyGet。建议您使用 NuGet CLI 的 source 命令将这些添加到您的源中。对于安全源，您可以执行以下操作之一：

添加预认证 URL。
使用 nuget sources 命令的 -UserName 和 -Password 选项指定源的用户名和密码。
使用凭证提供程序，如 Azure Artifacts 凭证提供程序。

dotnet-outdated 支持计算机级、用户级和项目级配置文件。

使用凭证提供程序需要设置环境变量 DOTNET_HOST_PATH，指向 dotnet 可执行文件的路径（例如，/usr/local/share/dotnet/dotnet）。某些版本的 .NET Core SDK 会在运行时为您设置，有些则不会。如果进程发现缺少此变量，您将收到解释此问题的错误消息。

macOS 上的问题

在我的测试中，在 macOS 上遇到了用户级配置文件位置未被正确检测的问题。如果您遇到 dotnet-outdated 似乎没有正确获取您的源的问题，请将源添加到项目级配置文件中。

此外，在 macOS 和 Linux 上，密码需要以明文形式存储。您可以通过向 nuget sources 命令传递 -StorePasswordInClearText 选项来实现这一点。

处理预发布版本

dotnet-outdated 允许您通过传递 -pre|--pre-release 选项来指定是否使用包的预发布版本。

默认值 Auto 将根据引用的版本本身是否为预发布版本来决定是否使用包的预发布版本。如果引用的版本是预发布版本，dotnet-outdated 将包含该包的较新预发布版本。如果引用的版本不是预发布版本，dotnet-outdated 将忽略预发布版本。

您也可以通过为此选项传递 Always 值来告诉 dotnet-outdated 始终包含预发布版本。相反，您可以通过传递 Never 值来告诉它永不包含预发布版本。

锁定当前主要或次要版本

dotnet-outdated 允许您通过传递 -vl|--version-lock 选项来锁定当前主要或次要版本。

默认值 None 将返回绝对最新的包，无论它是主要版本还是次要版本升级。

传递 Major 值将只报告当前主要版本范围内的较新包。例如，如果包的当前版本是 4.1.0，dotnet-outdated 将只报告 4.x 版本范围内的较新包。

传递 Minor 值将只报告当前次要版本范围内的较新包。例如，如果包的当前版本是 4.1.0，dotnet-outdated 将只报告 4.1.x 版本范围内的较新包。

报告传递依赖

dotnet-outdated 支持报告传递依赖。这些是您的应用程序直接引用的 NuGet 包所依赖的 NuGet 包。要启用传递依赖报告，您可以传递 -t|--transitive 选项。

分析传递依赖的截图

您还可以使用 -td|--transitive-depth 选项指定应分析传递依赖的深度。您可以为此选项传递一个整数值（默认值为 1）。

使用这些选项时要小心！。如果您尝试分析太多层级的依赖，分析可能需要很长时间。

当有更新可用时失败

dotnet-outdated 可以轻松集成到您的构建过程中。当发现更新时，您可以选择启用非零返回代码，以便轻松配置构建失败。要启用此选项，您可以传递 -f|--fail-on-updates 选项。

自动引用

在 dotnet-outdated 的 1.2 版本之前，它会在输出中包含自动引用的包。自动引用的包通常是您的框架包，如 Microsoft.NETCore.App 或 NETStandard.Library。报告这些包为过时没有意义，因为您应该针对新框架来更新它们。

从 1.2 版本开始，如果您想报告这些包，可以传递 -i|--include-auto-references 选项。这些包也将在输出中的包名后用 [A] 文本标注。

将结果保存到文件

您可以使用 -o|--output 选项指定输出文件名，将 dotnet-outdated 的结果保存到文件中。默认情况下，结果将以 JSON 格式保存。您可以使用 -of|--output-format 选项指定替代格式。

包含和排除包

您可以使用 -inc|--include 选项选择只包含特定的包。只有名称包含指定值的包才会被包含。例如，如果您只想分析包含 "microsoft" 值的包，可以使用命令 dotnet outdated --include microsoft。此选项可以多次传递：每个包将根据所有过滤器进行评估。只要有一个匹配就足以包含该包。

相反，您可以使用 -exc|--exclude 选项排除特定的包。在这种情况下，将分析所有包，除了名称包含指定值的包。例如，如果您想排除包含 "microsoft" 值的包，可以使用命令 dotnet outdated --exclude microsoft。此选项可以多次传递：每个包将根据所有过滤器进行评估。只要有一个匹配就足以排除该包。

请注意，对于包含和排除，比较都不区分文化和大小写。