发布时间:2023-05-21 文章分类:WEB开发, 电脑百科 投稿人:王小丽 字号: 默认 | | 超大 打印

统一项目格式化规则:

1、首先创建项目后,安装babel-eslint插件

2、然后将下面这三个文件放在项目的根目录中

3、最后将这个下面的json文件内容粘贴到vscode中的setting.json文件中, codeActionsOnSave 这个属性是vscode装了eslint插件后才会有的属性,该属性值设置为: "source.fixAll": true 时,则可以使代码在保存时自动按照 .eslintrc.js 中定义的规则格式化代码)

{
  "editor.codeActionsOnSave": {
    "source.fixAll": true,
  }
}

4、最后重启一下vscode就可以了

下面介绍常用的代码格式化工具:

  1、Vetur:专门用于格式化 *.vue 文件

这个插件是 vscode 能优雅写 Vue 的核心,绝对的神器,它的优点:

这里主要说说格式化代码相关,防止和 ESLint 打架。

从官方文档可以看出,Vetur集成了prettier,这就非常棒了。Vetur能够让 *.vue 文件中不同的块使用不同的格式化方案,<template>调用 html 格式化工具,<script>调用 JavaScript 格式化工具,<style>使用样式格式化工具。

下面是Vetur中默认的格式化工具

{
  "vetur.format.defaultFormatter.html": "prettyhtml",
  "vetur.format.defaultFormatter.css": "prettier",
  "vetur.format.defaultFormatter.postcss": "prettier",
  "vetur.format.defaultFormatter.scss": "prettier",
  "vetur.format.defaultFormatter.less": "prettier",
  "vetur.format.defaultFormatter.stylus": "stylus-supremacy",
  "vetur.format.defaultFormatter.js": "prettier",
  "vetur.format.defaultFormatter.ts": "prettier",
  "vetur.format.defaultFormatter.sass": "sass-formatter"
}

重要的是,这些工具已经集成!!!不需要额外下载了。

  2、Eslint:校验文件格式的标准(上文提到过的,也是我们项目正在使用的规则)

vscode 的 ESLint 插件在某个版本已经移除了 "eslint.validate" 这个配置选项,而网上很多教程都是使用的这个,导致一贴进 vscode 的配置文件,就开始保存和不兼容。

在新版的 ESLint 中已经支持了对 *.vue 文件的校验,所以无需再进行这项配置了,只需要添加一个保存时自动修复 ESLint 错误的功能就行了。

{
  // eslint配置项,保存时自动修复错误
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}

  3、Prettier:和Vetur一样都是格式化工具,但Vetur虽好却只能作用于*.vue文件, *.js *.html文件则可以使用Prettier插件来进行格式化

这里做下简单配置,来让 Prettier 更好的和和 ESLint 配合。在项目的根目录建立  .prettierrc 文件,键入以下代码

{
  "semi": false, // 去除语句结尾的分号 ; 
  "singleQuote": true // 使用单引号 ' 替代双引号 "
}

同时建议在 vscode 的配置文件中加入以下代码:

{
  // 保存时自动格式化代码
  "editor.formatOnSave": true,
  // 默认使用prettier格式化支持的文件
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  // 指定 *.vue 文件的格式化工具为vetur,防止和prettier冲突
  "[vue]": {
    "editor.defaultFormatter": "octref.vetur"
  },
  // 指定 *.js 文件的格式化工具为vscode自带,以符合ESLint规范
  "[javascript]": {
    "editor.defaultFormatter": "vscode.typescript-language-features"
  }
}