美文网首页
VSCode里统一项目代码规范

VSCode里统一项目代码规范

作者: 衡成飞 | 来源:发表于2021-11-10 11:01 被阅读0次

背景

俗话说,工欲善其事,必先利其器,使用一些优秀的工具,能起到事半功倍的效果。
在开发团队中,每个人的编码风格都不一样,如何让代码看上去规范统一,像出自一人之手呢?


准备

VSCode安装如下插件

  • Vetur
  • ESClient
  • Prettier
  1. 安装方式1
    VSCode的插件市场里搜索相关插件,安装即可使用

    prettier插件
  2. 安装方式2
    通过命令行,局部安装npm install eslint或全局安装 npm install -g eslint


配置

  • 保存时自动格式化配置
    • Ctrl+Shift+P


      Settings.json
    • 直接修改settings.json添加一条记录,或通过UI界面修改
      "editor.formatOnSave": true
UI界面修改配置图
  • 格式化配置
    1. 新建.prettierrc.js文件,放置在project根目录


      .prettierrc.js
      module.exports = {
         printWidth: 120, // 每行代码最大长度
         tabWidth: 4, //一个tab代表几个空格数,默认为80
         useTabs: false, //是否使用tab进行缩进,默认为false,表示用空格进行缩减
         semi: true, // 声明后带分号
         singleQuote: false, // 使用单引号
         jsxSingleQuote: true, // 使用单引号
         jsxBracketSameLine: true, // 启用jsx语法,> 放在末尾
         trailingComma: 'all',
      };
      
    2. 修改vue等类型文件的默认format方式


      vue.png
      "[vue]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
      },
      "[html]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
      },
      "[javascript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
      },
      "[typescript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
      },
      

效果

screen.gif

相关文章

  • VSCode里统一项目代码规范

    背景 俗话说,工欲善其事,必先利其器,使用一些优秀的工具,能起到事半功倍的效果。在开发团队中,每个人的编码风格都不...

  • 记一次在 VSCode 中解决「扩展 ESLint 无法格式化

    最近在带队写一个前端项目。为了统一项目组的规范,我用了 VSCode + ESLint 插件来自动格式化代码,但是...

  • Go语言编码规范

    本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一...

  • git commit规范

    git commit规范 git-commit规范 在多人协作项目中,如果代码风格统一、代码提交信息的说明准确,那...

  • vscode和webstorm中如何显示隐藏的tab和空格

    近期由于老项目之前代码规范没有统一,导致代码的缩进是用tab 还是 空格键没有一个统一的规范!但是在代码提交合并的...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

  • MMC代码规范与代码格式化统一配置安装

    暖流静态代码规范与代码格式化统一配置安装 概述 我们项目组人员已达一定规模,统一代码规范与风格是非常有帮助的。十分...

  • VS Code 扩展巡礼- phpcs

    本篇文章中介绍的扩展是 vscode-phpcs,用于项目开发中 PHP 代码的编码规范。 Github 库地址 ...

  • vscode使用 typeScript 和格式化文档技巧

    vue-cli构建的项目默认启用ESLint进行代码检测,凡是不符合它规范的就会报错,但是vscode代码格式化中...

  • 系统重构的一点思考

    系统重构目的 统一规范 统一代码格式化,开发规范,rpc规范,日志规范,sql规范,mybatis提示插件,lom...

网友评论

      本文标题:VSCode里统一项目代码规范

      本文链接:https://www.haomeiwen.com/subject/mpmbzltx.html