1. 安裝必要工具
在Debian系統上進行JS代碼審查前,需先安裝基礎開發環境和審查工具。首先通過以下命令安裝Node.js(包含npm,Node包管理器):
sudo apt update && sudo apt install nodejs npm
驗證安裝版本:node -v、npm -v。接著安裝核心審查工具:
npm install eslint prettier jest --save-dev
初始化ESLint和Prettier配置:
npx eslint --init # 按提示選擇項目規范(如Airbnb、Standard)
npx prettier --write . # 格式化當前目錄下所有文件
2. 靜態代碼分析(核心審查步驟)
靜態分析是代碼審查的基礎,通過工具自動檢測代碼中的問題。以ESLint為例,配置完成后運行以下命令檢查指定文件或整個項目:
npx eslint yourfile.js # 檢查單個文件
npx eslint . # 檢查當前目錄及子目錄所有JS文件
ESLint會根據配置文件(如.eslintrc.json)中的規則報錯或警告,例如:
{
"extends": "eslint:recommended",
"env": { "browser": true, "node": true },
"rules": { "no-console": "warn", "semi": ["error", "always"] }
}
上述配置會警告console的使用,并強制要求語句末尾加分號。Prettier則通過--write參數自動修復格式問題(如調整縮進、引號),無需手動修改。
3. 自動化測試(驗證代碼功能)
代碼審查需包含功能驗證,確保修改不會引入新bug。使用Jest編寫單元測試,示例如下:
// sum.js
function sum(a, b) { return a + b; }
module.exports = sum;
// sum.test.js
const sum = require('./sum');
test('adds 1 + 2 to equal 3', () => { expect(sum(1, 2)).toBe(3); });
運行測試:
npx jest
測試通過后會顯示綠色提示,失敗則會輸出錯誤信息,幫助審查者快速定位問題。
4. 代碼審查工具與流程
5. 持續集成(CI)自動化
將代碼審查集成到CI/CD流程中,確保每次提交都自動運行檢查。以GitHub Actions為例,創建.github/workflows/ci.yml文件:
name: JS Code Review
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v3
with: { node-version: '18' }
- run: npm install
- run: npx eslint .
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v3
with: { node-version: '18' }
- run: npm install
- run: npx jest
CI流程會在每次推送或PR時自動運行ESLint和Jest,若檢查失敗則阻止合并,確保代碼質量。
6. 最佳實踐
eval、innerHTML等危險操作)、性能(是否避免不必要的循環)等方面。const代替let,因為變量未重新賦值”)。