leet-tui 0.1.0

package/README.md

@@ -0,0 +1,149 @@
+# LeetCode TUI
+
+A terminal user interface (TUI) application for solving LeetCode problems with an embedded Neovim editor.
+
+## Features
+
+- **Home page with problem list**: Browse all available LeetCode problems with difficulty indicators
+- **Split-screen interface**: 1/3 for problem description, 2/3 for Neovim editor
+- **Automatic boilerplate generation**: Each problem gets custom boilerplate code and test cases
+- **Run tests locally**: Press Ctrl+R to run your solution against test cases with instant feedback
+- **Color-coded results**: Test output shows PASSED in green, FAILED in red
+- **Embedded Neovim**: Full Neovim functionality within the TUI
+- **JavaScript solutions**: Default language is JavaScript (other languages coming soon)
+- **Organized solution files**: Solutions saved to `~/.local/share/leet-tui/solutions/`
+- **Proper window sizing**: Neovim automatically fits the available space
+- **Focus switching**: Toggle between question pane and editor pane
+- **Scrollable question view**: Navigate through problem descriptions
+- **Proper input forwarding**: All keyboard shortcuts work in Neovim (arrows, Ctrl combinations, etc.)
+
+## Architecture
+
+The application uses:
+- **ratatui**: Terminal UI framework
+- **portable-pty**: PTY system for spawning Neovim
+- **vt100**: Terminal emulator parser
+- **tui-term**: Widget for rendering terminal output
+- **crossterm**: Cross-platform terminal manipulation
+
+## Installation
+
+### Via npm (recommended)
+
+```bash
+npm install -g leet-tui
+```
+
+This will automatically download the correct binary for your platform.
+
+### From source
+
+Prerequisites:
+- Rust (1.70+)
+- Neovim installed and available in PATH
+
+```bash
+cargo build --release
+./target/release/leet-tui
+```
+
+## Running
+
+```bash
+leet-tui
+```
+
+## Keyboard Shortcuts
+
+### Home Page
+- **Up/Down**: Navigate problem list
+- **Enter**: Select a problem
+- **Ctrl+C**: Quit application
+
+### Question View
+- **Ctrl+R**: Save file and run tests (auto-saves before testing)
+- **Ctrl+Q**: Switch focus between question pane and editor pane
+- **Ctrl+H**: Back to home page
+- **Ctrl+C**: Quit application
+- **Esc**: Close test results popup
+- **Up/Down**: Scroll question (when question pane is focused)
+- **PageUp/PageDown**: Fast scroll question (when question pane is focused)
+- **Home**: Jump to top of question (when question pane is focused)
+- **All Neovim shortcuts**: Work when editor pane is focused
+
+## Project Structure
+
+```
+src/
+├── main.rs       # Main application logic and UI rendering
+├── pty.rs        # PTY manager for Neovim integration
+├── input.rs      # Keyboard input handling and ANSI escape sequence mapping
+└── leetcode.rs   # LeetCode API integration (currently with sample data)
+```
+
+## How It Works
+
+### PTY Integration
+
+The application spawns Neovim in a pseudo-terminal (PTY) and renders its output in a Ratatui widget. A background thread continuously reads from the PTY and updates a VT100 parser, which maintains the terminal state.
+
+### Input Forwarding
+
+When the editor pane is focused, all keyboard events are converted to ANSI escape sequences and sent to the PTY. This includes:
+- Regular characters
+- Control combinations (Ctrl+A, Ctrl+W, etc.)
+- Arrow keys and function keys
+- Special keys (Home, End, PageUp, PageDown, etc.)
+
+### Focus Management
+
+The application maintains a focus state that determines which pane receives input:
+- **Question pane**: Arrow keys scroll the problem description
+- **Editor pane**: All input is forwarded to Neovim
+
+## Extending
+
+### Adding Real LeetCode API Integration
+
+Currently, the app displays a sample problem. To integrate with the real LeetCode API:
+
+1. Update `src/leetcode.rs` to make GraphQL requests to LeetCode
+2. Add authentication support
+3. Implement problem selection UI
+
+### Customizing Neovim
+
+You can customize the Neovim instance by:
+- Setting environment variables (e.g., `NVIM_APPNAME` for different configs)
+- Passing command-line arguments in `src/pty.rs:25`
+- Creating a custom init file for the TUI context
+
+The app currently opens `solution.js` by default. To support other languages, modify the file extension in `src/pty.rs:25`.
+
+## Troubleshooting
+
+### Keys not working in Neovim
+
+If certain key combinations don't work, you may need to add them to the `key_to_bytes` function in `src/input.rs`.
+
+### Terminal size issues
+
+The application handles resize events and updates the PTY size accordingly. If you experience rendering issues, try resizing your terminal.
+
+### Neovim colors look wrong
+
+The VT100 parser supports basic colors. If you use a complex Neovim theme, some colors may not render perfectly in the embedded terminal.
+
+## Future Enhancements
+
+- [ ] Real LeetCode API integration
+- [ ] Problem selection menu
+- [ ] Multiple test case support
+- [ ] Submit solution functionality
+- [ ] History of attempted problems
+- [ ] Custom Neovim configuration per problem type
+- [ ] Split terminal for running tests
+
+## License
+
+MIT

package/bin/leet-tui

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+const { execFileSync, spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+const binDir = __dirname;
+const binName = process.platform === 'win32' ? 'leet-tui.exe' : 'leet-tui-binary';
+const binaryPath = path.join(binDir, binName);
+
+if (!fs.existsSync(binaryPath)) {
+  console.error('[leet-tui] Binary not found. Running postinstall...');
+  try {
+    execFileSync('node', [path.join(__dirname, '..', 'scripts', 'postinstall.js')], {
+      stdio: 'inherit',
+    });
+  } catch (err) {
+    console.error('[leet-tui] Failed to install binary.');
+    process.exit(1);
+  }
+}
+
+if (!fs.existsSync(binaryPath)) {
+  console.error('[leet-tui] Binary still not found after postinstall.');
+  console.error('Please try reinstalling: npm install -g leet-tui');
+  process.exit(1);
+}
+
+// Use spawn with inherit to properly handle TTY
+const child = spawn(binaryPath, process.argv.slice(2), {
+  stdio: 'inherit',
+  env: process.env,
+});
+
+child.on('error', (err) => {
+  console.error(`[leet-tui] Failed to start: ${err.message}`);
+  process.exit(1);
+});
+
+child.on('exit', (code, signal) => {
+  if (signal) {
+    process.exit(1);
+  }
+  process.exit(code ?? 0);
+});

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "leet-tui",
+  "version": "0.1.0",
+  "description": "A terminal UI for practicing LeetCode Blind 75 problems with embedded Neovim",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trevor-ofarrell/leet-tui"
+  },
+  "homepage": "https://github.com/trevor-ofarrell/leet-tui#readme",
+  "bugs": {
+    "url": "https://github.com/trevor-ofarrell/leet-tui/issues"
+  },
+  "keywords": [
+    "leetcode",
+    "tui",
+    "terminal",
+    "neovim",
+    "coding",
+    "interview",
+    "practice",
+    "blind75"
+  ],
+  "bin": {
+    "leet-tui": "bin/leet-tui"
+  },
+  "files": [
+    "bin",
+    "scripts"
+  ],
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,104 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const https = require('https');
+const { execSync } = require('child_process');
+
+const REPO = 'trevor-ofarrell/leet-tui';
+const VERSION = require('../package.json').version;
+
+const PLATFORMS = {
+  'darwin-arm64': 'leet-tui-darwin-arm64',
+  'darwin-x64': 'leet-tui-darwin-x64',
+  'linux-x64': 'leet-tui-linux-x64',
+  'linux-arm64': 'leet-tui-linux-arm64',
+  'win32-x64': 'leet-tui-win32-x64.exe',
+};
+
+const platformKey = `${process.platform}-${process.arch}`;
+const binaryName = PLATFORMS[platformKey];
+
+if (!binaryName) {
+  console.warn(`\n[leet-tui] No prebuilt binary for ${platformKey}`);
+  console.warn(`Supported: ${Object.keys(PLATFORMS).join(', ')}`);
+  console.warn('Build from source: https://github.com/' + REPO + '\n');
+  process.exit(0);
+}
+
+const binDir = path.join(__dirname, '..', 'bin');
+const binPath = path.join(binDir, process.platform === 'win32' ? 'leet-tui.exe' : 'leet-tui-binary');
+const url = `https://github.com/${REPO}/releases/download/v${VERSION}/${binaryName}`;
+
+function download(url, dest) {
+  return new Promise((resolve, reject) => {
+    const file = fs.createWriteStream(dest);
+
+    https.get(url, (response) => {
+      // Handle redirects (GitHub releases redirect to S3)
+      if (response.statusCode === 302 || response.statusCode === 301) {
+        file.close();
+        fs.unlinkSync(dest);
+        return download(response.headers.location, dest).then(resolve).catch(reject);
+      }
+
+      if (response.statusCode !== 200) {
+        file.close();
+        fs.unlinkSync(dest);
+        reject(new Error(`Download failed: HTTP ${response.statusCode}`));
+        return;
+      }
+
+      const total = parseInt(response.headers['content-length'], 10);
+      let downloaded = 0;
+
+      response.on('data', (chunk) => {
+        downloaded += chunk.length;
+        if (total) {
+          const pct = Math.round((downloaded / total) * 100);
+          process.stdout.write(`\r[leet-tui] Downloading... ${pct}%`);
+        }
+      });
+
+      response.pipe(file);
+
+      file.on('finish', () => {
+        file.close();
+        console.log('\r[leet-tui] Download complete.      ');
+        resolve();
+      });
+    }).on('error', (err) => {
+      fs.unlink(dest, () => {});
+      reject(err);
+    });
+  });
+}
+
+async function main() {
+  console.log(`[leet-tui] Installing binary for ${platformKey}...`);
+
+  // Ensure bin directory exists
+  if (!fs.existsSync(binDir)) {
+    fs.mkdirSync(binDir, { recursive: true });
+  }
+
+  try {
+    await download(url, binPath);
+
+    // Make executable on Unix
+    if (process.platform !== 'win32') {
+      fs.chmodSync(binPath, 0o755);
+    }
+
+    console.log('[leet-tui] Installation successful!');
+  } catch (err) {
+    console.error(`\n[leet-tui] Failed to download binary: ${err.message}`);
+    console.error(`URL: ${url}`);
+    console.error('\nYou can build from source:');
+    console.error('  git clone https://github.com/' + REPO);
+    console.error('  cd leet-tui && cargo build --release');
+    process.exit(1);
+  }
+}
+
+main();