project-compass 3.6.5 โ†’ 3.6.7

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.
package/AGENTS.md ADDED
@@ -0,0 +1,36 @@
1
+ # AGENTS.md - Project Compass Workspace
2
+
3
+ Welcome to Project Compass. This file provides context for AI agents (Clawdy, Claude, Copilot, etc.) working on this repository.
4
+
5
+ ## Overview
6
+ Project Compass is a futuristic project navigator and runner designed for modern polyglot development (Node.js, Python, Rust, Go). It provides a high-fidelity terminal UI (using Ink) to manage complex workspaces.
7
+
8
+ ## Project Structure
9
+ - `src/cli.js`: Entry point. Handles argument parsing and the main Ink UI loop.
10
+ - `src/projectDetection.js`: Logic for identifying projects and their frameworks.
11
+ - `src/components/`: React/Ink components for the TUI.
12
+ - `TaskManager.js`: Orbit Task Manager (background processes).
13
+ - `PackageRegistry.js`: Dependency management interface.
14
+ - `ProjectArchitect.js`: Scaffolding and templates.
15
+ - `Studio.js`: Omni-Studio health audit.
16
+ - `assets/`: UI-related assets (screenshots, etc.).
17
+
18
+ ## Tech Stack
19
+ - **Runtime:** Node.js (ESM)
20
+ - **UI Framework:** [Ink](https://github.com/vadimdemedes/ink) (React for CLI)
21
+ - **Styling:** `kleur` (Note: Use `kleur.bold(kleur.magenta('text'))` instead of chained `.magenta.bold`)
22
+ - **Execution:** `execa` for robust subprocess management.
23
+
24
+ ## Development Rules
25
+ 1. **Zero Mock Data:** Always aim for live system/project data.
26
+ 2. **ESM Only:** The project uses `"type": "module"`. Use `import/export`.
27
+ 3. **UI Consistency:** Keep the "Futuristic Cockpit" aesthetic (use symbols, borders, and dim colors where appropriate).
28
+ 4. **Performance:** Heavy operations (like workspace-wide globbing) should be optimized or backgrounded.
29
+
30
+ ## Common Tasks
31
+ - `npm start`: Launch the navigator.
32
+ - `npm run lint`: Check code style.
33
+ - `npm version <patch|minor|major>`: Update version and sync with npm.
34
+
35
+ ---
36
+ *Created for the CrimsonDevil333333 Ecosystem.*
@@ -0,0 +1,21 @@
1
+ # Project Compass Architecture
2
+
3
+ This document describes the high-level architecture of Project Compass.
4
+
5
+ ## Data Flow
6
+ 1. **Initialization:** `cli.js` resolves the working directory (defaults to current folder).
7
+ 2. **Discovery:** `projectDetection.js` performs a high-speed glob search for common manifest files (`package.json`, `cargo.toml`, `go.mod`, etc.).
8
+ 3. **State Management:** The discovered projects and their metadata (frameworks, scripts, dependencies) are passed into an Ink React tree.
9
+ 4. **Rendering:** Components in `src/components` handle specific views (Task Manager, Architect, etc.) based on user keypresses.
10
+ 5. **Execution:** User-triggered scripts (like running `npm test`) are managed by `TaskManager.js` using `execa` with streaming logs.
11
+
12
+ ## Design Patterns
13
+ - **React-for-CLI:** Leveraging React's lifecycle and state management for a terminal environment.
14
+ - **Component-Driven:** Each view is an isolated component in `src/components`.
15
+ - **Async Execution:** Heavy lifting (globbing, command execution) is offloaded from the main render loop to prevent UI lag.
16
+
17
+ ## Security
18
+ Project Compass respects workspace boundaries and does not execute arbitrary code unless explicitly requested by the user.
19
+
20
+ ---
21
+ *Built for scale and precision.*
@@ -0,0 +1,23 @@
1
+ # Contributing to Project Compass
2
+
3
+ Thank you for your interest in helping to navigate the project universe! ๐Ÿš€
4
+
5
+ ## Core Principles
6
+ 1. **High Fidelity:** The UI should feel like a cockpit, not just a text list.
7
+ 2. **Safety First:** Commands should be executed safely, and critical actions (like `rm` or `kill`) should have a confirmation gate.
8
+ 3. **Speed:** Operations must be non-blocking. Use Ink's async components or background processes via `execa`.
9
+
10
+ ## Working with AI Agents
11
+ This repository is "AI-First." Always update `AGENTS.md` after making structural changes to the code or adding new core components. This helps subsequent agents (and humans!) maintain high-velocity context.
12
+
13
+ ## Workflow
14
+ 1. **Fork and Branch:** Create a branch for your feature or fix.
15
+ 2. **Code Style:** Follow the existing ESM pattern.
16
+ 3. **Testing:** Run `npm start` in a large workspace (like a multi-repo folder) to ensure the UI remains performant.
17
+ 4. **Commits:** Use conventional commits (`feat:`, `fix:`, `docs:`, `refactor:`).
18
+
19
+ ## Deployment
20
+ All production versions are managed by Satyaa and the primary agent, Clawdy. Any `npm version` bump must include an update to `package-lock.json`.
21
+
22
+ ---
23
+ *Navigate the future.*
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "project-compass",
3
- "version": "3.6.5",
3
+ "version": "3.6.7",
4
4
  "description": "Futuristic project navigator and runner for Node, Python, Rust, and Go",
5
5
  "main": "src/cli.js",
6
6
  "bin": {
package/src/cli.js CHANGED
@@ -630,26 +630,26 @@ async function main() {
630
630
  }
631
631
  if (args.help) {
632
632
  console.clear();
633
- console.log(kleur.magenta.bold('๐Ÿงญ Project Compass ยท Premium Developer Cockpit'));
633
+ console.log(kleur.bold(kleur.magenta('๐Ÿงญ Project Compass ยท Premium Developer Cockpit')));
634
634
  console.log(kleur.dim('โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€'));
635
635
  console.log('');
636
636
  console.log(kleur.bold('Usage:'));
637
637
  console.log(' project-compass [--dir <path>] [--studio]');
638
638
  console.log('');
639
- console.log(kleur.cyan.bold('๐ŸŒŒ Core Views:'));
639
+ console.log(kleur.bold(kleur.cyan('๐ŸŒŒ Core Views:')));
640
640
  console.log(' Shift+T ' + kleur.bold('Orbit Task Manager') + ' - Manage background processes & stream logs');
641
641
  console.log(' Shift+P ' + kleur.bold('Package Registry') + ' - Direct dependency management (add/remove)');
642
642
  console.log(' Shift+N ' + kleur.bold('Project Architect') + ' - Scaffold new projects from templates');
643
643
  console.log(' Shift+A ' + kleur.bold('Omni-Studio') + ' - Environment & runtime health audit');
644
644
  console.log('');
645
- console.log(kleur.yellow.bold('๐ŸŽฎ Navigation & Details:'));
645
+ console.log(kleur.bold(kleur.yellow('๐ŸŽฎ Navigation & Details:')));
646
646
  console.log(' โ†‘ / โ†“ Move focus through discovered projects');
647
647
  console.log(' Enter Toggle deep detail view (manifests, scripts, frameworks)');
648
648
  console.log(' Shift+C Add a persistent custom command to the focused project');
649
649
  console.log(' 1-9 Quick-run numbered scripts in detail view');
650
650
  console.log(' B/T/R Macro run: Build / Test / Run');
651
651
  console.log('');
652
- console.log(kleur.green.bold('๐Ÿ› ๏ธ Workspace Tools:'));
652
+ console.log(kleur.bold(kleur.green('๐Ÿ› ๏ธ Workspace Tools:')));
653
653
  console.log(' Shift+B Toggle Art-coded Build Atlas');
654
654
  console.log(' Shift+S Toggle Directory Structure Guide');
655
655
  console.log(' Shift+H Toggle Navigation Help Cards');
@@ -657,7 +657,7 @@ async function main() {
657
657
  console.log(' Shift+X Clear active log buffer');
658
658
  console.log(' Shift+E Export current session logs to .txt');
659
659
  console.log('');
660
- console.log(kleur.red.bold('๐Ÿšช System:'));
660
+ console.log(kleur.bold(kleur.red('๐Ÿšช System:')));
661
661
  console.log(' Shift+Q Quit application (triggers confirmation if tasks are running)');
662
662
  console.log(' Esc Global "Back" key to return to Main Navigator');
663
663
  console.log('');
Binary file