项目中统一换行符CRLF/LF还需增加的git配置

最新推荐文章于 2025-02-22 13:30:29 发布

原创最新推荐文章于 2025-02-22 13:30:29 发布 · 2.9k 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#git

git 专栏收录该内容

1 篇文章

订阅专栏

项目合作开发时，统一换行符是关键，尤其在Windows与Unix系统间。Git默认行为可能导致换行符转换问题，影响代码一致性。通过.gitattributes文件针对特定文件类型配置换行符，避免破坏非代码文件，实现更精确的跨平台兼容。

背景

我们在合作开发中，对于 git 的配置往往是只有 .git 文件夹，或者再多一个 .gitignore 文件，常常忽略了一个非常重要的内容：换行符。

换行符是个很重要的东西，特别是当你的项目或者团队使用了不同的操作系统时，这个时候统一换行符是非常必要的东西。常见的换行符有以 Windows 为代表的 CRLF 和以 Unix 系列的 LF，具体含义可以自行搜索。

场景

也许我们在项目中配置了 editorconfig 的换行符，编辑器的换行符，eslint 等代码检查工具的换行符等等设置，但是当执行 git pull, stash 等操作，换行符都还是会自动变成“系统默认”。

于是使用 Mac 的同事拉了 Windows 同事刚上传的代码，到自己本地后换行符全都变了样，可能导致显示出错或者代码报错，甚至某些格式的文件（如图片、可执行文件）会被破坏！

原因

git 为了解决不同平台换行符不一致的问题，在 windows 操作系统中默认在检出代码时将 LF 转换为 CRLF,而在提交的时候再转换为 LF，但是看似完美的解决方案在中文环境中却失效了，导致原先的代码用的 LF 都会被转成 CRLF。

解决方法

全局修改：

# 统一换行符为 lf
git config --global core.eol lf
# 将自动转换关闭,避免转换失败不能不同进行提交
git config --global core.autocrlf false
# 禁止混用 lf 和 crlf 两种换行符
git config --global core.safecrlf true

但这是全局的修改，难免其他项目的规范不一样。更好的方式是在项目根目录下放 .gitattributes：

项目配置 gitattributes：

* text eol=lf

存在的问题

以上两个方法有个致命的问题，就是对所有文件都进行了LF的换行处理。这意味着，不仅你的代码，连你的图片、office 文档、可执行文件等等文件格式，文件内容都有可能被强制破坏。（这个大家实验一下就会发现）。

因此，我们不应该进行全局的修改，也不应该在项目配置中对所有文件都进行统一换行符，而是进行针对性的按需配置，例如：

*.html text eol=lf
*.css text eol=lf
*.js text eol=lf