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才生效。如果配置后,配置不生效,尝试以下设置:

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

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



相关文章
|
9天前
|
JavaScript 前端开发
如何在 Vue 项目中配置 Tree Shaking?
通过以上针对 Webpack 或 Rollup 的配置方法,就可以在 Vue 项目中有效地启用 Tree Shaking,从而优化项目的打包体积,提高项目的性能和加载速度。在实际配置过程中,需要根据项目的具体情况和需求,对配置进行适当的调整和优化。
|
9天前
|
存储 缓存 JavaScript
在 Vue 中使用 computed 和 watch 时,性能问题探讨
本文探讨了在 Vue.js 中使用 computed 计算属性和 watch 监听器时可能遇到的性能问题,并提供了优化建议,帮助开发者提高应用性能。
|
9天前
|
存储 缓存 JavaScript
如何在大型 Vue 应用中有效地管理计算属性和侦听器
在大型 Vue 应用中,合理管理计算属性和侦听器是优化性能和维护性的关键。本文介绍了如何通过模块化、状态管理和避免冗余计算等方法,有效提升应用的响应性和可维护性。
|
9天前
|
存储 缓存 JavaScript
Vue 中 computed 和 watch 的差异
Vue 中的 `computed` 和 `watch` 都用于处理数据变化,但使用场景不同。`computed` 用于计算属性,依赖于其他数据自动更新;`watch` 用于监听数据变化,执行异步或复杂操作。
|
8天前
|
JavaScript 前端开发 UED
vue学习第二章
欢迎来到我的博客!我是一名自学了2年半前端的大一学生,熟悉JavaScript与Vue,目前正在向全栈方向发展。如果你从我的博客中有所收获,欢迎关注我,我将持续更新更多优质文章。你的支持是我最大的动力!🎉🎉🎉
|
10天前
|
存储 JavaScript 开发者
Vue 组件间通信的最佳实践
本文总结了 Vue.js 中组件间通信的多种方法,包括 props、事件、Vuex 状态管理等,帮助开发者选择最适合项目需求的通信方式,提高开发效率和代码可维护性。
|
8天前
|
JavaScript 前端开发 开发者
vue学习第一章
欢迎来到我的博客!我是瑞雨溪,一名热爱JavaScript和Vue的大一学生。自学前端2年半,熟悉JavaScript与Vue,正向全栈方向发展。博客内容涵盖Vue基础、列表展示及计数器案例等,希望能对你有所帮助。关注我,持续更新中!🎉🎉🎉
|
23天前
|
数据采集 监控 JavaScript
在 Vue 项目中使用预渲染技术
【10月更文挑战第23天】在 Vue 项目中使用预渲染技术是提升 SEO 效果的有效途径之一。通过选择合适的预渲染工具,正确配置和运行预渲染操作,结合其他 SEO 策略,可以实现更好的搜索引擎优化效果。同时,需要不断地监控和优化预渲染效果,以适应不断变化的搜索引擎环境和用户需求。
|
10天前
|
存储 JavaScript
Vue 组件间如何通信
Vue组件间通信是指在Vue应用中,不同组件之间传递数据和事件的方法。常用的方式有:props、自定义事件、$emit、$attrs、$refs、provide/inject、Vuex等。掌握这些方法可以实现父子组件、兄弟组件及跨级组件间的高效通信。
|
15天前
|
JavaScript
Vue基础知识总结 4:vue组件化开发
Vue基础知识总结 4:vue组件化开发
下一篇
无影云桌面