projax 3.3.0 → 3.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +46 -2
  2. package/dist/index.js +14 -11
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,14 @@
1
1
  # projax
2
2
 
3
- A cross-platform project management dashboard for tracking local development projects. Features a powerful CLI tool, interactive Terminal UI (TUI), Desktop app (Electron-based), REST API, and built-in tools for test detection, port management, and script execution.
3
+ A cross-platform project management dashboard for tracking local development projects. Features a powerful CLI tool, interactive Terminal UI (TUI), Desktop app (Electron-based), **VS Code/Cursor/Windsurf extension**, REST API, and built-in tools for test detection, port management, and script execution.
4
+
5
+ ## 🌟 Key Interfaces
6
+
7
+ - **🖥️ CLI**: Full-featured command-line tool - `prx <command>`
8
+ - **⚡ Terminal UI**: Interactive TUI with real-time updates - `prx i`
9
+ - **🎨 Desktop App**: Beautiful Electron-based UI - `prx web`
10
+ - **📝 Editor Extension**: Native sidebar for VS Code, Cursor, and Windsurf - [Get Extension](#vscode-cursorf-windsurf-extension)
11
+ - **🔌 REST API**: Express-based API server for integrations
4
12
 
5
13
  ## Features
6
14
 
@@ -11,7 +19,9 @@ A cross-platform project management dashboard for tracking local development pro
11
19
  - **Intelligent Script Selection**: Automatically selects the right script (dev/start) when running projects
12
20
  - **Port Scanning & Indexing**: Automatically extracts and indexes ports from project config files
13
21
  - **CLI Interface**: Full-featured command-line tool for project management
14
- - **Web Interface**: Beautiful Desktop UI (Electron-based) for visual project management
22
+ - **Terminal UI (TUI)**: Interactive terminal interface with real-time updates
23
+ - **Desktop App**: Beautiful Desktop UI (Electron-based) for visual project management
24
+ - **Editor Extension**: Native sidebar extension for VS Code, Cursor, and Windsurf editors
15
25
  - **JSON Database**: Lightweight JSON-based database stores all project metadata
16
26
  - **REST API**: Express-based API server for centralized data access
17
27
  - **Cross-Platform Support**: Works on macOS, Linux, and Windows
@@ -26,6 +36,40 @@ npm install -g projax
26
36
 
27
37
  After installation, the `prx` command will be available globally.
28
38
 
39
+ ## VS Code/Cursor/Windsurf Extension
40
+
41
+ **PROJAX for Editors** brings the power of PROJAX directly into your editor's sidebar with a native extension for VS Code, Cursor, and Windsurf.
42
+
43
+ ### 🎯 Features
44
+
45
+ - **📂 Projects Browser**: Search and browse all PROJAX projects in a sidebar panel
46
+ - **🎯 Auto-Detection**: Automatically detects and highlights the current workspace project
47
+ - **📊 Project Details**: View tests, ports, scripts, and statistics at a glance
48
+ - **▶️ Script Execution**: Run and stop npm/yarn scripts directly from the editor
49
+ - **🔗 Quick Access**: One-click access to development server URLs
50
+ - **⌨️ Command Palette**: 13 PROJAX commands accessible via `Cmd+Shift+P`
51
+ - **🔄 Real-Time Updates**: Live process status and port information
52
+ - **🎨 Native UI**: Beautiful sidebar panels that match your editor's theme
53
+
54
+ ### 📦 Installation
55
+
56
+ ```bash
57
+ # Get installation instructions and .vsix location
58
+ prx vscode-extension
59
+
60
+ # Or install directly:
61
+ code --install-extension ./release/projax-vscode-3.0.0.vsix # VS Code
62
+ cursor --install-extension ./release/projax-vscode-3.0.0.vsix # Cursor
63
+ windsurf --install-extension ./release/projax-vscode-3.0.0.vsix # Windsurf
64
+ ```
65
+
66
+ ### 📚 Documentation
67
+
68
+ - [Extension Overview](https://projax.dev/docs/editors/overview)
69
+ - [Installation Guide](https://projax.dev/docs/editors/installation)
70
+ - [Usage Guide](https://projax.dev/docs/editors/usage)
71
+ - [Command Reference](https://projax.dev/docs/editors/commands)
72
+
29
73
  ### Database Setup
30
74
 
31
75
  The database is automatically created on first use. No manual setup required.
package/dist/index.js CHANGED
@@ -1482,30 +1482,33 @@ program
1482
1482
  }
1483
1483
  else {
1484
1484
  const vsixPath = path.join(releaseDir, vsixFiles[0]);
1485
- console.log(`✅ Extension package: ${vsixFiles[0]}`);
1485
+ console.log(`✅ Extension: ${vsixFiles[0]}`);
1486
1486
  console.log(`📁 Location: ${vsixPath}\n`);
1487
- console.log('📖 Installation Instructions:\n');
1488
- console.log('1. Open VS Code, Cursor, or Windsurf');
1489
- console.log('2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)');
1490
- console.log('3. Click the "..." menu → "Install from VSIX..."');
1491
- console.log(`4. Navigate to: ${releaseDir}`);
1492
- console.log(`5. Select: ${vsixFiles[0]}\n`);
1493
- console.log('🚀 Quick Install:\n');
1487
+ console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
1488
+ console.log('🚀 QUICK INSTALL (Easiest Method)');
1489
+ console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n');
1494
1490
  console.log(` code --install-extension "${vsixPath}"`);
1495
1491
  console.log(` cursor --install-extension "${vsixPath}"`);
1496
1492
  console.log(` windsurf --install-extension "${vsixPath}"\n`);
1493
+ console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
1494
+ console.log('📖 Manual Installation');
1495
+ console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n');
1496
+ console.log('1. Open VS Code, Cursor, or Windsurf');
1497
+ console.log('2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)');
1498
+ console.log('3. Click the "..." menu → "Install from VSIX..."');
1499
+ console.log(`4. Select: ${vsixPath}\n`);
1497
1500
  // Open in Finder/Explorer
1498
1501
  const platform = process.platform;
1499
1502
  if (platform === 'darwin') {
1500
- console.log('💡 Open in Finder:');
1503
+ console.log('💡 Open release folder in Finder:');
1501
1504
  console.log(` open "${releaseDir}"\n`);
1502
1505
  }
1503
1506
  else if (platform === 'win32') {
1504
- console.log('💡 Open in Explorer:');
1507
+ console.log('💡 Open release folder in Explorer:');
1505
1508
  console.log(` explorer "${releaseDir}"\n`);
1506
1509
  }
1507
1510
  else {
1508
- console.log('💡 Open in File Manager:');
1511
+ console.log('💡 Open release folder:');
1509
1512
  console.log(` xdg-open "${releaseDir}"\n`);
1510
1513
  }
1511
1514
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "projax",
3
- "version": "3.3.0",
3
+ "version": "3.3.3",
4
4
  "description": "Cross-platform project management dashboard for tracking local development projects. Features CLI, Terminal UI, Desktop app, REST API, and built-in tools for test detection, port management, and script execution.",
5
5
  "main": "dist/index.js",
6
6
  "bin": {