Vue3如何通過ESLint校驗代碼是否符合規范詳解
前言
VUE3中項目使用的瞭ESLint插件校驗代碼是否符合編碼規則,一起來看看eslint的安裝方式,vs code編輯器,idea編輯器中方法。
1.在項目中安裝ESLint命令
npm install eslint --save-dev
2.初始化ESLint配置命令
通過向導的方式生成初始的配置包
npx eslint --init You can also run this command directly using 'npm init @eslint/config'. npx: 40 安裝成功,用時 27.246 秒 √ 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? ... (Press <space> to select, <a> to toggle all, <i> to invert selection) √ Browser √ Node ? How would you like to define a style for your project? ... > Use a popular style guide Answer questions about your style ? 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 ? What format do you want your config file to be in? ... > JavaScript YAML JSON Checking peerDependencies of eslint-config-airbnb-base@latest The config that you've selected requires the following dependencies: eslint-plugin-vue@latest @typescript-eslint/eslint-plugin@latest eslint-config-airbnb-base@latest eslint@^7.32.0 || ^8.2.0 eslint-plugin-import@^2.25.2 @typescript-eslint/parser@latest √ Would you like to install them now with npm? · No / Yes Installing eslint-plugin-vue@latest, @typescript-eslint/eslint-plugin@latest, eslint-config-airbnb-base@latest, eslint@^7.32.0 || ^8.2.0, eslint-plugin-import@^2.25.2, @typescript-eslint/parser@latest npm WARN [email protected] requires a peer of typescript@>=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta but none is installed. You must install peer dependencies yourself. npm WARN [email protected] No description npm WARN [email protected] No repository field. + [email protected] + [email protected] + [email protected] + [email protected] + @typescript-eslint/[email protected] + @typescript-eslint/[email protected] added 112 packages from 71 contributors, updated 4 packages and audited 195 packages in 187.851s 49 packages are looking for funding run `npm fund` for details found 0 vulnerabilities A config file was generated, but the config file itself may not follow your linting rules.
3.查看eslint.js文件
看到生成的文件在plugin:vue/essential使用瞭vue2的規則,修改vue3的ue3-strongly-recommended校驗方法。
module.exports = { "env": { "es2021": true }, "extends": [ //默認使用vue2的配置 //"plugin:vue/essential", //修改使用vue3的規則 "plugin:vue/vue3-strongly-recommended", "airbnb-base" ], "parserOptions": { "ecmaVersion": "latest", "parser": "@typescript-eslint/parser", "sourceType": "module" }, "plugins": [ "vue", "@typescript-eslint" ], "rules": { } }
在 https://eslint.vuejs.org/user-guide/#usage #Bundle Configurations 可以看到說明,翻譯瞭下可以參考:
這個插件提供瞭一些預定義的配置。可以通過將以下配置添加到extends. "plugin:vue/base"... 啟用正確 ESLint 解析的設置和規則。 使用 Vue.js 3.x 的配置。 "plugin:vue/vue3-essential"... base,以及防止錯誤或意外行為的規則。 "plugin:vue/vue3-strongly-recommended"... 上面,加上大大提高代碼可讀性和/或開發體驗的規則。 "plugin:vue/vue3-recommended"... 上面,加上強制執行主觀社區默認值的規則,以確保一致性。 使用 Vue.js 2.x 的配置。 "plugin:vue/essential"... base,以及防止錯誤或意外行為的規則。 "plugin:vue/strongly-recommended"... 上面,加上大大提高代碼可讀性和/或開發體驗的規則。 "plugin:vue/recommended"...以上,加上強制執行主觀社區默認值以確保一致性的規則。
4.在package.json下添加驗證腳本
–fix 可以自動修復低級代碼問題
"scripts": { "dev":"vite", "lint": "eslint ./src/**/*.{js,vue,ts,tsx,jsx} --fix" },
5.編輯器中安裝eslint插件
5.1 VS Code中安裝eslint插件步驟,按下圖操作
在VS Code設置中開啟eslint格式化配置勾上,默認是不開啟的。
5.2 Idea 中配置eslint方法
setting–搜索eslint就有結果,點ESLint勾上相應的選項。
6.在提交git時自動進行ESLint校驗方法
執行命令:
npx mrm@2 lint-staged
在package.json文件下添加下面的代碼。提交git就會自動校驗修復,加入git提交。
"lint-staged": { "*.{js,vue,ts}": [ "eslint --cache --fix", "npm run lint", //執行lint校驗規則,不需要手動校驗 "git add" / /修改後的文件添加git ] }
總結
項目中使用瞭ESLint插件工具,幫助我們寫出符合規范的代碼,可以提高代碼規范和編碼效率。當然瞭,還有其他的工具也歡迎在評論區留言一起學習,成長進步。
推薦閱讀:
- 詳解React項目中eslint使用百度風格
- 關於eslint+prettier+husky的配置及說明
- Vue中使用eslint和editorconfig方式
- vue基礎ESLint Prettier配置教程詳解
- Vue腳手架學習之項目創建方式