project-compass 2.5.0 → 2.6.0

package/README.md

@@ -1,4 +1,4 @@
-# Project Compass (v2.5.0)
+# Project Compass (v2.6.0)
 
 Project Compass is a futuristic CLI navigator built with [Ink](https://github.com/vadimdemedes/ink) that scans your current folder tree for familiar code projects and gives you one-keystroke access to build, test, or run them.
 
@@ -11,6 +11,7 @@ Project Compass is a futuristic CLI navigator built with [Ink](https://github.co
 - 🧠 **Smart Detection**: Support for 20+ frameworks including **Spring Boot** (Maven/Gradle), **ASP.NET Core**, **Rocket/Actix** (Rust), **Laravel** (PHP), **Vite**, **Prisma**, and more.
 - ⚠️ **Runtime Health**: Automatically checks if the required language/runtime (e.g., `node`, `python`, `cargo`) is installed and warns you if it's missing.
 - 💎 **Omni-Studio**: A new interactive environment intelligence mode to see all installed runtimes and versions.
+- 📂 **Log Management**: Clear output with **Shift+X** or export logs to a text file with **Shift+E**.
 - 🔌 **Extensible**: Add custom commands with **Shift+C** and frameworks via `plugins.json`.
 
 ## Installation
@@ -35,7 +36,8 @@ project-compass [--dir /path/to/workspace] [--studio]
 | **Shift+A** | Open **Omni-Studio** (Environment View) |
 | **Shift+C** | Add a custom command (`label|cmd`) |
 | **Shift+X** | **Clear output logs** |
-| **Shift ↑ / ↓** | Scroll output buffer |
+| **Shift+E** | **Export logs to .txt** |
+| **Shift ↑ / ↓** | Scroll output buffer (Intuitive Direction) |
 | **Shift+L** | Rerun last command |
 | **Shift+H** | Toggle help cards |
 | **Shift+S** | Toggle structure guide |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "project-compass",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Ink-based project explorer that detects local repos and lets you build/test/run them without memorizing commands.",
   "main": "src/cli.js",
   "type": "module",

package/src/cli.js

@@ -177,9 +177,9 @@ function Compass({rootPath, initialView = 'navigator'}) {
   const addLog = useCallback((line) => {
     setLogLines((prev) => {
       const normalized = typeof line === 'string' ? line : JSON.stringify(line);
-      const appended = [...prev, normalized];
-      const next = appended.length > 500 ? appended.slice(appended.length - 500) : appended;
-      return next;
+      const lines = normalized.split(/\r?\n/).filter(l => l.trim().length > 0);
+      const appended = [...prev, ...lines];
+      return appended.length > 500 ? appended.slice(appended.length - 500) : appended;
     });
   }, []);
 
@@ -228,10 +228,10 @@ function Compass({rootPath, initialView = 'navigator'}) {
       runningProcessRef.current = subprocess;
 
       subprocess.stdout?.on('data', (chunk) => {
-        addLog(chunk.toString().trimEnd());
+        addLog(chunk.toString());
       });
       subprocess.stderr?.on('data', (chunk) => {
-        addLog(kleur.red(chunk.toString().trimEnd()));
+        addLog(kleur.red(chunk.toString()));
       });
 
       await subprocess;
@@ -292,6 +292,19 @@ function Compass({rootPath, initialView = 'navigator'}) {
     setCustomInput('');
   }, [customInput, selectedProject, handleAddCustomCommand, addLog]);
 
+  const exportLogs = useCallback(() => {
+    if (!logLines.length) {
+      return;
+    }
+    try {
+      const exportPath = path.resolve(process.cwd(), `compass-logs-${Date.now()}.txt`);
+      fs.writeFileSync(exportPath, logLines.join('\n'));
+      addLog(kleur.green(`✓ Logs exported to ${exportPath}`));
+    } catch (err) {
+      addLog(kleur.red(`✗ Export failed: ${err.message}`));
+    }
+  }, [logLines, addLog]);
+
     useInput((input, key) => {
     if (customMode) {
       if (key.return) {
@@ -334,6 +347,10 @@ function Compass({rootPath, initialView = 'navigator'}) {
       setLogOffset(0);
       return;
     }
+    if (shiftCombo('e')) {
+      exportLogs();
+      return;
+    }
 
     const scrollLogs = (delta) => {
       setLogOffset((prev) => {
@@ -366,11 +383,11 @@ function Compass({rootPath, initialView = 'navigator'}) {
     }
 
     if (key.shift && key.upArrow) {
-      scrollLogs(-1);
+      scrollLogs(1);
       return;
     }
     if (key.shift && key.downArrow) {
-      scrollLogs(1);
+      scrollLogs(-1);
       return;
     }
 
@@ -418,21 +435,18 @@ function Compass({rootPath, initialView = 'navigator'}) {
     }
   });
 
-  if (mainView === 'studio') {
-    return create(Studio);
-  }
-
-const projectRows = [];
+  const projectCountLabel = `${projects.length} project${projects.length === 1 ? '' : 's'}`;
+  const projectRows = [];
   if (loading) {
-    projectRows.push(create(Text, {dimColor: true}, 'Scanning projects…'));
+    projectRows.push(create(Text, {key: 'scanning', dimColor: true}, 'Scanning projects…'));
   }
   if (error) {
-    projectRows.push(create(Text, {color: 'red'}, `Unable to scan: ${error}`));
+    projectRows.push(create(Text, {key: 'error', color: 'red'}, `Unable to scan: ${error}`));
   }
   if (!loading && !error && projects.length === 0) {
-    projectRows.push(create(Text, {dimColor: true}, 'No recognizable project manifests found.'));
+    projectRows.push(create(Text, {key: 'empty', dimColor: true}, 'No recognizable project manifests found.'));
   }
-  if (!loading) {
+  if (!loading && mainView === 'navigator') {
     projects.forEach((project, index) => {
       const isSelected = index === selectedIndex;
       const frameworkBadges = (project.frameworks || []).map((frame) => `${frame.icon} ${frame.name}`).join(', ');
@@ -466,59 +480,58 @@ const projectRows = [];
     detailContent.push(
       create(
         Box,
-        {flexDirection: 'row'},
+        {key: 'title-row', flexDirection: 'row'},
         create(Text, {color: 'cyan', bold: true}, `${selectedProject.icon} ${selectedProject.name}`),
         selectedProject.missingBinaries && selectedProject.missingBinaries.length > 0 && create(Text, {color: 'red', bold: true}, '  ⚠️ MISSING RUNTIME')
       ),
-      create(Text, {dimColor: true}, `${selectedProject.type} · ${selectedProject.manifest || 'detected manifest'}`),
-      create(Text, {dimColor: true}, `Location: ${path.relative(rootPath, selectedProject.path) || '.'}`)
+      create(Text, {key: 'manifest', dimColor: true}, `${selectedProject.type} · ${selectedProject.manifest || 'detected manifest'}`),
+      create(Text, {key: 'loc', dimColor: true}, `Location: ${path.relative(rootPath, selectedProject.path) || '.'}`)
     );
     if (selectedProject.description) {
-      detailContent.push(create(Text, null, selectedProject.description));
+      detailContent.push(create(Text, {key: 'desc'}, selectedProject.description));
     }
     const frameworks = (selectedProject.frameworks || []).map((lib) => `${lib.icon} ${lib.name}`).join(', ');
     if (frameworks) {
-      detailContent.push(create(Text, {dimColor: true}, `Frameworks: ${frameworks}`));
+      detailContent.push(create(Text, {key: 'frames', dimColor: true}, `Frameworks: ${frameworks}`));
     }
     if (selectedProject.extra?.scripts && selectedProject.extra.scripts.length) {
-      detailContent.push(create(Text, {dimColor: true}, `Scripts: ${selectedProject.extra.scripts.join(', ')}`));
+      detailContent.push(create(Text, {key: 'scripts', dimColor: true}, `Scripts: ${selectedProject.extra.scripts.join(', ')}`));
     }
 
     if (selectedProject.missingBinaries && selectedProject.missingBinaries.length > 0) {
       detailContent.push(
-        create(Text, {color: 'red', bold: true, marginTop: 1}, 'MISSING BINARIES:'),
-        create(Text, {color: 'red'}, `Please install: ${selectedProject.missingBinaries.join(', ')}`),
-        create(Text, {dimColor: true}, 'Project commands may fail until these are in your PATH.')
+        create(Text, {key: 'missing-title', color: 'red', bold: true, marginTop: 1}, 'MISSING BINARIES:'),
+        create(Text, {key: 'missing-list', color: 'red'}, `Please install: ${selectedProject.missingBinaries.join(', ')}`),
+        create(Text, {key: 'missing-hint', dimColor: true}, 'Project commands may fail until these are in your PATH.')
       );
     }
 
-    detailContent.push(create(Text, {dimColor: true, marginTop: 1}, `Custom commands stored in ${CONFIG_PATH}`));
-    detailContent.push(create(Text, {dimColor: true, marginBottom: 1}, `Extend frameworks via ${PLUGIN_FILE}`));
-    detailContent.push(create(Text, {bold: true, marginTop: 1}, 'Commands'));
+    detailContent.push(create(Text, {key: 'config-path', dimColor: true, marginTop: 1}, `Custom commands stored in ${CONFIG_PATH}`));
+    detailContent.push(create(Text, {key: 'plugin-path', dimColor: true, marginBottom: 1}, `Extend frameworks via ${PLUGIN_FILE}`));
+    detailContent.push(create(Text, {key: 'cmd-header', bold: true, marginTop: 1}, 'Commands'));
     detailedIndexed.forEach((command) => {
       detailContent.push(
         create(Text, {key: `detail-${command.shortcut}-${command.label}`}, `${command.shortcut}. ${command.label} ${command.source === 'custom' ? kleur.magenta('(custom)') : command.source === 'framework' ? kleur.cyan('(framework)') : command.source === 'plugin' ? kleur.green('(plugin)') : ''}`)
       );
-      detailContent.push(create(Text, {dimColor: true}, `   ↳ ${command.command.join(' ')}`));
+      detailContent.push(create(Text, {key: `detail-line-${command.shortcut}-${command.label}`, dimColor: true}, `   ↳ ${command.command.join(' ')}`));
     });
     if (!detailedIndexed.length) {
-      detailContent.push(create(Text, {dimColor: true}, 'No built-in commands yet. Add a custom command with Shift+C.'));
+      detailContent.push(create(Text, {key: 'no-cmds', dimColor: true}, 'No built-in commands yet. Add a custom command with Shift+C.'));
     }
     const setupHints = selectedProject.extra?.setupHints || [];
     if (setupHints.length) {
-      detailContent.push(create(Text, {dimColor: true, marginTop: 1}, 'Setup hints:'));
-      setupHints.forEach((hint) => detailContent.push(create(Text, {dimColor: true}, `  • ${hint}`)));
+      detailContent.push(create(Text, {key: 'setup-header', dimColor: true, marginTop: 1}, 'Setup hints:'));
+      setupHints.forEach((hint, hidx) => detailContent.push(create(Text, {key: `hint-${hidx}`, dimColor: true}, `  • ${hint}`)));
     }
-    detailContent.push(create(Text, {dimColor: true}, 'Press Shift+C → label|cmd to save custom actions, Enter to close detail view.'));
+    detailContent.push(create(Text, {key: 'hint-line', dimColor: true}, 'Press Shift+C → label|cmd to save custom actions, Enter to close detail view.'));
   } else {
-    detailContent.push(create(Text, {dimColor: true}, 'Press Enter on a project to reveal details (icons, commands, frameworks, custom actions).'));
+    detailContent.push(create(Text, {key: 'enter-hint', dimColor: true}, 'Press Enter on a project to reveal details (icons, commands, frameworks, custom actions).'));
   }
 
   if (customMode) {
-    detailContent.push(create(Text, {color: 'cyan'}, `Type label|cmd (Enter to save, Esc to cancel): ${customInput}`));
+    detailContent.push(create(Text, {key: 'custom-input', color: 'cyan'}, `Type label|cmd (Enter to save, Esc to cancel): ${customInput}`));
   }
 
-  const projectCountLabel = `${projects.length} project${projects.length === 1 ? '' : 's'}`;
   const artTileNodes = useMemo(() => {
     const selectedName = selectedProject?.name || 'Awaiting selection';
     const selectedType = selectedProject?.type || 'Unknown stack';
@@ -602,7 +615,7 @@ const projectRows = [];
   const visibleLogs = logLines.slice(logWindowStart, logWindowEnd);
   const logNodes = visibleLogs.length
     ? visibleLogs.map((line, index) => create(Text, {key: index}, line))
-    : [create(Text, {dimColor: true}, 'Logs will appear here once you run a command.')];
+    : [create(Text, {key: 'no-logs', dimColor: true}, 'Logs will appear here once you run a command.')];
 
   const helpCards = [
     {
@@ -622,7 +635,7 @@ const projectRows = [];
         'B / T / R build/test/run',
         '1-9 run detail commands',
         'Shift+L rerun last command',
-        'Shift+X clear output logs'
+        'Shift+X clear / Shift+E export'
       ]
     },
     {
@@ -662,7 +675,7 @@ const projectRows = [];
           )
         )
       )
-    : create(Text, {dimColor: true, marginTop: 1}, 'Help cards hidden · press Shift+H to show navigation, command flow, and recent runs.');
+    : create(Text, {key: 'help-hint', dimColor: true, marginTop: 1}, 'Help cards hidden · press Shift+H to show navigation, command flow, and recent runs.');
 
   const structureGuide = showStructureGuide
     ? create(
@@ -693,14 +706,18 @@ const projectRows = [];
           padding: 1
         },
         create(Text, {color: 'cyan', bold: true}, 'Help overlay · press ? to hide'),
-        create(Text, null, 'Shift+↑/↓ scrolls the log buffer; Shift+X clears logs; Shift+A opens Omni-Studio.'),
-        create(Text, null, 'B/T/R run build/test/run; 1-9 executes detail commands; Shift+L reruns the previous command.'),
-        create(Text, null, 'Shift+H toggles help cards, Shift+S structure guide, ? overlay, Shift+Q quits.'),
+        create(Text, null, 'Shift+↑/↓ scrolls logs; Shift+X clears; Shift+E exports to file; Shift+A Omni-Studio.'),
+        create(Text, null, 'B/T/R run build/test/run; 1-9 detail commands; Shift+L reruns previous command.'),
+        create(Text, null, 'Shift+H help cards, Shift+S structure guide, ? overlay, Shift+Q quits.'),
         create(Text, null, 'Projects + Details stay paired while Output keeps its own full-width band.'),
         create(Text, null, 'Structure guide lists the manifests that trigger each language detection.')
       )
     : null;
 
+  if (mainView === 'studio') {
+    return create(Studio);
+  }
+
   const toggleHint = showHelpCards ? 'Shift+H hides the help cards' : 'Shift+H shows the help cards';
   const headerHint = viewMode === 'detail'
     ? `Detail mode · 1-${Math.max(detailedIndexed.length, 1)} to execute, Shift+C: add custom commands, Enter: back to list, Shift+Q: quit · ${toggleHint}, Shift+S toggles structure guide`
@@ -834,8 +851,32 @@ function parseArgs() {
 async function main() {
   const args = parseArgs();
   if (args.help) {
-    console.log('Project Compass · Ink project runner');
-    console.log('Usage: project-compass [--dir <path>] [--mode test] [--studio]');
+    console.log(kleur.cyan('Project Compass · Ink project navigator/runner'));
+    console.log('');
+    console.log(kleur.bold('Usage:'));
+    console.log('  project-compass [--dir <path>] [--studio]');
+    console.log('');
+    console.log(kleur.bold('Arguments:'));
+    console.log('  --dir, --path <path>  Specify root workspace directory to scan');
+    console.log('  --studio              Launch directly into Omni-Studio mode');
+    console.log('  --help, -h            Show this help menu');
+    console.log('');
+    console.log(kleur.bold('Core Keybinds:'));
+    console.log('  ↑ / ↓                 Move project focus');
+    console.log('  Enter                 Toggle detail view for selected project');
+    console.log('  Shift+A               Switch to Omni-Studio (Environment Health)');
+    console.log('  Shift+X               Clear the output log buffer');
+    console.log('  Shift+E               Export current logs to a .txt file');
+    console.log('  Shift+↑ / ↓           Scroll the output logs back/forward');
+    console.log('  Shift+Q               Quit application');
+    console.log('');
+    console.log(kleur.bold('Execution shortcuts:'));
+    console.log('  B / T / R             Quick run: Build / Test / Run');
+    console.log('  1-9                   Run numbered commands in detail view');
+    console.log('  Shift+L               Rerun the last executed command');
+    console.log('  Shift+C               Add a custom command (in detail view)');
+    console.log('');
+    console.log(kleur.dim('Documentation: https://github.com/CrimsonDevil333333/project-compass'));
     return;
   }
   const rootPath = args.root ? path.resolve(args.root) : process.cwd();