DIV CSS 佈局教程網

ESLint 入門指南:配置、規則與 Gulp 整合
編輯:JavaScript基礎知識     

介紹

ESLint 由《JavaScript 紅寶書》作者 Nicholas C. Zakas 撰寫,2013 年釋出第一個版本。他的初衷並非重造輪子,而是在 JSHint 團隊未能回應實際需求時做出的取捨:以「可擴充、每條規則獨立、不內建編碼風格」為設計理念。

官方網站:https://eslint.org/

ESLint 能協助我們檢查 JavaScript 的語法問題。大型應用中,漏洩的變數或拼錯的方法名往往難以察覺,ESLint 透過靜態分析找出這些 bug,並確保一定程度的語法正確性。

它建立在 Esprima(ECMAScript 解析器)之上,除了內建的可擴充規則,也允許使用者自訂規則來約束團隊的程式碼風格。

支援範圍

  • ES6 語法
  • AngularJS
  • JSX
  • 風格檢查
  • 自訂錯誤與提示

可檢查的項目

  • 語法錯誤
  • 不重要或遺漏的分號等標點
  • 永遠執行不到的程式碼區塊
  • 未被使用的參數
  • 缺少的結尾符號(如右大括號)
  • 樣式一致性(如 sass、less 相關規則)
  • 變數命名

一、安裝與初始化

npm install gulp-eslint --save-dev

在專案目錄執行 eslint --init 會產生 .eslintrc 設定檔,內容即為規則清單:

{
  "rules": {
    "semi": ["error", "always"],
    "quotes": ["error", "double"]
  }
}

其中 semi 與 quotes 是規則名稱。ESLint 的錯誤等級以數字表示:0 代表關閉提示、1 代表警告但不影響編譯、2 代表抛出錯誤。

"extends": "eslint:recommended"

extends 是官方推薦的規則集,你可以再依需求增減,實際清單可於 npmjs.com 查閱。

二、自訂配置

你可以關掉所有預設驗證,自行挑選規則。ESLint 提供兩種配置方式:

  1. Configuration Comments:在要檢查的檔案中,直接用 JavaScript 註解嵌入設定。
  2. Configuration Files:使用 JavaScript、JSON 或 YAML 檔案(如 .eslintrc),也可在 package.json 中加上 eslintConfig 欄位,ESLint 都會自動讀取。

parserOptions:指定要檢查的 ECMAScript 版本與相關特性。

{
  "parserOptions": {
    "ecmaVersion": 6,          // 6 代表 ES6
    "sourceType": "module",    // 可為 "script" 或 "module"
    "ecmaFeatures": {
      "jsx": true              // 啟用 JSX
    }
  }
}

Parser:預設使用 esprima,也可切換為 babel-eslint 等以支援更多語法。

{
  "parser": "esprima" // 可改為 babel-eslint
}

Environments:預先載入特定環境的全域變數,例如 browser、node、es6、mocha。

{
  "env": {
    "browser": true,
    "node": true
  }
}

若要使用外掛提供的環境變數:

{
  "plugins": ["example"],
  "env": { "example/custom": true }
}

Globals:宣告自用的全域變數,true 代表允許被覆寫、false 代表不允許。

{
  "globals": {
    "var1": true,
    "var2": false
  }
}

Plugins:載入第三方外掛。

{
  "plugins": [ "react" ]
}

Rules:自訂規則,格式為「規則名稱」: 等級。0 為關閉、1 為警告、2 為錯誤,也可指定範圍如 [1, 4]。

{
  "plugins": [ "react" ],
  "rules": {
    "eqeqeq": "off",              // 關閉
    "curly": "error",             // 抛出錯誤
    "quotes": ["warn", "double"], // 警告,要求雙引號
    "react/jsx-quotes": 0         // 使用第三方外掛的規則
  }
}

預設規則清單:https://eslint.org/docs/rules/ React 外掛:https://www.npmjs.com/package/eslint-plugin-react

三、在 Gulp 中使用

var eslint = require('gulp-eslint');

gulp.task('validate-eslint', function(){
  return gulp.src(['app/**/*.js'])          // 指定檢查路徑
    .pipe(eslint({ configFile: "./.eslintrc" })) // 載入設定檔
    .pipe(eslint.format());
});

總結

ESLint 的價值在於把風格與錯誤檢查交給工具,讓 code review 聚焦在設計本身。建議的切入順序是:先用 eslint:recommended 跑起來,再依團隊共識逐條開啟風格規則,避免一開始就訂定過多約束而難以推行。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved