vue3如何添加eslint校验(eslint-plugin-vue)

 更新时间:2024年01月02日 09:13:03   作者:James_liPeng  
这篇文章主要介绍了vue3如何添加eslint校验(eslint-plugin-vue),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

前言

例如:

随着 随着vue3项目的使用, 提高团队的代码规范和减少code review的时间, eslint的代码校验就越来越重要了。

目前的pritter对vue3的支持度不是很理想,很多vue3的新特性还不支持,目前pritter官网上也没有给出解决方案, 所以只能自己使用eslint来配置vue3的代码校验

一、eslint是什么?

本文针对的是有前端开发基础的同学,所以基础概念不做赘述。

二、使用步骤

1.引入库 安装eslint 和 eslint-plugin-vue

代码如下:

npm install --save-dev eslint eslint-plugin-vue

2.添加配置

在项目的根目录下新增.eslintrc.js文件, 文件内容如下,可粘贴后直接使用, 重点是配置是 plugin:vue/vue3-recommended, rules中的内容是在vue3-recommended的配置基础上,额外自定义的配置, 具体的参数配置可根据自己的项目实际情况进行相关的配置, 配置官网文档为

eslint-plugin-vue 官网文档

module.exports = {
  extends: [
    'plugin:vue/vue3-recommended'
  ],
  rules: {
    'vue/max-attributes-per-line': ['error', {
      singleline: 5 //标签超出5个属性就会换行
    }],
    'vue/script-setup-uses-vars': 'error', // setup 语法糖校验
    'object-curly-spacing': ['error', 'always'], // 对象前后要加空格 { a: 1 }
    // 'array-bracket-spacing': ['error', 'always'], // 数组前后要加空格 [ 1, 2 ]
    'array-bracket-newline': ['error', { "minItems": 5}], // 数组超过五个值可以换行
    'arrow-spacing': "error", //箭头函数前后加空格 () => {}
    // 'vue/no-unsupported-features': ['error', { // 校验不支持的特性
    //   'version': "^3.0.0",
    //   'ignores': [],
    // }]
    'vue/block-tag-newline': ['error', { //  标签直接的换行规范
      "singleline": "always",
      "multiline": "always",
      "maxEmptyLines": 0,
      "blocks": {
        "script": {
          "singleline": "always",
          "multiline": "always",
          "maxEmptyLines": 0,
        },
        "template": {
          "singleline": "always",
          "multiline": "always",
          "maxEmptyLines": 0,
        },
        "my-block": {
          "singleline": "always",
          "multiline": "always",
          "maxEmptyLines": 0,
        }
      }
    }],
    // 'vue/no-unused-properties': ['error', { // 未使用的props, 数据, 和方法
    //   "groups": ['props', 'data', 'methods']
    // }],
  }
}

3.添加自动化代码修复

在package.json的script中添加

"lint-fix": "eslint --fix --ext .js --ext .vue src/"

运行npm run lint-fix 就可以进行代码的自动化修复了

注意:有些代码之后修复可能会影响代码的功能的风险, 这种代码修复不会自动化修复,会给出相关的提示。

4.在vue.config.js中设置

在vue.config.js的module.exports中设置

lintOnSave: true,

总结

上文中提供的相关eslint校验配置只能支持大部分的代码校验,还达不到prettier对于vue2的校验力度, 需要更多的校验配置可以参考官网的api。

相关文章

  • vue.js 实现输入框动态添加功能

    vue.js 实现输入框动态添加功能

    这篇文章主要介绍了vue.js 实现输入框动态添加功能,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-06-06
  • vue3.0如何在全局挂载对象和方法

    vue3.0如何在全局挂载对象和方法

    这篇文章主要介绍了vue3.0如何在全局挂载对象和方法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-04-04
  • 使用vue实现计时器功能

    使用vue实现计时器功能

    这篇文章主要为大家详细介绍了使用vue实现计时器功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • Vue+Webpack完美整合富文本编辑器TinyMce的方法

    Vue+Webpack完美整合富文本编辑器TinyMce的方法

    这篇文章主要介绍了Vue+Webpack完美整合富文本编辑器TinyMce的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-11-11
  • Vue的基本知识你都了解吗

    Vue的基本知识你都了解吗

    这篇文章主要为大家详细介绍了Vue的基本知识,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-02-02
  • vue3中安装并且使用Tailwind CSS的完整步骤

    vue3中安装并且使用Tailwind CSS的完整步骤

    这篇文章主要介绍了vue3中安装并且使用Tailwind CSS的完整步骤,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧
    2025-04-04
  • 在uni-app中使用element-ui的方法与报错解决

    在uni-app中使用element-ui的方法与报错解决

    我们在开web开发的时候,经常会使用到element或者uview-ui,下面这篇文章主要给大家介绍了关于在uni-app中使用element-ui的方法与报错解决的相关资料,需要的朋友可以参考下
    2022-04-04
  • vue3父子组件数据更新不及时的问题解决方案

    vue3父子组件数据更新不及时的问题解决方案

    文章介绍了在使用props向子组件传值时,如果直接赋值不会导致子组件数据更新的问题,文章提供了解决方案,通过在父组件中使用 nextTick确保数据变化后再调用子组件中的接口,从而保证数据同步更新,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • 深入了解vue-loader是如何工作的

    深入了解vue-loader是如何工作的

    这篇文章主要为大家详细介绍了vue-loader的工作原理与使用,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-12-12
  • 使用iView Upload 组件实现手动上传图片的示例代码

    使用iView Upload 组件实现手动上传图片的示例代码

    这篇文章主要介绍了使用iView Upload 组件实现手动上传图片的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-10-10

最新评论