Todo Time - VSCode 扩展
这是一个 VSCode 扩展，可以自动为 TODO 注释添加当前的日期和时间。
功能特性
- 🕒 自动时间戳：输入
// todo 或 // TODO 时自动添加当前日期时间
- 🎯 智能识别：支持多种注释格式（
//、#、/*、<!-- 等）
- 🔧 高度可配置：可自定义日期时间格式和触发关键词
- 🌐 多语言支持：支持 TypeScript、JavaScript、Go、Python、Java、C/C++、Rust 等多种编程语言
- ⌨️ 快捷键支持：提供快捷键快速插入带时间戳的 TODO
使用方法
自动完成
在任何支持的文件中输入注释符号后跟 todo，例如：
// todo# todo/* todo<!-- todo
当你输入完 todo 后，VSCode 会自动提示完成选项
选择提示的完成项，扩展会自动将 todo 替换为 todo(2025-01-29 12:22:33)
手动插入
使用快捷键 Ctrl+Shift+T（macOS: Cmd+Shift+T）在当前光标位置插入带时间戳的 TODO 注释。
配置选项
在 VSCode 设置中搜索 "todo-time" 可以找到以下配置选项：
- 类型:
string
- 默认值:
"yyyy-MM-dd HH:mm:ss"
- 描述: 设置日期时间的格式
可用的格式占位符：
yyyy - 4位年份MM - 2位月份dd - 2位日期HH - 24小时制小时mm - 分钟ss - 秒
示例格式：
{
"todo-time.dateFormat": "yyyy-MM-dd HH:mm:ss" // 2025-01-29 12:22:33
}
{
"todo-time.dateFormat": "yyyy/MM/dd HH:mm" // 2025/01/29 12:22
}
todo-time.enableAutoComplete
- 类型:
boolean
- 默认值:
true
- 描述: 是否启用自动完成功能
{
"todo-time.enableAutoComplete": false // 禁用自动完成
}
todo-time.todoKeywords
- 类型:
array
- 默认值:
["todo", "TODO", "Todo"]
- 描述: 触发自动完成的关键词列表
{
"todo-time.todoKeywords": ["todo", "TODO", "fixme", "FIXME", "hack"]
}
支持的语言
- TypeScript (.ts)
- JavaScript (.js)
- Go (.go)
- Python (.py)
- Java (.java)
- C (.c)
- C++ (.cpp)
- C# (.cs)
- Rust (.rs)
- PHP (.php)
- HTML (.html)
- CSS (.css)
- SCSS (.scss)
- Less (.less)
- Vue (.vue)
- React (.jsx, .tsx)
- JSON (.json)
- YAML (.yml, .yaml)
- XML (.xml)
- Markdown (.md)
- 纯文本 (.txt)
示例
输入前
function myFunction() {
// todo
}
输入后（自动完成）
function myFunction() {
// todo(2025-01-29 12:22:33)
}
不同注释格式的示例
JavaScript/TypeScript:
// todo(2025-01-29 12:22:33) 添加错误处理
/* todo(2025-01-29 12:22:33) 优化性能 */
Python:
# todo(2025-01-29 12:22:33) 重构这个函数
HTML:
<!-- todo(2025-01-29 12:22:33) 添加响应式设计 -->
CSS:
/* todo(2025-01-29 12:22:33) 优化样式 */
安装
- 打开 VSCode
- 进入扩展市场 (Ctrl+Shift+X 或 Cmd+Shift+X)
- 搜索 "Todo Time"
- 点击安装
或者从 .vsix 文件安装：
- 下载
.vsix 文件
- 在 VSCode 中按
Ctrl+Shift+P（或 Cmd+Shift+P）
- 输入 "Extensions: Install from VSIX..."
- 选择下载的
.vsix 文件
开发
准备环境
# 克隆仓库
git clone <repo-url>
cd todo-time
# 安装依赖
npm install
# 编译
npm run compile
调试
- 在 VSCode 中打开项目
- 按 F5 或运行调试配置
- 这会启动一个新的 VSCode 窗口，扩展已加载
- 在新窗口中测试扩展功能
构建
# 编译
npm run compile
# 打包
npm run package
许可证
MIT License
贡献
欢迎提交 Issue 和 Pull Request！
更新日志
1.0.0
- 初始版本
- 支持自动完成功能
- 支持多种编程语言
- 可配置日期时间格式和关键词
- 提供快捷键支持
