🌟 每日仪式 - VSCode 插件
一个具有仪式感的每日打卡插件,帮助你记录每一天的心情和成长。
✨ 功能特色
📅 日历视图
- 在 VSCode 侧边栏显示精美的日历界面
- 直观显示打卡记录和统计信息
- 支持月份导航,查看历史记录
- 实时统计:总打卡天数、连续天数、最长记录
🎯 每日打卡
- 6种心情选择(😊 😐 😔 😤 🤩 😌)
- 记录今日笔记和想法
- 独立打卡界面,体验更佳
- 防止重复打卡,每天只能打卡一次
🔮 今日运势
- 每日运势预测(基于日期生成,同一天保持一致)
- 幸运指数、适合活动、幸运颜色和数字
- 编程相关励志语录
- 支持手动刷新运势
📊 数据统计
- 总打卡天数统计
- 当前连续打卡天数
- 最长连续打卡记录
- 今日打卡状态实时显示
🚀 快速开始
开发环境测试
# 1. 克隆或下载项目
git clone <repository-url>
cd daily-ritual
# 2. 安装依赖
npm install
# 3. 编译代码
npm run compile
# 4. 在 VSCode 中按 F5 启动调试
安装插件
- 在 VSCode 中按
Ctrl+Shift+P
打开命令面板
- 输入 "Extensions: Install from VSIX"
- 选择本插件的
.vsix
文件进行安装
- 重启 VSCode
📖 详细使用指南
打开日历视图
- 方法一: 点击 VSCode 左侧活动栏的日历图标 📅
- 方法二: 命令面板 →
Ctrl+Shift+P
→ "每日仪式: 打开每日仪式日历"
每日打卡
- 方法一: 在日历视图中点击"今日打卡"按钮
- 方法二: 命令面板 →
Ctrl+Shift+P
→ "每日仪式: 今日打卡"
- 步骤:
- 选择今天的心情(6种表情可选)
- 填写今日笔记(可选)
- 点击"打卡"按钮
- 查看成功提示
查看运势
- 命令面板 →
Ctrl+Shift+P
→ "每日仪式: 今日运势"
- 查看今日运势、幸运指数、适合活动
- 点击"刷新运势"可随机生成新运势
🎨 界面预览
日历视图
- 显示当月日历,已打卡日期会有绿色标记 ✓
- 实时统计信息展示(总天数、连续天数等)
- 心情选择器和笔记输入
- 月份导航按钮
打卡界面
- 全屏美观的打卡表单
- 6种心情选择,带表情和文字说明
- 大尺寸笔记输入框
- 实时显示统计数据
运势界面
- 每日运势预测卡片
- 幸运指数和适合活动
- 幸运颜色和数字展示
- 励志语录展示
🔧 开发说明
项目结构
daily-ritual/
├── src/
│ ├── extension.ts # 插件主入口
│ ├── providers/
│ │ └── CalendarProvider.ts # 日历视图提供者
│ ├── panels/
│ │ ├── CheckInPanel.ts # 打卡面板
│ │ └── FortunePanel.ts # 运势面板
│ └── utils/
│ └── StorageManager.ts # 数据存储管理
├── resources/
│ └── icon.svg # 插件图标
├── out/ # 编译输出目录
├── .vscode/ # VSCode 配置
├── package.json # 插件配置
├── tsconfig.json # TypeScript 配置
└── README.md # 说明文档
技术栈
- TypeScript: 主要开发语言,类型安全
- VSCode Extension API: 插件开发框架
- Webview: 自定义界面实现
- Memento: 数据持久化存储
- CSS Grid/Flexbox: 响应式布局
编译和运行
# 安装依赖
npm install
# 编译 TypeScript
npm run compile
# 开发模式(监听文件变化)
npm run watch
# 测试插件
node test-extension.js
调试模式
- 在 VSCode 中打开项目
- 按
F5
启动调试模式
- 在新窗口中测试插件功能
- 使用
Ctrl+Shift+I
查看控制台日志
📝 数据存储
存储方式
插件使用 VSCode 的 Memento
API 进行数据存储,包括:
- 打卡记录(日期、心情、笔记、时间戳)
- 用户统计信息(总天数、连续天数等)
- 用户设置
数据格式
{
"date": "2024-01-15",
"mood": "😊",
"note": "今天学习了新的编程技术,感觉很有收获!",
"timestamp": 1705123456789
}
数据安全
- 数据存储在 VSCode 的全局状态中,安全可靠
- 支持 VSCode 的数据同步功能
- 不会丢失,重启后数据仍然保存
🧪 测试指南
功能测试
日历视图测试
- 检查日历是否正确显示
- 测试月份导航功能
- 验证统计信息显示
打卡功能测试
- 选择不同心情进行打卡
- 填写笔记内容
- 检查重复打卡限制
运势功能测试
数据持久化测试
- 完成打卡后重启 VSCode
- 检查数据是否保存
- 验证统计信息正确性
运行测试
# 运行测试脚本
node test-extension.js
# 预期输出:所有检查项都显示 ✅
❓ 常见问题
Q: 插件没有显示在活动栏?
A: 请检查插件是否正确安装,可以尝试重启 VSCode。
Q: 打卡数据会丢失吗?
A: 不会,数据存储在 VSCode 的全局状态中,安全可靠。
Q: 可以修改已打卡的记录吗?
A: 目前不支持修改历史记录,但可以重新打卡覆盖当天的记录。
Q: 运势每天都不一样吗?
A: 同一天的运势是固定的,但可以点击"刷新运势"按钮随机生成新的。
Q: 支持数据导出吗?
A: 当前版本不支持,这是未来计划中的功能。
Q: 如何卸载插件?
A: 在 VSCode 扩展管理器中找到插件,点击卸载即可。
⌨️ 快捷键
功能 |
快捷键 |
打开命令面板 |
Ctrl+Shift+P |
今日打卡 |
Ctrl+Shift+P → "每日仪式: 今日打卡" |
今日运势 |
Ctrl+Shift+P → "每日仪式: 今日运势" |
打开日历 |
Ctrl+Shift+P → "每日仪式: 打开每日仪式日历" |
🎯 未来计划
- [ ] 数据导出功能(CSV、JSON 格式)
- [ ] 成就徽章系统
- [ ] 自定义提醒设置
- [ ] 主题切换(深色/浅色)
- [ ] 数据备份和同步
- [ ] 更多运势类型
- [ ] 社交分享功能
- [ ] 数据可视化图表
- [ ] 自定义心情标签
- [ ] 多语言支持
🤝 贡献
欢迎提交 Issue 和 Pull Request!
贡献指南
- Fork 项目
- 创建功能分支 (
git checkout -b feature/AmazingFeature
)
- 提交更改 (
git commit -m 'Add some AmazingFeature'
)
- 推送到分支 (
git push origin feature/AmazingFeature
)
- 打开 Pull Request
📄 许可证
MIT License - 详见 LICENSE 文件
🙏 致谢
感谢所有为这个项目提供灵感和帮助的朋友们!
灵感来源
- 每日打卡习惯的养成
- 程序员的工作仪式感
- 心情记录的重要性
让每一天都充满仪式感,记录你的编程成长之路! 🚀
如果这个插件对你有帮助,请给个 ⭐ 支持一下!