VSCode下Prettier - Code formatter插件的设置

本文详细介绍如何在VSCode中配置前端开发环境,包括安装关键扩展如ESLint、Prettier和Vetur,以及如何调整settings.json文件以优化代码格式和编辑体验。适合初学者快速上手。

一、安装vscode扩展程序

ESLint

Prettier - Code formatter

Vetur

二、打开settings文件

快捷键:

    mac:Command + ,

    Windows:Ctrl + ,

此时打开settings视图界面,点击右上角图标(鼠标悬上去显示“Open Settings(UI)”字样),打开settings.json文件(本人Windows环境)

三、添加配置信息到settings.json文件中

  // tab 大小为2个空格

  "editor.tabSize": 2,

  // 100 列后换行

  "editor.wordWrapColumn": 100,

  // 保存时格式化

  "editor.formatOnSave": true,

  // 开启 vscode 文件路径导航

  "breadcrumbs.enabled": true,

  // prettier 设置强制单引号

  "prettier.singleQuote": true,

  // prettier 设置语句末尾加分号

  "prettier.semi": false,

  // 选择 vue 文件中 template 的格式化工具

  "vetur.format.defaultFormatter.html": "prettyhtml",

  // 显示 markdown 中英文切换时产生的特殊字符

  "editor.renderControlCharacters": true,

  // 让函数(名)和后面的括号之间加个空格

  "javascript.format.insertSpaceBeforeFunctionParenthesis": true,

  // 让vue中的js按编辑器自带的ts格式进行格式化

  "vetur.format.defaultFormatter.js": "vscode-typescript",

  // vetur 的自定义设置

  "vetur.format.defaultFormatterOptions": {

    "prettier": {

      "singleQuote": true,

      "semi": false

    }

  },

  // Ctrl + Shift + F 快捷键设置(依照vetur格式化代码)

  "[vue]": {

    "editor.defaultFormatter": "octref.vetur"

  }

`Prettier - Code formatter` 是 VSCode 中非常流行的一个插件,用于自动格式化多种前端和后端语言的代码(如 JavaScript、TypeScript、HTML、CSS、JSON、Vue、React 等)。它支持自定义配置文件,并且可以与 Git、ESLint 等工具集成。 --- ## ✅ 一、安装 Prettier 插件 ### 步骤: 1. 打开 VSCode 2. 点击左侧活动栏的扩展图标(或使用快捷键 `Ctrl+Shift+X`) 3. 搜索 `Prettier - Code formatter` 4. 找到由 **Prettier - Prettier** 官方发布的插件 5. 点击 `Install` --- ## ✅ 二、基本使用方法 ### 1. **格式化当前文件** - 右键点击代码编辑器 -> `Format Document With...` -> 选择 `Prettier` 作为默认格式化器 - 或者使用快捷键: - Windows / Linux: `Shift + Alt + F` - macOS: `Shift + Option + F` ### 2. **保存时自动格式化** 打开 VSCode 设置(`Ctrl + ,`),搜索 `format on save`,勾选 `Editor: Format On Save`,或者在 `settings.json` 中添加: ```json { "editor.formatOnSave": true, "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, "[typescript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, "[html]": { "editor.defaultFormatter": "esbenp.prettier-vscode" } } ``` --- ## ✅ 三、配置 Prettier ### 1. 创建 `.prettierrc` 配置文件(项目根目录) ```json { "printWidth": 80, "tabWidth": 4, "useTabs": false, "semi": true, "singleQuote": true, "trailingComma": "es5", "bracketSpacing": true, "arrowParens": "always", "endOfLine": "auto" } ``` ### 常用配置项说明: | 配置项 | 含义 | |--------|------| | `printWidth` | 每行最大字符数 | | `tabWidth` | 缩进空格数 | | `useTabs` | 是否使用 Tab 缩进 | | `semi` | 是否在语句末尾添加分号 | | `singleQuote` | 是否使用单引号 | | `trailingComma` | 多行时在末尾添加逗号(es5 / none / all) | | `bracketSpacing` | 对象括号之间是否加空格 `{ foo: bar }` | | `arrowParens` | 箭头函数参数是否始终用括号包裹 | | `endOfLine` | 换行符类型(auto / lf / crlf / none) | --- ### 2. 创建 `.prettierignore` 文件(忽略格式化) 你可以在项目根目录创建 `.prettierignore` 文件来指定不希望被格式化的文件: ``` # .prettierignore /dist /build /*.min.js ``` --- ## ✅ 四、命令行使用 Prettier(可选) 你可以全局安装 Prettier 并使用命令行格式化文件: ```bash npm install --global prettier ``` 格式化单个文件: ```bash prettier --write src/index.js ``` 格式化整个目录: ```bash prettier --write src/**/*.js ``` --- ## ✅ 五、与 ESLint 集成(推荐) 如果你的项目使用 ESLint,可以安装 `eslint-config-prettier` 来禁用 ESLint 中与 Prettier 冲突的规则。 ### 安装: ```bash npm install --save-dev eslint-config-prettier eslint-plugin-prettier ``` ### 配置 `.eslintrc.js`: ```js module.exports = { extends: ['eslint:recommended', 'plugin:react/recommended', 'prettier'], }; ``` --- ## ✅ 总结:推荐设置 | 功能 | 设置方法 | |------|----------| | 自动格式化保存 | `editor.formatOnSave = true` | | 设置默认格式化器 | `editor.defaultFormatter = "esbenp.prettier-vscode"` | | 自定义格式规则 | `.prettierrc` | | 忽略格式化文件 | `.prettierignore` | | 与 ESLint 集成 | `eslint-plugin-prettier` | | 支持的语言 | JavaScript、TypeScript、HTML、CSS、Vue、React、JSON、Markdown 等 | ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值