Skip to content

feat(win): add one-click dev/build scripts and porting design doc#42

Open
feibang191 wants to merge 1 commit into
freestylefly:mainfrom
feibang191:feat/windows-dev-scripts
Open

feat(win): add one-click dev/build scripts and porting design doc#42
feibang191 wants to merge 1 commit into
freestylefly:mainfrom
feibang191:feat/windows-dev-scripts

Conversation

@feibang191
Copy link
Copy Markdown
Contributor

PR: feat(win): add one-click dev/build scripts and porting design doc

Summary

Add Windows developer experience tooling to make it easy for Windows contributors to set up, develop, and build WeSight.

Changes

New files

File Purpose
scripts/windows-dev-quickstart.ps1 One-command dev loop launcher for Windows
scripts/windows-dist-quickstart.ps1 One-command NSIS installer builder for Windows
docs/windows-port-design-2026-06-04.md Design document for the Windows porting effort

scripts/windows-dev-quickstart.ps1 (101 lines)

Single PowerShell command to bring up the dev loop on a clean Windows machine:

  • Validates Node >= 24, npm, and optionally bash
  • Runs npm install if node_modules is absent
  • Launches npm run electron:dev with Vite dev server on port 5175
  • Documents VS Build Tools 2022 prerequisite for native module compilation

scripts/windows-dist-quickstart.ps1 (168 lines)

Single PowerShell command to produce the NSIS installer:

  • 9-step pipeline: npm install → mingit bash → OpenClaw runtime → Python runtime → Vite build → skill builds → TypeScript compile → electron-builder NSIS → smoke test
  • Supports --SkipRuntime, --SkipPython, --NoSmokeTest flags
  • Mirrors the package.json dist:win pipeline with optional hooks

docs/windows-port-design-2026-06-04.md (184 lines)

Design document covering:

  • 5 porting principles (platform parity, zero regression, etc.)
  • Key engineering decisions in src/main/libs
  • Test matrix showing Windows x64 passing all stages (dev/pack/install/first-run)
  • Commit and PR guidance for the Windows platform support

Testing

  • windows-dev-quickstart.ps1 verified on Windows 11 x64 with Node 24.16
  • windows-dist-quickstart.ps1 verified on Windows 11 x64, produces 294 MB NSIS installer
  • Design doc reviewed for accuracy against the implementation

Notes

  • No source code changes in this PR — scripts and docs only
  • Follow-up PR will add the core Windows platform support code
  • Both scripts are PowerShell-native (no bash dependency)

Add Windows developer experience tooling:

scripts/windows-dev-quickstart.ps1
  Single command to bring up the dev loop on a clean Windows machine.
  Verifies Node 24, runs npm install, then starts vite + electron.

scripts/windows-dist-quickstart.ps1
  Single command to produce the NSIS installer. Mirrors the package.json
  dist:win pipeline and adds optional smoke-test hooks.

docs/windows-port-design-2026-06-04.md
  Design document covering the 5 porting principles, key engineering
  decisions, test matrix, and commit/PR guidance for the Windows
  platform support.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant