代码质量和 Pre commit

一个人写代码的时候,想怎么写就怎么写,能实现功能就非常不错了,何必去和代码质量计较呢,谈什么代码重构!但是在 teamwork 中,这是一个不得不重视的问题。

Paste_Image.png

可能你的 team中有代码 review,这个确认能解决不少的问题,但是人眼在某些时候会远不如机器,如果你在 review 别人代码的时,发现有些地方空行太多,命名格式不规范等基本代码功力问题,必定会火冒三丈,心想:我 tm 百忙之中,抽空reveiw 你的代码,结果基本规范都没有通过,简直只浪费我的时间。

低级问题不应该提交到远程仓库,所有提交代码前的审查变得非常有必要。Git,Svn 等版本控制工具支持很多 hooks。以 git hooks 为例 , 钩子(hooks)是一些在"$GIT-DIR/hooks"目录的脚本, 在被特定的事件(certain points)触发后被调用。

pre-commit

在commit 之前会被触发,编程语言以 javascript 为例,如果能在 js 文件提交之前,执行一次 jshint ,那就满足我们的需求了。可最为一个追求极致的人怎么能只满足呢。

最优的模式,

  1. jshint 检查问题
  2. beauty code
  3. format code
  4. auto review
    ...

这些都是在本地完成的,当然你也可以用服务器端 check 的方式。比如 code climatetravisjinkens 等工具。

今天的主角是 http://pre-commit.com/

安装

Before you can run hooks, you need to have the pre-commit package manager installed.

Using pip:

pip install pre-commit

Non Administrative Installation:

curl http://pre-commit.com/install-local.py | python

System Level Install:

curl https://bootstrap.pypa.io/get-pip.py | sudo python - pre-commit

In a Python Project, add the following to your requirements.txt (or requirements-dev.txt):

pre-commit

使用

  1. 进入你的项目目录
  2. 执行 pre-commit install
  3. 新建文件 .pre-commit-config.yaml。yaml 的语法参考
  4. 编辑你的配置文件

example

-   repo: git://github.com/pre-commit/mirrors-jshint
    sha: 'v2.8.0'  # Use the sha you want to point at
    hooks:
    -   id: jshint
        name: jshint
        entry: jshint
        language: node
        files: \.js$
        args: []
        #excludes:

        # Use additional_dependencies to install the actual node package
        additional_dependencies: ['jshint@2.8.0']
        minimum_pre_commit_version: 0.7.0

更多 hooks

pre-commit 支持非常多的 hooks,配置方法也很简单,只需要你修改 .pre-commit-config.yaml 文件即可,更多 hooks 参考以下截图

http://pre-commit.com/hooks.html

Paste_Image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,679评论 6 342
  • 1.什么是 Git Hooks 如同其他许多的版本控制系统一样,Git 也具有在特定事件发生之前或之后执行特定脚本...
    就叫yang阅读 3,231评论 3 11
  • "这个世界,由于你注下来的水,淹没了我的天堂"―多恩《告别词·莫哭泣》 泪流满面,却不知从何而起。 做过无数次的梦...
    隆光阅读 244评论 0 0
  • 2017 10 28 星期六 晴 今天又是周末了,越没规律越容易忘记。明天终于可以休息下了。
    郑宇雅芯妈阅读 90评论 0 0