001 前端工程化之统一代码规范

一、git hooks

通过 git init 创建.git>hooks文件夹中有一系列hooks钩子,此时只需要关注pre-commit.sample,即提交前触发的钩子,如果熟悉shell编程,我们可以在pre-commit.sample文件中编写想要做的事情,但是绝大多数前端并不熟悉,所以我们需要使用工具:husky。

1、安装

yarn add husky @commitlint/cli @commitlint/config-conventional -D

2、配置

目前最新版本为7.0.4,需要注意的是老版本的husky配置与新版本配置方法差异很大。

package.json中添加脚本, 此脚本命令会生成 .husky/ 文件夹,此后生成的git hooks命令都会放在这里。多人合作开发时必须添加该脚本,此脚本会在yarn install 时自动触发。

```js

"script":{

    ...

    "prepare": "husky install"

}

```

创建git hooks,运行一下俩条命令,.husky目录下会生成两个文件: pre-commit 、commit-msg

npx husky add .husky/pre-commit "yarn lint-staged"

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

pre-commit:在提交前触发lint-staged,双引号中的yarn lint-staged可以替换为任意提交前想要运行的脚本;

commit-msg: 规范提交时添加的信息,格式为: <type>: <summary>

type(自定义):

feat: 新增页面或功能

fix:  bug修复

style:  样式修改

docs:  文档改动

perf:  性能提升改动

refactor:  不影响功能的代码重构(既不修复错误也不添加功能)

test:  添加或修改测试用例

ci:  对 CI 配置文件和脚本的更改

3、添加commitlint.config.js文件(与package.json同级),配置commitlint,不配置husky不生效,内容:

```js

module.exports = { extends: ['@commitlint/config-conventional'] }

```

二、prettier 和 lint-staged

prettier为前端常用的代码格式化工具;lint-staged可以使lint只对git暂存区的文件进行检测,而无需检测整个项目,提高速度

1、安装

yarn add prettier lint-staged -D

2、配置lint-staged

package.json文件中配置, prettier --write 命令为检查并修改格式

```js

"lint-staged": {

    "*.{ts,tsx,js,jsx}": [

      "prettier --write",

      "eslint"

    ]

  }

```

3、配置prettier

添加 .prettierrc.js 文件(与package.json同级)

```js

module.exports = {

    // 一行最多 100 字符

    printWidth: 100,

    // 使用 4 个空格缩进

    tabWidth: 4,

    // 不使用缩进符,而使用空格

    useTabs: false,

    // 行尾是否需要有分号

    semi: false,

    // 使用单引号

    singleQuote: true,

    ....

  }

```

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

推荐阅读更多精彩内容