project-compass 4.1.8 → 4.1.9
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 +13 -15
- package/ARCHITECTURE.md +2 -2
- package/CONTRIBUTING.md +1 -1
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -3,34 +3,32 @@
|
|
|
3
3
|
Welcome to Project Compass. This file provides context for AI agents (Clawdy, Claude, Copilot, etc.) working on this repository.
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
|
-
Project Compass is a futuristic project navigator and runner designed for modern polyglot development
|
|
6
|
+
Project Compass is a futuristic project navigator and runner designed for modern polyglot development. It provides a high-fidelity terminal UI (using Ink) to manage complex workspaces with integrated Agentic AI intelligence.
|
|
7
7
|
|
|
8
8
|
## Project Structure
|
|
9
|
-
- `src/cli.js`: Entry point. Handles argument parsing and the main Ink UI loop.
|
|
10
|
-
- `src/projectDetection.js`:
|
|
9
|
+
- `src/cli.js`: Entry point. Handles argument parsing, global input, and the main Ink UI loop.
|
|
10
|
+
- `src/projectDetection.js`: Orchestrator for identifying projects.
|
|
11
|
+
- `src/detectors/`: Modular detection logic for Node, Python, Rust, Go, Java, PHP, Ruby, and .NET.
|
|
11
12
|
- `src/components/`: React/Ink components for the TUI.
|
|
13
|
+
- `AIHorizon.js`: [NEW] Agentic AI intelligence suite (OpenRouter, Gemini, Claude, Ollama).
|
|
14
|
+
- `Navigator.js`: Paginated project navigator with strict boundary guards.
|
|
12
15
|
- `TaskManager.js`: Orbit Task Manager (background processes).
|
|
13
|
-
- `PackageRegistry.js`:
|
|
16
|
+
- `PackageRegistry.js`: Native dependency management interface.
|
|
14
17
|
- `ProjectArchitect.js`: Scaffolding and templates.
|
|
15
|
-
|
|
16
|
-
- `assets/`: UI-related assets (screenshots, etc.).
|
|
18
|
+
- `assets/`: UI-related screenshots and branding.
|
|
17
19
|
|
|
18
20
|
## Tech Stack
|
|
19
21
|
- **Runtime:** Node.js (ESM)
|
|
20
22
|
- **UI Framework:** [Ink](https://github.com/vadimdemedes/ink) (React for CLI)
|
|
21
|
-
- **Styling:** `kleur`
|
|
23
|
+
- **Styling:** `kleur`
|
|
22
24
|
- **Execution:** `execa` for robust subprocess management.
|
|
25
|
+
- **Intelligence:** Native `fetch` for agentic API handshakes.
|
|
23
26
|
|
|
24
27
|
## Development Rules
|
|
25
28
|
1. **Zero Mock Data:** Always aim for live system/project data.
|
|
26
|
-
2. **ESM Only:**
|
|
27
|
-
3. **
|
|
28
|
-
4. **
|
|
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.
|
|
29
|
+
2. **ESM Only:** Use `import/export`.
|
|
30
|
+
3. **Paging Rules:** Use the hard-coded `maxVisibleProjects` (current default: 3) for navigation logic.
|
|
31
|
+
4. **Port Logic:** Respect `projectMeta` in `config.json` for manual port assignments.
|
|
34
32
|
|
|
35
33
|
---
|
|
36
34
|
*Created for the CrimsonDevil333333 Ecosystem.*
|
package/ARCHITECTURE.md
CHANGED
|
@@ -4,9 +4,9 @@ This document describes the high-level architecture of Project Compass.
|
|
|
4
4
|
|
|
5
5
|
## Data Flow
|
|
6
6
|
1. **Initialization:** `cli.js` resolves the working directory (defaults to current folder).
|
|
7
|
-
2. **Discovery:** `projectDetection.js`
|
|
7
|
+
2. **Discovery:** `projectDetection.js` orchestrates modular detectors in `src/detectors/` to perform a high-speed glob search for common manifest files (`package.json`, `cargo.toml`, `go.mod`, etc.).
|
|
8
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.
|
|
9
|
+
4. **Rendering:** Components in `src/components` handle specific views (Task Manager, Architect, AI Horizon, etc.) based on user keypresses.
|
|
10
10
|
5. **Execution:** User-triggered scripts (like running `npm test`) are managed by `TaskManager.js` using `execa` with streaming logs.
|
|
11
11
|
|
|
12
12
|
## Design Patterns
|
package/CONTRIBUTING.md
CHANGED
|
@@ -13,7 +13,7 @@ This repository is "AI-First." Always update `AGENTS.md` after making structural
|
|
|
13
13
|
## Workflow
|
|
14
14
|
1. **Fork and Branch:** Create a branch for your feature or fix.
|
|
15
15
|
2. **Code Style:** Follow the existing ESM pattern.
|
|
16
|
-
3. **Testing:** Run `npm start`
|
|
16
|
+
3. **Testing:** Run `npm start` and verify AI Horizon (`Shift+O`) and Port Config (`Shift+R`) functionality. (like a multi-repo folder) to ensure the UI remains performant.
|
|
17
17
|
4. **Commits:** Use conventional commits (`feat:`, `fix:`, `docs:`, `refactor:`).
|
|
18
18
|
|
|
19
19
|
## Deployment
|