您好,登錄后才能下訂單哦!
今天小編給大家分享一下vue-cli怎么創(chuàng)建gitHooks的相關(guān)知識點,內(nèi)容詳細,邏輯清晰,相信大部分人都還太了解這方面的知識,所以分享這篇文章給大家參考一下,希望大家閱讀完這篇文章后有所收獲,下面我們一起來了解一下吧。
在 package.json
文件中會發(fā)現(xiàn) gitHooks
、 lint-staged
等字段,不難看出它是在我們執(zhí)行 git 命令的時候會自動執(zhí)行的一些額外的操作,比如語法提示、錯誤提示等。
流程解析
yorkie 包
執(zhí)行 vue create
命令的時候,會安裝一個包,叫: yorkie ,這個包是尤大 fork 自 husky 的,它倆功能是一樣的,都是生成一些 git hooks 文件,讀取項目中 package.json
的相關(guān)配置項去執(zhí)行一些命令,區(qū)別是尤大做了一些邏輯和配置上的改動。
安裝完這個包以后,會自動執(zhí)行 yorkie 包里面的一個腳本: bin/install.js
:
這個腳本會在你項目下的 .git/hooks
目錄中生成很多 git hooks 文件:
當你執(zhí)行一些 git 命令的時候,比如: git push, git commit
等,git 就會執(zhí)行相應(yīng)的 hook。
package.json
以 git commit -a -m'123'
這個命令為例子,執(zhí)行這個命令的時候,git 會去執(zhí)行 pre-commit 這個 hook。
先把 package.json
的相關(guān)內(nèi)容貼出來,讓大家先有個印象:
"gitHooks": { "pre-commit": "lint-staged", }, "lint-staged": { "*.{js,jsx,vue}": [ "vue-cli-service lint", "git add" ] }
pre-commit hook
接下來我們看 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 # 運行 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) } // 從上文得知,這個值是 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' })
從這個過程中可以看到,當我們執(zhí)行 git commit -a -m'123'
這個 git 命令的時候,git hook 執(zhí)行了 yorkie 的一個腳本去讀取了 package.json
文件中的內(nèi)容,取到相關(guān)的配置項,然后執(zhí)行配置項中的命令。
在上述例子中,因為執(zhí)行了 lint-staged
命令,它會讀取 package.json
中的 "lint-staged"
配置項,進而又繼續(xù)執(zhí)行了 vue-cli-service lint
這個命令,整個執(zhí)行的過程就像像鏈條一樣一環(huán)連著一環(huán),直到所有命令都執(zhí)行完畢。
實踐
明白了這個流程后,在項目中就可以根據(jù)需求靈活地做一些配置了,比如在執(zhí)行 commit-msg
hook 的時候加上 commitlint
,規(guī)范協(xié)作者提交的git 信息,加上這個以后,執(zhí)行之前的示例命令: git commit -a -m'123'
就會有提交信息不規(guī)范的錯誤提示,根據(jù)提示改成: git commit -a -m'feat: 123'
就可以提交了。
同樣的,與 pre-commit
搭配使用的 lint-staged
,也可以加上一些命令,比如這里加了 pretty-quick
用來統(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" ] }
Vue具體輕量級框架、簡單易學(xué)、雙向數(shù)據(jù)綁定、組件化、數(shù)據(jù)和結(jié)構(gòu)的分離、虛擬DOM、運行速度快等優(yōu)勢,Vue中頁面使用的是局部刷新,不用每次跳轉(zhuǎn)頁面都要請求所有數(shù)據(jù)和dom,可以大大提升訪問速度和用戶體驗。
以上就是“vue-cli怎么創(chuàng)建gitHooks”這篇文章的所有內(nèi)容,感謝各位的閱讀!相信大家閱讀完這篇文章都有很大的收獲,小編每天都會為大家更新不同的知識,如果還想學(xué)習(xí)更多的知識,請關(guān)注億速云行業(yè)資訊頻道。
免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。