git commit 检查风格 自动化格式代码

参考1：基于space command 从 git commit 自动化代码风格 https://juejin.cn/post/6844903555866820622
参考2: git hook原理 https://c.isme.pub/2017/06/14/git-hooks/

背景

大多数 iOS 开发者应该都知道 Xcode 的插件 Clang Format,它是基于 clang-format 命令行工具的一个 Xcode 插件,但是这款插件在Xcode9上已经无法使用了，因为Xcode9的插件机制已经变了。
现在可以使用这一款XcodeClangFormat，具体的使用方式点击链接，大家自行去看吧。这款有个缺点，就是不能像之前那款插件可以设置在保存时自动格式化(这其实也不能怪作者，Xcode新的机制不允许)。 不过使用这种插件还是不够方便，你还得手动选中文件或者代码再按快捷键来格式化，很容易忘，而导致把不规范的代码直接提交到仓库里了。

那么有没有一种方式，可以让我在敲代码的时候随心所欲，提交时又能提醒我然后自动帮我格式化吗？

思路

这里我直接介绍一款神器Space Commander，它利用 Git Hooks ，在 commit 之前检查代码风格是否符合规范，只有符合规范的代码才允许提交，列出不符合规范的文件，同时提供 Shell 脚本来自动格式化。接下来我介绍下如何使用。

目标

• 理解目前格式化的手段，基于.clang_format 文件做
• spacecommander这个开源组件可以内部做具体代码格式合法检测、它消---费.clang_format做自动化代码
• 使用 xcode build hook 启动 spacecommander 自动化下载组件
• 脚本启动 spacecommander

跟着步骤来一遍

第一步：项目根目录下新增一个下载并且启动 spacecommander 脚本文件 ：format-check.sh

#!/usr/bin/env bash
orgin=`git rev-parse --show-toplevel` #展示工作根目录
if [ ! -d .git ];
then exit 0
fi
if [ -d .spacecommander ];
then exit 0
fi
mkdir .spacecommander
cd .spacecommander
git clone git@git.koolearn-inc.com:k12/iOS/SpaceCommand.git spacecommander
cd $orgin
bash "$(pwd)/.spacecommander/spacecommander/setup-repo.sh"
exit 0

第二步：利用编译的插桩

方式1: clang 自定义插件
方式2: xcode -> build phase -> add run script （目前使用这种方式）增加一下脚本，启动spacecommander下载启动脚本

cd ${SRCROOT}
chmod u+x ./format-check.sh
sh format-check.sh

执行 command + b，结果如下：

• 工程根目录下会生成一个.spacecommander隐藏文件，已多一分.clang_format副本，这个文件用于做自动化检测代码风格的基础，我们可以修改内部的规则
• .git文件夹 目录会自动生成一个pre-commit文件 ，用于hook我们的hook操作

第三步：我们在自己的工程里随便增加一部分代码，随便风格编写

- (void)viewDidLoad
{
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    //方式1
    //self.threadAliveHelper = [[GGZResidentThread alloc] init];

    //方式2
    self.threadAliveHelper = [[GGZKeepAliveHelper alloc] init];

UIView *view1 = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 100, 100)];
    NSLog(@"view1-frame:%@", NSStringFromCGRect(view1.frame));
    view1.bounds = CGRectMake(0, 0, 50, 50);
    NSLog(@"view2-frame:%@", NSStringFromCGRect(view1.frame));
    view1.backgroundColor = [UIColor redColor];
    [self.view addSubview:view1];
    UIView *view2 = [[UIView alloc] initWithFrame:CGRectMake(50, 30, 300, 300)];
    [self.view addSubview:view2];
    view2.backgroundColor = [UIColor yellowColor];
[view2 addSubview:view1];}


- (IBAction)resumeResidentThread:(id)sender
{
[self.threadAliveHelper resume];
}

- (void)test
{
NSLog(@"aa");
}

- (void)test2
{
NSLog(@"aa");
}

cmd上执行 git commit -m '修改文件' 或者source tree 提交修改

这时会示我们代码风格根clang_format 文件不一致的风格，提示如下？

Xnip2021-08-08_17-57-39.jpg

根据提示：我们的 ViewController.m 风格不对 ，执行提示的命令去格式化

"/Users/gegaozhao/Desktop/Person/练习/IOS-learning/TEST12-Threadkeepalive/.spacecommander/spacecommander"/format-objc-files.sh

注意：引号不要漏掉

格式化后代码：

@interface ViewController ()
{
    BOOL _stopLoop;
}
@property (nonnull, strong) id<GGZKeepThreadProtocol> threadAliveHelper;
@end


@implementation ViewController

- (void)viewDidLoad
{
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    //方式1
    //self.threadAliveHelper = [[GGZResidentThread alloc] init];

    //方式2
    self.threadAliveHelper = [[GGZKeepAliveHelper alloc] init];

    UIView *view1 = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 100, 100)];
    NSLog(@"view1-frame:%@", NSStringFromCGRect(view1.frame));
    view1.bounds = CGRectMake(0, 0, 50, 50);
    NSLog(@"view2-frame:%@", NSStringFromCGRect(view1.frame));
    view1.backgroundColor = [UIColor redColor];
    [self.view addSubview:view1];
    UIView *view2 = [[UIView alloc] initWithFrame:CGRectMake(50, 30, 300, 300)];
    [self.view addSubview:view2];
    view2.backgroundColor = [UIColor yellowColor];
    [view2 addSubview:view1];
}


- (IBAction)resumeResidentThread:(id)sender
{
    [self.threadAliveHelper resume];
}

- (void)test
{
    NSLog(@"aa");
}

- (void)test2
{
    NSLog(@"aa");
}

思考。。。
我们实现的是半自动化，我们执行commit 后还是需要我们执行提示的命令去修改 可不可以 我们直接提示 然后按照提示去修改呢

进一步继续优化😄

关于这里有点复杂，需要了解 git hook 原理 和 clang 插桩操作 ，参加开头我提供的文档
这里执行给你们提供我完善的 Space Commander 组件库 ，执行git commit 提示是否自动格式化代码 ，可以将前面的第一步：format-check.sh脚本 git clone 地址换为我的 Space Commander 的 git@ 地址即可 ，你也可以down下来自己看下，是否存在安全因素再选择是否用，具体修改如下：

Xnip2021-08-08_18-08-30.jpg

常见问题

问题1: 如果你command + b 发现 跟目录没有 spacecommander
原因1：你的format-check.sh 的git 地址不对，很有可能，这个不可要 fan qiang .
原因2：你的github的受本地的nds影响，修改电脑dns即可

问题2: .git / hook/ 没有 pre-commit 执行文件
原因：你的工程的format-check.sh 没有执行 spacecommander 目录下的setup-repo.sh的路径不对

如果你想省事，可以直接，下再我们的 Space Commander 然后解压到根目录下即可，要保证和脚本format-check.sh路径一致

其他

• 如果你想省事，可以直接down下我的 Space Commander 然后解压到根目录下即可，要保证和脚本format-check.sh路径一致
• 如果你想要用自己的规则，可以去Space Commander仓库中改真身，也可以用新的.clang-format文件替换掉这个替身。
  -其实上面的方式，需要每一个开发者第一次command +b 下载对应的space command ，我们后面使用gitlab或者其他的代码管理仓的web hook方式，首先在jenkins我们的flow 构建工程勾选代码提交监听，这时会生成对应的webhook地址，这时将地址放在gitlab/设置/webhook,这样你每一次提交，会触发这个地址，jenkins会对提交的commit代码进行自动化格式化，这种方式方便了许多