Vue3如何通过ESLint校验代码是否符合规范详解

 更新时间:2022年07月18日 11:04:09   作者:冷A冷  
ESLint可以灵活设置规则,也发布了很多公开的规则集,下面这篇文章主要给大家介绍了关于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 tsutils@3.21.0 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 vue-item@1.0.0 No description
npm WARN vue-item@1.0.0 No repository field.

+ eslint@8.14.0
+ eslint-plugin-import@2.26.0
+ eslint-config-airbnb-base@15.0.0
+ eslint-plugin-vue@8.7.1
+ @typescript-eslint/parser@5.22.0
+ @typescript-eslint/eslint-plugin@5.22.0
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插件工具,帮助我们写出符合规范的代码,可以提高代码规范和编码效率。当然了,还有其他的工具也欢迎在评论区留言一起学习,成长进步。

相关文章

  • 关于vue中路由的跳转和参数传递,参数获取

    关于vue中路由的跳转和参数传递,参数获取

    这篇文章主要介绍了关于vue中路由的跳转和参数传递,参数获取方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Vue使用mockjs问题(返回数据、get、post 请求)

    Vue使用mockjs问题(返回数据、get、post 请求)

    这篇文章主要介绍了Vue使用mockjs问题(返回数据、get、post 请求),具有很好的参考价值,希望对大家有所帮助。
    2023-05-05
  • Vue页面反复刷新的常见问题及解决方案

    Vue页面反复刷新的常见问题及解决方案

    Vue.js 是一个流行的前端框架,旨在通过其响应式的数据绑定和组件化的开发模式简化开发,然而,在开发 Vue.js 应用时,页面反复刷新的问题可能会对用户体验和开发效率产生负面影响,本文将深入探讨 Vue 页面反复刷新的常见原因,并提供详细的解决方案
    2024-09-09
  • vue3结合typescript中使用class封装axios

    vue3结合typescript中使用class封装axios

    这篇文章主要为大家介绍了vue3结合typescript中使用class封装axios实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • vue+element-ui实现头部导航栏组件

    vue+element-ui实现头部导航栏组件

    这篇文章主要为大家详细介绍了vue+element-ui实现头部导航栏组件,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • VUE 自定义取色器组件的实现

    VUE 自定义取色器组件的实现

    本文主要介绍了VUE 自定义取色器组件的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Vue el-table组件如何实现将日期格式化

    Vue el-table组件如何实现将日期格式化

    这篇文章主要介绍了Vue el-table组件如何实现将日期格式化问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • vue编写的功能强大的swagger-ui页面及使用方式

    vue编写的功能强大的swagger-ui页面及使用方式

    swagger是一种标准的数据格式的定义,对于不同语言进行实现一些注解API式的东西,能快速生成这种描述restful格式的api信息的json串,本文给大家详细介绍vue编写的功能强大的swagger-ui页面,感兴趣的朋友跟随小编一起看看吧
    2022-02-02
  • electron + vue项目实现打印小票功能及实现代码

    electron + vue项目实现打印小票功能及实现代码

    这篇文章主要介绍了electron + vue项目实现打印小票功能,需要的朋友可以参考下
    2018-11-11
  • 详解基于vue-cli3快速发布一个fullpage组件

    详解基于vue-cli3快速发布一个fullpage组件

    这篇文章主要介绍了详解基于vue-cli3快速发布一个fullpage组件,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03

最新评论