Vue项目优化:编程规范|(一)Eslint + Prettier 统一代码风格

简介: Vue项目优化:编程规范|(一)Eslint + Prettier 统一代码风格

前言

团队开发的项目,我们需要对团队编程代码风格进行强制性统一规范。在规范过程中,我们会借助一些工具。

eslint VS prettier

ESLint、StyleLint、TSLint(已废弃)都属于Linters,它们按照一定规则对代码进行校验,另外,Linters的客户端还会提供一些修复功能,实际开发中,常用的IDE借助这些客户端可以实现代码自动修复。

既然Linters已经可以自动修复了,为什么我们还要用Prettier?

Linters的自动修复是基于上述两种规则:Formatting和Code-quality。

在Code-quality上,Linters做的做够好了,像no-unused-varsno-extra-bindno-undef等;

但是在Formatting上,Linters虽然能在一定程度上保证代码的格式,像max-lenno-mixed-spaces-and-tabskeyword-spacing等。

但是如果我们的团队规范要求更高的话,要保证团队的代码风格完全一致,Linters还不足。比如下面两种写法,Linters都是允许的:

// 小明写的
const {a, b, c} = obj
// 小李写的
const {
  a,
b,
c,
} = obj
复制代码

因此,在各种Linters的基础下,我们还需要Prettier。

关于PrettierPrettier是一个多语言支持的代码格式化工具,它也是通过AST解析代码,然后以一个特定的格式输出格式化后的代码。相比Linters,Prettier没有那么多针语言语法的规则,而是一个纯粹的代码格式化工具,在Prettier看来,任何东西都是可以格式化的。

Prettier和Linter在代码格式化的思路差异:

  • Linters的格式化思路是:给我一个规则,如果不符合这个规则,我才会去格式化。
  • Prettier的格式化思路是:给我一个规则,如果不符合这个规则,我按照A格式格式化,如果符合这个规则,我按照B格式格式化。

因此,基于Prettier的格式化思路,代码的风格差异性能够被完全抹除,不管你怎么写,Prettier格式化后的代码格式总是一样的。

Linters和Prettier之间是否会有冲突?

有冲突,所以最佳实践是禁用掉Linters中所有与Prettier冲突的Formatting Rules,用prettier负责格式化

linters有两种能力:检查代码质量(是否有未使用的变量,使用函数式编程的函数是否产生副作用等)和检查代码风格,另外,通过IDE借助这些linters客户端可以实现一些代码自动修复。

但是代码风格方面完全靠Linters是远远不够的,还需要prettier,pretter没有对代码的质量进行检查的能力,其只会对代码风格按照指定的规范进行统一,避免一个项目中出现多种不同的代码风格。

Eslint + Prettier 统一代码风格

安装Eslint

npm install --save-dev eslint eslint-plugin-vue
// or
yarn add -D eslint eslint-plugin-vue
复制代码

安装eslint之后,默认会在项目根目录下就会生成.eslintrc.js,这里还安装了eslint-plugin-vue,因为要使用到他的vue/recommended插件。

配置.eslintrc.js

module.exports = { 
    root: true, 
    env: { 
        node: true, 
        browser: true, 
        es6: true 
    }, 
    extends: [ "plugin:vue/recommended", "eslint:recommended" ], 
    parserOptions: { "parser": "babel-eslint" }, 
    rules: {} // 用来自定义一些符合个人或者团队的规则 }
复制代码

根目录下创建.eslintignore文件,配置需要忽略检查的文件:

# 忽略build目录下类型为js的文件的语法检查
build/*.js
# 忽略src/assets目录下文件的语法检查
src/assets
# 忽略public目录下文件的语法检查
public
dist
复制代码

安装Prettier

npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
复制代码
  • prettier: 核心模块
  • eslint-config-prettier: 关闭所有不必要或可能跟prettier产生冲突的规则
  • eslint-plugin-prettier: 可以让eslint使用prettier规则进行检查

根目录下.eslintrc.json文件中添加extends设置:

{
    // ...
    "extends": [
        // ...
        "plugin:prettier/recommended",
    ],
}
复制代码

根目录下创建.prettierrc.json文件:

{
  "trailingComma": "es5",
  "tabWidth": 2,
  "semi": true,
  "singleQuote": true
}
复制代码

修改.prettierrc.json文件后,需要重启vscode才生效。如果配置后,配置不生效,尝试以下设置:

网络异常,图片无法展示
|

网络异常,图片无法展示
|



相关文章
|
7天前
|
JavaScript
vue使用iconfont图标
vue使用iconfont图标
51 1
|
17天前
|
JavaScript 关系型数据库 MySQL
基于VUE的校园二手交易平台系统设计与实现毕业设计论文模板
基于Vue的校园二手交易平台是一款专为校园用户设计的在线交易系统,提供简洁高效、安全可靠的二手商品买卖环境。平台利用Vue框架的响应式数据绑定和组件化特性,实现用户友好的界面,方便商品浏览、发布与管理。该系统采用Node.js、MySQL及B/S架构,确保稳定性和多功能模块设计,涵盖管理员和用户功能模块,促进物品循环使用,降低开销,提升环保意识,助力绿色校园文化建设。
|
2月前
|
JavaScript API 开发者
Vue是如何进行组件化的
Vue是如何进行组件化的
|
2月前
|
JavaScript 前端开发 开发者
vue学习第一章
欢迎来到我的博客!我是瑞雨溪,一名热爱前端的大一学生,专注于JavaScript与Vue,正向全栈进发。博客分享Vue学习心得、命令式与声明式编程对比、列表展示及计数器案例等。关注我,持续更新中!🎉🎉🎉
48 1
vue学习第一章
|
2月前
|
JavaScript 前端开发 索引
vue学习第三章
欢迎来到瑞雨溪的博客,一名热爱JavaScript与Vue的大一学生。本文介绍了Vue中的v-bind指令,包括基本使用、动态绑定class及style等,希望能为你的前端学习之路提供帮助。持续关注,更多精彩内容即将呈现!🎉🎉🎉
34 1
|
2月前
|
缓存 JavaScript 前端开发
vue学习第四章
欢迎来到我的博客!我是瑞雨溪,一名热爱JavaScript与Vue的大一学生。本文介绍了Vue中计算属性的基本与复杂使用、setter/getter、与methods的对比及与侦听器的总结。如果你觉得有用,请关注我,将持续更新更多优质内容!🎉🎉🎉
41 1
vue学习第四章
|
2月前
|
JavaScript 前端开发 算法
vue学习第7章(循环)
欢迎来到瑞雨溪的博客,一名热爱JavaScript和Vue的大一学生。本文介绍了Vue中的v-for指令,包括遍历数组和对象、使用key以及数组的响应式方法等内容,并附有综合练习实例。关注我,将持续更新更多优质文章!🎉🎉🎉
32 1
vue学习第7章(循环)
|
2月前
|
JavaScript 前端开发
vue学习第九章(v-model)
欢迎来到我的博客,我是瑞雨溪,一名热爱JavaScript与Vue的大一学生,自学前端2年半,正向全栈进发。此篇介绍v-model在不同表单元素中的应用及修饰符的使用,希望能对你有所帮助。关注我,持续更新中!🎉🎉🎉
35 1
vue学习第九章(v-model)
|
2月前
|
JavaScript 前端开发 开发者
vue学习第十章(组件开发)
欢迎来到瑞雨溪的博客,一名热爱JavaScript与Vue的大一学生。本文深入讲解Vue组件的基本使用、全局与局部组件、父子组件通信及数据传递等内容,适合前端开发者学习参考。持续更新中,期待您的关注!🎉🎉🎉
49 1
vue学习第十章(组件开发)
|
2月前
|
JavaScript 前端开发
vue学习第十一章(组件开发2)
欢迎来到我的博客,我是瑞雨溪,一名自学前端两年半的大一学生,专注于JavaScript与Vue。本文介绍Vue中的插槽(slot)使用方法,包括基本插槽、具名插槽及作用域插槽,帮助你在组件开发中实现内容的灵活定制。如果你觉得有帮助,请关注我,持续更新中!🎉🎉🎉
25 1
vue学习第十一章(组件开发2)

热门文章

最新文章