# PlanFlow

> 🌐 **语言**：简体中文 · [English](README.en.md)

- **计划自动拆解+每日打卡行动：让目标细化成可执行的颗粒**
- **清晰目标追踪：四个页面一条闭环，今日行动 / 计划管理 / 任务看板 / 我的成就**
- **自动统计激励系统：打卡连续天数 + 铜银金徽章 + 成就墙**
- **数据自动流转：统一数据源，纯 Markdown，告别杂乱**

📖 **完整图文使用说明（设计理念 / 功能性 / 易用性）：[docs/USAGE.md](docs/USAGE.md)**

**个人自用小工具，分享给有需求的小伙伴。项目地址：https://github.com/yezhangdeng01/PlanFlow ，有任何正负向的反馈都欢迎去项目提issue或点star。**
## 设计理念

### 1. 计划是一条流，不是一堆表

大多数计划工具把「年度目标、月度计划、每日打卡」做成互不相通的三套数据，靠手动同步。PlanFlow 则实现计划自动拆解、任务自动流转，数据统一互通，让计划和执行都更简单：

![](docs/screenshots/flow.png)

- **计划自动拆解流转**：所有新建和编辑入口统一在计划管理页，在这里建立的计划和目标会自动分解，自动流转到相关页面；
- **聚焦今日行动**：主页默认在今日行动页，聚焦在今日打卡和总结；
- **清晰任务追踪**：任务看板分类/状态/甘特图多种展示方式，清晰把握任务状况；
- **成就激励系统**多图表展示进度状态，徽章激励，实时反馈系统，让成就即时可见

### 2. 执行优先

「今日打卡 + 今日总结」是界面的视觉中心，年度目标进度条常驻顶部——打开 Obsidian 第一眼看到的是「今天要做什么、做了多少」。

![](docs/screenshots/today-action.png) 

## ✨ 功能
| 页面 | 职责 | 核心操作 |
|---|---|---|
| **今日行动** | 目标 → 执行 → 总结 | 勾选打卡、日期下拉补昨日卡、写今日总结、一键写复盘 |
| **计划管理** | 计划总览与目标管理 | 新建计划自动生成每日行动打卡，量化目标自动拆解到月/周任务 |
| **任务看板** | 执行面板（分类 / 状态 / 甘特三形态） | 按计划分组|
| **我的成就** | 统计与激励 | 徽章墙、打卡统计环、月度分布、累计曲线、热力图 |

其他特性：
- 🏆 打卡连续天数（streak）+ 周/月完成度徽章（铜/银/金）
- 📊 按计划的完成率统计、年度目标自动进度
- 🎨 深空蓝主题色 + 珊瑚橙行动区 + 计划色点缀（明暗主题适配）
- 📝 每日笔记自动生成（代码内模板），总结可自动派生

### 📸 视图一览

**今日行动**——打卡、今日总结、本月图表与周/月任务清单，一屏总览。

![](docs/screenshots/today-action.png)

**计划管理**——每个计划的打卡行动、量化目标与任务列表。

![](docs/screenshots/plans.png)

**任务看板**——按计划分组的看板，支持状态与甘特形态。

![](docs/screenshots/tasks.png)

**我的成就**——徽章墙、打卡统计环、月度分布、累计曲线与热力图。

![](docs/screenshots/achievements.png)

## 🚀 安装

### 方式一：社区插件市场（推荐）

1. Obsidian 设置 → 第三方插件 → 关闭安全模式（受限模式）
2. 点「浏览」，搜索 **PlanFlow**
3. 安装并启用（后续更新由 Obsidian 自动管理）

也可以直接打开插件页：[obsidian://show-plugin?id=planflow](obsidian://show-plugin?id=planflow)

### 方式二：BRAT（跟踪测试版 / 预发布）

1. 安装 [BRAT](obsidian://show-plugin?id=obsidian42-brat) 插件
2. BRAT 设置 → Add Beta plugin → 输入 `yezhangdeng01/PlanFlow`
3. 启用 PlanFlow（后续发新版自动更新）

### 方式三：手动安装

1. 下载 [最新 Release](https://github.com/yezhangdeng01/PlanFlow/releases) 的 `main.js`、`manifest.json`、`styles.css`
2. 在 vault 中创建 `.obsidian/plugins/planflow/` 目录，放入三个文件
3. Obsidian 设置 → 第三方插件 → 启用 PlanFlow

## 📂 数据格式（vault 内纯 Markdown）

```
raw/计划/                  ← 可在设置中修改根路径
├── 2026/
│   ├── 年度计划.md         ← 计划定义（frontmatter: plans）
│   ├── 任务.md             ← 任务池（所有计划的任务）
│   ├── 成就.md             ← 徽章记录
│   ├── 每日/2026-08-15.md  ← 每日打卡笔记（自动生成）
│   └── 周/2026-W33.md      ← 周目标（自动聚合）
```

**年度计划 frontmatter 示例**：

```yaml
---
plans:
  - name: 阅读
    type: 量化
    target: 24
    unit: 本
    desc: 读书笔记
  - name: 健身
    type: 习惯
    target: 100
    unit: 天
---
```

任务通过 `#计划/{计划名}` 标签或 frontmatter 归属计划，日期窗口（本周=ISO 周、本月=自然月）自动聚合到对应视图。

## 🛠 开发

```bash
npm install
npm run build    # tsc + esbuild → main.js
npm run typecheck
```

## ⚠️ 说明

- UI 目前为中文（数据格式与字段名保持英文，便于国际化）
- 纯本地运行：无网络调用、无遥测、无数据外发

## 📄 许可

MIT © 2026 JCH