Add Ruff formatter integration for Python code formatting support

MakanShabani · MakanShabani · commit 9282f85290e2 · 2025-11-05T23:28:32.000+03:30
- Implemented downloading and extraction of the Ruff binary in build scripts for Linux and macOS.
- Enhanced pyright-bridge.ts to handle formatting requests using Ruff, with support for Unix platforms only.
- Updated README.md to document the new formatting feature and its platform limitations.
- Introduced formatter.ts for managing Ruff execution and formatting logic.
diff --git a/.github/workflows/build-and-release.yml b/.github/workflows/build-and-release.yml
@@ -62,6 +62,61 @@ jobs:
         fi
         cd ../../..
         
+        # Download and extract Ruff binary
+        RUFF_VERSION="0.14.3"
+        RUFF_ARCHIVE=""
+        RUFF_SUBDIR=""
+        
+        case "${NODE_ARCH}" in
+            "linux-x64")
+                RUFF_ARCHIVE="ruff-x86_64-unknown-linux-gnu.tar.gz"
+                RUFF_SUBDIR="ruff-x86_64-unknown-linux-gnu"
+                ;;
+            "linux-arm64")
+                RUFF_ARCHIVE="ruff-aarch64-unknown-linux-gnu.tar.gz"
+                RUFF_SUBDIR="ruff-aarch64-unknown-linux-gnu"
+                ;;
+            *)
+                echo "⚠️  Warning: Unsupported platform for ruff, skipping..."
+                RUFF_ARCHIVE=""
+                ;;
+        esac
+        
+        if [ -n "${RUFF_ARCHIVE}" ]; then
+            RUFF_URL="https://github.com/astral-sh/ruff/releases/download/v${RUFF_VERSION}/${RUFF_ARCHIVE}"
+            RUFF_FILE="/tmp/${RUFF_ARCHIVE}"
+            RUFF_EXTRACT_DIR="/tmp/ruff-extract-${PLATFORM}"
+            
+            if [ ! -f "${RUFF_FILE}" ]; then
+                curl -L "${RUFF_URL}" -o "${RUFF_FILE}" || {
+                    echo "⚠️  Warning: Failed to download Ruff, formatting will not be available"
+                    RUFF_ARCHIVE=""
+                }
+            else
+                echo "✓ Using cached Ruff"
+            fi
+            
+            if [ -n "${RUFF_ARCHIVE}" ]; then
+                echo "📂 Extracting Ruff..."
+                mkdir -p "${RUFF_EXTRACT_DIR}"
+                tar -xzf "${RUFF_FILE}" -C "${RUFF_EXTRACT_DIR}"
+                mkdir -p "output/${PLATFORM}/bin"
+                
+                if [ -f "${RUFF_EXTRACT_DIR}/${RUFF_SUBDIR}/ruff" ]; then
+                    cp "${RUFF_EXTRACT_DIR}/${RUFF_SUBDIR}/ruff" "output/${PLATFORM}/bin/ruff"
+                    chmod +x "output/${PLATFORM}/bin/ruff"
+                    echo "✓ Ruff extracted to output/${PLATFORM}/bin/ruff"
+                else
+                    echo "⚠️  Warning: Ruff binary not found in archive at ${RUFF_EXTRACT_DIR}/${RUFF_SUBDIR}/ruff"
+                    ls -la "${RUFF_EXTRACT_DIR}/" || true
+                fi
+                
+                rm -rf "${RUFF_EXTRACT_DIR}" 2>/dev/null || true
+            fi
+        else
+            echo "⚠️  Skipping Ruff for unsupported platform"
+        fi
+        
         # Install production dependencies
         cp package.json output/${PLATFORM}/
         cd output/${PLATFORM}
@@ -96,6 +151,7 @@ jobs:
         cat > output/${PLATFORM}/start.sh << 'EOF'
         #!/bin/bash
         DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+        export PATH="${DIR}/bin:${PATH}"
         "${DIR}/node/bin/node" "${DIR}/bundle.js" "$@"
         EOF
         chmod +x output/${PLATFORM}/start.sh
diff --git a/README.md b/README.md
@@ -84,6 +84,15 @@ start.bat --port 9011 --bot-root C:\path\to\jesse-bot --jesse-root C:\path\to\je
 
 The Pyright language server is configured via `pyrightconfig.json`. The bridge automatically deploys this configuration file to the bot root directory specified by `--bot-root` on startup. You can customize type checking behavior, Python version, include/exclude patterns, and more.
 
+### Formatting Support
+
+The bridge includes Python code formatting using Ruff (bundled binary). **Formatting is only available on Unix platforms (Linux, macOS)**, not Windows.
+
+- **Unix (Linux/macOS)**: Formatting is automatically available via `textDocument/formatting` LSP requests
+- **Windows**: Formatting requests are not supported (will return "not supported")
+
+Ruff formatting options can be configured via `pyproject.toml` or `ruff.toml` in the project root.
+
 ## Features
 
 - ✅ Bundled Node.js runtime (no system dependencies)
@@ -92,6 +101,7 @@ The Pyright language server is configured via `pyrightconfig.json`. The bridge a
 - ✅ Production-ready dependencies only
 - ✅ WebSocket-based communication
 - ✅ Full Pyright LSP capabilities
+- ✅ Python code formatting with Ruff (Unix only: Linux, macOS)
 
 ## Architecture
 
@@ -107,10 +117,12 @@ 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
+- `formatter.ts` - Python code formatting with Ruff (Unix only)
 - `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-windows.sh` - Build script for Windows x64
 - `output/` - Build output directory (generated)
 
 ## License
diff --git a/build-all.sh b/build-all.sh
@@ -99,6 +99,78 @@ build_platform() {
     fi
     echo "✓ Node.js extracted"
     
+    # Step 2.5: Download and extract Ruff binary
+    echo "📥 Downloading Ruff formatter binary..."
+    
+    RUFF_VERSION="0.14.3"
+    local ruff_archive=""
+    local ruff_subdir=""
+    
+    case "${platform}" in
+        "linux-x64")
+            ruff_archive="ruff-x86_64-unknown-linux-gnu.tar.gz"
+            ruff_subdir="ruff-x86_64-unknown-linux-gnu"
+            ;;
+        "linux-arm64")
+            ruff_archive="ruff-aarch64-unknown-linux-gnu.tar.gz"
+            ruff_subdir="ruff-aarch64-unknown-linux-gnu"
+            ;;
+        "darwin-x64")
+            ruff_archive="ruff-x86_64-apple-darwin.tar.gz"
+            ruff_subdir="ruff-x86_64-apple-darwin"
+            ;;
+        "darwin-arm64")
+            ruff_archive="ruff-aarch64-apple-darwin.tar.gz"
+            ruff_subdir="ruff-aarch64-apple-darwin"
+            ;;
+        "win32-x64")
+            # Ruff formatter excluded from Windows builds (formatting only available on Unix)
+            ruff_archive=""
+            ;;
+        *)
+            echo "⚠️  Warning: Unsupported platform for ruff, skipping..."
+            ruff_archive=""
+            ;;
+    esac
+    
+    if [ -n "${ruff_archive}" ]; then
+        local ruff_url="https://github.com/astral-sh/ruff/releases/download/v${RUFF_VERSION}/${ruff_archive}"
+        local ruff_file="/tmp/${ruff_archive}"
+        local ruff_extract_dir="/tmp/ruff-extract-${platform}"
+        
+        if [ ! -f "${ruff_file}" ]; then
+            curl -L "${ruff_url}" -o "${ruff_file}" || {
+                echo "⚠️  Warning: Failed to download Ruff, formatting will not be available"
+                ruff_archive=""
+            }
+        else
+            echo "✓ Using cached Ruff"
+        fi
+        
+        if [ -n "${ruff_archive}" ]; then
+            echo "📂 Extracting Ruff..."
+            mkdir -p "output/${platform}/bin"
+            
+            # Windows builds skip ruff (formatting only available on Unix)
+            if [ "$os" != "win32" ]; then
+                # Linux/macOS use .tar.gz
+                mkdir -p "${ruff_extract_dir}"
+                tar -xzf "${ruff_file}" -C "${ruff_extract_dir}"
+                if [ -f "${ruff_extract_dir}/${ruff_subdir}/ruff" ]; then
+                    cp "${ruff_extract_dir}/${ruff_subdir}/ruff" "output/${platform}/bin/ruff"
+                    chmod +x "output/${platform}/bin/ruff"
+                    echo "✓ Ruff extracted to output/${platform}/bin/ruff"
+                else
+                    echo "⚠️  Warning: Ruff binary not found in archive at ${ruff_extract_dir}/${ruff_subdir}/ruff"
+                    ls -la "${ruff_extract_dir}/" || true
+                fi
+                rm -rf "${ruff_extract_dir}" 2>/dev/null || true
+            fi
+        fi
+    else
+        echo "⚠️  Skipping Ruff for unsupported platform"
+    fi
+    
     # Step 3: Strip unnecessary files from Node.js
     echo "🧹 Optimizing Node.js runtime..."
     cd "output/${platform}/node"
@@ -183,6 +255,7 @@ EOF
 # Usage: ./start.sh --port <PORT> --project-root <ROOT> --jesse-relative-path <JESSE> --bot-relative-path <BOT>
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+export PATH="${DIR}/bin:${PATH}"
 "${DIR}/node/bin/node" "${DIR}/bundle.js" "$@"
 EOF
         chmod +x "output/${platform}/start.sh"
@@ -253,9 +326,12 @@ echo "📁 Each archive contains:"
 echo "   - bundle.js (your bridge code)"
 echo "   - node/ (optimized Node.js runtime)"
 echo "   - node_modules/ (Pyright + pruned dependencies)"
+echo "   - bin/ (ruff formatter binary - Unix only, not included in Windows builds)"
 echo "   - pyrightconfig.json (config template)"
 echo "   - start.sh or start.bat (startup script)"
 echo ""
+echo "ℹ️  Note: Formatting support is only available on Unix (Linux/macOS), not Windows"
+echo ""
 echo "🚀 To deploy (Linux/macOS):"
 echo "   1. Upload: scp output/linux-x64.tar.gz server:/opt/"
 echo "   2. Extract: tar -xzf linux-x64.tar.gz"
diff --git a/build.sh b/build.sh
@@ -65,6 +65,75 @@ tar -xzf "${NODE_FILE}" -C /tmp/
 mv "/tmp/${NODE_PKG}" "output/${PLATFORM}/node"
 echo "✓ Node.js extracted to output/${PLATFORM}/node"
 
+# Step 2.5: Download and extract Ruff binary
+echo ""
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo "📥 Downloading Ruff formatter binary..."
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+
+RUFF_VERSION="0.14.3"
+RUFF_ARCHIVE=""
+RUFF_SUBDIR=""
+
+case "${NODE_ARCH}" in
+    "linux-x64")
+        RUFF_ARCHIVE="ruff-x86_64-unknown-linux-gnu.tar.gz"
+        RUFF_SUBDIR="ruff-x86_64-unknown-linux-gnu"
+        ;;
+    "linux-arm64")
+        RUFF_ARCHIVE="ruff-aarch64-unknown-linux-gnu.tar.gz"
+        RUFF_SUBDIR="ruff-aarch64-unknown-linux-gnu"
+        ;;
+    "darwin-x64")
+        RUFF_ARCHIVE="ruff-x86_64-apple-darwin.tar.gz"
+        RUFF_SUBDIR="ruff-x86_64-apple-darwin"
+        ;;
+    "darwin-arm64")
+        RUFF_ARCHIVE="ruff-aarch64-apple-darwin.tar.gz"
+        RUFF_SUBDIR="ruff-aarch64-apple-darwin"
+        ;;
+    *)
+        echo "⚠️  Warning: Unsupported platform for ruff, skipping..."
+        RUFF_ARCHIVE=""
+        ;;
+esac
+
+if [ -n "${RUFF_ARCHIVE}" ]; then
+    RUFF_URL="https://github.com/astral-sh/ruff/releases/download/v${RUFF_VERSION}/${RUFF_ARCHIVE}"
+    RUFF_FILE="/tmp/${RUFF_ARCHIVE}"
+    RUFF_EXTRACT_DIR="/tmp/ruff-extract-${PLATFORM}"
+    
+    if [ ! -f "${RUFF_FILE}" ]; then
+        curl -L "${RUFF_URL}" -o "${RUFF_FILE}" || {
+            echo "⚠️  Warning: Failed to download Ruff, formatting will not be available"
+            RUFF_ARCHIVE=""
+        }
+    else
+        echo "✓ Using cached Ruff"
+    fi
+    
+    if [ -n "${RUFF_ARCHIVE}" ]; then
+        echo "📂 Extracting Ruff..."
+        mkdir -p "${RUFF_EXTRACT_DIR}"
+        tar -xzf "${RUFF_FILE}" -C "${RUFF_EXTRACT_DIR}"
+        mkdir -p "output/${PLATFORM}/bin"
+        
+        if [ -f "${RUFF_EXTRACT_DIR}/${RUFF_SUBDIR}/ruff" ]; then
+            cp "${RUFF_EXTRACT_DIR}/${RUFF_SUBDIR}/ruff" "output/${PLATFORM}/bin/ruff"
+            chmod +x "output/${PLATFORM}/bin/ruff"
+            echo "✓ Ruff extracted to output/${PLATFORM}/bin/ruff"
+        else
+            echo "⚠️  Warning: Ruff binary not found in archive at ${RUFF_EXTRACT_DIR}/${RUFF_SUBDIR}/ruff"
+            ls -la "${RUFF_EXTRACT_DIR}/" || true
+        fi
+        
+        rm -rf "${RUFF_EXTRACT_DIR}" 2>/dev/null || true
+    fi
+else
+    echo "⚠️  Skipping Ruff for unsupported platform"
+fi
+echo ""
+
 # Strip unnecessary files from Node.js to reduce size
 echo "🧹 Stripping unnecessary files from Node.js..."
 cd "output/${PLATFORM}/node"
@@ -143,6 +212,7 @@ cat > "output/${PLATFORM}/start.sh" << 'EOF'
 # Usage: ./start.sh --port <PORT> --project-root <ROOT> --jesse-relative-path <JESSE> --bot-relative-path <BOT>
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+export PATH="${DIR}/bin:${PATH}"
 "${DIR}/node/bin/node" "${DIR}/bundle.js" "$@"
 EOF
 chmod +x "output/${PLATFORM}/start.sh"
@@ -179,6 +249,7 @@ echo "📁 Archive contains:"
 echo "   - bundle.js (all your bridge code bundled)"
 echo "   - node/ (Node.js ${NODE_VERSION} runtime, optimized)"
 echo "   - node_modules/ (Pyright + pruned dependencies)"
+echo "   - bin/ (ruff formatter binary)"
 echo "   - pyrightconfig.json (config template)"
 echo "   - start.sh (startup script)"
 echo ""
diff --git a/formatter.ts b/formatter.ts
@@ -0,0 +1,93 @@
+import { execSync } from 'child_process'
+import { readFileSync, writeFileSync, existsSync, chmodSync, unlinkSync } from 'fs'
+import path, { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+export function getRuffPath(): string {
+    const ruffPath = join(__dirname, 'bin', 'ruff')
+    if (process.platform === 'win32') {
+        return ruffPath + '.exe'
+    }
+    return ruffPath
+}
+
+export function isRuffAvailable(): boolean {
+    try {
+        const ruffPath = getRuffPath()
+        if (existsSync(ruffPath)) {
+            try {
+                chmodSync(ruffPath, 0o755)
+            } catch {
+            }
+            return true
+        }
+    } catch {
+        try {
+            execSync('ruff --version', { stdio: 'ignore' })
+            return true
+        } catch {
+            return false
+        }
+    }
+    return false
+}
+
+export async function formatPythonCode(
+    filePath: string,
+    content: string,
+    botRoot: string
+): Promise<any[]> {
+    if (!isRuffAvailable()) {
+        throw new Error('Ruff formatter not available')
+    }
+    
+    try {
+        const ruffPath = getRuffPath()
+        const useBundled = existsSync(ruffPath)
+        const ruffCmd = useBundled ? ruffPath : 'ruff'
+        
+        // Create temp file path - use path utilities for cross-platform compatibility
+        const tempFile = path.join(path.dirname(filePath), path.basename(filePath) + '.ruff-format.tmp')
+        writeFileSync(tempFile, content, 'utf-8')
+        
+        try {
+            // Execute ruff format command with proper quoting for cross-platform compatibility
+            // Using array form for better cross-platform support (avoids shell interpretation issues)
+            execSync(`"${ruffCmd}" format "${tempFile}"`, {
+                cwd: botRoot,
+                stdio: 'pipe',
+                shell: 'true'  // Use shell for proper path handling on all platforms
+            })
+            
+            const formatted = readFileSync(tempFile, 'utf-8')
+            
+            const lines = content.split('\n')
+            const fullRange = {
+                start: { line: 0, character: 0 },
+                end: { 
+                    line: Math.max(0, lines.length - 1), 
+                    character: lines.length > 0 ? lines[lines.length - 1].length : 0
+                }
+            }
+            
+            return [{
+                range: fullRange,
+                newText: formatted
+            }]
+        } finally {
+            if (existsSync(tempFile)) {
+                try {
+                    unlinkSync(tempFile)
+                } catch {
+                }
+            }
+        }
+    } catch (error: any) {
+        console.error('Formatting error:', error)
+        throw error
+    }
+}
+
diff --git a/pyright-bridge.ts b/pyright-bridge.ts
