Skip to content
| Marketplace
Sign in
Visual Studio Code>Snippets>提测Wiki生成器New to Visual Studio Code? Get it now.
提测Wiki生成器

提测Wiki生成器

five

|
3 installs
| (0) | Free
帮助快速生成项目需求提测wiki模板的VSCode插件
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

提测Wiki生成器

一个帮助快速生成项目需求提测wiki模板的VSCode插件。

功能特性

  • 🚀 快速生成提测wiki模板
  • 🎯 智能自动获取项目信息
    • 📂 自动获取项目名称(从package.json或文件夹名)
    • 🔗 自动获取Git仓库URL(从remote origin)
    • 🌿 自动获取当前git分支名
    • 📝 自动获取最新commit信息
  • ⚙️ 支持自定义配置项目信息
  • ⌨️ 支持快捷键操作 (Cmd+Alt+W / Ctrl+Alt+W)
  • 📋 一键复制到剪贴板,保持完整格式
  • ✏️ 多行编辑器界面,支持实时预览和编辑

安装方法

  1. 在VSCode中,按 Ctrl+Shift+X (Mac: Cmd+Shift+X) 打开扩展面板
  2. 搜索 "提测Wiki生成器"
  3. 点击安装

或者

  1. 下载 .vsix 文件
  2. 在VSCode中按 Ctrl+Shift+P (Mac: Cmd+Shift+P) 打开命令面板
  3. 输入 "Install from VSIX" 并选择下载的文件

使用方法

方法1:使用快捷键

  • Windows/Linux: Ctrl+Alt+W
  • Mac: Cmd+Alt+W

方法2:使用命令面板

  1. 按 Ctrl+Shift+P (Mac: Cmd+Shift+P) 打开命令面板
  2. 输入 "生成提测Wiki模板"
  3. 按回车执行

🎯 完全自动化模式

插件现在支持完全自动化使用!当你在任何项目中使用时,会自动:

  • 📂 项目名称: 直接使用VSCode工作区名称
  • 🔗 项目URL: 从 git remote get-url origin 获取当前仓库地址
  • 🌿 分支名: 从 git branch --show-current 获取当前分支
  • 📝 更新内容: 从 git log -1 获取最新提交信息
  • 👤 前端开发人员: 从 git config user.name 获取当前git用户名

无需任何配置,开箱即用!

配置选项

在VSCode设置中搜索 "wikiGenerator" 可以配置以下选项:

配置项 说明 默认值
wikiGenerator.defaultResponsiblePerson 默认负责人 吴铝
wikiGenerator.defaultTester 默认测试人员 周小芳
wikiGenerator.defaultEnvironment 默认测试环境 联团 老生产

💡 注意: 项目名称、项目URL和前端开发人员现在完全自动获取,无需配置。

如何配置

  1. 打开VSCode设置 (Ctrl+, 或 Cmd+,)
  2. 搜索 "wikiGenerator"
  3. 修改相应的配置项
  4. 配置会自动保存

或者在工作区的 .vscode/settings.json 文件中添加:

{
  "wikiGenerator.defaultResponsiblePerson": "你的名字",
  "wikiGenerator.defaultTester": "测试人员名字",
  "wikiGenerator.defaultEnvironment": "测试环境"
}

生成的模板格式

1、[vscode-wiki-generator](https://github.com/five/vscode-wiki-generator) **!!#ff0000 更新服务!!**
- 负责人:吴铝
- 开发人员:
	- 前端:five
- 内容:feat: 添加自动获取项目信息功能
- 代码分支名:feature/auto-project-info
- 影响范围:*!!#ff0000 编写本次提测涉及改动点帮助测试精准测试和评估风险*!!
- 测试人员:周小芳
- 环境: 联团 老生产

✨ 示例说明: 以上是在本插件项目中生成的真实示例,项目名、仓库URL、分支名和commit信息都是自动获取的!

💫 工作流程

  1. 按快捷键 Cmd+Alt+W (Mac) 或 Ctrl+Alt+W (Windows/Linux)
  2. 自动分析: 插件自动分析当前项目并获取信息
  3. 打开编辑器: 在右侧打开新标签页显示生成的模板
  4. 预览编辑: 在编辑器中查看和修改模板内容
  5. 确认复制: 点击"确认并复制"将模板复制到剪贴板
  6. 随处粘贴: 在任何地方粘贴,格式完美保留

🎨 智能功能详解

🔍 完全自动识别

  • 项目名称: 直接使用VSCode工作区名称
  • 仓库地址: 自动执行 git remote get-url origin 获取远程仓库地址
  • 分支信息: 自动执行 git branch --show-current 获取当前分支名
  • 提交信息: 自动执行 git log -1 --pretty=format:"%s" 获取最新提交标题
  • 开发人员: 自动执行 git config user.name 获取当前git用户名

✏️ 多行编辑器

  • 语法高亮: 使用Markdown语法高亮显示模板
  • 实时编辑: 支持多行编辑,完整保留格式
  • 并排显示: 在右侧打开编辑器,不影响当前工作

📋 智能复制

  • 保留格式: 复制时完整保留所有换行符和格式
  • 零手动调整: 粘贴后无需手动处理格式问题
  • 跨平台兼容: 在任何应用中粘贴都能保持格式

开发和调试

如果你想修改或调试这个插件:

  1. 克隆项目到本地
  2. 在VSCode中打开项目文件夹
  3. 按 F5 启动调试模式
  4. 在新打开的扩展开发主机窗口中测试插件

构建和打包

# 安装依赖
npm install

# 安装vsce(如果还没有安装)
npm install -g vsce

# 打包成vsix文件
vsce package

问题反馈

如果在使用过程中遇到问题,请:

  1. 检查VSCode输出面板的错误信息
  2. 确保当前工作区是一个git仓库(用于获取分支名)
  3. 检查插件配置是否正确

📝 更新日志

v1.1.2 - 2025年9月23日

  • 🎯 完全自动化升级
    • 📂 项目名称直接使用VSCode工作区名称,无需配置
    • 👤 前端开发人员直接使用git用户名,无需配置
    • 🔗 项目URL直接使用git remote origin,无需配置
    • 🚀 真正的零配置体验,开箱即用
  • 🧹 简化配置
    • 移除项目名称、项目URL、前端开发人员配置项
    • 保留负责人、测试人员、环境配置项
    • 优化代码逻辑,提升执行效率

v1.1.1 - 2025年9月23日

  • 📚 更新README文档,添加详细功能说明
  • 📦 优化包大小和内容

v1.1.0 - 2025年9月23日

  • 🎯 新增智能自动获取功能
    • 📂 自动获取项目名称(从package.json或文件夹名)
    • 🔗 自动获取Git仓库URL(从remote origin)
    • 📝 自动获取最新commit信息作为更新内容
    • 👤 新增前端开发人员配置项
  • 🚀 优化用户体验
    • 📋 改为复制到剪贴板模式,保持完整格式
    • ✏️ 使用多行编辑器界面,支持Markdown语法高亮
    • ⌨️ 修复快捷键冲突,改为 Cmd+Alt+W / Ctrl+Alt+W
  • 🐛 问题修复
    • 修复VSCode版本兼容性问题
    • 优化错误处理和回退机制

v1.0.1 - 2025年9月23日

  • 🐛 修复VSCode版本兼容性问题
  • 📦 添加MIT许可证

v1.0.0 - 2025年9月23日

  • ✨ 首次发布
  • 🚀 支持快速生成提测wiki模板
  • ⚙️ 支持自定义配置
  • 🌿 自动获取git分支名
  • ⌨️ 支持快捷键操作

许可证

MIT License

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft