内容简介:每个团队都应该有统一的代码风格和规范,这带来的好处我相信不言而喻,具体我就不多说了,大家都懂的。如何更有效率的去做这件事呢,我这次就来说说如何更好的自动格式化你的代码。大多数 iOS 开发者应该都知道 Xcode 的插件 Clang Format,它是基于 clang-format 命令行工具的一个 Xcode 插件,但是这款插件在Xcode9上已经无法使用了,因为Xcode9的插件机制已经变了。现在可以使用这一款
前言
每个团队都应该有统一的代码风格和规范,这带来的好处我相信不言而喻,具体我就不多说了,大家都懂的。如何更有效率的去做这件事呢,我这次就来说说如何更好的自动格式化你的代码。
现状
大多数 iOS 开发者应该都知道 Xcode 的插件 Clang Format,它是基于 clang-format 命令行 工具 的一个 Xcode 插件,但是这款插件在Xcode9上已经无法使用了,因为Xcode9的插件机制已经变了。
现在可以使用这一款 XcodeClangFormat ,具体的使用方式点击链接,大家自行去看吧。这款有个缺点,就是不能像之前那款插件可以设置在保存时自动格式化(这其实也不能怪作者,Xcode新的机制不允许)。
不过使用这种插件还是不够方便,你还得手动选中文件或者代码再按快捷键来格式化,很容易忘,而导致把不规范的代码直接提交到仓库里了。
那么有没有一种方式,可以让我在敲代码的时候随心所欲,提交时又能提醒我然后自动帮我格式化吗?
该怎么做
这里我直接介绍一款神器 Space Commander ,它利用 Git Hooks ,在 commit 之前检查代码风格是否符合规范,只有符合规范的代码才允许提交,列出不符合规范的文件,同时提供 Shell 脚本来自动格式化。接下来我介绍下如何使用。
-
1 clone Space Commander
git clone https://github.com/square/spacecommander.git
-
2 在项目中安装Space Commander
cd到你的项目根目录,执行setup-repo.sh脚本(在你clone下来的项目中,所以要全路径),执行完后会在项目根目录多一个隐藏文件.clang-format,这是一个替身,指向Space Commander仓库中的.clang-format文件,里面默认包含了一系列代码规则,如果你想要用自己的规则,可以去Space Commander仓库中改真身,也可以用新的.clang-format文件替换掉这个替身。
-
3 让我们提交代码试试
BasedOnStyle: Chromium IndentWidth: 4 AlignConsecutiveAssignments: true AlignConsecutiveDeclarations: true ObjCSpaceAfterProperty: true PointerAlignment: Right BreakBeforeBraces: Attach
这是我自定义的一些规则,具体.clang-format的写法请参照这个。
好,让我们写一下代码
#import "ViewController.h" @interface ViewController () @property(nonatomic, copy) NSString* p; @property(nonatomic, strong) UITextView * textview; @end @implementation ViewController -(void)formatTest:(NSString *)param{ if (param) { NSLog(@"sss"); } int a=0; int b = 1; int c= 2; NSLog(@"%d%d%d",a,b,c); } -(void)viewDidLoad{ [super viewDidLoad]; // Do any additional setup after loading the view, typically from a nib. } -(void)viewDidAppear:(BOOL)animated { } - (void)didReceiveMemoryWarning { [super didReceiveMemoryWarning]; // Dispose of any resources that can be recreated. } @end
这一看,就很不规范吧,先让我们提交看看
提交的时候明确提示ViewController文件需要格式化,这时候我们可以使用format-objc-file.sh脚本单独格式化某个文件,也可以format-objc-files.sh格式化所有的暂存文件,甚至使用format-objc-files-in-repo.sh格式化整个仓库的文件。
再提交一遍
好,接下来我们在看看代码变成什么样子了
#import "ViewController.h" @interface ViewController () @property (nonatomic, copy) NSString * p; @property (nonatomic, strong) UITextView *textview; @end @implementation ViewController - (void)formatTest:(NSString *)param { if (param) { NSLog(@"sss"); } int a = 0; int b = 1; int c = 2; NSLog(@"%d%d%d", a, b, c); } - (void)viewDidLoad { [super viewDidLoad]; // Do any additional setup after loading the view, typically from a nib. } - (void)viewDidAppear:(BOOL)animated { } - (void)didReceiveMemoryWarning { [super didReceiveMemoryWarning]; // Dispose of any resources that can be recreated. } @end
完美!
后续
可以看到上面的命令太长了,必须要指定shell脚本的全路径才能执行,我们可以简化命令,如果你用的zsh,去修改 ~/.zshrc,如果是bash,则修改~/.bash_profile,
// 初始化 alias clangformatsetup="/你自己的路径/spacecommander/setup-repo.sh" // 格式化对应文件 alias clangformatfile="/你自己的路径/spacecommander/format-objc-file.sh" // 格式化所有暂存文件 alias clangformatfiles="/你自己的路径/spacecommander/format-objc-files.sh" // 格式化整个仓库 alias clangformatall="/你自己的路径/spacecommander/format-objc-files-in-repo.sh
如果你还想知道更多的用法,直接去spacecommander的github主页查看。
作者:小顾Bruce
链接:https://juejin.im/post/5a6989dff265da3e2e62af2d
以上所述就是小编给大家介绍的《让你的代码自动格式化》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
猜你喜欢:- 代码风格统一之代码自动格式化
- Go代码格式化
- [译] Swift 代码格式化
- 一键自动格式化你的代码
- vscode代码格式化和eslint
- GO语言学习笔记(二)IDE安装与配置、格式化代码、生成代码文档
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
R语言实战(第2版)
[美] Robert I. Kabacoff / 王小宁、刘撷芯、黄俊文等 / 人民邮电出版社 / 2016-5 / 99.00元
本书注重实用性,是一本全面而细致的R指南,高度概括了该软件和它的强大功能,展示了使用的统计示例,且对于难以用传统方法处理的凌乱、不完整和非正态的数据给出了优雅的处理方法。作者不仅仅探讨统计分析,还阐述了大量探索和展示数据的图形功能。新版做了大量更新和修正,新增了近200页内容,介绍数据挖掘、预测性分析和高级编程。一起来看看 《R语言实战(第2版)》 这本书的介绍吧!