vscode vue项目使用 prettier 格式化

Timo来了2024-10-17 19:06

1.vscode 安装Prettier-Code formatter。

（安装完需要重启vscode，不然可能不生效。）

tips：vscode快捷键重启 ctrl+shift+p 出现的输入框中输入Reload Window。

2.1.格式方法一：选择代码使用右键选项格式化

2.2.格式方法二：安装prettier依赖进行命令行格式化

npm install -D prettier

package.json文件中加入

package.json 复制代码

"scripts": {
    ...
    "format": "prettier src/**/*.{js,ts,jsx,tsx,vue} --write"
},

终端中运行

npm run format

2.3.格式方法三：保存代码进行格式化

根目录下新增一个文件（支持多种文件格式，比如.prettierrc.js、.prettierrc.cjs、.prettierrc.json）

.prettierrc.cjs 复制代码

/**
 * prettier 配置文件，详见：https://prettier.io/docs/en/configuration
 * - vscode插件 "Prettier - Code formatter" 会自动识别该文件
 */
module.exports = {
  printWidth: 150, //一行最大字符长度。默认 80
  singleQuote: true, //使用单引号而不是双引号。默认false
  semi: false, //在语句的末尾打印分号。默认 true
  bracketSameLine: false, // 是否在html标签中将 ">" 放在尾行而不是单独起一行。false： 单独一行
  singleAttributePerLine: false, // 是否每个属性单独一行。视情况而定，少的话就一行，多的话就一行一个属性
  /**
   * 行尾风格
   * "lf（默认）"-- 仅换行 ( \n)，常见于 Linux 和 macOS 以及 git repos 内部
   * "crlf"- 回车 + 换行字符 ( \r\n)，常见于 Windows
   * "cr"- 仅回车字符 ( \r)，很少使用
   * "auto"- 保持现有的行尾（一个文件中的混合值通过查看第一行之后使用的内容进行标准化）
   */
  endOfLine: 'auto',
  /** 尾随逗号 */
  trailingComma: 'none'
}

根目录下新建一个.vscode/setting.json文件

.vscode/setting.json 复制代码

{
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "editor.formatOnPaste": true,
  "editor.formatOnSave": true,
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

进行代码编辑后保存自动进行格式化。

tips：如果格式化效果没有生效，可以多次重启vscode。