使用 husky 和 lint-staged 检查 Node.js 的代码一致性
生活随笔
收集整理的這篇文章主要介紹了
使用 husky 和 lint-staged 检查 Node.js 的代码一致性
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
在軟件開發過程中,代碼風格檢查(Code Linting)是保障代碼規范和一致性的有效手段。過去,Lint 的工作一般在 Code Review 或者 CI 的時候進行,但這樣會導致問題的反饋鏈,浪費不必要的時間。因此,我們需要利用 Git 的 Pre Commit 鉤子,將 Lint 過程放到開發者提交代碼之前。
本文將會重點介紹如何使用 husky 和 lint-staged 來檢查 Node.js 項目的代碼一致性。其中 husky 用于設置本地的 Git 鉤子,lint-staged 會讓鉤子只檢查本次提交所修改的文件。
安裝 husky 和 lint-staged
首先,我們使用下面的命令把 husky 和 lint-staged 安裝到 Node.js 項目的 devDependencies 中:
$ npm install husky lint-staged --save-dev 復制代碼如果你使用的是 Yarn,請使用下面的命令
$ yarn add husky --dev 復制代碼修改 package.json 配置
將下面的代碼加入 package.json文件中:
{"husky": {"hooks": {"pre-commit": "lint-staged"}},"lint-staged": {"src/**/*.ts": ["tslint --project . --format stylish"],"src/**/*.{css,scss}": ["stylelint --config src/stylelint.config.json"]} } 復制代碼這樣,當在終端輸入 git commit 命令提交代碼的時候,Lint 程序便會自動檢查本次提交所修改的文件是否符合本項目的代碼規范。如果代碼不符合規范,便會拒絕提交代碼。
如果想要跳過 Lint 程序,可以使用 git commit -no-verify 進行提交。
查看原文: myanbin.github.io/post/lintin…
總結
以上是生活随笔為你收集整理的使用 husky 和 lint-staged 检查 Node.js 的代码一致性的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: STM32CubeMX系列教程 5.0版
- 下一篇: 这些职场办公神器,你会喜欢的!