1. 从“Delete ␍”说起:一个让开发者头疼的小符号
不知道你有没有遇到过这种情况:在VSCode里写代码,用Prettier格式化的时候,突然在问题面板或者终端里蹦出来一个“Delete ␍ prettier/prettier”的警告或错误。这个“␍”符号看起来有点陌生,但错误信息却很明确——它让你删除这个“␍”。我第一次遇到时也是一头雾水,心想这到底是什么玩意儿?后来才明白,这其实是换行符不一致引发的一场“内战”,而Prettier作为代码格式的“纪律委员”,正在严格执行它的标准。
简单来说,这个错误的根源在于你的代码文件里,混用了两种不同的“换行”表示方法。在计算机的世界里,换行这个看似简单的操作,在不同操作系统中有着不同的“方言”。Windows系统习惯用一对组合拳“\r\n”(回车+换行,简称CRLF)来表示一行的结束,而Unix/Linux以及macOS(现代版本)则更偏爱简洁的单字符“\n”(换行,简称LF)。Prettier默认期望的是Unix风格的LF。当你项目里的文件,特别是从Windows环境创建或编辑过的文件,使用了CRLF时,Prettier就会跳出来说:“嘿,这里有个多余的‘\r’(也就是那个␍),不符合规范,请删除它!” 这就是“Delete ␍”的由来。
这个问题看似不起眼,但在团队协作、跨平台开发或者集成CI/CD流水线时,却可能带来不少麻烦。它会导致不必要的git diff(因为换行符的改变也被视为文件内容的变更)、破坏代码库的一致性,甚至在某些极端情况下影响脚本的执行。所以,理解并解决它,是保持项目整洁和团队协作顺畅的一个基础步骤。接下来,我们就一起挖一挖这个问题的根,然后看看在不同的开发场景下,怎么把它收拾得服服帖帖。
2. 刨根问底:CRLF与LF的“前世今生”与冲突原理
要彻底解决“Delete ␍”问题,我们得先当一回“考古学家”,看看CR(Carriage Return,回车)和LF(Line Feed,换行)这两个控制字符的历史。这故事得追溯到打字机时代:CR的作用是把打印头移回一行的开头,LF则是把纸向上滚动一行。在早期的计算机系统中,为了完成“新起一行”这个动作,需要同时执行这两个操作,于是就有了CRLF的组合。微软的DOS和后来的Windows继承了这个传统。而Unix系统在设计时,认为用一个LF字符来表示“新行”就足够了,这个传统也被Linux和现代的macOS所采纳。
2.1 技术层面的差异与冲突
在代码层面,它们的差异非常直接:
- LF (Line Feed):ASCII码是
10,在字符串或正则表达式中表示为\n。这是Prettier、ESLint等许多现代前端工具链默认或推荐的格式。 - CRLF (Carriage Return + Line Feed):实际上是两个字符,
\r(ASCII 13)后面紧跟\n(ASCII 10)。在文本编辑器中,它们通常被渲染为一个换行效果。
当Prettier开始工作时,它会读取你的配置文件(比如 .prettierrc)中的 endOfLine 规则。如果这个规则被设置为 "lf"(或者未设置,因为lf是默认值),那么Prettier就会期望文件中的每一行都以 \n 结尾。它在扫描文件时,一旦发现某行末尾是 \r\n,它就会识别出那个“多余”的 \r 字符,并抛出“Delete ␍”的警告或错误。这里的“␍”就是 \r 这个控制字符的可视化符号。
2.2 为什么不同工具和行为会“打架”?
冲突的发生,往往源于环境的不一致:
- 操作系统差异:这是最经典的场景。团队成员A在Windows上用VSCode新建了一个文件,系统默认的换行符是CRLF。团队成员B在Mac上拉取代码后,用Prettier格式化,立刻就遇到了“Delete ␍”错误。
- 编辑器/IDE配置各异:即使在同一系统下,不同编辑器的默认设置也可能不同。有的编辑器会“智能”地根据文件内容或项目设置猜测换行符,有的则固执地使用系统默认。当你用不同编辑器交替修改同一个文件时,换行符就可能被无意中改变。
- Git的“好意”干预:Git有一个叫做
core.autocrlf的配置项。当它被设置为true时(Windows上的常见推荐设置),Git会在你提交代码时,自动将LF转换为CRLF;在拉取代码时,再将CRLF转换回LF。本意是为了跨平台友好,但如果这个配置在团队中不统一,或者与Prettier的固化规则冲突,反而会成为混乱的源头。 - 遗留项目的历史包袱:一些老项目可能是在早期Windows环境下创建的,积累了大量的CRLF文件。当引入Prettier等现代工具时,整个代码库都会“爆红”。
理解这些根源,我们就能明白,解决“Delete ␍”不是一个简单的单点配置,而是一个需要根据你的开发场景,进行一系列协同配置的系统工程。
3. 场景化修复指南:总有一款适合你
知道了病因,我们就可以对症下药了。不同的开发场景,修复策略的侧重点也不同。我根据自己的经验,把它们分成了几类,你可以看看自己属于哪一种。
3.1 场景一:个人项目或全新团队项目——防患于未然
如果你是项目初始化负责人,或者团队刚刚成立,目标是建立一个干净、统一的基础。那么我们的策略是“前置强制”,从一开始就把规则锁死。
核心武器组合:.editorconfig + .prettierrc + 仓库级VSCode设置
-
建立
.editorconfig(编辑器统一战线): 这个文件是给所有支持它的编辑器(VSCode、WebStorm、Sublime等)看的“宪法”,它能在文件被保存的早期阶段就统一格式。在项目根目录创建它:root = true [*] charset = utf-8 end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true indent_style = space indent_size = 2 [*.md] trim_trailing_whitespace = false这里的关键是
end_of_line = lf。insert_final_newline和trim_trailing_whitespace也能帮你避免其他常见的格式警告。 -
配置
.prettierrc(格式化工具准则): Prettier自己的配置文件,确保其规则与EditorConfig一致。{ "endOfLine": "lf", "singleQuote": true, "tabWidth": 2, "semi": false // ... 你的其他Prettier规则 } -
配置项目级VSCode设置(为团队提供开箱即用的体验): 在项目
.vscode/settings.json文件中进行配置,这样任何用VSCode打开此项目的开发者,都会自动应用这些设置,无需手动调整。{ "files.eol": "\n", "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true, "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, "[typescript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" } // ... 为其他文件类型也配置上 }"files.eol": "\n"会告诉VSCode,创建新文件时默认使用LF。editor.formatOnSave配合Prettier扩展,可以在保存时自动格式化,将任何潜在的CRLF即时纠正为LF。
完成这三步,你的项目就已经建立了一个强大的“格式防御体系”。新加入的成员只要编辑器支持,几乎不会遇到“Delete ␍”问题。
3.2 场景二:中途引入Prettier的遗留项目——一次性大扫除
很多团队是在项目进行到一半时才引入Prettier追求代码规范的。这时候代码库可能已经是CRLF和LF的“混合体”了。我们的目标是做一次彻底的“大扫除”,然后转入场景一的维护状态。
修复四部曲:
-
统一Git配置(停止制造新的混乱): 首先,在团队内部统一Git的换行符处理策略。对于跨平台团队,我推荐将
core.autocrlf设置为input。- 在Linux/Mac上:
git config --global core.autocrlf input - 在Windows上:
git config --global core.autocrlf true
更推荐的做法是将这个配置写入项目根目录的
.gitattributes文件中,这样配置就随仓库走,不依赖个人全局设置。# .gitattributes * text=auto eol=lf这行配置的意思是:Git自动识别文本文件,并在检出到工作区时,统一将行尾转换为LF。这是最彻底、最推荐的方式。
- 在Linux/Mac上:
-
执行一次性格式化(清理历史遗留): 在配置好
.prettierrc(endOfLine: "lf")和.editorconfig之后,运行Prettier对整个代码库进行格式化。这能修复所有可格式化文件中的换行符问题。npx prettier --write . # 或者如果你已全局安装 prettier --write . -
处理非Prettier格式化的文件(查漏补缺): 对于Prettier不支持的文件(比如某些配置文件、Markdown中的代码块等),可以使用系统命令或脚本进行批量转换。在Unix-like系统(Mac, Linux)或Windows的WSL/Git Bash中:
# 递归地查找所有文件,并将CRLF转换为LF find . -type f -name "*.js" -o -name "*.ts" -o -name "*.json" -o -name "*.md" | xargs dos2unix注意:
dos2unix命令可能需要安装。执行前务必先提交或备份代码,并在一个干净的分支上操作,方便review变化。 -
提交一个专门的“格式化”提交: 将上述所有更改一次性提交,提交信息可以类似
“chore: normalize line endings to LF”。这样,历史记录清晰,以后团队协作的基础就是干净统一的LF了。
3.3 场景三:集成CI/CD流水线——守住最后一道关卡
对于严肃的团队项目,仅仅依赖本地工具是不够的。我们需要在代码合并的“咽喉要道”——CI/CD流水线上设置检查,确保任何不符合规范的代码都无法进入主分支。
核心方案:在CI中运行Prettier的检查模式
以GitHub Actions为例,你可以在 .github/workflows 下创建一个 check-format.yml 文件:
name: Code Format Check
on: [push, pull_request]
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18'
- name: Install dependencies
run: npm ci # 或 yarn install --frozen-lockfile
- name: Run Prettier check
run: npx prettier --check .
这个工作流会在每次推送或拉取请求时运行。prettier --check . 命令会检查所有文件是否符合Prettier规则(包括换行符),如果不符合,命令会以非零状态退出,导致CI检查失败。这样,团队成员就会收到通知,需要先在本地运行 prettier --write . 修复格式问题,包括“Delete ␍”错误,然后才能通过CI检查。
更进一步:使用Husky钩子在提交前检查
你还可以结合Husky,在本地git commit时触发检查,将问题拦截在更早的阶段。
# 安装Husky
npx husky-init && npm install
# 在 .husky/pre-commit 钩子文件中添加
npx --no-install prettier --write . && git add -u
# 或者只检查,让提交失败
npx --no-install prettier --check .
4. 高级技巧与疑难杂症排查
即使按照上面的场景做了,有时候一些顽固的问题还是会出现。这里分享几个我踩过坑后总结的高级技巧。
4.1 诊断工具:如何精准定位“问题文件”?
当错误只零星出现时,你需要快速找到是哪个文件、哪一行出了问题。
-
使用Prettier的详细输出:
npx prettier --check . --loglevel debug更详细的日志可能会给你更多线索。
-
利用编辑器内置功能: 在VSCode中,你可以点击底部状态栏的“LF”或“CRLF”字样,为当前文件强制选择一种换行符。也可以安装“Line Endings Unifier”这类扩展,来批量查看和转换当前项目文件的换行符。
-
命令行侦查: 在Unix系统或WSL中,使用
grep或find命令快速定位包含CRLF的文件。# 查找当前目录下所有.js文件中包含CRLF(\r\n)的行 grep -l $'\r' *.js # 递归查找 find . -type f -name "*.js" -exec grep -l $'\r' {} \;
4.2 处理.gitattributes的例外情况
有些文件必须是CRLF格式的,比如Windows的批处理文件(.bat, .cmd)。.gitattributes 文件可以精细控制:
# .gitattributes
* text=auto eol=lf
*.bat text eol=crlf
*.cmd text eol=crlf
*.ps1 text eol=crlf
# 二进制文件不应该被转换
*.png binary
*.jpg binary
4.3 当VSCode设置不生效时
有时候,即使配置了 "files.eol": "\n",VSCode打开旧文件可能还是显示CRLF。这是因为VSCode会“尊重”文件已有的换行符。要强制转换单个文件,最快捷的方法是:
- 点击状态栏的“CRLF”。
- 在弹出的选择器中点击“LF”。
- 保存文件(
Ctrl+S)。
此时,换行符就被转换了,再配合 formatOnSave,Prettier的错误就会消失。如果整个项目都需要,可以用“更改所有文件换行符”的命令(在命令面板搜索“Change All End of Line Sequence”)。
4.4 与ESLint的配合
如果你同时使用ESLint和Prettier,确保它们不会在换行符规则上冲突。通常我们会使用 eslint-config-prettier 来关闭ESLint中与Prettier冲突的规则。对于换行符,ESLint有自己的 linebreak-style 规则。在 .eslintrc.js 中,你可以这样配置:
module.exports = {
rules: {
'linebreak-style': ['error', 'unix'], // 强制使用Unix换行符(LF)
},
};
但更佳实践是,让Prettier管理所有格式规则(包括换行符),并用 eslint-config-prettier 关闭ESLint的格式规则,避免双重校验和潜在冲突。
解决“Delete ␍”问题,本质上是在追求一种极致的开发环境一致性。它虽然是个小问题,但却是工程规范中很重要的一环。从我经历过的多个项目来看,在项目初期就花一点时间把这些配置固化下来,能省去后期大量的协作摩擦和琐碎的格式修复时间。现在,你的工具链已经具备了自动处理和校验换行符的能力,可以把精力更多地集中在创造性的编码工作上了。
3855



被折叠的 条评论
为什么被折叠?



