项目查看器 (Project Viewer)
一个功能强大的 VS Code 扩展,用于查看和管理 Git 项目(支持 Gitee、GitHub、GitLab)。
功能特性
📁 项目管理
- 浏览项目文件结构
- 在线查看文件内容
- 下载单个文件
- 克隆项目到本地
🔧 便捷操作
- 设置访问令牌
- 切换默认分支
- 浏览用户项目
- 浏览个人项目
🎨 TODO 高亮
- 自动识别注释中的 TODO 标记
- 注释部分内容高亮显示
- 支持自定义背景色和前景色
- 支持多种关键词(TODO、FIXME、HACK、NOTE)
- 可配置关键词列表和大小写敏感
🎨 代码生成 (Generate)
- JSON 到 TypeScript 接口转换
- 智能分析 JSON 结构,自动生成 TypeScript 接口
- 支持复杂嵌套对象和数组
- 自动检测可选属性(在某些对象中不存在的属性添加
? )
- 支持混合类型属性的联合类型推导
- 为数组中的对象元素创建独立的接口定义
- 两种使用方式:
- 右键菜单 "Generate" → "JSON to TypeScript Interface" (可选择复制到剪切板或保存)
- 右键菜单 "Generate" → "JSON to TypeScript Interface (Save to File)" (直接保存到新文件)
安装
- 打开 VS Code
- 按
Ctrl+Shift+X 打开扩展面板
- 搜索 "项目查看器" 或 "Project Viewer"
- 点击安装
使用方法
1. 设置访问令牌
- 打开 VS Code 设置(
Ctrl+, 或 Cmd+, )
- 搜索 "gitProjectViewer.tokens"
- 分别为各平台设置令牌:
- Gitee 令牌:
gitProjectViewer.tokens.gitee
- GitHub 令牌:
gitProjectViewer.tokens.github
- GitLab 令牌:
gitProjectViewer.tokens.gitlab
2. 加载项目
- 点击"查看项目"
- 输入项目 URL 或路径(如:
owner/repo )
- 项目信息将显示在左侧面板
3. 浏览文件
- 在项目文件面板中浏览文件结构
- 点击文件名查看内容
- 右键文件可下载到本地
4. 克隆项目
- 加载项目后,点击项目文件面板的克隆按钮
- 选择克隆方式:
- VS Code 克隆(推荐)
- 终端克隆
- 复制 URL
配置
访问令牌获取
Gitee
- 登录 Gitee
- 进入 设置 → 私人令牌
- 生成新令牌,选择相应权限
GitHub
- 登录 GitHub
- 进入 Settings → Developer settings → Personal access tokens
- 生成新令牌
GitLab
- 登录 GitLab
- 进入 User Settings → Access Tokens
- 创建个人访问令牌
设置选项
Git 项目查看器
- 访问令牌: 用于访问私有项目和提高 API 限制(传统配置,建议使用单独的平台令牌配置)
- Gitee 令牌: Gitee (码云) 平台的独立访问令牌
- GitHub 令牌: GitHub 平台的独立访问令牌
- GitLab 令牌: GitLab 平台的独立访问令牌
- 默认分支: 设置默认查看的分支(如 master、main)
- Git 平台: 选择使用的 Git 平台
- 当前项目: 当前加载的项目路径
TODO 高亮
- 启用状态: 是否启用 TODO 注释高亮功能
- 背景颜色: TODO 注释的背景颜色(支持 HEX、RGB、颜色名称)
- 前景色: TODO 注释的文字颜色(默认白色)
- 透明度: 颜色的透明度(0.1-1.0)
- 透明背景: 是否使用透明背景(只显示前景色)
- 排除文件: 不进行高亮的文件模式列表(支持 glob 模式)
- 关键词列表: 需要高亮的关键词(默认:TODO、FIXME、HACK、NOTE)
- 大小写敏感: 关键词匹配是否区分大小写
故障排除
常见问题
Q: 无法加载项目文件?
A: 请检查访问令牌是否正确设置,以及项目路径格式是否正确。
Q: 克隆失败?
A: 确保本地已安装 Git,并且网络连接正常。
Q: 私有项目无法访问?
A: 请确保访问令牌具有相应的权限。
贡献
欢迎提交 Issue 和 Pull Request!
许可证
MIT License - 详见 LICENSE 文件
联系方式
| |