详解如何在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 相关文章推荐
jQuery处理xml格式的返回数据(实例解析)
Nov 28 Javascript
jquery预览图片实现鼠标放上去显示实际大小
Jan 16 Javascript
JavaScript的arguments对象应用示例
Sep 15 Javascript
探究Vue.js 2.0新增的虚拟DOM
Oct 20 Javascript
详解AngularJS中的表单验证(推荐)
Nov 17 Javascript
初学者AngularJS的环境搭建过程
Oct 27 Javascript
vue+node+webpack环境搭建教程
Nov 05 Javascript
打通前后端构建一个Vue+Express的开发环境
Jul 17 Javascript
微信小程序webview组件交互,内联h5页面并网页实现微信支付实现解析
Aug 16 Javascript
JS代码优化的8点建议
Feb 04 Javascript
小程序自定义圆形进度条
Nov 17 Javascript
JavaScript手写数组的常用函数总结
Nov 22 Javascript
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
phalcon model在插入或更新时会自动验证非空字段的解决办法
2016/12/29 PHP
php实现微信支付之现金红包
2018/05/30 PHP
Windows平台PHP+IECapt实现网页批量截图并创建缩略图功能详解
2019/08/02 PHP
javascript动态添加样式(行内式/嵌入式/外链式等规则)
2013/06/24 Javascript
js中onload与onunload的使用示例
2013/08/25 Javascript
用js实现in_array的方法
2013/11/05 Javascript
Jquery each方法跳出循环,并获取返回值(实例讲解)
2013/12/12 Javascript
jquery处理json对象
2014/11/03 Javascript
初识Node.js
2015/03/20 Javascript
js改变Iframe中Src的方法
2015/05/05 Javascript
使用javaScript动态加载Js文件和Css文件
2015/10/24 Javascript
jQuery+CSS3实现3D立方体旋转效果
2015/11/10 Javascript
JS在一定时间内跳转页面及各种刷新页面的实现方法
2016/05/26 Javascript
Angularjs处理页面闪烁的解决方法
2017/03/09 Javascript
jquery在启动页面时,自动加载数据的实例
2018/01/22 jQuery
微信小程序页面上下滚动效果
2020/11/18 Javascript
微信小程序indexOf的替换方法(推荐)
2020/01/14 Javascript
Python开发编码规范
2006/09/08 Python
python读取oracle函数返回值
2016/07/18 Python
Python中%是什么意思?python中百分号如何使用?
2018/03/20 Python
python得到qq句柄,并显示在前台的方法
2018/10/14 Python
python tkinter组件摆放方式详解
2019/09/16 Python
使用pycharm和pylint检查python代码规范操作
2020/06/09 Python
基于python实现ROC曲线绘制广场解析
2020/06/28 Python
Python实现弹球小游戏
2020/08/01 Python
python3字符串输出常见面试题总结
2020/12/01 Python
英国和世界各地预订便宜的酒店:LateRooms.com
2019/05/05 全球购物
耐克波兰官方网站:Nike波兰
2019/09/03 全球购物
机电一体化专业应届本科生求职信
2013/09/27 职场文书
高分子材料与工程专业推荐信
2013/12/01 职场文书
全国优秀辅导员事迹材料
2014/05/14 职场文书
科学育儿宣传标语
2014/10/08 职场文书
工作检讨书怎么写
2015/01/23 职场文书
环卫处个人工作总结
2015/03/04 职场文书
2015年世界环境日活动方案
2015/05/05 职场文书
JavaScript 反射学习技巧
2021/10/16 Javascript