如何使用Prettier管理好代码一致性

Prettier

介绍

​ 在写这篇文章的时候，也正是因为自己遇到接触不同的项目，不同的人写的代码风格也是千奇百怪，(无奈.gif)，之前就知道这个插件可以配合ESLint 一起使用，最近需求刚结束，空下来，查询资料使用下这个插件来提升自己写代码的可读性，高效性，舒适性。

正题

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.

意思是：Prettier是一种固执己见的代码格式化程序。它通过解析代码并使用自己的规则(考虑到最大行的长度)重新打印代码，以及在必要时包装代码，从而实现一致的风格。（来源有道翻译 哈哈哈）

简单的说：就是用 设定好的代码规则 格式化代码的插件

如何使用

我用的的VSCode编辑器，所以只描述这个编辑器怎么配置

• 安装Perttier插件，在扩展应用商店直接搜索即可
• 在你的项目下新建一个.prettierrc文件，这个文件就是配置代码规则的地方

   {
      "singleQuote": true,
      "trailingComma": "es5",
      "printWidth": 140,
      "overrides": [
        {
          "files": ".prettierrc",
          "options": { "parser": "json" }
        }
      ]
    }
    -----------------------以下内容为参考项--------------------------------------
    "prettier.printWidth": 100, // 超过最大值换行
    "prettier.tabWidth": 4, // 缩进字节数
    "prettier.useTabs": false, // 缩进不使用tab，使用空格
    "prettier.semi": true, // 句尾添加分号
    "prettier.singleQuote": true, // 使用单引号代替双引号
    "prettier.proseWrap": "preserve", // 默认值。因为使用了一些折行敏感型的渲染器（如GitHub comment）而按照markdown文本样式进行折行
    "prettier.arrowParens": "avoid", //  (x) => {} 箭头函数参数只有一个时是否要有小括号。avoid：省略括号
    "prettier.bracketSpacing": true, // 在对象，数组括号与文字之间加空格 "{ foo: bar }"
    "prettier.disableLanguages": ["vue"], // 不格式化vue文件，vue文件的格式化单独设置
    "prettier.endOfLine": "auto", // 结尾是 \n \r \n\r auto
    "prettier.eslintIntegration": false, //不让prettier使用eslint的代码格式进行校验
    "prettier.htmlWhitespaceSensitivity": "ignore",
    "prettier.ignorePath": ".prettierignore", // 不使用prettier格式化的文件填写在项目的.prettierignore文件中
    "prettier.jsxBracketSameLine": false, // 在jsx中把'>' 是否单独放一行
    "prettier.jsxSingleQuote": false, // 在jsx中使用单引号代替双引号
    "prettier.parser": "babylon", // 格式化的解析器，默认是babylon
    "prettier.requireConfig": false, // Require a 'prettierconfig' to format prettier
    "prettier.stylelintIntegration": false, //不让prettier使用stylelint的代码格式进行校验
    "prettier.trailingComma": "es5", // 在对象或数组最后一个元素后面是否加逗号（在ES5中加尾逗号）
    "prettier.tslintIntegration": false // 不让prettier使用tslint的代码格式进行校验
	 // 详细配置资料，自己查询一下

• 配置完成后，那么这个项目下，你只需要使用alt+shift+f就可以按照预先设定好的规则一键修正，非常酸爽！！！哈哈哈 快去体验吧

• 如果对于每次都需要按一下组合键才能更新代码不满意的话，那么还有大招，那就是 保存时，就可以格式化啦，设置如下

  • 打开你 VSCode 的系统settins.json设置文件，打开方式：ctrl + shift + P，搜索 open settings(json) 在列表中选则这一项，添加如下参数

  "editor.formatOnSave": true,
  

  • 如果同时设置了"files.autoSave": "autoSaveDelay",保存及格式化会失效。files.autoSave配置成别的选项即可。