飞书云文档助手

在 Cursor/VS Code 中直接读取和编辑飞书云文档的扩展插件。

✨ 功能特性

• 📖 读取飞书文档 - 直接在编辑器中打开飞书文档
• ✍️ 编辑飞书文档 - 将编辑器内容同步到飞书文档
• 🔄 自动同步 - 保存时自动同步到飞书（可选）
• 🆕 创建文档 - 在飞书创建新文档
• 🔗 URL支持 - 支持直接粘贴飞书文档URL
• 📝 Markdown格式 - 支持Markdown格式转换

📦 安装

方式一：从应用市场安装

1. 打开 Cursor/VS Code
2. 进入扩展商店（Extensions）
3. 搜索 "飞书云文档助手" 或 "Feishu Docs"
4. 点击安装

方式二：从源码安装

# 克隆仓库
git clone <repository-url>
cd cursor-feishu-docs

# 安装依赖
npm install

# 编译
npm run compile

# 打包
npm run package

# 安装 .vsix 文件
code --install-extension feishu-docs-1.0.0.vsix

🚀 快速开始

1. 设置 Access Token

首次使用需要配置飞书的 User Access Token：

1. 打开命令面板（Cmd+Shift+P 或 Ctrl+Shift+P）
2. 输入 飞书: 设置 Access Token
3. 输入你的 User Access Token

如何获取 Token？

• 可以使用飞书开放平台应用获取
• 或者使用飞书小组件中的授权功能获取

2. 读取文档

方式一：使用命令

1. 打开命令面板
2. 输入 飞书: 读取文档
3. 输入文档 Token（如：doxcnxxxxxxxxxxxxxx）

方式二：使用 URL

1. 打开命令面板
2. 输入 飞书: 打开文档
3. 粘贴完整的飞书文档 URL

3. 编辑文档

1. 在编辑器中修改文档内容
2. 打开命令面板
3. 输入 飞书: 写入文档
4. 输入目标文档 Token

4. 同步文档

1. 在编辑器中打开已关联的文档
2. 右键菜单选择 飞书: 同步当前文档
3. 或保存时自动同步（需开启自动同步功能）

⚙️ 配置选项

在设置中搜索 "feishu" 可以看到以下配置：

feishu-docs.accessToken

• 类型: string
• 默认值: ""
• 说明: 飞书 User Access Token

feishu-docs.autoSync

• 类型: boolean
• 默认值: false
• 说明: 是否在保存时自动同步到飞书文档

feishu-docs.syncInterval

• 类型: number
• 默认值: 60
• 说明: 自动同步间隔（秒）

📝 支持的命令

📖 使用示例

示例1：读取飞书文档

1. Cmd+Shift+P 打开命令面板
2. 输入 "飞书: 读取文档"
3. 输入文档Token: doxcnxxxxxxxxxxxxxx
4. 文档内容会在新标签页打开

示例2：编辑并同步

1. 在编辑器中编辑文档
2. Cmd+Shift+P 打开命令面板
3. 输入 "飞书: 同步当前文档"
4. 输入文档Token
5. 内容自动同步到飞书

示例3：使用URL打开

1. 复制飞书文档URL: https://xxx.feishu.cn/docx/doxcnxxxxxx
2. Cmd+Shift+P 打开命令面板
3. 输入 "飞书: 打开文档"
4. 粘贴URL
5. 文档自动打开

🔍 Markdown 支持

插件支持以下 Markdown 语法：

• ✅ 标题（H1-H3）
• ✅ 无序列表
• ✅ 有序列表
• ✅ 代码块
• ✅ 引用
• ✅ 分割线
• ✅ 普通文本

示例：

# 这是一级标题

## 这是二级标题

- 无序列表项1
- 无序列表项2

1. 有序列表项1
2. 有序列表项2

```javascript
console.log('代码块');

这是引用

## 🔐 安全说明

### Token 安全
- Token 存储在 VS Code 的配置中
- Token 不会上传到任何服务器
- 建议定期更新 Token

### 权限要求
确保你的 Token 具有以下权限：
- `docx:document` - 编辑文档
- `docx:document:readonly` - 读取文档

## 🐛 故障排查

### 问题1：Token 无效

**症状**: 提示 "请先设置 Access Token"

**解决方案**:
1. 运行 `飞书: 设置 Access Token` 命令
2. 输入有效的 User Access Token
3. 确保 Token 有相应的权限

### 问题2：读取失败

**症状**: 提示 "读取文档失败"

**检查清单**:
- ✅ Token 是否正确
- ✅ 文档 Token 是否正确
- ✅ 是否有文档访问权限
- ✅ 网络连接是否正常

### 问题3：写入失败

**症状**: 提示 "写入文档失败"

**检查清单**:
- ✅ 是否有文档编辑权限
- ✅ 文档是否被锁定
- ✅ Token 是否过期

## 📚 相关文档

- [飞书开放平台](https://open.feishu.cn/)
- [云文档 API](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx)
- [授权说明](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)

## 🤝 贡献

欢迎提交 Issue 和 Pull Request！

## 📄 许可证

MIT License

## 👥 作者

Cool Ye

## 🔄 更新日志

### v1.0.0 (2025-10-10)
- ✨ 初始版本发布
- ✅ 支持读取飞书文档
- ✅ 支持编辑飞书文档
- ✅ 支持创建新文档
- ✅ 支持自动同步
- ✅ 支持 Markdown 格式

---

**享受在 Cursor 中使用飞书文档吧！** 🎉