用 husky 和 prettier 保证团队代码格式一致性

好久没有写博客,久到在刚想到写一篇博客的时候要打开哪个编辑器都楞了一下。今天介绍一下两个小工具 husky(对,哈士奇,2哈)和 prettier。我认为他们的出现减轻了软件开发流程中一些痛点。

husky 为 git commit 增加钩子

在之前的工作中,我们尝试通过在 git 的 pre-receive 阶段嵌入一系列的 ci 流程处理代码以提供给开发者们 "just push" 的开发流程(当然这个想法是完完全全源自 heroku 的)。这个流程将原先的 "push -> wait for verify -> new correct commit -> repush" 的流程转变为 "push -> fail -> correct -> repush":如果没有在 "pre-receive" 阶段设置门禁的话,坏的提交会被同步到中心仓库后在进行检测;而设置门禁之后坏的 commit 会被拒绝在本地,本地只能将 ci 可以通过的代码提交到中心仓库。但是将所有东西都通过 push 验证很显然是慢了一些:这就像表单的前端验证和后端验证一样,虽然后端验证永远必不可少但是它增加了服务器的负担并且延长了反馈周期。

这时候 husky 就要派上用场了。husky 其实就是一个为 git 客户端增加 hook 的工具。将其安装到所在仓库的过程中它会自动在 .git/ 目录下增加相应的钩子实现在 pre-commit 阶段就执行一系列流程保证每一个 commit 的正确性。部分在 cd commit stage 执行的命令可以挪动到本地执行,比如 lint 检查、比如单元测试。当然,pre-commit 阶段执行的命令当然要保证其速度不要太慢,每次 commit 都等很久也不是什么好的体验。

prettier 保证每个团队代码格式一致性

多少年来开发者在使用 tab 还是 space 的问题上真是花费了不少的时间,美剧硅谷里主角还因为 tab 和别人闹了一集,可见大家对代码格式化的重视程度-_-。记得我在上一个项目里看到有小哥把我的代码强行刷成他满意的格式的 commit 也非常不满。仅仅修改格式的 commit 是毫无必要的,它没有对软件本身的行为做任何的修改,而夹带了修改格式的 commit 更是令人抓狂的,给 review 的同学也带来了不小的负担(在一坨提交里仔仔细细看了半天发现神马也没变!!尼玛!!)。

golang 取了个巧,语言自带官方格式,你们终于不吵了吧。虽然会有时候看 golang 的格式化结果略微有点麻烦(就是 struct 对 json type 的制表符对齐的要求),但是也没有哪里是让人无法忍受的丑。如果其他的语言也以类似的方式制定一个官方格式是不是就会将此事平息下去呢。当然,我们可以在制定这个官方格式的时候吵架,只要官方格式不会三天两头的更新那在实际项目中为这种不必要的分歧导致浪费大把时间了。

在我看来 prettier 就是这么一个 "类官方格式" 了。不过目前它还只是支持 js 体系下的格式化,其他语言由于这样那样的问题还要再等等。

image

大家对有个公认的格式这件事还是非常认可的,项目出现一年,Github star 破 2.1w,并且像 facebook 这样的大公司已经在内部逐渐铺开使用了。

集成

最后,通过 husky 为 prettierpre-commit 加个钩子,这体验就更完美了:不论你家的格式是什么样子,只要你想提交,就必须格式化成 prettier 要求的样子,这样就没有那种因为格式变动出现的无聊的 diff 了。集成的流程基本是以下这个样子:

  1. 添加 prettier 依赖

    yarn add prettier --dev --exact
    
  2. 测试格式化是否工作

    yarn prettier -- --write src/index.js
    
  3. 在 commit 时执行 prettier

    yarn add pretty-quick husky --dev
    

    修改 package.json 添加 pre-commit 钩子

    {
      "scripts": {
        "precommit": "pretty-quick --staged"
      }
    }
    

其实官方文档也有,但是官方文档可耻的写错了...第二步命令少了 -- 的命令。

最后的最后,放一段 prettier 格式化的 react 代码,我还是对其默认的格式非常满意的。

class Badges extends React.Component {
  componentDidMount() {
    let { user, loadBadges } = this.props;
    loadBadges(user.username);
  }

  render() {
    let { badges } = this.props;
    return (
      <div style={{ marginTop: "50px" }}>
        <h1>已经获得的成就</h1>

        <Row
          gutter={16}
          type="flex"
          justify="center"
          align="top"
          style={{ marginTop: "20px", paddingBottom: "10px" }}
        >
          {badges.map(badge => (
            <Col
              lg={6}
              md={6}
              sm={8}
              xs={12}
              style={{ marginBottom: "1em" }}
              key={badge.project.id}
            >
              <ProjectBadge badge={badge} />
            </Col>
          ))}
        </Row>
      </div>
    );
  }
}

相关资料

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

推荐阅读更多精彩内容

  • 背景 某某你提交的代码有问题,怎么把没有验证的dev代码合并到master上去了…… 某某你提交的代码有问题,怎么...
    小黑妞_b8b9阅读 11,448评论 1 18
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,504评论 25 707
  • 你的名字 假如你敲响我的骨头 回荡的声音将是你的名字 假如你咬破我的嘴唇 流出的血迹将是你的名字 假如你放逐我于沙...
    不定行者阅读 302评论 1 4
  • 脑袋炸毛似的,脑回路缺损,阻塞,细胞的流速,从形成新的到逐渐死亡,再到新的,感觉缓慢了几个世纪。对,大脑在退化,我...
    Adaever阅读 90评论 0 0
  • 活动策划过程 策划一个活动包含很多环节,前期要做很多事情,比如:活动主题、活动对象、活动时间、活动描述、规则详情、...
    一个白菜运营喵阅读 1,606评论 0 0