原文链接

前言

随着Flutter 2.0的公布，越来越多的公司和集体都在尝试应用Flutter来编写性能优异、跨平台、渲染一致性好的App。当然，在谋求效率的同时，也不要忘了给你的代码增加更多谨严的限度，来保障代码的品质。明天我给大家举荐一个插件，用于给提交代码到Github或者GitLab时，在本地应用dart语言，即可限度提交代码的品质。

Git Hooks

Git Hooks是什么，Hooks顾名思义，就是钩子。它在Git中的作用就是在咱们通过git命令操作仓库或者增加我的项目文件时，运行一些脚本，脚本通过即可实现事件，如果失败就被终止事件。这里是官网定义的所有钩子，有趣味的能够一一查看。比方咱们在.git/hooks/下新建了一个pre-commit文件，并输出以下内容

#!/bin/shecho '文件正在提交'exit(-1)

而后咱们在命令行中执行

git add testgit commit -m '提交信息'

而后咱们就会在命令行看到文件正在提交，并且文件最初没有提交到本地仓库，因为下面我exit了。

这样，咱们就能够在这个文件中写一些校验，比方通过dartanalyzer查看本地我的项目语法是否有语法问题。

git_hooks

这是一个Dart命令行插件，也是一个Dart插件。咱们看到下面应用shell脚本来写校验，它存在一些问题：

  • 每个人的.git文件夹是不通过版本治理的，所以一个人第一次拉了代码，在.git/hooks文件夹下是不会存在能运行的hooks文件的
  • shell脚本比拟生涩难写，上手难度高

git_hooks库就是为了解决下面问题。它的作用就是能通过命令生成所有hooks，而后在咱们通过git命令提交代码时，能够通过dart来进行提交前或者提交信息的校验。它让咱们程序员能够疏忽hooks文件存在，在dart代码中实现对所有钩子的操作。

这里咱们定一个咱们能看懂的术语

hooks文件：指在.git/hooks文件夹下生成的钩子文件
dart钩子文件：指在我的项目中生成的应用dart语言来操作hooks文件的dart文件

咱们能够通过上面命令来装置它，装置它前请保障你的dart曾经装置且曾经配置了环境变量，还要保障你的 dart 版本大于 2.1.0

运行命令dart --version查看dart版本号

而后运行pub global activate git_hooks即可全局装置git_hooks命令

创立hooks我的项目文件

当咱们关上一个领有git版本治理的我的项目（在我的项目中可看到.git文件夹）

在我的项目中的pubspec.yaml文件中增加

dev_dependencies:  git_hooks: ^0.1.5

创立hooks文件和dart钩子文件的命令是：

git_hooks create {{targetFileName}}
  • targetFileName指的是dart钩子文件，它能够是我的项目中任何地位，比方在根目录下的git_hooks.dart文件（这也是如果此参数不传默认会创立的文件）

那咱们来执行：

git_hooks create git_hooks.dart

如果输入

create files...                        All files wrote successful!0.2s

那阐明咱们曾经创立胜利。咱们来检查一下文件是否生成胜利，查看.git/hooks文件下是否有多个文件例如pre-commit,pre-push等等，查看根目录下是否已生成git_hooks.dart文件

关上git_hooks.dart文件会看到如下

import 'package:git_hooks/git_hooks.dart';// import 'dart:io';void main(List arguments) {  // ignore: omit_local_variable_types  Map<Git, UserBackFun> params = {    Git.commitMsg: commitMsg,    Git.preCommit: preCommit  };  GitHooks.call(arguments, params);}Future<bool> commitMsg() async {  // String rootDir = Directory.current.path;  // String commitMsg = Utils.getCommitEditMsg();  // if (commitMsg.startsWith('fix:')) {  //   return true; // you can return true let commit go  // } else  //   return false;  return true;}Future<bool> preCommit() async {  // try {  //   ProcessResult result = await Process.run('dartanalyzer', ['bin']);  //   print(result.stdout);  //   if (result.exitCode != 0) return false;  // } catch (e) {  //   return false;  // }  return true;}

解释：

  • main办法下的params是一个Map，是咱们想要自定义的钩子汇合，每个钩子对应上面具体的函数
  • GitHooks.call 是固定写法，库的外部会执行钩子函数并校验
  • commitMsg函数是一个例子，当执行git的commit-msg脚本时，会执行此函数，如果返回false，会终止git操作

咱们尝试把正文关上

Future<bool> commitMsg() async {  var commitMsg = Utils.getCommitEditMsg();  if (commitMsg.startsWith('fix:')) {    return true; // you can return true let commit go  } else  {    print('you should add `fix` in the commit message');    return false;  }}

而后在我的项目门路的命令行下执行:

git add git_hooks.dartgit commit -m '提交信息'

脚本输入如下

you should add `fix` in the commit message

并且文件没有被提交到本地仓库。

功败垂成！

删除所有hooks文件

当咱们有一天被本人写的钩子折磨，不想再用此校验，咱们有两个形式来删除钩子

  1. 删除.git/hooks文件夹，留神是hooks文件夹而不是.git文件夹
  2. 通过命令git_hooks uninstall来删除

其它钩子的枚举

你能够通过上面的枚举，增加更多的钩子操作

enum Git {  applypatchMsg,  preApplypatch,  postApplypatch,  preCommit,  prepareCommitMsg,  commitMsg,  postCommit,  preRebase,  postCheckout,  postMerge,  prePush,  preReceive,  update,  postReceive,  postUpdate,  pushToCheckout,  preAutoGc,  postRewrite,  sendemailValidate}

具体含意能够参考git官网文档

结语

下面是我的一个例子，当然咱们能够应用该工具做更多的事件，比方应用dartanalyzer查看代码品质，应用dartfmt来查看代码文件格式是否对齐等等。

pub仓库地址

github地址

git hooks 官网文档