介紹

ESLint 是一個根據方案識別並報告 ECMAScript/JavaScript 程式碼問題的工具，其目的是使程式碼風格更加一致並避免錯誤。在很多地方它都與 JSLint 和 JSHint 類似，除了：

ESLint 使用 Espree 對 JavaScript 進行解析。
ESLint 在程式碼中使用 AST 評估方案。
ESLint 完全是外掛式的，每個規則都是一個外掛，你可以在執行時中新增更多外掛。

安裝

@REM npm 安裝eslint
npm i -D eslint
@REM yarn 安裝eslint
yarn  add -D eslint

設定

設定過程

npm init @eslint/config

You can also run this command directly using 'npm init @eslint/config'.
Need to install the following packages:
  @eslint/[email protected]
Ok to proceed? (y) y
@REM 您還可以使用「npm init @eslint/config」直接執行此命令。
@REM 需要安裝以下軟體包：
@REM  @eslint/[email protected]
@REM 確定繼續: 是

How would you like to use ESLint? ...
  To check syntax only
  To check syntax and find problems
> To check syntax, find problems, and enforce code style
@REM 您想如何使用 ESLint？ ...
@REM   僅檢查語法
@REM   檢查語法並行現問題
@REM > 檢查語法、發現問題並強制執行程式碼風格

What type of modules does your project use? ...
> JavaScript modules (import/export)
  CommonJS (require/exports)
  None of these
@REM 您的專案使用什麼型別的模組？ ...
@REM > JavaScript 模組（匯入/匯出）
@REM   CommonJS（要求/匯出）
@REM   都不是

Which framework does your project use? ...
  React
> Vue.js
  None of these
@REM 您的專案使用哪個框架？ ...
@REM   React
@REM > Vue.js
@REM   都不是

Does your project use TypeScript? » No / Yes
@REM 您的專案使用 TypeScript 嗎？ » 否/是

Where does your code run? ...  (Press <space> to select, <a> to toggle all, <i> to invert selection)
√ Browser
√ Node
你的程式碼在哪裡執行？ ...（按 <space> 進行選擇，<a> 切換全部，<i> 反轉選擇）
√ 瀏覽器
√ 節點

How would you like to define a style for your project? ...
> Use a popular style guide
  Answer questions about your style
@REM 您希望如何為您的專案定義風格？ ...
@REM > 使用流行的風格指南
@REM   回答有關您風格的問題

Which style guide do you want to follow? ...
  Airbnb: https://github.com/airbnb/javascript
> Standard: https://github.com/standard/standard
  Google: https://github.com/google/eslint-config-google
  XO: https://github.com/xojs/eslint-config-xo

@REM 您想遵循哪種風格指南？ ...
@REM   Airbnb: https://github.com/airbnb/javascript
@REM > Standard: https://github.com/standard/standard
@REM   Google: https://github.com/google/eslint-config-google
@REM   XO: https://github.com/xojs/eslint-config-xo

What format do you want your config file to be in? ...
> JavaScript
  YAML
  JSON
@REM 您希望組態檔採用什麼格式？ ...
@REM > JavaScript
@REM   YAML
@REM   JSON

@REM 您選擇的設定需要以下依賴項：

@REM eslint-plugin-vue@latest eslint-config-standard@latest eslint@^8.0.1 eslint-plugin-import@^2.25.2 eslint-plugin-n@^15.0.0 || ^16.0.0  eslint-plugin-promise@^6.0.0
@REM ？您想現在安裝它們嗎？ » 否/是
The config that you've selected requires the following dependencies:

eslint-plugin-vue@latest eslint-config-standard@latest eslint@^8.0.1 eslint-plugin-import@^2.25.2 eslint-plugin-n@^15.0.0 || ^16.0.0  eslint-plugin-promise@^6.0.0
? Would you like to install them now? » No / Yes

Which package manager do you want to use? ...
> npm
  yarn
  pnpm
@REM 您想使用哪個包管理器？ ...
@REM > npm
@REM   yarn
@REM   pnpm

設定結果

√ How would you like to use ESLint? · style
√ What type of modules does your project use? · esm
√ Which framework does your project use? · vue
√ Does your project use TypeScript? · No / Yes
√ Where does your code run? · browser, node
√ How would you like to define a style for your project? · guide
√ Which style guide do you want to follow? · standard
√ What format do you want your config file to be in? · JavaScript
Checking peerDependencies of eslint-config-standard@latest
The config that you've selected requires the following dependencies:

eslint-plugin-vue@latest eslint-config-standard@latest eslint@^8.0.1 eslint-plugin-import@^2.25.2 eslint-plugin-n@^15.0.0 || ^16.0.0  eslint-plugin-promise@^6.0.0
√ Would you like to install them now? · No / Yes
√ Which package manager do you want to use? · npm
Installing eslint-plugin-vue@latest, eslint-config-standard@latest, eslint@^8.0.1, eslint-plugin-import@^2.25.2, eslint-plugin-n@^15.0.0 || ^16.0.0 , eslint-plugin-promise@^6.0.0

安裝專案 Eslint 支援

Webpack 方式

安裝 eslint-webpack-plugin

@REM npm
npm install eslint-webpack-plugin -D
@REM yarn
yarn add eslint-webpack-plugin --save-dev

在 Webpack.config.js 中使用

詳細設定可檢視官網：eslint-webpack-plugin

plugins: [
  new ESLintWebpackPlugin({
    // 指定檢查檔案的根目錄
    context: path.resolve(__dirname, "src")
  })
],

Vite 方式

其實， Viite 建立的專案本來是不需要另外設定 Eslint 根據 Vite 官網檔案，一般在使用 Vite 的命令建立 Web 專案時使用自定義建立使用不使用預設模版時會詢問是否需要設定 Eslint，但是在使用指令碼建立 uniapp 專案時需要另外安裝

使用 Vite 建立專案例子

npm create vite@latest my-vue-app --template vue
√ Select a framework: » Vue
√ Select a variant: » Customize with create-vue ↗
Need to install the following packages:
  [email protected]
Ok to proceed? (y) y

Vue.js - The Progressive JavaScript Framework

√ Add TypeScript? ... No / Yes
√ Add JSX Support? ... No / Yes
√ Add Vue Router for Single Page Application development? ... No / Yes
√ Add Pinia for state management? ... No / Yes
√ Add Vitest for Unit Testing? ... No / Yes
√ Add an End-to-End Testing Solution? » No
√ Add ESLint for code quality? ... No / Yes
√ Add Prettier for code formatting? ... No / Yes

安裝 vite-plugin-eslint

說明: 該包是用於設定 vite 執行的時候自動檢測 eslint 規範不符合頁面會報錯

@REG npm 安裝
npm i -D vite-plugin-eslint
@REG yarn 安裝
yarn add -D vite-plugin-eslint --save-dev

安裝 eslint-parser

@REM npm 安裝
npm i -D @babel/core @babel/eslint-parser
@REM yarn 安裝
yarn add @babel/core @babel/eslint-parser --save-dev

拓展（安裝 prettier）

正常來說安裝到上一步已經是完成了 Eslint 設定，此時使用的是 Eslint 流行風格中的 Standard 風格，由於該規則比較嚴格，使用起來可能有點麻煩，有些開發者就喜歡使用 prettier 的相對比較寬鬆的規則，以下就是該規則的設定方式

安裝依賴

@REM npm 安裝
npm i -D prettier eslint-config-prettier eslint-plugin-prettier
@REM yarn 安裝
yarn add prettier eslint-config-prettier eslint-plugin-prettier --save-dev

設定.prettierrc.js

在根目錄下面新增.prettierrc.js 檔案，然後將下面的設定新增到其中：

//這些設定隨專案規範而定，並非需要
module.exports = {
  // 一行最多多少個字元
  printWidth: 150,
  // 指定每個縮排級別的空格數
  tabWidth: 2,
  // 使用製表符而不是空格縮排行
  useTabs: true,
  // 在語句末尾是否需要分號
  semi: true,
  // 是否使用單引號
  singleQuote: true,
  // 更改參照物件屬性的時間 可選值"<as-needed|consistent|preserve>"
  quoteProps: "as-needed",
  // 在JSX中使用單引號而不是雙引號
  jsxSingleQuote: false,
  // 多行時儘可能列印尾隨逗號。（例如，單行陣列永遠不會出現逗號結尾。） 可選值"<none|es5|all>"，預設none
  trailingComma: "es5",
  // 在物件文字中的括號之間列印空格
  bracketSpacing: true,
  // jsx 標籤的反尖括號需要換行
  jsxBracketSameLine: false,
  // 在單獨的箭頭函數引數週圍包括括號 always：(x) => x \ avoid：x => x
  arrowParens: "always",
  // 這兩個選項可用於格式化以給定字元偏移量（分別包括和不包括）開始和結束的程式碼
  rangeStart: 0,
  rangeEnd: Infinity,
  // 指定要使用的解析器，不需要寫檔案開頭的 @prettier
  requirePragma: false,
  // 不需要自動在檔案開頭插入 @prettier
  insertPragma: false,
  // 使用預設的折行標準 always\never\preserve
  proseWrap: "preserve",
  // 指定HTML檔案的全域性空格敏感度 css\strict\ignore
  htmlWhitespaceSensitivity: "css",
  // Vue檔案指令碼和樣式標籤縮排
  vueIndentScriptAndStyle: false,
  endOfLine: "auto",
};

注意：組態檔修改如果是 eslint 能立刻反應並且提示，但是 prettier 修改後，由於結合了 eslint 外掛，可能會導致不同步，需要重啟 VsCode 才能一致，比如把單引號修改為雙引號，prettier 能立馬格式化程式碼使用雙引號，但是 eslint 檢查會報錯，所以修改完成 prettier 組態檔建議重啟一下 VsCode，保證 eslint 檢查同步更新。

設定.prettierignore

如果不想格式化某些檔案可以再新增一個的檔案，用法和.gitignore 檔案差不多，將不需要格式化的資料夾或檔案通過正則匹配或者具名的方式新增進去，這樣就不會格式化對應的檔案了。

Prettier 結合 ESLint

在 package.json 的 scripts 節點中新增如下節點

"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"

在.eslintrc.js 在新增如下選項，然後執行 npm run lint 命令即可生效

"plugin:prettier/recommended", "prettier";

Web專案如何設定Eslint

介紹

安裝

設定