Cake.DotNetLocalTools.Module 3.0.12

dotnet add package Cake.DotNetLocalTools.Module --version 3.0.12                
NuGet\Install-Package Cake.DotNetLocalTools.Module -Version 3.0.12                
此命令旨在在 Visual Studio 的包管理器控制台中使用,因为它使用 NuGet 模块的版本 Install-Package
<PackageReference Include="Cake.DotNetLocalTools.Module" Version="3.0.12" />                
对于支持 PackageReference 的项目,将此 XML 节点复制到项目文件中以引用包。
paket add Cake.DotNetLocalTools.Module --version 3.0.12                
#r "nuget: Cake.DotNetLocalTools.Module, 3.0.12"                
#r 指令可以在 F# Interactive 和 Polyglot Notebooks 中使用。将其复制到交互式工具或脚本的源代码中,以引用包。
#module nuget:?package=Cake.DotNetLocalTools.Module&version=3.0.12                

Cake.DotNetLocalTools.Module

A Cake Module that extends Cake with functionality to install tools from a .NET tool manifest.

You can read the latest documentation at https://github.com/ap0llo/Cake.DotNetLocalTools.Module

目录

概述

Cake 允许通过 #tool 预处理器直接和 Cake.Frosting 的 InstallTool 方法(参见 安装和工具使用 以获取详细信息)安装 .NET CLI 工具

.NET Core 3.1 引入了“本地工具”的概念。本地工具列在“工具清单”(dotnet-tools.json)中,并通过 dotnet 命令执行。

Cake.DotNetLocalTools.Module 将这两个概念结合起来。它从一个或多个工具清单中读取工具列表,并通过 Cake 的工具基础架构进行安装。这样,您可以在 Cake 中轻松使用工具,同时仍然以通用格式描述工具及其版本。

用法

Cake 脚本

要在 Cake 脚本文件中使用此模块,请执行以下步骤

  1. 添加预处理器指令以安装模块

    #module nuget:?package=Cake.DotNetLocalTools.Module&version=VERSION
    
  2. 使用 #tool 预处理器指令和 toolmanifest uri 方案安装工具

    #tool "toolmanifest:?package=.config/dotnet-tools.json"
    

Cake.Frosting

要在 Cake.Frosting 项目中使用此模块,请按照以下步骤操作。

  1. 通过将包引用添加到您的项目中来安装模块包。

    <PackageReference Include="Cake.DotNetLocalTools.Module" Version="VERSION" /> 
    
  2. LocalToolsModule 注册到 Cake 主机。

    using Cake.DotNetLocalTools.Module;
    
    public static int Main(string[] args)
    {
        return new CakeHost()
            // Register LocalToolsModule
            .UseModule<LocalToolsModule>()        
            // Continue with the standard setup of a Cake.Frosting project
            .UseContext<BuildContext>()
            .Run(args);
    }
    
  3. 您不能使用 InstallToolsFromManifest() 方法或使用 InstallTools() 并以 toolmanifest 为 uri 方案来安装工具。

    using Cake.DotNetLocalTools.Module;
    
    public static int Main(string[] args)
    {
        return new CakeHost()
            // Register LocalToolsModule
            .UseModule<LocalToolsModule>() 
            // Install Tools (both install options are equivalent)
            .InstallToolsFromManifest(".config/dotnet-tools.json")       
            .InstallTools(new Uri("tool-manifest:?package=.config/dotnet-tools.json"))       
            // Continue with the standard setup of a Cake.Frosting project
            .UseContext<BuildContext>()
            .Run(args);
    }
    

示例

从工具清单中安装工具相当于使用 #tool 预处理程序指令或通过 InstallTool() 安装清单中列出的工具。

例如,位于 .config/dotnet-tools.json 的工具清单可能如下所示

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "nbgv": {
      "version": "3.4.231",
      "commands": [
        "nbgv"
      ]
    },
    "dotnet-format": {
      "version": "5.1.225507",
      "commands": [
        "dotnet-format"
      ]
    },
    "dotnet-reportgenerator-globaltool": {
      "version": "4.8.12",
      "commands": [
        "reportgenerator"
      ]
    }
  }
}

可以使用以下方法安装清单中的工具

#tool "toolmanifest:?package=.config/dotnet-tools.json"

这相当于分别安装每个工具

#tool "dotnet:?package=nbgv&version=3.4.231"
#tool "dotnet:?package=dotnet-format&version=5.1.225507"
#tool "dotnet:?package=dotnet-reportgenerator-globaltool&version=4.8.12"

许可

Cake.DotNetLocalTools.Module 适用于 MIT 许可证。

详细信息请见 https://github.com/ap0llo/Cake.DotNetLocalTools.Module/blob/master/LICENSE

产品 兼容和额外的计算目标框架版本。
.NET net6.0 兼容。 net6.0-android 已计算。 net6.0-ios 已计算。 net6.0-maccatalyst 已计算。 net6.0-macos 已计算。 net6.0-tvos 已计算。 net6.0-windows 已计算。 net7.0 兼容。 net7.0-android 已计算。 net7.0-ios 已计算。 net7.0-maccatalyst 已计算。 net7.0-macos 已计算。 net7.0-tvos 已计算。 net7.0-windows 已计算。 net8.0 已计算。 net8.0-android 已计算。 net8.0-browser 已计算。 net8.0-ios 已计算。 net8.0-maccatalyst 已计算。 net8.0-macos 已计算。 net8.0-tvos 已计算。 net8.0-windows 已计算。
兼容目标框架
包含目标框架(在包中)
了解更多关于 目标框架.NET Standard 的信息。

NuGet 包

此包未被任何 NuGet 包使用。

GitHub 仓库 (1)

显示依赖于 Cake.DotNetLocalTools.Module 的前 1 个最受欢迎的 GitHub 仓库

仓库 星标
GitTools/GitVersion
从 Git 日志到 SemVer 一瞬间
版本 下载 最后更新
3.0.12 15,960 11/24/2022
1.0.2 15,941 10/13/2021