团队项目开发:VScode使用Prettier格式化代码

69 阅读2分钟

一、安装Prettier插件

在扩展商店中搜索 Prettier 并安装

安装插件.png

二、指定 Prettier 插件的配置路径

setting.png

设置配置路径.png

三、在项目根目录配置 .prettierrc 配置文件

文件具体配置,可根据项目所需进行选取

{
  "printWidth": 80, // 指定行的最大长度
  "tabWidth": 2, // 指定缩进的空格数
  "useTabs": false, // 是否使用制表符进行缩进,默认为 false
  "singleQuote": true, // 是否使用单引号,默认为 false
  "quoteProps": "as-needed", // 对象属性是否使用引号,默认为 "as-needed"
  "trailingComma": "none", // 是否使用尾随逗号(末尾的逗号),可以是 "none""es5""all" 三个选项
  "bracketSpacing": true, // 对象字面量中的括号是否有空格,默认为 true
  "jsxBracketSameLine": false, // JSX 标签的右括号是否与前一行的末尾对齐,默认为 false
  "arrowParens": "always", // 箭头函数参数是否使用圆括号,默认为 "always"
  "rangeStart": 0, // 指定格式化的范围的起始位置
  "rangeEnd": Infinity, // 指定格式化的范围的结束位置
  "requirePragma": false, // 是否需要在文件顶部添加特殊的注释才能进行格式化,默认为 false
  "insertPragma": false, // 是否在格式化后的文件顶部插入特殊的注释,默认为 false
  "proseWrap": "preserve", // 是否保留 markdown 文件中的换行符,默认为 "preserve"
  "htmlWhitespaceSensitivity": "css", // 指定 HTML 文件中空格敏感度的配置选项,可以是 "css""strict" 两个选项
  "vueIndentScriptAndStyle": false, // 是否缩进 Vue 文件中的 <script> 和 <style> 标签,默认为 false
  "endOfLine": "auto", // 指定换行符的风格,可以是 "auto""lf""crlf""cr" 四个选项
  "semi": true, // 行末是否添加分号,默认为 true
  "usePrettierrc": true, // 是否使用项目根目录下的 .prettierrc 文件,默认为 true
  "overrides": [ // 针对特定文件或文件类型的格式化配置
    {
      "files": "*.json", // 匹配的文件或文件类型
      "options": {
        "tabWidth": 4 // 针对该文件类型的配置选项
      }
    },
    {
      "files": "*.md",
      "options": {
        "printWidth": 100
      }
    }
  ]
}

四、设置 Prettier 为默认格式化程序

  1. 打开vscode设置

default1.png

  1. 搜索 Default Formatter,选择 Prettier 为默认格式化程序

default2.png

五、设置代码保存时自动格式化

在vscode设置中搜索 Format On Save,打对勾选中,在保存时进行格式化

auto.png