vs code 代码保存自动格式化

本文介绍如何在VSCode中配置Prettier插件,实现代码格式化及ESLint集成,特别针对Vue项目的自动格式化需求进行了详细说明。

vs code安装插件Prettier - Code formatter

在这里插入图片描述

配置settings.json文件

设置->命令面板->输入settings,打开setting.json文件
在这里插入图片描述
在这里插入图片描述

文件粘贴代码,根据自己需要可在文件中增加或修改

{
  // vscode默认启用了根据文件类型自动设置tabsize的选项
  "editor.detectIndentation": false,
  // 重新设定tabsize
  "editor.tabSize": 2,
  // #每次保存的时候自动格式化
  "editor.formatOnSave": true,
  // #每次保存的时候将代码按eslint格式进行修复
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  // 添加 vue 支持
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "vue",
    "typescript",
    "typescriptreact"
  ],
  // //  #让prettier使用eslint的代码格式进行校验
  // "prettier.eslintIntegration": true,
  // //  #去掉代码结尾的分号
  // "prettier.semi": false,
  // //  #使用带引号替代双引号
  // "prettier.singleQuote": false,
  //  #让函数(名)和后面的括号之间加个空格
  "javascript.format.insertSpaceBeforeFunctionParenthesis": true,
  // #让vue中的js按编辑器自带的ts格式进行格式化
  "vetur.format.defaultFormatter.js": "vscode-typescript",
  "vetur.format.defaultFormatterOptions": {
    "js-beautify-html": {
      "wrap_attributes": "force-aligned"
      // #vue组件中html代码格式化样式
    }
  },
  "window.zoomLevel": 0,
  "explorer.confirmDelete": false,
  "explorer.confirmDragAndDrop": false,
  "editor.renderControlCharacters": true,
  "editor.renderWhitespace": "all",
  "eslint.migration.2_x": "off",
  "[json]": {
    "editor.defaultFormatter": "vscode.json-language-features"
  },
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "eslint.codeAction.showDocumentation": {
  
    "enable": true
  },
  "files.eol": "\n",
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "stylusSupremacy.insertColons": false,
  "stylusSupremacy.insertSemicolons": false,
  "stylusSupremacy.insertBraces": false,
}

这样vue项目中即可保存自动格式化了(创建的vue项目需要选择,)

创建vue cli项目

vue create name
然后选择自定义
在这里插入图片描述
然后选择需要的插件(在要选中前面按空格键即可选中,全部选完之后按enter即可)
在这里插入图片描述
然后按照自己需要选择,这里用道德保存格式化需要选择prettier
![在这里插入图片描述](https://img-blog.csdnimg.cn/20210314224718412.png
打开项目之后可以在标签后随便打几个空格保存测试一下

<think>嗯,用户问的是VS Code保存时自动格式化文档的方法。我需要先回忆一下相关的设置步骤。首先,VS Code有内置的格式化功能,但要实现保存自动格式化,可能需要调整设置。 首先,用户需要安装相应的格式化插件,比如Prettier或者语言特定的工具。然后,在设置里开启“Format On Save”选项。这部分我记得是在设置里搜索“format on save”,然后勾选复选框。不过要确认用户是否已经安装了必要的插件,否则可能无法生效。 接下来,可能会遇到不同语言需要不同格式化工具的情况,这时候可能需要配置默认的格式化器。例如,对于JavaScript,可以选择Prettier作为默认,而Python可能需要用autopepp或者black。用户可能需要手动选择每个语言的格式化器,或者在settings.json里进行配置。 还有可能用户会遇到格式化失败的情况,这时候需要检查是否有多个格式化器冲突,或者插件未正确安装。此外,文件是否被正确识别为某种语言模式,比如.js文件被识别为JavaScript,这样对应的格式化器才会生效。 另外,VS Code的配置文件分为用户级别和工作区级别,用户可能需要根据具体情况调整。有些项目可能有自己的格式化配置,比如.editorconfig或者.prettierrc,这些也会影响保存时格式化行为。 可能还需要提醒用户注意,某些格式化规则可能与项目原有的代码风格不一致,需要根据团队规范进行调整,或者自定义格式化选项。比如Prettier允许在配置文件中设置单引号、分号等选项。 最后,常见的错误可能包括未安装插件、设置未正确启用、文件类型未识别等,可以建议用户检查这些方面,并提供查看输出面板的方法,以便调试格式化过程中的错误信息。</think>在 VS Code 中实现「保存时自动格式化文档」的功能可通过以下步骤配置: ### 一、基础配置 1. **启用自动格式化** - 按 `Ctrl+,` 打开设置 - 搜索 `Format On Save` - 勾选 `Editor: Format On Save` 复选框 2. **设置默认格式化工具** - 按 `Ctrl+Shift+P` 打开命令面板 - 输入 `Format Document With` - 选择语言后指定默认格式化器(如 Prettier/ESLint/clang-format 等) ### 二、进阶配置(按需调整) ```json // settings.json 示例 { "editor.formatOnSave": true, "editor.defaultFormatter": "esbenp.prettier-vscode", "[javascript]": { "editor.defaultFormatter": "vscode.typescript-language-features" } } ``` ### 三、常见问题排查 1. **未生效可能原因** - 未安装对应语言格式化插件 - 文件未被正确识别语言模式(检查右下角状态栏语言标识) - 存在多个格式化器冲突(右键选择「配置默认格式化程序」) 2. **强制格式化命令** - 手动触发格式化:`Shift+Alt+F`(Windows)或 `Shift+Option+F`(Mac) - 查看格式化错误:`Ctrl+Shift+U` 打开输出面板 ### 四、语言特定配置示例 | 语言 | 推荐插件 | 配置文件 | |------------|-------------------------|----------------------| | JavaScript | Prettier | .prettierrc | | Python | Python Extension Pack | .pylintrc | | C/C++ | C/C++ Extension Pack | .clang-format | | Java | Language Support for Java | eclipse-formatter.xml | ### 五、个性化规则设置 通过项目根目录添加配置文件: ```javascript // .prettierrc 示例 { "semi": false, "singleQuote": true, "tabWidth": 2 } ``` > **注意**:企业级项目建议与团队代码规范同步配置,可通过版本控制共享 `.vscode/settings.json` 文件统一团队格式标准。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值