這篇文章主要介紹了vue-cli如何創(chuàng)建的項(xiàng)目中的gitHooks,具有一定借鑒價(jià)值,感興趣的朋友可以參考下,希望大家閱讀完這篇文章之后大有收獲,下面讓小編帶著大家一起了解一下。
在寧晉等地區(qū),都構(gòu)建了全面的區(qū)域性戰(zhàn)略布局,加強(qiáng)發(fā)展的系統(tǒng)性、市場(chǎng)前瞻性、產(chǎn)品創(chuàng)新能力,以專(zhuān)注、極致的服務(wù)理念,為客戶(hù)提供網(wǎng)站設(shè)計(jì)制作、網(wǎng)站設(shè)計(jì) 網(wǎng)站設(shè)計(jì)制作定制網(wǎng)站制作,公司網(wǎng)站建設(shè),企業(yè)網(wǎng)站建設(shè),品牌網(wǎng)站建設(shè),成都全網(wǎng)營(yíng)銷(xiāo),成都外貿(mào)網(wǎng)站制作,寧晉網(wǎng)站建設(shè)費(fèi)用合理。在 package.json
文件中會(huì)發(fā)現(xiàn) gitHooks
、 lint-staged
等字段,不難看出它是在我們執(zhí)行 git 命令的時(shí)候會(huì)自動(dòng)執(zhí)行的一些額外的操作,比如語(yǔ)法提示、錯(cuò)誤提示等。
這個(gè)完整的過(guò)程是怎樣的呢?
流程解析
yorkie 包
執(zhí)行 vue create
命令的時(shí)候,會(huì)安裝一個(gè)包,叫: yorkie ,這個(gè)包是尤大 fork 自 husky 的,它倆功能是一樣的,都是生成一些 git hooks 文件,讀取項(xiàng)目中 package.json
的相關(guān)配置項(xiàng)去執(zhí)行一些命令,區(qū)別是尤大做了一些邏輯和配置上的改動(dòng)。
安裝完這個(gè)包以后,會(huì)自動(dòng)執(zhí)行 yorkie 包里面的一個(gè)腳本: bin/install.js
:
這個(gè)腳本會(huì)在你項(xiàng)目下的 .git/hooks
目錄中生成很多 git hooks 文件:
當(dāng)你執(zhí)行一些 git 命令的時(shí)候,比如: git push, git commit
等,git 就會(huì)執(zhí)行相應(yīng)的 hook。
package.json
以 git commit -a -m'123'
這個(gè)命令為例子,執(zhí)行這個(gè)命令的時(shí)候,git 會(huì)去執(zhí)行 pre-commit 這個(gè) hook。
先把 package.json
的相關(guān)內(nèi)容貼出來(lái),讓大家先有個(gè)印象:
"gitHooks": { "pre-commit": "lint-staged", }, "lint-staged": { "*.{js,jsx,vue}": [ "vue-cli-service lint", "git add" ] }
pre-commit hook
接下來(lái)我們看 pre-commit 的文件內(nèi)容:
##... has_hook_script () { [ -f package.json ] && cat package.json | grep -q "\"$1\"[[:space:]]*:" } # 檢查 package.json 文件中是否定義了 pre-commit has_hook_script pre-commit || exit 0 # 運(yùn)行 hook node "./node_modules/yorkie/src/runner.js" pre-commit || { echo echo "pre-commit hook failed (add --no-verify to bypass)" exit 1 }
可以看到 pre-commit 文件去檢查了一下 package.json
文件中是否定義了pre-commit,如果定義了,就執(zhí)行 yorkie 的 runner.js
腳本。
yorkie 的 runner.js 腳本
我們繼續(xù)看 runner.js
腳本的內(nèi)容:
//... const cwd = process.cwd() const pkg = fs.readFileSync(path.join(cwd, 'package.json')) // 取到 package.json 里面定義的 gitHooks 內(nèi)容 const hooks = JSON.parse(pkg).gitHooks if (!hooks) { process.exit(0) } // 從上文得知,這個(gè)值是 pre-commit const hook = process.argv[2] // 取 gitHooks 里面定義的 pre-commit 的內(nèi)容,也就取到:lint-staged const command = hooks[hook] if (!command) process.exit(0) // 執(zhí)行 lint-staged 命令 execa.shellSync(command, { stdio: 'inherit' })
從這個(gè)過(guò)程中可以看到,當(dāng)我們執(zhí)行 git commit -a -m'123'
這個(gè) git 命令的時(shí)候,git hook 執(zhí)行了 yorkie 的一個(gè)腳本去讀取了 package.json
文件中的內(nèi)容,取到相關(guān)的配置項(xiàng),然后執(zhí)行配置項(xiàng)中的命令。
在上述例子中,因?yàn)閳?zhí)行了 lint-staged
命令,它會(huì)讀取 package.json
中的 "lint-staged"
配置項(xiàng),進(jìn)而又繼續(xù)執(zhí)行了 vue-cli-service lint
這個(gè)命令,整個(gè)執(zhí)行的過(guò)程就像像鏈條一樣一環(huán)連著一環(huán),直到所有命令都執(zhí)行完畢。
實(shí)踐
明白了這個(gè)流程后,在項(xiàng)目中就可以根據(jù)需求靈活地做一些配置了,比如在執(zhí)行 commit-msg
hook 的時(shí)候加上 commitlint
,規(guī)范協(xié)作者提交的git 信息,加上這個(gè)以后,執(zhí)行之前的示例命令: git commit -a -m'123'
就會(huì)有提交信息不規(guī)范的錯(cuò)誤提示,根據(jù)提示改成: git commit -a -m'feat: 123'
就可以提交了。
同樣的,與 pre-commit
搭配使用的 lint-staged
,也可以加上一些命令,比如這里加了 pretty-quick
用來(lái)統(tǒng)一代碼格式。
示例:
"gitHooks": { "pre-commit": "lint-staged", "commit-msg": "commitlint -E GIT_PARAMS" }, "lint-staged": { "*.{js,jsx,vue}": [ "pretty-quick --staged", "vue-cli-service lint", "git add" ] }
感謝你能夠認(rèn)真閱讀完這篇文章,希望小編分享的“vue-cli如何創(chuàng)建的項(xiàng)目中的gitHooks”這篇文章對(duì)大家有幫助,同時(shí)也希望大家多多支持創(chuàng)新互聯(lián),關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,更多相關(guān)知識(shí)等著你來(lái)學(xué)習(xí)!