Hidden Writer VSCode插件 - 完整使用指南

🚀 安装步骤

1. 获取源代码

git clone <repository-url>
cd vscode-write-extension

2. 安装依赖

npm install

3. 编译项目

npm run compile

4. 测试运行

在VSCode中：

1. 按 F5 或 Ctrl+F5
2. 选择 "Launch Extension"
3. 会打开一个新的VSCode扩展开发窗口

5. 打包安装（可选）

# 安装打包工具
npm install -g vsce

# 打包扩展
vsce package

# 安装.vsix文件
code --install-extension write-0.0.3.vsix

📍 如何找到插件入口

方法1：侧边栏视图（主要入口）

1. 打开VSCode
2. 在左侧活动栏找到 "HIDDEN WRITER" 图标
3. 在资源管理器面板中找到 "HIDDEN WRITER" 部分
4. 点击 "Files" 面板中的按钮或工具栏中的图标

方法2：命令面板

1. 按 Ctrl+Shift+P (Mac: Cmd+Shift+P)
2. 输入 "Hidden Writer"
3. 选择相关命令，如 "Hidden Writer: Open Hidden Writer"

方法3：快捷键

• 打开编辑器: Ctrl+Shift+H (Mac: Cmd+Shift+H)
• 关闭编辑器: Ctrl+Shift+Q (Mac: Cmd+Shift+Q)
• 新建编辑器窗口: Ctrl+Shift+N (Mac: Cmd+Shift+N) - 仅在编辑器激活时
• 打开文件: Ctrl+Shift+O (Mac: Cmd+Shift+O) - 仅在编辑器激活时
• 保存文件: Ctrl+Shift+S (Mac: Cmd+Shift+S) - 仅在编辑器激活时
• 关闭所有编辑器: Ctrl+Shift+H (Mac: Cmd+Shift+H) - 仅在编辑器激活时

方法4：状态栏

• 点击右下角状态栏的 "✏️ Writer" 按钮

🎯 功能特性

📝 编辑器功能

• 多窗口支持: 可同时打开多个编辑器窗口
• 标签页管理: 可以在多个打开的文件间切换
• 实时编辑: 内容实时保存，防止意外丢失
• 字数统计: 实时显示行数、单词数、字符数
• 未保存提示: 自动检测未保存的修改并提示

📁 文件管理

• 侧边栏文件树: 显示所有保存的文件
• 文件信息: 显示修改时间和文件大小
• 快速打开: 双击文件即可打开编辑
• 文件删除: 右键删除不需要的文件，或通过侧边栏按钮删除选中项目
• 文件类型支持: 支持.txt和.md文件
• 文件夹支持: 支持创建和管理文件夹，可将文件组织在不同目录中
• 忽略规则: 可配置忽略特定文件和文件夹（如 .git, node_modules），不显示在文件树中
• 自动保存: 支持多种自动保存模式，可配置延迟时间

⌨️ 快捷键支持

🎛️ 界面说明

侧边栏面板

HIDDEN WRITER
├── 📝 Open Editor (打开编辑器按钮)
├── 📄 New File (新建文件按钮)  
├── 📁 New Folder (新建文件夹按钮)
├── 🗑️ Delete Selected (删除选中项目按钮)
├── 🔄 Refresh (刷新文件列表)
└── 📁 文件列表
    ├── Documents/ (文件夹)
    │   ├── note-2024-01-01.txt
    │   └── diary.md
    ├── Personal/
    │   └── thoughts.txt
    └── ideas.txt

编辑器界面

┌─ Hidden Writer - filename.txt ───────────────────┐
│  📄 New    📁 Open    💾 Save                   │
├──────────────────────────────────────────────────┤
│ [标签页区域]                                      │
│ ┌─────────┐ ┌─────────┐ ┌─────────┐              │
│ │Untitled*│ │file1.txt│ │file2.md │              │
│ └─────────┘ └─────────┘ └─────────┘              │
├──────────────────────────────────────────────────┤
│                                                  │
│  [编辑区域]                                       │
│  在这里输入你的文字内容...                         │
│                                                  │
│                                                  │
├──────────────────────────────────────────────────┤
│ Ready                    Lines: 5 | Words: 20    │
└──────────────────────────────────────────────────┘

📂 文件存储

默认存储位置

• Windows: C:\Users\{username}\.hidden-writer\
• macOS: /Users/{username}/.hidden-writer/
• Linux: /home/{username}/.hidden-writer/

支持的文件格式

• .txt - 纯文本文件
• .md - Markdown文件

文件命名建议

note-2024-01-01.txt          # 日期格式笔记
diary-work.md                # 工作日记
thoughts-morning.txt         # 想法记录
meeting-notes-20240101.md    # 会议记录

⚙️ 配置选项

在VSCode设置中搜索 "hiddenWriter"：

hiddenWriter.workspaceFolder

• 类型: 字符串
• 默认值: ~/.hidden-writer
• 说明: 文件保存的根目录路径

hiddenWriter.opacity

• 类型: 数字 (0.05-1)
• 默认值: 0.1
• 说明: 编辑器背景透明度，数值越小越透明（适用于隐蔽模式）

hiddenWriter.autoSave

• 类型: 字符串
• 枚举值: "off"（关闭）, "afterDelay"（延迟保存）, "onFocusChange"（失去焦点时保存）, "onWindowChange"（窗口切换时保存）
• 默认值: "off"
• 说明: 控制自动保存功能

hiddenWriter.autoSaveDelay

• 类型: 数字
• 默认值: 1000
• 范围: 100-10000
• 说明: 延迟自动保存的时间（毫秒），当autoSave设置为"afterDelay"时生效

hiddenWriter.ignoreItems

• 类型: 数组
• 默认值: [".git", ".svn", ".hg", "node_modules", ".DS_Store", "Thumbs.db"]
• 说明: 需要在文件树和文件操作中忽略的文件和文件夹名称列表
• 用途: 控制哪些文件和文件夹不应在文件树中显示或参与文件操作
• 示例:

  {
    "hiddenWriter.ignoreItems": [".git", "node_modules", "dist", "temp"]
  }
  

修改配置示例

{
    "hiddenWriter.workspaceFolder": "D:/MyNotes",
    "hiddenWriter.opacity": 0.2,
    "hiddenWriter.autoSave": "afterDelay",
    "hiddenWriter.autoSaveDelay": 2000,
    "hiddenWriter.ignoreItems": [".git", "node_modules", "dist", "temp"]
}

🔧 使用技巧

1. 隐蔽写作

• 将编辑器放在下方面板，看起来像终端输出
• 调整透明度，融入背景
• 使用快捷键快速切换

2. 文件组织

.hidden-writer/
├── daily/
│   ├── 2024-01-01.md
│   └── 2024-01-02.md
├── projects/
│   ├── novel-chapter1.txt
│   └── blog-draft.md
└── temp/
    └── quick-notes.txt

3. 高效写作

• 利用实时字数统计控制篇幅
• 启用自动保存功能避免内容丢失
• 使用文件夹组织不同类型的文档
• 定期使用 Ctrl+Shift+S 保存避免丢失
• 使用多窗口功能同时编辑多个文件

4. 快速操作

• 双击侧边栏文件快速打开
• 利用文件列表按修改时间排序找到最新文件
• 使用标签页在多个文件间快速切换
• 选中文件或文件夹后点击删除按钮快速删除

🚨 注意事项

使用建议

1. 合规使用: 确保符合公司/组织的计算机使用政策
2. 数据安全: 不要存储敏感或机密信息
3. 定期备份: 重要内容建议额外备份
4. 合理使用: 不要影响正常工作效率

故障排除

插件无法激活

• 检查VSCode版本是否 ≥ 1.104.0
• 确认TypeScript编译是否成功
• 查看开发者工具控制台错误信息

侧边栏不显示

• 重启VSCode扩展开发窗口
• 检查 package.json 中的视图配置
• 确认命令是否正确注册

文件保存失败

• 检查文件路径权限
• 确认磁盘空间充足
• 验证文件名是否包含特殊字符

编辑器无法打开

• 尝试重新编译：npm run compile
• 检查webview相关代码是否正确
• 查看扩展主机输出日志

📊 开发信息

技术架构

┌─ VSCode Extension API ─────────────────┐
│  ├─ TreeView (侧边栏文件管理)          │
│  ├─ WebviewPanel (编辑器界面)          │
│  ├─ Commands (命令系统)                │
│  └─ File System (文件操作)             │
└────────────────────────────────────────┘

项目结构

src/
├── extension.ts          # 主入口文件
├── models/
│   └── FileItem.ts       # 文件项模型
├── providers/
│   ├── HiddenWriterTreeProvider.ts  # 文件树提供器
│   └── HiddenWriterEditorProvider.ts # 编辑器提供器
└── utils/
    ├── WebViewHtmlGenerator.ts  # Webview HTML生成器
    ├── FileOperations.ts        # 文件操作工具
    └── WindowManager.ts         # 窗口管理工具

版本历史

• v0.0.1: 初始版本

  • 基础文件管理功能
  • 侧边栏集成
  • 编辑器面板
  • 快捷键支持
  • 多窗口支持
  • 标签页管理

• v0.0.2: 功能增强版本

  • 文件夹支持：可创建和管理文件夹，支持层次化文件结构
  • 自动保存：支持多种自动保存模式，可配置延迟时间
  • 删除功能增强：支持右键菜单和侧边栏按钮删除文件/文件夹
  • 选中删除：可通过选中文件或文件夹后点击删除按钮进行删除

• v0.0.3

  • UI修改
  • 打开命令逻辑修复
  • 中文字词统计
  • 文件夹多级展开
  • 新增文件过滤功能

💡 后续开发计划

即将添加的功能

• [x] 文件夹支持
• [ ] 隐藏状态
• [x] 打开功能优化（文件夹）
• [ ] 自动保存多模式待完善TODO
• [x] 精确字词统计
• [ ] 搜索功能
• [ ] 主题切换
• [ ] 导出功能
• [ ] 云同步选项
• [ ] 加密存储

改进建议

如有使用问题或功能建议，请提交Issue！