自动格式化以及提交代码时的优化配置

概览:

prettier

eslint fix

git hook

commitlint

以配置js为例

第一步 格式化所有代码 prettier

在package.json的script里面添加如下配置,注意修改成自己的文件路径,采用glob配置。

配置完毕,可以执行 测试一下。

更多配置访问官网 https://prettier.io/docs/en/install.html

如果有eslint配置文件,会发现格式化之后,有些不符合eslint规范,配置eslint。

第二步 配置Eslint

假设你已经配置好eslint的配置文件 在package.json的scripts里添加如下,注意修改成自己的文件路径。

配置完毕。 执行完 之后再执行 ,完美自动格式化所有JS代码。

此时我们配置format的语句如下:

可以一次实现格式化和fix。

第三步 添加Git钩子(Pre-commit Hook)

Git 钩子(hooks)是在Git 仓库中特定事件(certain points)触发后被调用的脚本。 详情可浏览https://git-scm.com/book/zh/v2/%E8%87%AA%E5%AE%9A%E4%B9%89-Git-Git-%E9%92%A9%E5%AD%90

每次提交代码,执行之后进行自动格式化,免去每次人为手动格式化,使远程仓库代码保持风格统一。

在package.json里面配置

配置完成。 这样每次git commit 都会自动执行格式化并fix,成功之后会将格式化之后的文件自动add,然后统一commit。

第四步 添加git commit注释规范

提交commit格式如下:

For example:

配置package.json

配置完毕。

现在提交代码,只需要执行然后格式化成功之后,进入默认编辑器(我的是VIM),填写commit。wq保存就OK了。

  • 发表于:
  • 原文链接http://kuaibao.qq.com/s/20180303G0D09Y00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券