在 vscode 中,通过安装 prettier 插件,可以格式化代码,保证团队代码风格保持一致,不至于代码经过其他人编辑并通过不一样的格式化方式格式化以后,git历史记录全部被覆盖的问题。
但是如果依赖 prettier 插件默认的格式,如果有人修改后,还是会和团队风格不一致,因此,需要将 prettier 的配置项,同代码一起保存,这样所有人的 prettier 项都会保存一致。
保存代码时,自动进行代码格式化
在 目录 .vscode - > settings.json
文件内,增加配置项,开启保存代码时,自动格式化
editor.formatOnSave": true,
命令行全局代码格式化
通过 npm 安装 prettier
npm install prettier -D
package.json添加命令行
{
script:{
...
"lint:fotmet": "prettier --write --loglevel warn \"src/**/*.{js,ts,json,tsx,css,less,vue,html,md}\""
...
}
}
以后执行 npm run lint:format
即可全局格式化代码
问题
在使用过程中,遇到一个问题,在项目根目录下添加 prettier.config.js
文件,搭配 vscode 的 prettier 插件一起使用。但是在修改 config 文件后,prettier 插件还是使用上次的配置。
解决办法:重启 vscode
prettier.config.js
内容
/** 配置项文档:https://prettier.io/docs/en/configuration.html */
module.exports = {
/** 每一行的宽度 */
printWidth: 80,
/** tab 健的空格数 */
tabWidth: 2,
/** 在对象中的括号之间用空格来间隔 */
bracketSpacing: true,
/** 箭头函数的参数无论有几个,都要括号包裹 */
arrowParens: "always",
/** 换行符的使用 */
endOfLine: "auto",
/** 是否采用单引号 */
singleQuote: false,
/** 对象或者数组的最后一个元素后面不要加逗号 */
trailingComma: "none",
/** 不加分号 */
semi: false,
/** 不使用 tab 格式化 */
useTabs: false
}