Enhance build scripts and documentation for cross-platform support with Ruff

- Updated `build-with-ruff.sh` to include Windows support, bundling Pyright only (no Ruff).
- Modified Node.js download logic to accommodate Windows platform.
- Improved cleanup process for both Windows and Unix builds.
- Enhanced README.md to clarify Ruff support for Linux/macOS and Pyright-only builds for Windows.
- Updated GitHub Actions workflow to build for all platforms, including Windows.

Author: MakanShabani

.github/workflows/build-with-ruff.yml

@@ -1,4 +1,4 @@
-name: Build with Ruff Support
+name: Build with Ruff Support (All Platforms)
 
 on:
   push:
@@ -12,6 +12,12 @@ env:
   NODE_VERSION: 'v20.11.0'
   RUFF_VERSION: '0.14.3'
 
+# This workflow builds for all platforms:
+# - Linux x64 with Ruff
+# - macOS x64 with Ruff
+# - macOS arm64 with Ruff  
+# - Windows x64 (Pyright only - no Ruff)
+
 jobs:
   linux:
     runs-on: ubuntu-latest
@@ -213,10 +219,101 @@ jobs:
         name: darwin-${{ matrix.arch }}
         path: output/darwin-${{ matrix.arch }}.tar.gz
 
+  windows:
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+    
+    - name: Install dependencies
+      run: npm install
+    
+    - name: Build for win32-x64 (Pyright only)
+      shell: bash
+      run: |
+        PLATFORM="win32-x64"
+        NODE_DOWNLOAD_ARCH="win-x64"
+        
+        mkdir -p output/${PLATFORM}
+        
+        # Bundle TypeScript with esbuild
+        npx esbuild index.ts \
+          --bundle \
+          --platform=node \
+          --target=node18 \
+          --format=esm \
+          --outfile=output/${PLATFORM}/bundle.js \
+          --external:ws \
+          --external:vscode-ws-jsonrpc \
+          --external:vscode-jsonrpc \
+          --external:dotenv
+        
+        # Download Node.js runtime (Windows uses 'win-x64' not 'win32-x64')
+        NODE_PKG="node-${NODE_VERSION}-${NODE_DOWNLOAD_ARCH}"
+        NODE_URL="https://nodejs.org/dist/${NODE_VERSION}/${NODE_PKG}.zip"
+        echo "Downloading: ${NODE_URL}"
+        curl -fsSL "${NODE_URL}" -o "${NODE_PKG}.zip"
+        unzip -q "${NODE_PKG}.zip" -d "output/${PLATFORM}/"
+        mv "output/${PLATFORM}/${NODE_PKG}" "output/${PLATFORM}/node"
+        rm -f "${NODE_PKG}.zip"
+        
+        # Strip unnecessary files from Node.js
+        cd output/${PLATFORM}/node
+        rm -rf lib/node_modules/npm lib/node_modules/corepack node_modules/npm node_modules/corepack
+        rm -f npm npm.cmd npx npx.cmd corepack corepack.cmd
+        rm -f README.md CHANGELOG.md LICENSE *.md
+        cd ../../..
+        
+        # Note: Ruff is NOT bundled for Windows builds
+        echo "Windows build: Pyright only (no Ruff bundling)"
+        
+        # Install production dependencies
+        cp package.json output/${PLATFORM}/
+        cd output/${PLATFORM}
+        npm install --production --no-optional
+        rm package-lock.json
+        echo '{"type":"module"}' > package.json
+        
+        # Prune unnecessary files from node_modules
+        find node_modules -type d -name "test" -exec rm -rf {} + 2>/dev/null || true
+        find node_modules -type d -name "tests" -exec rm -rf {} + 2>/dev/null || true
+        find node_modules -type d -name "docs" -exec rm -rf {} + 2>/dev/null || true
+        find node_modules -type f -name "*.md" -delete 2>/dev/null || true
+        find node_modules -type f -name "*.ts" ! -name "*.d.ts" -delete 2>/dev/null || true
+        find node_modules -type f -name "*.map" -delete 2>/dev/null || true
+        cd ../..
+        
+        # Copy config template
+        cp pyrightconfig.json output/${PLATFORM}/
+        
+        # Create start script (without RUFF_PATH)
+        cat > output/${PLATFORM}/start.bat << 'EOF'
+        @echo off
+        REM Pyright LSP WebSocket Bridge (Pyright only - no Ruff bundled)
+        REM Usage: start.bat --port <PORT> --bot-root <BOT_ROOT> --jesse-root <JESSE_ROOT>
+        
+        set DIR=%~dp0
+        "%DIR%node\node.exe" "%DIR%bundle.js" %*
+        EOF
+        
+        # Create compressed archive
+        cd output
+        powershell Compress-Archive -Path ${PLATFORM} -DestinationPath ${PLATFORM}.zip
+        cd ..
+    
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: win32-x64
+        path: output/win32-x64.zip
+
   release:
     name: Create GitHub Release
     runs-on: ubuntu-latest
-    needs: [linux, macos]
+    needs: [linux, macos, windows]
     if: startsWith(github.ref, 'refs/tags/v')
 
     steps:
@@ -236,34 +333,45 @@ jobs:
         body: |
           ## Pyright LSP Bridge with Ruff Formatting Support
           
-          This release includes Ruff formatter bundled with the language server.
+          This release includes Ruff formatter bundled with Unix builds (Linux/macOS).
           
           ### Platform Support
-          - ✅ Linux x64 with Ruff
-          - ✅ macOS Intel (x64) with Ruff
-          - ✅ macOS Apple Silicon (arm64) with Ruff
+          - ✅ **Linux x64** (~46 MB) - Includes Ruff formatter
+          - ✅ **macOS Intel (x64)** (~44 MB) - Includes Ruff formatter
+          - ✅ **macOS Apple Silicon (arm64)** (~44 MB) - Includes Ruff formatter
+          - ✅ **Windows x64** (~34 MB) - Pyright only (no Ruff)
+          
+          > **Note:** Ruff formatting is only bundled for Unix-based systems (Linux/macOS). Windows builds include Pyright language server capabilities only.
           
           ### Features
-          - Python language server (Pyright)
-          - Code formatting (Ruff)
-          - Cross-platform support
-          - Bundled Node.js runtime
+          - ✅ Python language server (Pyright) - All platforms
+          - ✅ Code formatting (Ruff) - Linux/macOS only
+          - ✅ Cross-platform support
+          - ✅ Bundled Node.js runtime
+          - ✅ WebSocket-based communication
           
           ### Installation
           
           **Linux:**
           ```bash
-          tar -xzf linux-x64-with-ruff.tar.gz
+          tar -xzf linux-x64.tar.gz
           cd linux-x64
           ./start.sh --port 9011 --bot-root /path/to/bot --jesse-root /path/to/jesse
           ```
           
           **macOS:**
           ```bash
-          tar -xzf darwin-arm64-with-ruff.tar.gz  # or darwin-x64-with-ruff.tar.gz
+          tar -xzf darwin-arm64.tar.gz  # or darwin-x64.tar.gz for Intel Macs
           cd darwin-arm64  # or darwin-x64
           ./start.sh --port 9011 --bot-root /path/to/bot --jesse-root /path/to/jesse
           ```
+          
+          **Windows:**
+          ```cmd
+          REM Extract win32-x64.zip
+          cd win32-x64
+          start.bat --port 9011 --bot-root C:\path\to\bot --jesse-root C:\path\to\jesse
+          ```
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

README.md

@@ -9,12 +9,14 @@ This repository delivers:
 - **Bundled Runtime** - Includes Node.js, eliminating system dependencies
 - **Cross-Platform Support** - Works on Linux, macOS, and Windows
 - **Optimized Builds** - ~70% size reduction with production-only dependencies
+- **Ruff Formatting** - Built-in Python code formatting (Linux/macOS only)
 
 ## Technology Stack
 
 - **TypeScript** - Main language for the bridge implementation
 - **Node.js** - Runtime environment
 - **Pyright** - Microsoft's static type checker for Python
+- **Ruff** - Fast Python linter and formatter (Unix builds only)
 - **WebSocket (ws)** - WebSocket communication
 - **vscode-ws-jsonrpc** - JSON-RPC over WebSocket
 - **esbuild** - Fast JavaScript bundler
@@ -41,20 +43,30 @@ npm start -- \
 
 ## Build
 
-### Single Platform (Linux x64)
+### Build with Ruff Support (Recommended)
 ```bash
-./build.sh
+./build-with-ruff.sh
 ```
-Output: `output/linux-x64.tar.gz` (~34 MB)
+This builds for all platforms with Ruff formatting support included in Linux/macOS builds:
+- `linux-x64.tar.gz` (~46 MB) - **Includes Ruff**
+- `darwin-x64.tar.gz` (~44 MB) - **Includes Ruff**
+- `darwin-arm64.tar.gz` (~44 MB) - **Includes Ruff**
+- `win32-x64.zip` (~34 MB) - Pyright only (no Ruff)
+
+**Note:** Ruff is only bundled for Unix-based systems (Linux/macOS). Windows builds include Pyright only.
 
-### All Platforms
+### Build without Ruff (Legacy)
 ```bash
+# Single platform (Linux x64 only)
+./build.sh
+
+# All platforms (no Ruff bundled)
 ./build-all.sh
 ```
 Outputs:
-- `linux-x64.tar.gz` / `linux-arm64.tar.gz`
-- `darwin-x64.tar.gz` / `darwin-arm64.tar.gz`
-- `win32-x64.zip`
+- `linux-x64.tar.gz` / `linux-arm64.tar.gz` (~34 MB each)
+- `darwin-x64.tar.gz` / `darwin-arm64.tar.gz` (~34 MB each)
+- `win32-x64.zip` (~34 MB)
 
 ## Deployment & Usage
 
@@ -92,6 +104,16 @@ The Pyright language server is configured via `pyrightconfig.json`. The bridge a
 - ✅ Production-ready dependencies only
 - ✅ WebSocket-based communication
 - ✅ Full Pyright LSP capabilities
+- ✅ Ruff code formatting (Linux/macOS builds)
+
+### Ruff Formatting Support
+
+Ruff is a fast Python linter and formatter written in Rust. When using builds from `build-with-ruff.sh`:
+
+- **Linux/macOS**: Ruff binary is bundled and intercepts LSP formatting requests
+- **Windows**: Pyright only (no Ruff bundling)
+
+Formatting is automatically handled when you trigger "Format Document" in your IDE. The bridge intercepts `textDocument/formatting` requests and processes them with Ruff for Unix-based systems.
 
 ## Architecture
 
@@ -107,10 +129,13 @@ Messages are translated between WebSocket and the Language Server Protocol, enab
 
 - `index.ts` - Entry point and CLI argument handling
 - `pyright-bridge.ts` - WebSocket bridge implementation
+- `formatting.ts` - Ruff formatting handler
 - `pyrightconfig.json` - Pyright configuration
 - `package.json` - Node.js project configuration
-- `build.sh` - Build script for Linux x64
-- `build-all.sh` - Build script for all platforms
+- `build.sh` - Build script for Linux x64 (no Ruff)
+- `build-all.sh` - Build script for all platforms (no Ruff)
+- `build-with-ruff.sh` - Build script with Ruff support (Linux/macOS/Windows)
+- `build-windows.sh` - Build script for Windows only (with Ruff)
 - `output/` - Build output directory (generated)
 
 ## License

build-with-ruff.sh

@@ -1,14 +1,16 @@
 #!/bin/bash
 
 # Build script with Ruff support for Linux and macOS
-# Downloads platform-specific Ruff binaries and bundles them
+# Windows build included but without Ruff (Pyright only)
+# Note: Ruff is only bundled for Unix-based systems (Linux/macOS)
 
 set -e
 
 NODE_VERSION="v20.11.0"
 RUFF_VERSION="0.14.3"
 
 # Function to get ruff download info for a platform
+# Returns empty string for Windows (no Ruff bundling)
 get_ruff_info() {
     local os=$1
     local arch=$2
@@ -27,6 +29,7 @@ get_ruff_info() {
             echo "ruff-aarch64-apple-darwin.tar.gz|ruff"
             ;;
         *)
+            # Windows and other platforms: no Ruff bundling
             echo ""
             ;;
     esac
@@ -46,6 +49,9 @@ build_platform() {
 
     # Get Node.js architecture name
     local node_arch="${os}-${arch}"
+    if [ "${os}" = "win32" ]; then
+        node_arch="win-${arch}"  # Node.js uses "win-x64" for Windows
+    fi
 
     # Step 1: Bundle TypeScript
     echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@@ -74,8 +80,14 @@ build_platform() {
     echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
 
     NODE_PKG="node-${NODE_VERSION}-${node_arch}"
-    NODE_URL="https://nodejs.org/dist/${NODE_VERSION}/${NODE_PKG}.tar.gz"
-    NODE_FILE="/tmp/${NODE_PKG}.tar.gz"
+    
+    if [ "${os}" = "win32" ]; then
+        NODE_URL="https://nodejs.org/dist/${NODE_VERSION}/${NODE_PKG}.zip"
+        NODE_FILE="/tmp/${NODE_PKG}.zip"
+    else
+        NODE_URL="https://nodejs.org/dist/${NODE_VERSION}/${NODE_PKG}.tar.gz"
+        NODE_FILE="/tmp/${NODE_PKG}.tar.gz"
+    fi
 
     if [ ! -f "${NODE_FILE}" ]; then
         curl -L "${NODE_URL}" -o "${NODE_FILE}" || {
@@ -87,20 +99,34 @@ build_platform() {
     fi
 
     echo "📂 Extracting Node.js..."
-    tar -xzf "${NODE_FILE}" -C /tmp/
+    if [ "${os}" = "win32" ]; then
+        unzip -q "${NODE_FILE}" -d /tmp/
+    else
+        tar -xzf "${NODE_FILE}" -C /tmp/
+    fi
     mv "/tmp/${NODE_PKG}" "output/${platform}/node"
 
     # Strip unnecessary files from Node.js
     echo "🧹 Stripping unnecessary files from Node.js..."
     cd "output/${platform}/node"
-    rm -rf lib/node_modules/npm 2>/dev/null || true
-    rm -rf lib/node_modules/corepack 2>/dev/null || true
-    rm -f bin/npm bin/npx bin/corepack 2>/dev/null || true
-    rm -rf share/doc share/man share/systemtap include 2>/dev/null || true
-    rm -f README.md CHANGELOG.md LICENSE *.md 2>/dev/null || true
 
-    if command -v strip &> /dev/null && [ "${os}" != "darwin" ]; then
-        strip bin/node 2>/dev/null || true
+    if [ "${os}" = "win32" ]; then
+        # Windows cleanup
+        rm -rf node_modules/npm 2>/dev/null || true
+        rm -rf node_modules/corepack 2>/dev/null || true
+        rm -f npm npm.cmd npx npx.cmd corepack corepack.cmd 2>/dev/null || true
+        rm -f *.md LICENSE 2>/dev/null || true
+    else
+        # Unix cleanup
+        rm -rf lib/node_modules/npm 2>/dev/null || true
+        rm -rf lib/node_modules/corepack 2>/dev/null || true
+        rm -f bin/npm bin/npx bin/corepack 2>/dev/null || true
+        rm -rf share/doc share/man share/systemtap include 2>/dev/null || true
+        rm -f README.md CHANGELOG.md LICENSE *.md 2>/dev/null || true
+        
+        if command -v strip &> /dev/null && [ "${os}" != "darwin" ]; then
+            strip bin/node 2>/dev/null || true
+        fi
     fi
 
     cd ../../..
@@ -177,8 +203,10 @@ build_platform() {
     if [ "${os}" = "win32" ]; then
         cat > "output/${platform}/start.bat" << 'EOF'
 @echo off
+REM Pyright LSP WebSocket Bridge (Pyright only - no Ruff bundled)
+REM Usage: start.bat --port <PORT> --bot-root <BOT_ROOT> --jesse-root <JESSE_ROOT>
+
 set DIR=%~dp0
-set RUFF_PATH=%DIR%bin\ruff.exe
 "%DIR%node\node.exe" "%DIR%bundle.js" %*
 EOF
         echo "✓ Created start.bat"
@@ -221,6 +249,7 @@ EOF
 # Main script
 echo "╔════════════════════════════════════════════════════════╗"
 echo "║  Building Pyright LSP with Ruff Support               ║"
+echo "║  (Ruff bundled for Linux/macOS only)                  ║"
 echo "╚════════════════════════════════════════════════════════╝"
 echo ""
 
@@ -232,8 +261,9 @@ echo ""
 
 # Build for specified platforms or all
 if [ $# -eq 0 ]; then
-    # Build for Linux and macOS by default
-    PLATFORMS=("linux:x64" "darwin:x64" "darwin:arm64")
+    # Build for Linux, macOS, and Windows by default
+    # Note: Ruff is only bundled for Linux and macOS
+    PLATFORMS=("linux:x64" "darwin:x64" "darwin:arm64" "win32:x64")
 else
     PLATFORMS=("$@")
 fi