VitePress 项目在 GitHub Pages 部署中的大小写敏感问题解析

在基于 VitePress 构建文档项目并部署到 GitHub Pages 时，开发者可能会遇到一个典型的构建失败问题。这个问题在本地开发环境中不会出现，但在 GitHub Actions 的 CI/CD 流程中会突然暴露出来。

问题现象

当使用 VitePress 构建文档项目并通过 GitHub Actions 部署到 GitHub Pages 时，构建过程会报错，提示无法解析某些图片资源路径。错误信息中会明确指出找不到特定路径下的图片文件，例如：

RollupError: Could not resolve "./doc/images/1_create_empty_project.png"

有趣的是，同样的构建命令在本地开发环境中却能顺利执行，不会出现任何错误。

根本原因

这个问题的根源在于不同操作系统对文件路径大小写的处理方式不同：

1. Windows 系统采用不区分大小写的文件系统
2. Linux 系统（GitHub Actions 使用的 Ubuntu）采用区分大小写的文件系统

当项目中存在文件路径引用大小写不一致的情况时：

• 在 Windows 上，"./doc/images/1_create_empty_project.PNG" 和 "./doc/images/1_create_empty_project.png" 会被视为相同路径
• 在 Linux 上，这两个路径会被视为完全不同的文件

解决方案

1. 统一文件扩展名大小写

确保所有文件引用和实际文件名的大小写完全一致。特别是图片文件，应该统一使用小写的扩展名（如.png）。

2. 彻底清理 Git 缓存

有时即使修改了文件名大小写，Git 可能仍保留旧缓存。可以执行以下命令强制更新：

git rm -r --cached .
git add --all .

3. 自动化重命名脚本

对于大量需要修改的文件，可以使用脚本批量重命名：

$pngFiles = git ls-files | Where-Object { $_ -match '\.PNG$' }
foreach ($file in $pngFiles) {
    $newFile = [System.IO.Path]::ChangeExtension($file, 'png')
    Rename-Item -Path $file -NewName $newFile
    git mv -f $file $newFile
}

4. 检查所有资源引用路径

除了文件扩展名，还要检查路径中的目录名大小写是否一致。例如：

editBox/editbox-event.png  # 正确
EditBox/editbox-event.png  # 可能导致问题

最佳实践

1. 开发环境一致性：尽量在开发环境中模拟生产环境，可以使用 WSL 或 Docker 来获得与 GitHub Actions 相同的 Linux 环境
2. 严格命名规范：项目初期就制定并遵守统一的文件命名规范，特别是大小写规则
3. 预提交检查：设置 Git 钩子或 CI 检查，确保提交的代码不会包含大小写不一致的引用
4. 跨平台测试：在 Windows 和 Linux 环境下都进行构建测试

通过遵循这些实践，可以避免因文件系统差异导致的构建问题，确保项目在各种环境下都能顺利构建和部署。