diff options
| author | 2026-03-18 04:57:17 +0100 | |
|---|---|---|
| committer | 2026-03-18 11:57:17 +0800 | |
| commit | 8c913f2685383bcfa154c947a43571a8d33679ae (patch) | |
| tree | fcc363afcc41b3dae1043e6cf5b76389d3f950e4 /.gitignore | |
| parent | aff0903f625a2184d6d96e47b10041d741e59b4d (diff) | |
| download | DropOut-8c913f2685383bcfa154c947a43571a8d33679ae.tar.gz DropOut-8c913f2685383bcfa154c947a43571a8d33679ae.zip | |
fix(modpack): 将 CurseForge API Key 改为编译期可选常量 (#118)
# fix(modpack): 将 CurseForge API Key 改为编译期可选常量
修复 `env!()` 宏在开发者本地无 `CURSEFORGE_API_KEY` 时导致编译失败的问题,改用 `option_env!()`
+ build.rs 中的 `dotenvy` 读取 .env 文件,实现编译期嵌入、缺失时优雅降级。
## 更改类型
- [x] Bug 修复(修复问题的非破坏性更改)
- [ ] 新功能(添加功能的非破坏性更改)
- [ ] 破坏性更改(会导致现有功能无法正常工作的修复或功能)
- [ ] 文档更新
- [ ] UI/UX 改进
- [ ] 性能优化
- [ ] 代码重构(无功能性更改)
- [x] 配置更改
- [ ] 测试添加或更新
## LLM 生成代码声明
- [x] 此 PR 不包含 LLM 生成的代码,我**提供**质量担保
## 相关 Issue
相关 #110 #117
## 更改内容
### 后端 (Rust)
- modpack.rs:将 `env!("CURSEFORGE_API_KEY")` 替换为 `const
CURSEFORGE_API_KEY: Option<&str> =
option_env!("CURSEFORGE_API_KEY")`,key 不存在时编译为 `None`,调用 CurseForge
功能时返回友好错误而非 panic
- build.rs:添加 `dotenvy::dotenv()` 调用,允许通过 .env 文件在编译期注入 key,并注册
`cargo:rerun-if-changed` / `cargo:rerun-if-env-changed` 确保增量构建正确
### 前端 (Svelte)
- 无
### 配置
- Cargo.toml:在 `[build-dependencies]` 中添加 `dotenvy = { version = "0.15",
default-features = false }`
- .gitignore:添加 .env / `.env.local` 忽略规则,防止 key 被意外提交
- .env.example:新增示例文件,说明可选配置项及获取方式
## 测试
### 测试环境
- **操作系统**:Fedora Linux 6.19.6-300.fc44.x86_64 x86_64
- **DropOut 版本**:0.2.0-alpha.5
- **测试的 Minecraft 版本**:N/A
- **Mod 加载器**:N/A
### 测试用例
- [ ] 已在 Windows 上测试
- [ ] 已在 macOS 上测试
- [x] 已在 Linux 上测试
- [ ] 已测试原版 Minecraft
- [ ] 已测试 Fabric
- [ ] 已测试 Forge
- [ ] 已测试游戏启动
- [ ] 已测试登录流程
- [ ] 已测试 Java 检测/下载
### 测试步骤
1. 不设置 `CURSEFORGE_API_KEY`,不创建 .env 文件,直接执行 `cargo check` → 应编译通过(无报错)
2. 创建 .env 文件并写入 `CURSEFORGE_API_KEY=test_key`,执行 `cargo check` →
应编译通过,key 被嵌入二进制
3. 不含 key 的构建中触发 CurseForge modpack 导入 → 应返回友好错误提示而非 panic
## 检查清单
### 代码质量
- [x] 我的代码遵循项目的代码风格指南
- [x] 我已对自己的代码进行了自审
- [ ] 我已对难以理解的区域添加了注释
- [x] 我的更改没有产生新的警告或错误
### 测试验证
- [x] 我已在本地测试了我的更改
- [ ] 我已添加测试来证明我的修复有效或功能正常工作
- [x] 新的和现有的单元测试在本地通过
- [x] 我至少在一个目标平台上进行了测试
### 文档更新
- [ ] 我已相应地更新了文档
- [ ] 如有需要,我已更新 README
- [ ] 我已在必要处添加/更新代码注释
### 依赖项
- [x] 我已检查没有添加不必要的依赖项
- [x] 所有新依赖项都已正确记录
- [x] Cargo.lock 已更新
## 附加说明
`dotenvy` 仅作为 **build-dependency**,不会进入最终二进制。官方发布构建通过 CI 环境变量注入
key,普通开发者无需任何操作即可正常编译和运行。
Co-authored-by: 简律纯 <i@jyunko.cn>
Diffstat (limited to '.gitignore')
| -rw-r--r-- | .gitignore | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -29,6 +29,10 @@ __pycache__/ # Tauri artifacts artifacts/ +# Local secrets (do not commit) +.env +.env.local + # AUR Release release/ |