# bwf-board **Repository Path**: being_xyk/bwf-board ## Basic Information - **Project Name**: bwf-board - **Description**: 我的研发工作流 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2026-07-02 - **Last Updated**: 2026-10-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # bwf-board BWorkflow 的 dogfood 项目:一个 Windows 桌面看板,读取任意项目根目录下的 `.b_workflow/`(`state.yaml` + `reports/*.md`),把交付流程的阶段、门禁状态、阻塞项可视化出来。 ## 下载 `Publish/` 归档了当前版本的便携版 exe(`bwf-board X.Y.Z.exe`,当前 2.0.0),双击即用,无需安装。NSIS 安装包在打包时产出于 `SourceCode/dist/`,不入 git。 ## 界面概览(2.0.0 起) 深色工具风,信息按层级递进,首屏只呈现决策所需信息: - **topbar**:项目名、模式、工程路径 + 选择目录/刷新。 - **状态条**:当前阶段(含 gate 类型)、下一步动作、待人工确认数、门禁失败数。 - **阻塞横幅**:有阻塞才出现(机器/人判 chip 并列),无阻塞不占空间。 - **交付阶段**:主轴阶段流(卡片含 `M`/`H` 双进度徽标与状态顶条)+ 轴外 S6 变更循环入口(含活跃 proposal)。 - **阶段详情**:点击阶段卡片展开,分栏呈现机器门禁、人判项、result 明细、Agent 通知(notice 只读列表)。 - **后台监测**:主进程定时比对状态语义指纹,检测到变化时弹出 Windows 系统通知并自动刷新界面;窗口隐藏到托盘期间持续监测。 ## 快速开始 ```bash cd SourceCode npm install npm start ``` > `npm install` 之后需要确保 `node_modules/electron/dist/electron.exe` 是真实二进制(约 169MB)。若缺失或是占位符,将仓库自带的 `Document/research/electron-v30.5.1-win32-x64.zip` 解压到 `node_modules/electron/dist/`。 ## 常用命令 所有应用命令都在 `SourceCode/` 下执行: ```bash npm start # 开发模式启动 Electron npm test # 运行 Node 测试套件(node --test) node --test test/core/report-parser.test.js # 运行单个测试文件 npm run lint # ESLint 检查 src/ npm run build # 静态构建门禁:语法检查 + 资产完整性 npm run smoke # 启动应用约 1.5s 后自动退出(S5 机器门禁) npm run dist # 用 electron-builder 生成安装包和便携版 ``` ## 打包分发 需要 PowerShell 7: ```bash cd SourceCode pwsh.exe -NoProfile -ExecutionPolicy Bypass -File scripts/package.ps1 ``` 脚本会执行 `npm run build`、`npm run dist`,并校验 `dist/*Setup*.exe` 与便携版 `dist/*.exe` 是否存在。 > 离线打包说明:`npm run dist` 复用 electron-builder 本地缓存(`%LOCALAPPDATA%\electron-builder\Cache` 下的 nsis 与 winCodeSign)与本地 `electronDist`,构建过程本身不联网;但**全新机器首次打包需联网拉取一次该缓存**,之后即可离线打包。 ## 常见问题 - **`npm start` / `npm run smoke` 报 `Cannot read properties of undefined (reading 'whenReady')`**:先确认 `node_modules/electron/dist/electron.exe` 是真实二进制(约 169MB),不是则按上面的说明解压离线 zip;若二进制正常仍报错,是当前 shell 设了 `ELECTRON_RUN_AS_NODE` 环境变量(会导致 electron 以纯 node 模式启动),取消该变量后重试。 ## 项目结构 ```text SourceCode/ ├── scripts/ # 启动器、构建门禁、打包脚本 ├── src/ │ ├── core/ # 读取与解析 .b_workflow/,组装 ProjectState │ ├── main/ # Electron 主进程:窗口、托盘、IPC │ ├── preload/ # 渲染进程安全桥接 │ └── renderer/ # 纯 HTML/CSS/JS 前端,无框架无 bundler ├── test/ # Node 测试 ├── package.json └── electron-builder.yml ``` ## BWorkflow 流程 本项目使用 BWorkflow 交付流程。查看状态(`bwf.js` 相对 cwd 解析路径,**必须在仓库根目录执行**): ```bash node .b_workflow/bin/bwf.js status ``` 阶段报告在 `.b_workflow/reports/`,设计文档在 `Document/`,spike 验证产物(可丢弃代码 + 原始结论)在 `spike/`。完整的仓库约定见 `AGENTS.md`。 ## 关键设计约束 - **只读观察**:bwf-board 不写入被观察项目的 `.b_workflow/` 文件。 - **渲染进程无 Node 权限**:`contextIsolation: true`、`nodeIntegration: false`、`sandbox: true`。 - **无前端框架**:renderer 使用全局命名空间 `window.BWF.*` 和返回 HTML 字符串的组件函数。