vue前端代码格式化

这是一封关于前端代码整理、格式化、统一风格的邮件。
 
A. 分支
 
为了更好地整理和规范代码,我们需要做自动格式化,统一代码风格。但无法每个分支单独格式化,因为代码不同格式化之后会导致很多冲突难以merge。
 
为此,需要从功能齐全的 frontend/placelink 分支 (已merge des代码) 新分一个 frontend/ap 分支以代替目前的 frontend/des 分支。ap分支的代码已经格式化好并具有和des分支同样的功能 (屏蔽building和placelink)。
 
des目前只为修紧急bug发版本使用,des新的紧急改动我会手动同步到ap。大家可将非此次验收版本所需的改动push到ap分支,并测试此分支。待验收完毕,ap分支可替换掉des分支,而des分支则设置成禁止push,待之后不再需要再择日删除。
 
B. 格式化
  1. 我们的前端代码格式状态
    未统一风格,未格式化,未使用单引号,对象、函数、if-else、for语句等空格、换行、缩进、不统一,很多代码长度超出屏幕,一屏看不全,可读性差······比如MessageCenter.js:

     

     

  2. 格式化的好处
    风格统一、清晰、直观、优雅,可读性高,一屏看全,有助于协同开发,提高开发效率,合并的时候不会有格式化冲突,有助于追溯历史、迭代开发。
  3. 怎么格式化前端代码?
    1).  VScode(https://code.visualstudio.com/):我们使用VSCode来开发前端代码,不论是更新速度、功能、对于TypeScript的官方支持、Git集成、debug、插件管理等VSCode都支持的很好。

    2). Prettier(https://prettier.io/) 是一款强大的代码格式化插件,可以格式化js,css,html,sass,less,jsx,json等前端代码。下面图片中左边是格式化之前,右边是Prettier格式化之后: 

     

     

  4. 如何使用?
    1). 下载 VSCode https://code.visualstudio.com/docs/?dv=win64user ,默认选项安装后打开VSCode,然后选择"Open Folder"打开项目根目录

     

     

    or 
    2).  然后VSCode的右下角会弹出推荐插件提示,选择"Show Recommendations" (也可以直接点安装全部"Install All")
    3).  来到VSCode的插件面板,展示了几个推荐的插件,安装 "Prettier - Code formatter"(格式化)和 "vscode-icons"(文件图标):

    4). 待安装完成;随便打开一个JS文件,故意破坏代码格式化:

    然后
    a. 按 Ctrl + S 保存(会自动格式化);
    b. 或者按 Alt + Shift + F 手动触发格式化;
    c. 或者Ctrl + Shift + P调出快捷命令框后输入format,选Format Document ;
    即可格式化代码:
注意:目前保存时自动格式化1万多行的大js文件仍有问题,有时候不能触发,需要执行上面的 b. 和 c. 手动触发。

 

posted @ 2022-01-12 11:33  cbinqin  阅读(1323)  评论(0编辑  收藏  举报