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代碼進行自動化格式化，這種方式方便了許多
最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。
禁止轉載，如需轉載請通過簡信或評論聯系作者。

推薦閱讀更多精彩內容