xfy
2028897ce3
- 更新所有层级 AGENTS.md 中的模块描述（:app / :core） - 移除 KMP/iOS 相关引用，统一为纯 Android + Jetpack Compose - 同步构建命令和测试路径 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
<!-- Parent: ../../AGENTS.md -->
|
||
<!-- Generated: 2026-05-20 | Updated: 2026-05-20 -->
|
||
|
||
# main
|
||
|
||
## Purpose
|
||
核心库主 source set，包含所有 Compose UI、ViewModel 状态管理、业务逻辑和工具类。这是 YaYa 应用的主体代码所在。
|
||
|
||
## Key Files
|
||
|
||
| File | Description |
|
||
|------|-------------|
|
||
| `kotlin/plus/rua/project/AppInfo.kt` | 应用元数据（名称、版本、作者等） |
|
||
| `kotlin/plus/rua/project/CalendarViewModel.kt` | 日历状态管理（选中日期、展开/折叠、月/周/年视图） |
|
||
| `kotlin/plus/rua/project/ComposeTrace.kt` | Trace 标记 API（Android 实现用 Systrace） |
|
||
| `kotlin/plus/rua/project/Platform.kt` | 平台接口声明 |
|
||
| `kotlin/plus/rua/project/ShiftPattern.kt` | 个人班次排期模型（WORK/OFF 循环） |
|
||
|
||
## Subdirectories
|
||
|
||
| Directory | Purpose |
|
||
|-----------|---------|
|
||
| `kotlin/plus/rua/project/` | 业务逻辑和 ViewModel（见 `kotlin/plus/rua/project/AGENTS.md`） |
|
||
| `kotlin/plus/rua/project/ui/` | UI 组件层（见 `kotlin/plus/rua/project/ui/AGENTS.md`） |
|
||
| `assets/` | 原始资产文件（GIF 等） |
|
||
|
||
## For AI Agents
|
||
|
||
### Working In This Directory
|
||
- 所有新功能代码优先放在 `src/main/kotlin/` 中
|
||
- `CalendarViewModel.kt` 是核心状态枢纽，修改需谨慎
|
||
|
||
### Testing Requirements
|
||
- 修改后运行 `./gradlew :core:test`
|
||
|
||
### Common Patterns
|
||
- `@Suppress("DEPRECATION")` 用于 `monthNumber` 访问时需加解释注释
|
||
- 公共 `@Composable` 函数需要 KDoc（见 `COMMENTS.md`）
|
||
- `Modifier` 参数始终放在签名最后
|
||
- 回调参数使用 `on` 前缀（`onDateClick`、`onMonthChanged`）
|
||
- UI 文本使用中文
|
||
|
||
## Dependencies
|
||
|
||
### External
|
||
- Jetpack Compose, Material 3
|
||
- `kotlinx-datetime`, `kotlinx-coroutines`
|
||
- `tyme4kt`（农历/节气/节日）
|
||
- `sketch`（GIF 显示）
|
||
- `androidx-lifecycle-viewmodel-compose`
|
||
|
||
<!-- MANUAL: -->
|