一、不同系统的换行符
对于不同的操作系统,换行符的表示是不一样的。也就是说,当我们在不同系统操作,在键盘按下回车键换行的时候,保存进入文件的换行符是不一样的,如下所示:
CR:表示回车\r(Mac OS系统)
LF: 表示换行\n (Mac OS X系统、Linux/Unix系统)
CRLF:表示回车换行\r\n (Windows系统)
对于不同的系统,换行符有不同的表现形式,这就很容易引发问题。
**情形一:**代码开发者在不同的系统都编辑过同一份代码且来回传输过
**情形二:**多人协作开发一个项目,使用git进行源码管理来协作开发。比如,A使用Mac来写代码,此时换行符保存的是LF,上传至git;而B时使用windows,他需要从git上拉取A的代码进行改造,此时就会出现换行符不统一的问题。
二、换行符不一致的解决方案
1、编辑器
对于不同系统的换行符时不一样的,但各个编辑器是可以设置回车键后所要保存的换行符是哪一个的。
比如:vscode
单个文件修改:如下图所示,点击编辑器右下角的LF/CRLF,然后选择对应的换行符,再编辑下对应的文件,保存后,换行符修改就会生效。
全局修改:进入文件-首选项-设置,选择用户-文本编辑器-文件,找到Eol,然后设置到对应的换行符即可。
注意:
之前踩过一个大坑,所在的团队其他人是使用Mac,而有段时间在家办公是使用window进行开发的,就出现了换行符不一致的这个问题。
团队规定要强制使用一致的换行风格的,不允许修改.eslintrc文件里rules的对象linebreak-style,只能去修改文件的换行符号。
这时候只修改单独文件,执行eslint还是会被还原回去,根本是无效的。就开始去设置全局的换行符,还是不生效,百思不得其解,最后把所写的换行符不一致的代码重新建文件替代,此时才解决问题。
由此可以得出结论:编辑器的全局设置的换行符对于之前的文件是不生效的。
2、git
**windows:**默认在提交时把换行符CRLF转换为LF,在拉取代码时将LF转换为CRLF。(git安装时,没有额外设置的,默认使用这个方案)
**Linux/Unix和Mac OS和Mac OS X:**默认在提交时将CRLF转换为LF,在拉取时不进行转换。(git安装时,没有额外设置的,默认使用这个方案)
全局配置
// 提交时转换为LF,检出时转换为CRLF(一般设置这个)
git config --global core.autocrlf true
// 提交时转换为LF,检出时不转换
git config --global core.autocrlf input
// 提交检出均不转换
git config --global core.autocrlf false
// 拒绝提交包含混合换行符的文件
git config --global core.safecrlf true
// 允许提交包含混合换行符的文件
git config --global core.safecrlf false
// 提交包含混合换行符的文件时给出警告
git config --global core.safecrlf warn
单一仓库设置(.gitattributes)
gitattributes是针对一个单一的仓库的,也就是说每一个代码仓库都可以包含一个.gitattributes文件。这种方式设置之后,不需要一个项目组里面的同事分别再去修改自己电脑的git的全局配置。
1、text=auto:
采用git认为最好的方式来处理文件,未在.gitattributes中设置的项默认按照这种方式处理。
git发现是文本文件,那么在checkin的时候,会将文件结尾符转换为LF。
如果文件已经被已CRLF的形式提交(就是说已经在Gti仓库中的文件,如果结束符是CRLF,不会有任何的转换),不会有任何转换。
2、-text
表示让git在checkin以及checkout的时候,对end-of-line不做任何转换。
3、text
表示在checkin的时候会被转换为LF(在repository中的文件结束符是LF),如果需要控制在checkout的时候的换行符,需要结合eol进行设置(也就是控制working tree中的文件的结尾符,需要通过eol设置)。
4、text=auto和text的区别
text=auto由git来确定是不是文本文件,从而进行转换;
而text表示,你确定这个path就是文本文件,会直接对这个path进行转换,而不是有git来决定是否转换。
5、没有指定text
git会使用全局配置中的core.autocrlf来进行eol的转换。core.autocrlf需要自己在自己的电脑上进行配置。
6、eol=crlf
对左边匹配的文件统一使用CRLF换行符格式,如果有文件中出现LF将会转换成CRLF;也就是说,在checkin和checkout的时候,文件中都是CRLF,LF会被转换为CRLF。
7、eol=lf
对左边匹配的文件统一使用LF换行符格式,如果有文件中出现CRLF将会转换成LF;也就是说,在checkin和checkout的时候,文件中都是LF,CRLF会被转换为LF。
8、binary
告诉git该文件为二进制,防止git修改该文件。git不会对对其中的换行符进行改变。
注意:.gitattributes文件必须要提交之后才能生效。
|