二、标准化编程规范解决方案之自动格式化工具 Prettier

漏洞挖
• 阅读 1130

在上一节中,我们知道了 ESLint 可以让我们的代码格式变得更加规范,但是同样的它也会带来开发时编码复杂度上升的问题。

那么有没有办法既可以保证 ESLint 规则校验,又可以让开发者无需关注格式问题来进行顺畅的开发呢?

答案是:有的!

而解决这个问题的关键就是 prettier!(点击 这里 进入 prettier 中文官网!)

prettier 是什么?

  1. 一个代码格式化工具
  2. 开箱即用
  3. 可以直接集成到 VSCode 之中
  4. 在保存时,让代码直接符合 ESLint 标准(需要通过一些简单配置)

2-06:ESLint 与 Prettier 配合解决代码格式问题

prettier 可以在保存代码时,让我们的代码直接符合 ESLint 标准。但是想要实现这样的功能需要进行一些配置。

  1. VSCode 中安装 prettier 插件(搜索 prettier),这个插件可以帮助我们在 配置 prettier 的时候获得提示
    二、标准化编程规范解决方案之自动格式化工具 Prettier
  1. 在项目根目录中新建 .prettierrc 文件,该文件为 perttier 默认配置文件
  1. 在该文件中写入如下配置:

    {
      // 不尾随分号
      "semi": false,
      // 使用单引号
      "singleQuote": true,
      // 多行逗号分割的语法中,最后一行不加逗号
      "trailingComma": "none",
      // HTML 空白敏感性 "ignore"- 所有标签周围的空白(或缺少它)被认为是微不足道的。
      "htmlWhitespaceSensitivity": "ignore"
    }

    二、标准化编程规范解决方案之自动格式化工具 Prettier

  1. 打开 VSCode 《设置面板》
    二、标准化编程规范解决方案之自动格式化工具 Prettier
  1. 在设置中,搜索 save ,勾选 Format On Save
    二、标准化编程规范解决方案之自动格式化工具 Prettier

至此,你即可在 VSCode 保存时,自动格式化代码!

但是! 你只做到这样可能还不够!
你可能遇到以下问题,最常见的例如:

  1. VSCode 而言,默认一个 tab 等于 4 个空格,而 ESLint 希望一个 tab 为两个空格
    解决办法:打开 VSCode 《设置面板》-> Tab Size 设置为 2
    二、标准化编程规范解决方案之自动格式化工具 Prettier
  1. 如果你的 VSCode 安装了多个代码格式化工具
    解决办法:单击右键 -> 使用...格式化工具 -> 配置默认格式化程序为Prettier
    二、标准化编程规范解决方案之自动格式化工具 Prettier

    二、标准化编程规范解决方案之自动格式化工具 Prettier

  1. ESLint 和 prettier 之间的冲突问题
    我们尝试在 Home.vue 中写入一个 created 方法,写入完成之后,打开我们的控制台我们会发 现,此时代码抛出了一个 ESLint 的错误

    二、标准化编程规范解决方案之自动格式化工具 Prettier

这个错误的意思是说:created 这个方法名和后面的小括号之间,应该有一个空格!

但是当我们加入了这个空格之后,只要一保存代码,就会发现 prettier 会自动帮助我们去除掉这个空格。

那么此时的这个问题就是 prettier 和 ESLint 的冲突问题。

解决办法:打开 .eslintrc.js 配置文件 -> 在 rules 规则下,新增一条规则 -> 'space-before-function-paren': 'off' (该规则表示关闭《方法名后增加空格》的规则)

重启项目

至此我们整个的 perttier 和 ESLint 的配合使用就全部完成了。

在之后我们写代码的过程中,只需要保存代码,那么 perttier 就会帮助我们自动格式化代码,使其符合 ESLint 的校验规则。而无需我们手动进行更改了。

在这两个小节我们通过 prettier + ESLint 解决了代码格式的问题,但是我们之前也说过 编程规范 指的不仅仅只是 代码格式规范。

除了 代码格式规范 之外,还有另外一个很重要的规范就是 git 提交规范!

请看下个章节《标准化编程规范解决方案之git 提交规范化工具 Commitizen》

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
美凌格栋栋酱 美凌格栋栋酱
6个月前
Oracle 分组与拼接字符串同时使用
SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Wesley13 Wesley13
3年前
FLV文件格式
1.        FLV文件对齐方式FLV文件以大端对齐方式存放多字节整型。如存放数字无符号16位的数字300(0x012C),那么在FLV文件中存放的顺序是:|0x01|0x2C|。如果是无符号32位数字300(0x0000012C),那么在FLV文件中的存放顺序是:|0x00|0x00|0x00|0x01|0x2C。2.  
Stella981 Stella981
3年前
SpringBoot整合Redis乱码原因及解决方案
问题描述:springboot使用springdataredis存储数据时乱码rediskey/value出现\\xAC\\xED\\x00\\x05t\\x00\\x05问题分析:查看RedisTemplate类!(https://oscimg.oschina.net/oscnet/0a85565fa
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
PHP创建多级树型结构
<!lang:php<?php$areaarray(array('id'1,'pid'0,'name''中国'),array('id'5,'pid'0,'name''美国'),array('id'2,'pid'1,'name''吉林'),array('id'4,'pid'2,'n
Easter79 Easter79
3年前
SpringBoot整合Redis乱码原因及解决方案
问题描述:springboot使用springdataredis存储数据时乱码rediskey/value出现\\xAC\\xED\\x00\\x05t\\x00\\x05问题分析:查看RedisTemplate类!(https://oscimg.oschina.net/oscnet/0a85565fa
Wesley13 Wesley13
3年前
Java日期时间API系列36
  十二时辰,古代劳动人民把一昼夜划分成十二个时段,每一个时段叫一个时辰。二十四小时和十二时辰对照表:时辰时间24时制子时深夜11:00凌晨01:0023:0001:00丑时上午01:00上午03:0001:0003:00寅时上午03:00上午0
Python进阶者 Python进阶者
1年前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这