详解如何在vue项目中使用eslint+prettier格式化代码


Posted in Javascript onNovember 10, 2018

 对于前端代码风格这个问题一直是经久不衰,每个人都有自己的代码风格,每次看到别人代码一团糟时候我们都会吐槽下。今天给大家介绍如何使用eslint+prettier统一代码风格。

对于eslint大家应该比较了解了,是用来校验代码规范的。给大家介绍下prettier,prettier是用来统一代码风格,格式化代码的,支持js、ts、css、less、scss、json、jsx。并且集成了vscode、vim、webstorm、sublime text插件。

如果你的项目中采用的是ellint默认规则并且没有添加别的规则、没有使用standard或airbnb得风格,你可以下载编辑器插件直接保存代码时自动格式化。

以vscode为例:搜索插件  Eslint、vuter、prettier-code安装,在编辑器首选项   配置中修改配置

//由于prettier不能格式化vue文件template 所以使用js-beautify-html格式化
  "vetur.format.defaultFormatter.html": "js-beautify-html", 
  "vetur.format.defaultFormatterOptions": {
    "js-beautify-html": {
      "wrap_attributes": "force-aligned" //属性强制折行对齐
    }
  },
  "eslint.autoFixOnSave": true, //保存时使用自动格式化
  "eslint.validate": [  //验证文件类型
    "javascript",
    "javascriptreact",
    "vue",
    "html",
    "jsx",
    {
      "language": "html",
      "autoFix": true
    },
    {
      "language": "vue",
      "autoFix": true
    }
  ],
  "prettier.singleQuote": true, //使用单引号而不是双引号
  "prettier.jsxBracketSameLine": true, //将>多行JSX元素放在最后一行的末尾,而不是单独放在下一行
  "editor.formatOnSave": true, //保存时自动格式化

然后在eslint配置文件.eslintrc extends添加 eslint:recommended

extends: [
    'plugin:vue/essential',
    'eslint:recommended'
  ],

在page.json文件 scripts 中lint里面添加--fix   当执行npm run lint时eslint会帮你修复一些可以自动修复得规则

"scripts": {
    "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
    "start": "npm run dev",
    "lint": "eslint --fix --ext .js,.vue src",
    "build": "node build/build.js"
  },

现在我们就写完代码保存时prettier就会帮我们格式化代码,执行npm run lint时eslint会修复一些可以修复的规则,其余得规则就需要我们手动修复了

如果你的项目中使用的是standard或airbnd的代码规范、或项目中自己添加了一些eslint样式规则,那么我们需要安装一些依赖在项目中帮助格式化代码

npm i --save-dev prettier eslint-plugin-prettier eslint-config-prettier prettier-eslint-cli

安装eslint-plugin-prettier  配合eslint使用prettier,安装eslint-config-prettier禁用一些eslint和prettier冲突的规则,安装prettier-eslint-cli 使我们可以敲命令格式化代码

在.eslintrc.js  plugin和extends中添加prettier支持  rules中添加规则

extends: [
    'plugin:vue/essential',
    'eslint:recommended',
    'plugin:prettier/recommended'
  ],
  // required to lint *.vue files
  plugins: ['vue', 'prettier'],
  // add your custom rules here
  rules: {
    'prettier/prettier': 'error',
    // allow debugger during development
    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
  }

在page.json  script中添加配置   执行npm run format就可以格式化代码了

"scripts": {
    "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
    "start": "npm run dev",
    "lint": "eslint --fix --ext .js,.vue src",
    "build": "node build/build.js",
    "format": "prettier-eslint --write \"src/**/*.js\" \"src/**/*.vue\""
  },

当我们执行npm run format时还会报各种奇怪的错误 如:error: Delete ⏎ (prettier/prettier) at src/pages/xxx 等;这是因为prettier配置和编辑器prettier配置冲突导致的   在rules中配置下覆盖掉就可以了

"rules": {
 "no-console": 0,
 "prettier/prettier": [
  "error",
  {
   "singleQuote": true,
   "trailingComma": "none",
   "bracketSpacing": true,
   "jsxBracketSameLine": true
  }
 ]
}

现在我们就可以愉快的编码了

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
js实现tab切换效果实例
Sep 16 Javascript
JavaScript根据CSS的Media Queries来判断浏览设备的方法
May 10 Javascript
动态加载js、css的简单实现代码
May 26 Javascript
使用vue编写一个点击数字计时小游戏
Aug 31 Javascript
canvas雪花效果核心代码分享
Feb 19 Javascript
Vue2学习笔记之请求数据交互vue-resource
Feb 23 Javascript
JS中的三个循环小结
Jun 20 Javascript
JavaScript编写棋盘覆盖代码详解
Aug 28 Javascript
vue中实现高德定位功能
Dec 03 Javascript
详解JavaScript匿名函数和闭包
Jul 10 Javascript
最全vue的vue-amap使用高德地图插件画多边形范围的示例代码
Jul 17 Javascript
vue中如何添加百度统计代码
Dec 19 Vue.js
AngularJS上传文件的示例代码
Nov 10 #Javascript
详解vue-cli 3.0 build包太大导致首屏过长的解决方案
Nov 10 #Javascript
优雅的在React项目中使用Redux的方法
Nov 10 #Javascript
Vue组件之单向数据流的解决方法
Nov 10 #Javascript
详解如何制作并发布一个vue的组件的npm包
Nov 10 #Javascript
如何在基于vue-cli的项目自定义打包环境
Nov 10 #Javascript
Vue项目报错:Uncaught SyntaxError: Unexpected token
Nov 10 #Javascript
You might like
使用PHP和XSL stylesheets转换XML文档
2006/10/09 PHP
CI使用Tank Auth转移数据库导致密码用户错误的解决办法
2014/06/12 PHP
PHP使用Session遇到的一个Permission denied Notice解决办法
2014/07/30 PHP
关于Laravel参数验证的一些疑与惑
2019/11/19 PHP
JavaScript使用prototype定义对象类型
2007/02/07 Javascript
JavaScript更改class和id的方法
2008/10/10 Javascript
深入理解JavaScript系列(10) JavaScript核心(晋级高手必读篇)
2012/01/15 Javascript
基于jquery DOM写的类似微博发布的效果
2012/10/20 Javascript
jQuery定义背景动态切换效果的方法
2015/03/23 Javascript
jquery实现列表上下移动功能
2016/02/25 Javascript
简单谈谈ES6的六个小特性
2016/11/18 Javascript
js实现右键菜单功能
2016/11/28 Javascript
js is_valid_filename验证文件名的函数
2017/07/19 Javascript
使用Node搭建reactSSR服务端渲染架构
2018/08/30 Javascript
微信小程序实现分享朋友圈的图片功能示例
2019/01/18 Javascript
JS async 函数的含义和用法实例总结
2020/04/08 Javascript
[00:48]DOTA2国际邀请赛公开赛报名开始 扫码开启逐梦之旅
2018/06/06 DOTA
[01:05:00]2018国际邀请赛 表演赛 Pain vs OpenAI
2018/08/24 DOTA
ubuntu 16.04下python版本切换的方法
2019/06/14 Python
利用anaconda保证64位和32位的python共存
2021/03/09 Python
快速查找Python安装路径方法
2020/02/06 Python
基于Django OneToOneField和ForeignKey的区别详解
2020/03/30 Python
HTML5制作3D爱心动画教程 献给女友浪漫的礼物
2014/11/05 HTML / CSS
荷兰牛仔裤网上商店:Jeans Centre
2018/04/03 全球购物
公务员职务工作的自我评价
2013/11/01 职场文书
优秀研究生主要事迹
2014/06/03 职场文书
安全施工标语
2014/06/07 职场文书
联片教研活动总结
2014/07/01 职场文书
党的群众路线教育实践活动对照检查材料(四风)
2014/09/27 职场文书
任命书标准格式
2015/03/02 职场文书
死者家属慰问信
2015/03/24 职场文书
男人帮观后感
2015/06/18 职场文书
python基础之匿名函数详解
2021/04/21 Python
详解CSS中的特指度和层叠问题
2021/07/15 HTML / CSS
ROS系统将python包编译为可执行文件的简单步骤
2021/07/25 Python
如何通过简单的代码描述Angular父组件、子组件传值
2022/04/07 Javascript