README file from
GithubVault Cleanup Dashboard (仓库清理面板)
一个用于智能清理 Obsidian 仓库中孤立文件和附件的插件。
功能特性
- 可视化控制面板：通过侧边栏图标一键打开清理面板，实时查看扫描状态和统计信息
- 智能检测：精准识别孤立笔记、附件和其他文件，支持 Canvas 文件链接检测
- 选择性删除：预览文件列表后勾选确认，避免误删重要文件
- 自定义回收站：删除的文件移动到自定义回收站文件夹（默认
.vault-trash），支持随时恢复 - 定时自动清理：支持自定义间隔天数，自动扫描和清理孤立附件
- 文件保护机制：最近修改的文件自动受保护（默认 7 天内），防止误删活跃文件
- 灵活配置：支持白名单文件夹、正则忽略模式、自定义附件路径等高级选项
- 中英文双语：完整的国际化支持，可切换中文/英文界面
界面预览
使用方法
快速开始
- 点击侧边栏的 Vault Cleanup Dashboard 图标打开清理面板
- 点击 扫描 Vault 查找孤立文件
- 查看统计信息，了解孤立文件数量
- 根据需要选择清理附件、笔记或所有孤立文件
- 在预览界面确认文件列表后执行清理
命令面板
通过 Obsidian 命令面板（Ctrl/Cmd + P）快速执行：
- 打开控制面板 - 打开可视化清理面板
- 清理孤立附件 - 仅扫描和清理孤立附件
- 清理孤立笔记 - 仅扫描和清理孤立笔记
- 清理所有孤立文件 - 扫描和清理所有类型孤立文件
安装
从社区插件市场安装（推荐）
- 打开 Obsidian 设置 → 社区插件 → 浏览
- 搜索 "Vault Cleanup Dashboard"
- 点击安装并启用
手动安装
- 从 Releases 下载最新版本
- 将插件文件夹解压到仓库的
.obsidian/plugins/目录中 - 打开 Obsidian 设置 → 社区插件 → 启用 "Vault Cleanup Dashboard"
配置说明
清理设置
| 配置项 | 说明 | 默认值 |
|---|---|---|
| 删除策略 | 移动到自定义垃圾桶 或 永久删除（危险） | 自定义垃圾桶 |
| 自定义垃圾桶路径 | 删除文件的存放位置 | .vault-trash |
| 最近修改保护 | 此天数内修改的文件不会被删除 | 7 天 |
| 白名单文件夹 | 排除扫描的文件夹（每行一个） | 无 |
自动清理设置
| 配置项 | 说明 | 默认值 |
|---|---|---|
| 启用自动清理 | 按计划自动清理孤立附件 | 关闭 |
| 清理间隔 | 自动清理执行频率（天） | 3 天 |
| 打开 Vault 时检查 | 打开仓库时运行自动清理检查 | 开启 |
| 加载插件时检查 | 加载插件时运行自动清理检查 | 开启 |
注意：自动清理功能仅影响附件，不会删除笔记文件，确保重要内容安全。
高级设置
| 配置项 | 说明 | 默认值 |
|---|---|---|
| 覆盖附件文件夹 | 自定义附件存储位置（每行一个） | 跟随仓库设置 |
| 忽略模式 | 正则表达式模式，匹配的文件将被排除 | 无 |
| 测试设置 | 输入路径测试是否被忽略（红色=忽略，绿色=保留） | - |
| 替代附件查找算法 | 如果在子文件夹中找不到附件，尝试启用此选项 | 关闭 |
开发
# 安装依赖
npm install
# 开发模式（热重载）
npm run dev
# 生产构建
npm run build
项目结构
src/
├── main.ts # 插件入口，注册命令和图标
├── dashboardModal.ts # 可视化控制面板
├── scanService.ts # 孤立文件扫描服务
├── actionService.ts # 文件操作服务（删除/恢复）
├── previewModal.ts # 删除预览确认对话框
├── trash_modal.ts # 回收站管理对话框
├── autoCleanScheduler.ts # 定时自动清理调度器
├── settings.ts # 设置界面
└── locales/ # 国际化语言包
├── zh-CN.ts # 中文
└── en-US.ts # 英文
许可证
MIT
致谢
- 本插件基于 nuke-orphans-plugin 二次开发，在原插件基础上增加了可视化控制面板、定时自动清理、文件保护机制等增强功能。感谢原作者的优秀工作。
- 感谢所有为 Obsidian 社区做出贡献的开发者