1、代碼檢測工具: ESLint
2、代碼格式化工具: Prettier
3、約定式提交規(guī)范:commitizen + husky + commitlint
第一二步:ESLint 與 Prettier 配合在本地解決代碼格式問題
下面主要講講第三步: git 提交規(guī)范處理
1、git 提交規(guī)范化工具 commitizen
此時(shí)用git cz提交就搞定了規(guī)范化,但預(yù)防仍有人用git commit,于是
2、git hooks 阻止不符合的提交
git hooks工具:husky
檢查提交信息工具:commitlint
安裝Commitizen
1、全局安裝Commitizen:npm install -g commitizen@4.2.4
2、安裝并配置 cz-customizable 插件:npm i cz-customizable@6.3.0 --save-dev
3、項(xiàng)目根目錄下創(chuàng)建 .cz-config.js 自定義提示文件
安裝commitlint
1、npm install --save-dev @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4
2、創(chuàng)建 commitlint.config.js 文件
安裝 husky
1、npm install husky@7.0.1 --save-dev
2、啟動 hooks , 生成 .husky 文件夾需執(zhí)行命令: npx husky install
3、在 package.json 中生成 prepare 指令( 需要 npm > 7.0 版本 )
npm set-script prepare "husky install"
4、執(zhí)行 prepare 指令:npm run prepare
5、添加 commitlint
的 hook
到 husky
中
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
6、此時(shí)的 .husky
的文件結(jié)構(gòu)
至此,已處理好 強(qiáng)制規(guī)范化的提交要求,不符合將不可被提交
但要是有人忘記配置這些,把代碼寫的亂七八糟的直接就提交了怎么辦呢?
husky 配合 eslint 監(jiān)測 pre-commit 鉤子,這樣就算沒配置也提交不了
如果再配合 lint-staged 則可以嘗試自動修復(fù)格式錯(cuò)誤
感覺自己的團(tuán)隊(duì)目前不需要,所以具體的就不贅述了