良好的代碼規(guī)范有助于項(xiàng)目的維護(hù)和新人的快速上手践磅。前段時(shí)間姆蘸，把eslint引入了項(xiàng)目中做靜態(tài)代碼檢查官扣。 一下把所有的代碼都改造是不可能翅敌，要改的地方太多，而且要保證后來(lái)提交代碼的質(zhì)量惕蹄。于是有了eslint + pre-commit 的結(jié)合蚯涮。
pre-commit是git的鉤子治专，顧名思義就是在提交前運(yùn)行，所以一般用于代碼檢查遭顶、單元測(cè)試张峰。git還有其他鉤子，比如prepare-commit-msg棒旗、pre-push等喘批，具體可查看git官網(wǎng)。git 鉤子目錄在.git/hooks下（如下圖）：
git-hooks.png
上圖這些文件都是對(duì)應(yīng)鉤子的示例腳本铣揉，.sample后綴都是出于未啟動(dòng)狀態(tài)饶深。對(duì)應(yīng)的鉤子要生效，把.sample去掉逛拱。示例都是用shell腳本寫(xiě)的敌厘。那如果想用js寫(xiě)怎么辦呢？需要借助pre-commit庫(kù)：
- 安裝pre-commit
npm install pre-commit --save-dev
- 配置package.json
- 執(zhí)行靜態(tài)文件檢查
// package.json
"scripts": {
"lint": "eslint src --ext .js --cache --fix",
},
"pre-commit": [
"lint",
]
上面配置會(huì)保證eslint在提交時(shí)會(huì)校驗(yàn)src目錄下的js文件朽合。
那如果要?jiǎng)討B(tài)獲取提交的代碼進(jìn)行校驗(yàn)?zāi)兀?/p>
- 校驗(yàn)提交代碼
// 獲取修改后的js文件
git diff HEAD --name-only| grep .js$
package.json文件可改為：
// package.json
"scripts": {
"lint": "eslint src --ext .js --cache --fix",
"pre-lint": "node check.js"
},
"pre-commit": [
"pre-lint",
]
在check.js中需要調(diào)用eslint的Node.js API俱两，詳情可看eslint官網(wǎng)。以下是我在項(xiàng)目中的例子曹步，可作為參考：
// check.js
const exec = require('child_process').exec
const CLIEngine = require('eslint').CLIEngine
const cli = new CLIEngine({})
function getErrorLevel(number) {
switch (number) {
case 2:
return 'error'
case 1:
return 'warn'
default:
}
return 'undefined'
}
let pass = 0
exec('git diff --cached --name-only| grep .js$', (error, stdout) => {
if (stdout.length) {
const array = stdout.split('\n')
array.pop()
const results = cli.executeOnFiles(array).results
let errorCount = 0
let warningCount = 0
results.forEach((result) => {
errorCount += result.errorCount
warningCount += result.warningCount
if (result.messages.length > 0) {
console.log('\n')
console.log(result.filePath)
result.messages.forEach((obj) => {
const level = getErrorLevel(obj.severity)
console.log(` ${obj.line}:${obj.column} ${level} ${obj.message} ${obj.ruleId}`)
pass = 1
})
}
})
if (warningCount > 0 || errorCount > 0) {
console.log(`\n ${errorCount + warningCount} problems (${errorCount} ${'errors'} ${warningCount} warnings)`)
}
process.exit(pass)
}
if (error !== null) {
console.log(`exec error: ${error}`)
}
})
