內容非常詳細！領略Eslint代碼檢查的四種姿勢
前言：記得我剛開始參與到公司項目的開發(fā)時，由于代碼結構太亂被同事集體 diss，而后被強烈要求打開 eslint 來開發(fā)，無奈之下陷入 eslint 的魔爪。但是當我打開 eslint 的時候，我真的是去他喵的，代碼哪哪都給我爆紅，然后我就偷偷把 eslint 關掉了（機智如我 <(￣︶￣)>）。但是，果不其然，沒過多久我就又被抓住了。在經(jīng)歷了幾次貓抓老鼠的游戲之后，我終于習慣并且喜歡上 eslint 了。
在這篇文章中，我不會花太多的筆墨去介紹 Eslint 的使用，因為那是官方文檔該做的事情。我所希望做到的是，在閣下看完這篇文章之后，能夠超脫于 Eslint 本身，去看到它所實現(xiàn)的需求本身，即實現(xiàn) js/ts 的代碼檢查。而后，我會以實現(xiàn)代碼檢查這個需求為出發(fā)點，引出代碼 eslint 的四種代碼檢查姿勢。
對于代碼檢查需求及其實現(xiàn)方案，我從個人認識出發(fā)，用腦圖做了以下整理：
接下來的行文，我都會圍繞這副腦圖展開，如果您有興趣繼續(xù)往下看下去，我希望您能在這幅圖上停留多一些時間。
好的，按照上述腦圖中的邏輯，接下來我會分成以下幾個部分來展開探討本文。
- 理解代碼檢查
- 為項目接入 Eslint 實現(xiàn)代碼檢查
- 基于 Eslint 及其規(guī)則實現(xiàn) <編碼后檢查>
- 基于 Eslint 及其規(guī)則實現(xiàn) <編碼時檢查>
- 基于 Eslint 及其規(guī)則實現(xiàn) <構建前檢查>
- 基于 Eslint 及其規(guī)則實現(xiàn) <git 提交前檢查>
好的，理清了行文思路之后，下面我們進入第一部分，理解代碼檢查。
一：理解代碼檢查
代碼檢查，顧名思義就是檢查代碼，發(fā)生于開發(fā)階段，可有效幫助開發(fā)者減少 JavaScript 粗心代碼，如語法錯誤、變量未定義、變量未使用等等問題。除此之外，代碼檢查還可以約束統(tǒng)一開發(fā)人員的代碼風格，利于團隊協(xié)作。
經(jīng)過上面這段話，我們就已經(jīng)達成了對代碼檢查的概念理解。下面我們再從三個方面來展開分析，加深對代碼檢查的實踐理解。這三個方面分別為以下三點：
- 代碼檢查的功能
- 代碼檢查的類型
- 代碼檢查的工具
好的，下面我們就先進入代碼檢查功能的探討。
1. 代碼檢查的功能
我認為，代碼檢查這個切面大概可以幫助我們做以下三件事情：
- 語言語法檢查：比如檢查出字符串引號或者函數(shù)調用括號沒有匹配等問題。
- 編碼錯誤檢查：比如檢查出開發(fā)者在使用一個不存在的變量或者變量定義了卻沒有使用等問題。
- 代碼風格檢查：比如檢查出開發(fā)者沒有使用分號（與所選風格有關）等問題。
文外總結：切面所在層次，決定了該切面的職能上線。
理解了代碼檢查這個切面所可以實現(xiàn)的功能之后，下面我們就探討一下代碼檢查的類型。
2. 代碼檢查的方式
以代碼檢查發(fā)生的不同時間和場景來劃分，我把代碼檢查的方式分類成以下四種：
- 編碼時檢查：編寫代碼時檢查，通常表現(xiàn)為由 IDE 自動實時檢查并進行代碼提示。
- 編碼后檢查：編寫代碼后檢查，通常表現(xiàn)為手動調用檢查腳本 / 工具進行代碼的檢查或者代碼保存后由 IDE 自動檢查當前文件。
- 構建前檢查：構建執(zhí)行前檢查，通常表現(xiàn)為將代碼檢查作為構建任務的一個前置切面，構建時自動觸發(fā)代碼檢查。
- 提交前檢查：git commit 前檢查，通常表現(xiàn)為將代碼檢查作為 git commit 的一個 hooks 任務，代碼提交前自動觸發(fā)代碼檢查。
如此無私分享，不值得你的點贊和關注鼓勵一下嗎？
理解代碼檢查的方式很重要，這直接反映了你對代碼檢查這個概念本身的掌握程度。廢話不多說，下面我們進入代碼檢查工具的探討。
3. 代碼檢查工具
代碼檢查的實現(xiàn)通常不會僅僅是字符串分析處理，這其中會大量涉及到語法分析。既然涉及到語法，那么就需要對不同的代碼使用不同的代碼檢查工具，通常來說，我們會使用 Eslint 工具來實現(xiàn)對 JavaScript 和 Typescript 代碼的檢查，使用 stylelint 工具對樣式代碼進行代碼檢查。對于 stylelint，本文不多做敘述，接下來我們把舞臺交給 Eslint，一起探討一下如何使用 Eslint 實現(xiàn) JavaScript 代碼和 typescript 代碼的檢查。
好的，在按順序探討編碼后檢查、編碼時檢查、構建前檢查、git 提交前檢查這四種代碼檢查方式之前，我們先為項目接入 Eslint，并配置各種代碼檢查方式都需要的檢查規(guī)則。
二：為項目接入 Eslint 實現(xiàn)代碼檢查
有不少朋友可能并不了解 Eslint，下面我們先對它做個簡單介紹。
Eslint 是一款插件（檢查規(guī)則）化的 JavaScript 代碼檢查工具。概念言簡意賅，需要注意的是，概念中說到 eslint 是一個插件化的檢查工具，其意思是指 eslint 的設計是把檢查工具和檢查規(guī)則之間解耦了。也就是說，在安裝好 eslint 的開發(fā)依賴之后，我們還可以并且需要選擇安裝一個我們中意的檢查規(guī)則。
好的，理論就說到這，接下來我們就從實踐中得到真知，實踐步驟如下：
step1：安裝檢查工具 eslint
- yarn add eslint --dev
step2：安裝并配置檢查規(guī)則
在探討配置安裝檢查規(guī)則之前，我們有必要先明確一下我們的檢查目標是什么。我認為，檢查目標自然是構建前的代碼，并且是自己 / 自己團隊編寫的代碼（非第三方模塊）。畢竟檢查的最終目標是為修復服務的，我們只負責修復自己 / 自己團隊編寫的代碼，構建后代碼以及第三方代碼即使檢查不通過我們也不會也不應該由我們去修復。
檢查規(guī)則在項目中通常有兩種表現(xiàn)形式，即：
- 配置文件中配置的規(guī)則：主要形式，通過繼承和擴展的方式聲明了大量規(guī)則
- 項目代碼中的魔法注釋：次要形式，通常是用于作為配置文件中規(guī)則的特例
生成 eslint 配置文件：
對于配置文件，我們通常會使用 eslint --init 命令來生成這個配置文件，下表列舉了一些調用這個命令之后經(jīng)常出現(xiàn)的配置問題（不一定會是依次下面幾個問題）。
注意：我覺得回答這些問題還是要慎重一些，因為問題答案會影響配置，配置會影響檢查規(guī)則，檢查規(guī)則會影響檢查結果。當然，回答這些問題的目的也就是生成想要配置文件，如果問題回答錯了或者后續(xù)對規(guī)則有改動也可以直接修改 eslint 配置文件。
| 序號 | 作用 | 問題 |
|---|---|---|
| 1 | 選擇使用 eslint 的用途，常選 3 | How would you like to use ESLint? (Use arrow keys) To check syntax only To check syntax and find problems To check syntax, find problems, and enforce code style |
| 2 | 選擇項目使用的模塊化規(guī)范 | What type of modules does your project use? (Use arrow keys) JavaScript modules (import/export) only CommonJS (require/exports) None of these |
| 3 | 選擇項目使用的框架 | Which framework does your project use? (Use arrow keys) React Vue.js None of these |
| 4 | 是否使用 Typescript | Does your project use TypeScript? (y/N) |
| 5 | 選擇代碼的運行環(huán)境（多選） | Where does your code run? (Press <space> to select, <a> to toggle all, <i> to invert selection) ( ) Browser ( ) Node |
| 6 | 選擇如何為你的項目定義風格，常選 1 | How would you like to define a style for your project? (Use arrow keys) Use a popular style guide Answer questions about your style Inspect your JavaScript file(s) |
| 7 | 選擇使用具體的流行代碼風格 | Which style guide do you want to follow? (Use arrow keys) Airbnb (https://github.com/airbnb/javascript) Standard (https://github.com/standard/standard) (https://github.com/google/eslint-config-google) |
| 8 | 選擇配置文件格式，常選 1（更靈活） | What format do you want your config file to be in? (Use arrow keys) JavaScript YAML JSON |
代碼中的魔法注釋寫法：
除了配置文件中配置規(guī)則，eslint 還有一個代碼中通過魔法注釋打規(guī)則補丁的辦法，如下示例：
- // 屏蔽整行的代碼檢查
- const str1 = "${name} is a coder" // eslint-disable-line
- // 屏蔽某一個規(guī)則：如此行的no-template-curly-in-string規(guī)則
- const str1 = "${name} is a coder" // eslint-disable-line no-template-curly-in-string
溫馨提示：規(guī)則名稱可以從檢查結果提示或輸出信息中得到
三：基于 Eslint 及其規(guī)則實現(xiàn) <編碼后檢查>
對于一個工作流程的解釋，我還是更傾向于直接演示一個簡單的 demo。在這個行文思路下，下面我們就分別演示一個 Eslint 檢查 JS 代碼的示例以及一個 Eslint 檢查 TS 代碼的示例。根據(jù)代碼檢查的邏輯，demo 演示和講解時我會遵循以下思路，即：
- 目標問題代碼
- 代碼檢查規(guī)則配置
- 代碼檢查操作和結果
- 修復代碼操作
好的，下面我們就進入 Eslint 對 JS 代碼編碼后檢查示例的探討。
1.Eslint 編碼后檢查 JS 代碼示例
1): 目標問題代碼
- const noUsedVar = 1;
- function fn() {
- console.log('hello')
- cnsole.log('eslint');
- }
- fn(
- fn2();
以上短短幾行代碼就可以表示出 eslit 代碼檢查的三個部分，它們分別是：
- 語法錯誤
- 編碼錯誤：未定義、未使用
- 編碼風格：沒有分號
2): 代碼檢查規(guī)則配置
通過 eslint --init，根據(jù)項目特征來回答問題之后得到的 eslint 配置文件如下：
- module.exports = {
- env: {
- browser: true,
- es6: true,
- },
- extends: [
- 'airbnb-base',
- ],
- globals: {
- Atomics: 'readonly',
- SharedArrayBuffer: 'readonly',
- },
- parserOptions: {
- ecmaVersion: 2018,
- },
- rules: {
- },
- };
3): 代碼檢查操作和結果
第一輪檢查結果先是報了語法錯誤，在修復語法錯誤之后，第二輪檢查報錯了很多編碼以及風格上的錯誤。將兩次檢查結果關聯(lián)到問題代碼可以得到如下分析：
- const noUsedVar = 1; // find program：'noUsedVar' is assigned a value but never used
- function fn() {
- console.log('hello') // enforce code style：Missing semicolon（分號）
- cnsole.log('eslint'); // find program：'cnsole' is not defined
- }
- fn( // syntax error
- fn2(); // find program：'fn2' is not defined
4): 修復代碼
根據(jù)上述檢查結果進行修復。對于代碼風格上的不一致導致的錯誤，通過參數(shù) --fix 即可以自動修復大部分的問題。而對于語法以及編碼上的錯誤則大部分只能是開發(fā)者自己手動修復。經(jīng)過手動修復以及自動修復之后，問題代碼可能變?yōu)槿缦履樱?nbsp;
- import { fn2 } from './test2';
- function fn() {
- console.log('hello');
- console.log('eslint');
- }
- fn();
- fn2();
2.Eslint 編碼后檢查 TS 代碼示例
1): 目標問題代碼
- function foo(ms: string): void{
- console.log(msg);
- }
- foo("hello typescript~")
2): 代碼檢查規(guī)則配置
項目安裝 typescript 依賴后（不先安裝 typescript 依賴就執(zhí)行 eslint --init 會報錯），通過 eslint --init 命令，根據(jù)項目特征來回答問題（typesrcipt yes）之后得到的 eslint 配置文件如下：
- module.exports = {
- "env": {
- "browser": true,
- "es6": true
- },
- "extends": [
- "airbnb-base"
- ],
- "globals": {
- "Atomics": "readonly",
- "SharedArrayBuffer": "readonly"
- },
- "parser": "@typescript-eslint/parser",
- "parserOptions": {
- "ecmaVersion": 2018
- },
- "plugins": [
- "@typescript-eslint"
- ],
- "rules": {
- }
- };
相對于 JavaScript 的代碼檢查，對于 typescript 的檢查需要額外的一個語法解析器（即上述配置中的 parser 配置項內容）。
3): 代碼檢查操作和結果
eslint 以 --fix 參數(shù)檢查之后，主要報了兩個編碼錯誤，映射到文件中分析如下：
- function foo(ms: string): void { // 'ms' is defined but never used
- console.log(msg); // 'msg' is not defined
- }
- foo('hello typescript~');
4): 修復代碼
在本示例中，在 fix 自動修復代碼風格之后，手動把 foo 函數(shù)的形參改為 msg 即可。
- function foo(msg: string): void {
- console.log(msg);
- }
- foo('hello typescript~');
四：基于 Eslint 及其規(guī)則實現(xiàn) <編碼時檢查>
說到編碼時檢查就不得不提到代碼提示，也不得不聯(lián)系到我們所具體選擇使用的 IDE。除此之外，為了保證多種方式下代碼檢查規(guī)則的統(tǒng)一配置，我們還需要做到的關鍵一點是 IDE 能夠讀取我們在項目中配置的 eslint 規(guī)則文件去實時檢查代碼。
由于個人主要使用 VScode 開發(fā)，所以下面做的 demo 和探討都默認在 vscode 環(huán)境下。官方相關資料：Eslint 的官方整合工具列表中的 [1. 安裝 eslint、配置 eslint 規(guī)則](https://marketplace.visualstudio.com/items?item>Visual Studio Code: ESLint Extension 文檔。
說實話，這個東西我也是現(xiàn)學現(xiàn)賣，畢竟前端要學的東西實在太多了，而且這篇文章的初衷也不是對某一技術點的面面俱到，而是幫助你建立系統(tǒng)化認識以及引導。
由于我們需要做到在 IDE 實時代碼檢查時，能夠讀取讀取項目下的 eslint 規(guī)則。所以以下兩個步驟必不可少：
- 安裝 eslint、配置 eslint 規(guī)則
- IDE 實時代碼檢查功能相關安裝配置
根據(jù)以上實現(xiàn)步驟思路，下面我們就做一個vscode環(huán)境下，基于Eslint及其規(guī)則實現(xiàn)編碼時檢查的demo。
1.安裝eslint、配置eslint規(guī)則
- yarn add eslint --dev # 安裝
- eslint --init # 初始化配置
eslint的規(guī)則配置方式上面已經(jīng)討論過，這里就不再展開贅述了。
2.IDE 實時代碼檢查功能相關安裝配置
在 eslint 工具以及檢查規(guī)則準備好之后（該規(guī)則就是 IDE 代碼檢查的規(guī)則），剩下的具體的檢查行為觸發(fā)以及代碼提示工作就要交給 IDE 來實現(xiàn)了。對于 vscode，這里我們的實現(xiàn)思路是安裝 eslint 這個擴展插件（個人使用的版本 2.1.14，下面的配置 1.x 很可能不適用），而后注意打開 vscode 的 eslint 代碼檢查功能（vscode 下的 eslint 開關為右下角的 eslint 文字標識）即可實現(xiàn) vscode 環(huán)境下的 eslint 實時代碼檢查。
配置 IDE 的實時檢查功能
如果需要對 IDE 的實時檢查功能做一些配置，則可以通過 打開 vscode 的 setting -> 找到 eslint -> 打開 setting.json 這幾個步驟來找到相關的配置文件，以下是配置 vscode 代碼檢查功能示例:
- //配置eslint
- "editor.codeActionsOnSave": { // 保存時自動fix
- "source.fixAll.eslint": true
- },
- "eslint.quiet": true, // warning時不報紅色下劃線，可用于處理no-console規(guī)則爆的warning
實時代碼檢查報錯后的修復
在 IDE 自動檢查的過程中，報錯提示如果報的是代碼觸犯了規(guī)則的提示，那么就可以修改項目下的檢查規(guī)則文件（.eslintrc.js）。比如個人在 demo 實踐中就遇到了 ESLintExpected linebreaks to be 'LF' but found 'CRLF'這個規(guī)則錯誤，并且它的情況還有些特殊，它在 IDE 實時檢查會報，但是手動調用 eslint 命令時不報，具體原因在此不多做分析，個人是直接在規(guī)則文件（.eslintrc.js）加入以下規(guī)則得以解決的：
- rules: {
- 'linebreak-style': [0, 'error', 'windows'],
- },
五：基于 Eslint 及其規(guī)則實現(xiàn) <構建前檢查>
下面我們直接進入現(xiàn)如今較為常用的 gulp 以及 webpack 構建工具如何實現(xiàn)構建前檢查的探討。
1.gulp 構建前檢查
通過 gulp 實現(xiàn)這個代碼檢查切面的思路如下：
- 安裝 eslint 并初始化 eslint 配置文件
- 下載安裝 gulp-eslint 插件
- 編寫 js 文件處理的代碼檢查切面
1): 初始化 eslint 配置文件
- yarn add eslint --dev
- eslint --init
2): 下載安裝 gulp-eslint 插件
- yarn add gulp-eslint --dev
3): 編寫 js 文件處理的代碼檢查切面
示例如下：
- // ... 其它代碼
- const eslint = require('gulp-eslint');
- const script = (0 => {
- return src(['scripts/*.js'])
- .pipe(eslint()) // 代碼檢查
- .pipe(eslint.format()) // 將lint結果輸出到控制臺。
- .pipe(eslint.failAfterError()) // lint錯誤，進程退出，結束構建。
- .pipe(babel({ presets: ['@babel/preset-env']}))
- .pipe(dest('temp'))
- .pipe(bs.reload( { stream: true } ))
- }
- // ... 其它代碼
2.webpack 構建前檢查
通過 webpack 來實現(xiàn)這個代碼檢查切面的思路如下：
- 安裝 eslint 并初始化 eslint 配置文件
- 安裝 eslint-loader
- 編寫 webpack 配置文件，為 js 文件加上這個 eslint-loader
(1): 安裝 eslint 并初始化 eslint 配置文件
- yarn add eslint --dev
- eslint --init
(2): 安裝 eslint-loader
- yarn add eslint-loader --dev
(3): 編寫 webpack 配置文件，為 js 文件加上這個 eslint-loader
- rules: [
- {
- test: /.js$/,
- exclude: /node_modules/,
- use: [
- 'babel-loader',
- 'eslint-loader' // 更后的先執(zhí)行
- ]
- }
- ]
六：基于 Eslint 及其規(guī)則實現(xiàn) <git 提交前檢查>
這一個部分的講解，我接下來會從以下四個方面循序漸進的探討 Eslint 如何實現(xiàn) git 的提交前檢查：
- 1.git 提交前檢查原理：Git Hooks
- 使用 husky 實現(xiàn)：編寫 node 代碼替代 shell 代碼
- 實現(xiàn) hook 任務流：通過 lint-staged 來配合 husky 來實現(xiàn)
- 實現(xiàn) git 提交前檢查：先執(zhí)行 eslint 任務而后執(zhí)行 git add 任務
下面我們進入第一點，git 提交前檢查原理：Git Hooks 的探討。
1.git 提交前檢查原理：Git Hooks
Eslint 實現(xiàn) git 的提交前檢查是通過 Git Hooks 實現(xiàn)的，Git Hook 也稱之為 git 鉤子，每個鉤子都對應一個任務，通過 shell 腳本可以編寫鉤子任務觸發(fā)時要具體執(zhí)行的操作。
本文關注實現(xiàn) git 提交前的代碼檢查，所以我們關注 git commit 這個鉤子，使用步驟如下：
- 編寫 hook 任務：項目的. git/hooks 文件夾下新建一個 pre-commit 文件
- #!/bin/sh
- echo "before commit"
- 觸發(fā)鉤子：項目下執(zhí)行 git commit 命令
git commit 命令執(zhí)行后，可以發(fā)現(xiàn) commit 操作不管是否成功，都可以看到輸出的 before commit 信息。
上述方式可用但還在實際生產中使用還是不太合適，畢竟對于前端開發(fā)者來說，使用 shell 腳本編寫 git hook 的方式還是比較難接收，下面我們介紹 husky 這個庫的使用，幫助我們達成以 js 代碼的方式來編寫 hook 任務的目的。
2. 使用 husky 實現(xiàn)：編寫 node 代碼替代 shell 代碼
實現(xiàn)步驟如下：
- (1): 安裝 husky
- (2): 配置 husky 的 hook 任務：如下 package.json 任務
- (3): 觸發(fā)鉤子：git add -> git commit
1): 安裝 husky
- yarn add husky --dev
在安裝好這個模塊后，就可以在. git/hooks 文件夾下看到如下這些新添加的文件。
2): 配置 husky 的 hook 任務：如下 package.json 任務
- "scripts": {
- "test1": "echo before commit",
- "test2": "node test2.js"
- },
- "husky": {
- "hooks": {
- "pre-commit": "yarn test2"
- }
- },
3): 觸發(fā)鉤子：git add -> git commit
git commit 命令執(zhí)行后，就可以觸發(fā)我們通過 husky 實現(xiàn)的由 js 代碼編寫的 hook 任務。
下面我們增強一下，通過 lint-staged 這個庫，讓 hook 不但支持單任務還支持任務流的觸發(fā)。
3. 實現(xiàn) hook 任務流：通過 lint-staged 來配合 husky 來實現(xiàn)
實現(xiàn)步驟如下：
- (1): 安裝 husky 和 lint-staged 模塊
- (2): 配置 husky 的 hook 任務流：如下 package.json 任務
- (3): 觸發(fā)任務流：git add -> git commit
1): 安裝 husky 和 lint-staged 模塊
- yarn add husky --dev
- yarn add lint-staged --dev
2): 配置 husky 的 hook 任務流：如下 package.json 任務
- "scripts": {
- "precommit": "lint-staged"
- },
- "husky": {
- "hooks": {
- "pre-commit": "yarn precommit"
- }
- },
- "lint-staged": {
- "*.js":[
- "echo task1",
- "echo task2",
- "echo task3"
- ]
- }
3): 觸發(fā)任務流：git add -> git commit
實踐發(fā)現(xiàn)，與單獨的 husky 模塊實現(xiàn)單任務相比而言，使用 lint-staged 之后，git commit 命令只有成功執(zhí)行（有 add 資源并且有提交信息）才會觸發(fā) lint stage 中的操作，且這些操作只會對 js 文件有效。
好的，經(jīng)過以上鋪墊，下面我們就可以進入我們所要實現(xiàn)的最終需求，即實現(xiàn) git 提交前檢查的探討了。
4. 實現(xiàn) git 提交前檢查：先執(zhí)行 eslint 任務而后執(zhí)行 git add 任務
實現(xiàn)步驟如下：
- (1): 安裝 husky 和 lint-staged 模塊
- (2): 配置 husky 的 hook 任務流：如下 package.json 任務
- (3): 觸發(fā)任務流：git add -> git commit
1): 安裝 husky 和 lint-staged 模塊
- yarn add husky --dev
- yarn add lint-staged --dev
2): 配置 husky 的 hook 任務流：如下 package.json 任務
- "scripts": {
- "precommit": "lint-staged"
- },
- "husky": {
- "hooks": {
- "pre-commit": "yarn precommit"
- }
- },
- "lint-staged": {
- "*.js":[
- "eslint --fix",
- "git add"
- ]
- }
3): 觸發(fā)任務流：git add -> git commit
經(jīng)過這些開發(fā)包的下載以及配置，在我們執(zhí)行 git commit 之后，就會觸發(fā) husky 配置的 pre-commit 的 hook 任務，而這個 hook 任務又把任務交給了 lint-staged 處理，進而通過 lint-staged 實現(xiàn)對 js 文件的代碼檢查以及自動風格修復后（還是錯誤則會中斷提交）重新 add，而后再執(zhí)行 commit 任務，保證了代碼在提交前一定經(jīng)過了代碼檢查。
