vscode编辑器vue项目格式化代码

本文介绍如何在Vue项目中使用VSCode配置ESLint和Prettier,实现代码的自动格式化,包括设置保存时自动格式化、ESLint自动修复等功能,提升团队代码规范性和一致性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

使用Vue开发项目的时候,开启ESlint校验后有各种头疼的报错,即便与同事约定好了一些代码编写规范,偶尔也会有一些遗漏的时候,不过可以通过一些扩展插件来自动格式化代码,来避免一些低级bug的产生。

总体分三步:

  • 第一步:
    依次下载以下三个扩展插件,当然如果开发vue项目其他两个也是很有必要的。
    在这里插入图片描述

  • 第二步:
    打开编辑器中用户设置的settings.json文件,在后面添加如下关于格式化格则的代码

      // #让函数(名)和后面的括号之间加个空格
      "javascript.format.insertSpaceBeforeFunctionParenthesis": false,
      "explorer.confirmDragAndDrop": false,
      "javascript.preferences.quoteStyle": "single",
      "typescript.preferences.quoteStyle": "single",
      // tab 大小为2个空格
      "editor.tabSize": 2,
      // 100 列后换行
      "editor.wordWrapColumn": 100,
      // 保存时格式化
      "editor.formatOnSave": true,
      // 开启 vscode 文件路径导航
      "breadcrumbs.enabled": true,
      // prettier 设置语句末尾不加分号
      "prettier.semi": false,
      // prettier 设置强制单引号
      "prettier.singleQuote": true,
      // 注释后面加空格
      "prettier.eslintIntegration": true,
      // 选择 vue 文件中 template 的格式化工具
      "vetur.format.defaultFormatter.html": "prettyhtml",
      // 显示 markdown 中英文切换时产生的特殊字符
      "editor.renderControlCharacters": true,
      // 设置 eslint 保存时自动修复
      "eslint.autoFixOnSave": true,
      // eslint 检测文件类型
      "eslint.validate": [
        "javascript",
        "javascriptreact",
        {
          "language": "html",
          "autoFix": true
        },
        {
          "language": "vue",
          "autoFix": true
        }
      ],
      // vetur 的自定义设置
      "vetur.format.defaultFormatterOptions": {
        "prettier": {
          "singleQuote": true,
          "semi": false
        }
      }
    
  • 第三步:
    如果不出意外,以上两步是可以完成保存时自动格式化代码的功能,不过有些同学可能不太习惯函数圆括号之前没有空格,那就把第二步中的"javascript.format.insertSpaceBeforeFunctionParenthesis": false,删除掉就好了。喜欢的同学只需要关闭Eslint关于函数括号的错误提示就好了。比如在.eslintrc.js中添加如下代码:

    // allow async-await
    'generator-star-spacing': 'off',
    // 函数圆括号之前没有一个空格
    "space-before-function-paren": ["error", "never"]
    

    在这里插入图片描述
    over

### 如何配置 VSCodeVue3 项目进行代码格式化 #### 安装必要的扩展 为了确保 `.vue` 文件能够被正确格式化,在 Visual Studio Code (VSCode) 中应安装两个主要的扩展:Prettier - Code formatter 和官方支持的 Vue 扩展[^1]。 ```bash # 使用命令行安装扩展(需配合 Extensions Manager 或者通过市场页面) ext install esbenp.prettier-vscode ext install octref.vetur ``` #### 设置 Prettier 配置文件 当在命令行中执行 Prettier 进行格式化操作时,工具会在项目的根目录下寻找名为 `.prettierrc` 的配置文件;若未能定位该文件,则采用内置默认设置来处理文档样式问题[^2]。因此建议创建此配置文件并依据团队编码风格指南调整相应参数: ```json // ./.prettierrc { "semi": true, "singleQuote": false, "trailingComma": "es5" } ``` #### 处理 Vetur 插件冲突 对于已经安装了 Vetur 插件却仍遇到 `Shift+Alt+F` 不起作用的情况,可能是因为 Vetur 默认并未启用 HTML 格式化功能所致。此时可以通过修改编辑器全局或工作区级别的设置解决这一问题[^3]: 进入 **文件 -> 首选项 -> 设置**, 搜索关键字 `vetur.format.defaultFormatter.html`, 修改其值为 `"js-beautify-html"`: ```javascript "vetur.format.defaultFormatterOptions": { "js-beautify-html": { "wrap_attributes": "force-aligned" } }, "vetur.format.defaultFormatters": { "html": "js-beautify-html", "css": "prettier", "postcss": "prettier", "scss": "prettier", "less": "prettier", "typescript": "prettier", "javascript": "prettier", "vue": "prettier" } ``` 完成上述步骤之后保存更改,重新尝试使用快捷键组合触发自动格式化功能即可正常运作。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值