萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JSLint / ESLint 代碼質量檢查工具全面接入指南:規則配置、CI/CD 集成、IDE 支援

代碼質量工具從 JSLint 演進至 ESLink,已成現代前端工程標配。本文對比兩者歷史與現狀,詳細講解 ESLint 規則配置、共享配置、Prettier 整合、Git Hooks、CI/CD 流水線接入、VS Code/WebStorm/IDE 實時提示,助力團隊統一代碼風格、捕獲潛在 Bug。

JSLint vs ESLint:為什麼選 ESLint?

  • JSLint:Douglas Crockford 2002 年創建,規則固定、意見極強(如禁止 ++、要求單引號),難以定製,已基本退出主流。
  • ESLint:2013 年誕生,規則可插拔、支援 ES6+、TypeScript、JSX、Vue、自定義規則、自動修復、生態豐富,**事實標準**。

ESLint 核心配置 .eslintrc.js

module.exports = {
  env: { browser: true, es2022: true, node: true },
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:vue/vue3-recommended',
    'prettier' // 關閉與 Prettier 衝突的規則
  ],
  parser: '@typescript-eslint/parser',
  parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
  plugins: ['@typescript-eslint', 'vue', 'prettier'],
  rules: {
    'prettier/prettier': 'error',
    'no-console': ['warn', { allow: ['warn', 'error'] }],
    'no-unused-vars': 'off',
    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
    'vue/multi-word-component-names': 'off'
  },
  overrides: [
    { files: ['*.test.ts', '*.spec.ts'], env: { jest: true } }
  ]
};

Prettier 整合:格式化與質量分離

// .prettierrc
{ "semi": true, "singleQuote": true, "tabWidth": 2, "trailingComma": "es5", "printWidth": 100 }

// package.json scripts
"lint": "eslint . --ext .js,.ts,.vue",
"lint:fix": "npm run lint -- --fix",
"format": "prettier --write ."

Git Hooks:提交前強制檢查

# 安裝 husky + lint-staged
npx husky install
npx husky add .husky/pre-commit "npx lint-staged"

# package.json
"lint-staged": {
  "*.{js,ts,vue}": ["eslint --fix", "prettier --write"]
}

CI/CD 流水線

# GitHub Actions .github/workflows/lint.yml
name: Lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: { node-version: 20, cache: 'npm' }
      - run: npm ci
      - run: npm run lint

IDE 實時提示

  • VS Code:安裝 ESLint 擴展,啟用 "eslint.validate": ["javascript", "typescript", "vue"]、"editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" }。
  • WebStorm/IntelliJ:Settings → Languages → JavaScript → Code Quality Tools → ESLint,勾選自動修復。

常見規則推薦

規則建議說明
no-unused-varserror捕獲死代碼
no-undeferror防止拼寫錯誤
eqeqeqerror強制 ===
curlyerror強制大括號
default-casewarnswitch 兜底
prefer-consterror優先 const
copyright © 萬盛學電腦網 all rights reserved