在上一篇[Cake] 2. dotnet 全局工具 cake中介绍了通过.Net Core 2.1 的全局工具dotnet tool命令来简化cake的安装和使用。因为是全局安装，则无法适应每个项目对特定版本的要求。随着.Net Core 3.0中增加的对本地工具（项目级别）的支持，使得这一问题得以解决。

1. cake的安装和还原

# 创建一个本地的工具清单文件

dotnet new tool-manifest

# 安装本地工具

dotnet tool install cake.tool --version 0.35.0

dotnet new tool-manifest命令会在当前目录下创建一个.config/dotnet-tools.json的文件。当我们执行dotnet tool install cake.tool时，就会把cake.tool的相关信息写入到这个文件。

{

  "version": 1,

  "isRoot": true,

  "tools": {

    "cake.tool": {

      "version": "0.35.0",

      "commands": [

        "dotnet-cake"

      ]

    },

    "dotnet-format": {

      "version": "3.1.37601",

      "commands": [

        "dotnet-format"

      ]

    }

  }

}

之后就可以执行dotnet cake(或者dotnet tool run dotnet-cake)命令了。

$ dotnet cake --help

Usage: Cake.exe [script] [--target=value] [--verbosity=value]

                [--showdescription] [--dryrun] [..]

Example: Cake.exe

Example: Cake.exe build.cake --verbosity=quiet

Example: Cake.exe build.cake --showdescription

Options:

    --target <TARGET>    Target task to invoke. Script must support this explicitly.

    --verbosity=value    Specifies the amount of information to be displayed.

                         (Quiet, Minimal, Normal, Verbose, Diagnostic)

    --debug              Performs a debug.

    --showdescription    Shows description about tasks.

    --showtree           Shows the task dependency tree.

    --dryrun             Performs a dry run.

    --exclusive          Execute a single task without any dependencies.

    --bootstrap          Download/install modules defined by #module directives

    --version            Displays version information.

    --info               Displays additional information about Cake execution.

    --help               Displays usage information.

当我们在CI/CD或者另外一个环境上时，只需要执行

dotnet tool restore

就可以把.config/dotnet-tools.json文件中配置的相关工具安装在本地了。

2. dotnet format 格式化

介绍一下另外一个非常有用的工具dotnet-format。看下官方介绍：

dotnet-format is a code formatter for dotnet that applies style preferences to a project or solution. Preferences will be read from an .editorconfig file, if present, otherwise a default set of preferences will be used. At this time dotnet-format is able to format C# and Visual Basic projects with a subset of supported .editorconfig options.

它会使用.editorconfig中的格式化配置，来统一项目的文件编码和格式。 安装方式同上面的cake一样。

# 安装

dotnet tool install dotnet-format

# 检查并保存

dotnet format

# 只检查不保存，检查失败则返回非0的exit code

dotnet format --check --dry-run

结合CI使用非常方便，当你push的代码不符合格式要求时就直接失败了（一个失败的示例：https://github.com/linianhui/cake.example/commit/471f58754c390cb9946a5282c6d73275b90549d9/checks?check_suite_id=361927437）。

示例，它会提示出那些地方不符合.editorconfig的要求：

$ dotnet format --check --dry-run

  1-src/Cake.Example/Animals/Cat.cs(17,2): Add final newline.

  1-src/Cake.Example/Animals/Dog.cs(17,2): Add final newline.

  1-src/Cake.Example/IAnimal.cs(14,2): Add final newline.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(18,2): Add final newline.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(18,2): Add final newline.

  1-src/Cake.Example/Animals/Cat.cs(1,31): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(2,2): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(3,18): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(4,12): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(5,19): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(6,38): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(7,6): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(8,22): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(9,15): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(10,23): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(11,32): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(12,29): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(13,10): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(14,25): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(15,10): Fix end of line marker.

  1-src/Cake.Example/Animals/Cat.cs(16,6): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(1,31): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(2,2): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(3,18): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(4,11): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(5,19): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(6,38): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(7,6): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(8,22): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(9,15): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(10,23): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(11,32): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(12,29): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(13,10): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(14,25): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(15,10): Fix end of line marker.

  1-src/Cake.Example/Animals/Dog.cs(16,6): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(1,23): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(2,2): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(3,18): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(4,13): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(5,19): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(6,29): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(7,6): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(8,22): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(9,16): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(10,23): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(11,32): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(12,23): Fix end of line marker.

  1-src/Cake.Example/IAnimal.cs(13,6): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(1,28): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(2,13): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(2,13): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(4,42): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(5,2): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(6,32): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(7,6): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(8,15): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(9,39): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(10,10): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(11,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(11,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(13,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(13,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(15,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(16,10): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/CatTest.cs(17,6): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(1,28): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(2,13): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(2,13): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(4,42): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(5,2): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(6,32): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(7,6): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(8,15): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(9,39): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(10,10): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(11,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(11,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(13,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(13,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(15,40): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(16,10): Fix end of line marker.

  2-test/Cake.Example.Tests/AnimalsTests/DotTest.cs(17,6): Fix end of line marker.

  Formatted code file 'Cat.cs'.

  Formatted code file 'Dog.cs'.

  Formatted code file 'IAnimal.cs'.

  Formatted code file 'CatTest.cs'.

  Formatted code file 'DotTest.cs'.

  Format complete in 3529ms.

dotnet-foramt支持的.editorconfig信息比较丰富，具体的参考 https://github.com/dotnet/format/wiki/Supported-.editorconfig-options 的说明，这里也贴一个我在使用的.editorconfig：

https://github.com/linianhui/code.guide/blob/master/csharp/.editorconfig

3. 参考

源码： https://github.com/linianhui/cake.example

我的.editorconfig : https://github.com/linianhui/code.guide/blob/master/csharp/.editorconfig

https://editorconfig.org/

https://github.com/dotnet/format/wiki/Supported-.editorconfig-options

https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-core-3-0#local-tools

https://github.com/dotnet/format

[Cake] 3. dotnet 本地工具 cake & dotnet format的更多相关文章

  1. [Cake] 2. dotnet 全局工具 cake

    在上篇博客[Cake] 1. CI中的Cake中介绍了如何在CI中利用Cake来保持与CI/CD环境的解耦. 1. 简化cake的安装 当时dotnet 2.1还未正式发布,dotnet 还没有工具的 ...

  2. dotnet CLI工具是如何运行你的代码的

    原文连接:https://mattwarren.org/2016/07/04/How-the-dotnet-CLI-tooling-runs-your-code/作者 Matt Warren.授权翻译 ...

  3. [Cake] 1. CI中的Cake

    在上一篇C#Make自动化构建-简介中,简单的介绍了下Cake的脚本如何编写以及通过Powershell在本地运行Cake脚本.本篇在此基础上,介绍下如何在CI环境中使用Cake. 1. Cake简介 ...

  4. .NET Core 3.0 本地工具

    .NET Core从最早期的版本就开始支持全局工具了.如果仅仅需要在某个项目中或某个文件夹中使用特定的工具,那么.NET Core 3.0就允许您这样做. 使用.NET Core 3.0,您可以在特定 ...

  5. X86上搭建交叉工具链，来给龙芯笔记本编译本地工具链（未完待续）

    故事的背景是,我买了一台龙芯2F的笔记本来装B. 为什么说是装B呢?因为不但操作系统是Linux,而且CPU还是龙芯的. 一般人有这么酷的装备吗?简直是装B大圣啊. 这里一定要申明一点,本人不是IT技 ...

  6. X86给龙芯笔记本编译本地工具链（未完待续）

    我买了一台龙芯2F的笔记本来当玩具. 买回来发现,这台笔记本上没法安装软件,因为既没有软件仓库,也没有GCC. 因此需要构建交叉工具链和构建本地工具链. 下面是我研究如何搞定着一切的笔记. 工具链组件 ...

  7. 【dotnet跨平台】&quot;dotnet restore&quot;和&quot;dotnet run&quot;都做了些什么？

    [dotnet跨平台]"dotnet restore"和"dotnet run"都做了些什么? 前言: 关于dotnet跨平台的相关内容.能够參考:跨平台.NE ...

  8. 解决本地工具无法连接服务器上的mysql的问题

    当本地工具尝试连接服务器的时候,如果出现无法连接的情况,可能是权限没有开. 首先: mysql> show  databases: 发现有mysql数据库 进入该数据库,找到user表 mysq ...

  9. .net core下的dotnet全局工具

    .net core 2.1后支持了一个全新的部署和扩展命令,可以自己注册全局命令行. dotnet install tool -g dotnetsaydotnetsay 也可以自己构建自己的命令行,一 ...

随机推荐

  1. mysql 创建用户及授权（1）

    一. 创建用户 命令: CREATE USER 'username'@'host' IDENTIFIED BY 'password'; 说明: username:你将创建的用户名 host:指定该用户 ...

  2. ThreadLocal原理分析与代码验证

    ThreadLocal提供了线程安全的数据存储和访问方式,利用不带key的get和set方法,居然能做到线程之间隔离,非常神奇. 比如 ThreadLocal<String> thread ...

  3. java版单例模式

    单例模式可以说是最常用的设计模式之一,其主要作用就是保证一个类只有一个实例,并且提供一个访问它的全局访问点,严格的控制用户的访问方式. 单例模式又分为懒汉模式和饿汉模式,首先说一下饿汉模式: 饿汉模式 ...

  4. RxJS入门

    一.RxJS是什么? 官方文档使用了一句话总结RxJS: Think of RxJS as Lodash for events.那么Lodash主要解决了什么问题?Lodash主要集成了一系列关于数组 ...

  5. js 根据指定的多个索引，删除相应的数组元素。splice + sort

    更新于2018-04-19 var productItems = ["a", "b", "c", "d"]; var i ...

  6. 做为GPU服务器管理员，当其他用户需要执行某个要root权限的命令时，除了告诉他们root密码，还有没有别的办法？

    通常一台GPU服务器(这里指linux系统)不可能只有一个帐号能用的,比如当其他用户想要在GPU服务器上安装一些软件的时候,会需要用到apt-get命令,但是apt-get命令需要root用户的操作权 ...

  7. 30L，17L，13L容器分油，python递归，深度优先算法

    伪代码: 全部代码: a=[] b=[] def f(x,y,z): b.append([x,y,z]) if x==15 and y==15: print(x,y,z) i=0; for x in ...

  8. String类对象两种实例化方式比较

    第一种:直接赋值 String str =  "hello!" ; 在java中,有一个字符串常量池,对于这种直接赋值的,会直接写进常量池(常量池里面不存在其value,) 自JD ...

  9. Linux01机和Linux02机的切换 和秘钥的配置

    先试一下 01机和02机是否可以切换成功 使用 ssh root@ip地址 输入密码 ifconfig查看ip是否正确 切换回01机 01机配置的秘钥 查看隐形文件 01机配置秘钥 输入  ssh-c ...

  10. 11-kubernetes RBAC 及授权

    目录 RBAC role 和 clusterrole rolebinding 和 clusterrolebinding 公共权限 clusterrole user 创建测试 创建role案例 创建 r ...