tslint pre-commit 配置教程

bang590 發(fā)布于2019-08-21 17:11 / 1553人閱讀

摘要：而解決的需求既是拒絕向倉庫提交錯(cuò)誤代碼。的配置就在項(xiàng)目文件夾下面的文件夾中。而存在報(bào)錯(cuò)的話，會(huì)終止提交。而只是多帶帶鉤子，因此還需要在這個(gè)鉤子下去做相同的配置。

tslint 配合pre-commit的意義

為什么用pre-commit 加 tslint（jshint，eslint原理都類似），因?yàn)樵陧?xiàng)目中我們會(huì)經(jīng)常忘記主動(dòng)的去做代碼檢查，雖然結(jié)合webpack各種構(gòu)建工具下，存在*slint報(bào)錯(cuò)，項(xiàng)目會(huì)跑不起來。但在某些情況下，可能會(huì)因?yàn)橹保蛘咂渌颍瑳]有去觀察項(xiàng)目運(yùn)行的情況就倉促提交。團(tuán)隊(duì)開發(fā)的情景下，可能會(huì)成為別人的麻煩。而pre-commit tslint解決的需求既是：拒絕向倉庫提交錯(cuò)誤代碼。

git hooks

在配置tslint pre commit之前，首先需要了解git hooks，正如它的名字所示，這是一個(gè)關(guān)于git 操作的鉤子，比如我們想要在做遠(yuǎn)程倉庫推送時(shí)，那就會(huì)觸發(fā)pre-push這個(gè)鉤子，然后在這個(gè)鉤子中寫下自己想做的事。git hooks的配置就在項(xiàng)目.git文件夾下面的hooks文件夾中。

在寫相關(guān)的鉤子函數(shù)時(shí)，需要注意的是，將鉤子后面的sample后綴去掉，代碼才會(huì)生效。

比如，本文中用到的pre-commit這個(gè)鉤子。

更多關(guān)于git hooks的介紹，請參考：https://git-scm.com/book/en/v...

開始配置

1.打開項(xiàng)目中的.git/hooks文件夾，找到pre-commit.sample文件，將以下代碼替換到文件中。

#!/bin/bash
TSLINT="$(git rev-parse --show-toplevel)/node_modules/.bin/tslint"
for file in $(git diff --cached --name-only | grep -E ".ts$")
do
        git show ":$file" | "$TSLINT" "$file"
        if [ $? -ne 0 ]; then
                exit 1
        fi
done

2.將pre-commit.sample文件名修改為pre-commit。

此時(shí)再打開項(xiàng)目運(yùn)行g(shù)it commit -m"xx"命令時(shí)，tslint會(huì)做自動(dòng)的檢查，如果沒有錯(cuò)誤的話，才會(huì)提交成功。而存在tslint報(bào)錯(cuò)的話，會(huì)終止提交。

日常開發(fā)中，有時(shí)為了方便會(huì)直接使用git commit -am"xxx"（即add+commit）的指令。而pre-commit 只是多帶帶commit 鉤子，因此還需要在pre-applypatch這個(gè)鉤子下去做相同的配置。