快捷導(dǎo)航

一步步詳細(xì)講解vue3配置ESLint

更新時間：2023年01月16日 11:43:40 作者：harmsworth2016

ESLint主要用于代碼規(guī)范、統(tǒng)一代碼風(fēng)格,下面這篇文章主要給大家介紹了關(guān)于vue3配置ESLint的相關(guān)資料,文中通過圖文以及實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

對于前端項(xiàng)目而言，ESLint 可以檢查代碼，統(tǒng)一代碼風(fēng)格，避免不必要的錯誤。在 vue3 中配置 ESLint，如下所示。

環(huán)境

vite 2.3.3
vue 3.0.5

說明

由于在 ESLint優(yōu)先級中 .eslintrc.js 的優(yōu)先級最高，故使用 .eslintrc.js。

準(zhǔn)備一個 vue3 項(xiàng)目，請移步 vite構(gòu)建vue3項(xiàng)目

安裝

目前有 2 種主流配置 ESLint 的方式，都需要 eslint 庫的支持，故都需安裝 eslint。

standard
airbnb

standard規(guī)范

standard 有一個專門配合 ESLint 提供配置項(xiàng)的庫，eslint-config-standard。要想使用 standard 規(guī)范，必須安裝相關(guān)依賴。

yarn add eslint-config-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node -D
# OR
npm install --save-dev eslint-config-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node

可以看出，這里沒有針對 vue 文件的檢查規(guī)范的庫，vue 生態(tài)鏈中提供了eslint-plugin-vue庫。eslint-plugin-vue 的官網(wǎng)更加詳細(xì)的介紹了如何配置 .eslintrc.js

安裝 eslint-plugin-vue

yarn add eslint eslint-plugin-vue -D
#OR
npm install --save-dev eslint eslint-plugin-vue

官方配置如下

由于，eslint-plugin-vue 配置規(guī)則的強(qiáng)度逐步遞增，此處只使用最基本的配置 plugin:vue/vue3-essential。

再將 standard 添加上，此時 .eslintrc.js 配置如下

// .eslintrc.js
module.exports = {
  root: true,
  env: {
    node: true,
  },
  extends: [
    // https://github.com/vuejs/eslint-plugin-vue
    'plugin:vue/vue3-essential', 
    'standard'
  ],
};

eslint 已經(jīng)生效，如下所示：

vue 生態(tài)鏈已經(jīng)包裝好 eslint-config-standard ，即 vuejs/eslint-config-standard

故，可以直接安裝并使用

yarn add @vue/eslint-config-standard -D
#OR
npm install @vue/eslint-config-standard --save-dev

初步總結(jié)

安裝 standard規(guī)范
安裝 eslint 和 eslint-plugin-vue
替換 eslint-config-standard 為 @vue/eslint-config-standard所有的安裝如下所示

yarn add eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint eslint-plugin-vue @vue/eslint-config-standard -D
# OR
npm install --save-dev eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint eslint-plugin-vue @vue/eslint-config-standard

.eslintrc.js 配置如下

// .eslintrc.js
module.exports = {
 root: true,
 env: {
   node: true,
 },
 extends: [
   // https://github.com/vuejs/eslint-plugin-vue
   'plugin:vue/vue3-essential', 
   // https://github.com/vuejs/eslint-config-standard
  '@vue/standard'
 ],
};

其實(shí)，@vue/eslint-config-standard 是 eslint-config-standard 的集成，故無需安裝 eslint-config-standard。

package.json

{
  "name": "vue3-vite",
  "version": "0.0.0",
  "scripts": {
    "serve": "vite preview",
    "build": "vite build",
    "lint": "vue-cli-service lint",
    "dev": "vite"
  },
  "dependencies": {
    "vue": "^3.0.5"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^1.2.2",
    "@vue/compiler-sfc": "^3.0.5",
    "@vue/eslint-config-standard": "^6.0.0",
    "eslint": "^7.27.0",
    "eslint-plugin-import": "^2.23.4",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^5.1.0",
    "eslint-plugin-vue": "^7.10.0",
    "vite": "^2.3.3"
  }
}

vue 官方推薦安裝 ESLint

上文已經(jīng)驗(yàn)證了使用 yarn 的方式安裝 eslint-plugin-vue，現(xiàn)在我們使用官方推薦的方式。

先卸載所有已安裝的包

yarn remove eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint eslint-plugin-vue @vue/eslint-config-standard
# OR
npm uninstall eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint eslint-plugin-vue @vue/eslint-config-standard

刪除 .eslintrc.js 文件

vue add @vue/cli-plugin-eslint

此處一定要安裝了 @vuejs/app 才能在命令行中使用 vue 命令，可參考 vite構(gòu)建vue3項(xiàng)目

執(zhí)行后，選擇一種自己喜歡的規(guī)范

默認(rèn)保存即檢查代碼

見證奇跡的時刻到了，vue 自動安裝了必備的包并添加了配置文件。

package.json

{
  "name": "vue3-vite",
  "version": "0.0.0",
  "scripts": {
    "serve": "vite preview",
    "build": "vite build",
    "lint": "vue-cli-service lint",
    "dev": "vite"
  },
  "dependencies": {
    "vue": "^3.0.5"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^1.2.2",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/compiler-sfc": "^3.0.5",
    "@vue/eslint-config-standard": "^5.1.2",
    "eslint": "^6.7.2",
    "eslint-plugin-import": "^2.20.2",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^4.2.1",
    "eslint-plugin-standard": "^4.0.0",
    "eslint-plugin-vue": "^7.0.0",
    "vite": "^2.3.3"
  }
}