logo
0
0
WeChat Login
docs(readme): 删除环境适配章节并更新仓库URL

🔨 HWXT 自动构建插件

VSCode Node License

一键触发 hamsos 和 lams 项目构建的 VSCode 插件

解决浏览器跨域限制 | 支持可配置 API | 实时日志监控


✨ 核心功能

功能说明支持项目
🚀 一键构建快捷键快速启动构建流程hamsos (ZIP) / lams (WAR)
🌐 跨域解决解决浏览器 API 调用跨域限制全部
⚙️ 灵活配置API 地址和 Token 可自定义全部
📈 实时日志VSCode 输出面板显示详细日志全部
📅 构建历史保存最近20条构建记录,数据持久化全部
状态监控实时显示构建状态和进度全部
📧 邮件通知构建完成自动邮件通知全部
🎨 友好界面简洁美观的 WebView 操作界面全部

🚀 快速开始

💾 安装插件

  1. 从 VSIX 安装(推荐)

    • 下载最新的 .vsix 文件
    • VSCode 中按 Ctrl+Shift+P
    • 输入 Extensions: Install from VSIX
    • 选择下载的 .vsix 文件
  2. 从源码安装

    git clone https://cnb.cool/zrz2025/hwxt_build_vs_plugin.git cd hwxt-build npm install # 按 F5 启动调试模式

📖 使用指南

🎯 启动方式

方式操作说明
快捷键Alt+Z Alt+Z⭐ 推荐方式,快速启动
命令面板Ctrl+Shift+PHWXT: 打开构建面板通过命令面板启动
编辑器按钮文件编辑器右上角工具栏JS/TS/JSON 文件可见

📋 操作步骤

1️⃣ 启动插件

Alt+Z Alt+Z 或通过命令面板打开构建面板

2️⃣ 配置 API

  • API Token:填写访问令牌(必填)
  • API 地址:默认已配置,可根据环境调整

3️⃣ 选择项目

  • hamsos:构建 ZIP 安装包
  • lams:构建 WAR 部署包

4️⃣ 填写参数

  • 分支名称:如 maindevelop
  • 邮箱地址:接收构建结果通知

5️⃣ 开始构建

点击「开始构建」按钮,系统自动处理,50秒后开始轮询构建结果

6️⃣ 查看构建历史

  • 插件会自动保存最近20条构建记录
  • 显示构建状态:构建中、成功、失败、超时
  • 成功构建可一键复制下载地址
  • 支持删除单条记录或清空所有历史

7️⃣ 查看日志

在 VSCode 输出面板监控构建进度和结果

👍 构建历史管理

插件提供完善的构建历史管理功能:

📅 历史记录显示

  • 自动保存:最夐20条构建记录,超出自动删除最旧记录
  • 状态显示:构建中🔵 | 成功✅ | 失败❌ | 超时⚠️
  • 详细信息:项目类型、分支名称、开始时间、完成时间

📎 快捷操作

  • 一键复制:成功构建可直接复制下载地址到剪贴板
  • 删除记录:支持删除单条记录或清空所有历史
  • 有效期提醒:构建产物12小时有效期提示

💾 数据持久化

  • 自动存储:利用VSCode全局状态,重启后自动加载
  • 无缝体验:关闭插件重新打开,历史记录依然存在

🔍 构建状态说明

状态显示描述
构建中🔵构建请求已发送,等待轮询结果
成功构建完成,可下载构建产物
失败构建过程出错,请查看日志获取详情
超时⚠️轮询5分钟后仍未完成,请手动检查

⚙️ 配置说明

🔑 API 配置

配置项类型必填说明
API Tokenstring构建服务访问令牌
API 地址string构建服务接口地址

💡 提示:Token 在会话期间会被保持,API 地址支持不同环境切换

📝 构建参数

参数hamsoslams说明
分支名称Git 分支,如 maindevelop
邮箱地址接收构建完成通知
构建类型ZIP 包WAR 包自动根据项目选择

🛠️ 故障排除

❓ 常见问题

🌐 跨域错误

插件专门设计来解决跨域问题,如果仍遇到跨域错误:

  • 检查网络连接
  • 确认防火墙设置
  • 验证 API 地址是否正确
🔑 Token 无效
  • 确认 Token 格式正确
  • 检查 Token 是否已过期
  • 查看输出日志获取详细错误信息
🌍 网络连接失败
  • 检查网络连接状态
  • 确认防火墙和代理设置
  • 尝试使用其他网络环境
⚠️ 构建失败
  • 查看 VSCode 输出面板详细日志
  • 确认分支名称和邮箱格式
  • 检查构建服务状态

📊 日志查看

位置用途访问方式
输出面板详细构建日志VSCode → 输出 → "HWXT 构建插件"
命令面板快速打开日志Ctrl+Shift+P → "HWXT: 打开输出日志"

🤝 支持与反馈


Made with ❤️ by HWXT Team

⭐ Star | 🐛 Report Bug | 💡 Request Feature