Formatter 规范

目标

统一代码风格统一代码风格，避免合并时出现大量格式化变更

统一换行配置

统一IDE格式

建议使用visual studio code作为IDE工具，有丰富的插件，并支持各种主流开发语言。

本地环境配置统一换行符

Window 环境本地环境配置

配置：

git config --global core.autocrlf true

行为：

操作	转换规则
提交时	CRLF → LF（自动转换）
检出时	LF → CRLF（自动转换）

流程图：

工作区（Windows）         Git 仓库           工作区（Windows）
    CRLF          →         LF          →        CRLF
  (本地文件)      提交      (仓库)       检出    (本地文件)

适用场景：

• ✅ Windows 开发者
• ✅ 使用 Windows 原生工具（记事本、cmd）
• ✅ 需要保持 Windows 换行符习惯

Linux/Mac 环境本地环境配置

配置：

git config --global core.autocrlf input

行为：

操作	转换规则
提交时	CRLF → LF（自动转换）
检出时	不转换（保持 LF）

流程图：

工作区（Linux）          Git 仓库           工作区（Linux）
    LF/CRLF       →         LF          →        LF
  (本地文件)      提交      (仓库)       检出    (本地文件)

适用场景：

• ✅ Linux/Mac 开发者
• ✅ 服务器环境开发
• ✅ 需要确保仓库中只有 LF

代码仓库配置

在代码仓库中添加文件.gitattributes，内容如下：

* text=auto
*.php text eol=lf
*.js text eol=lf
*.css text eol=lf
*.html text eol=lf
*.md text eol=lf

统一IDE格式

建议使用visual studio code作为IDE工具，有丰富的插件，并支持各种主流开发语言。

通用文件统一格式化插件

Shell 文件文件插件

使用如下插件

Ts/Js 文件文件插件

使用如下插件

Python 文件文件插件

使用如下插件

PHP 文件

使用如下插件

Proto 文件文件插件