project-compass 1.0.9 β†’ 2.0.0

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/README.md CHANGED
@@ -7,8 +7,9 @@ Project Compass is a futuristic CLI navigator built with [Ink](https://github.co
7
7
  - πŸ” Scans directories for Node.js, Python, Rust, Go, Java, and Scala projects by looking at their manifest files.
8
8
  - 🎨 Combines the glyph-based art board with a Projects/Details row that keeps everything inside the viewport, while live stdout/stderr logs stay in their own band below.
9
9
  - πŸš€ Press **Enter** on any project to open the detail view, where you can inspect the type, manifest, frameworks, commands, and save custom actions.
10
- - πŸ’‘ A dedicated output row with an interactive stdin buffer, plus help tiles that stay in their own band; Shift+↑/↓ scrolls the log window, typing feeds stdin (buffer shows what you type, Enter submits, Ctrl+C aborts), L reruns the last command, H hides the cards, S opens the structure guide, and `?` pops an overlay with quick tips.
10
+ - πŸ’‘ A dedicated output row with an interactive stdin buffer, plus help tiles that stay in their own band; Shift+↑/↓ scrolls the log window, typing feeds stdin (buffer shows what you type, Enter submits, Ctrl+C aborts), Ctrl+L reruns the last command, Ctrl+H shows/hides the help cards, Ctrl+S opens the structure guide, and `?` pops an overlay with quick tips.
11
11
  - 🎯 Built-in shortcuts (B/T/R) run the canonical build/test/run workflow, while numeric hotkeys (1, 2, 3...) execute whichever command is listed in the detail view.
12
+ - 🧠 Modular detection now scans for Node, Python, Rust, Go, Java, Scala, PHP, Ruby, .NET, shell/Makefile projects plus custom workspaces, and surface setup hints (npm install, pip install, cargo fetch, etc.).
12
13
  - 🧠 Add bespoke commands via **C** in detail view and store them globally (`~/.project-compass/config.json`) so every workspace remembers your favorite invocations.
13
14
  - πŸ”Œ Extend detection via plugins (JSON specs under `~/.project-compass/plugins.json`) to teach Project Compass about extra frameworks or command sets.
14
15
  - πŸ“¦ Install globally and invoke `project-compass` from any folder to activate the UI instantly.
@@ -34,13 +35,13 @@ project-compass [--dir /path/to/workspace]
34
35
  | 1‑9 | Execute the numbered commands listed in detail view |
35
36
  | C | Add a custom command (`label|cmd`) that saves to `~/.project-compass/config.json` |
36
37
  | Shift ↑ / ↓ | Scroll the output buffer |
37
- | L | Rerun the most recent command |
38
+ | Ctrl+L | Rerun the most recent command |
38
39
  | ? | Toggle the help overlay with navigation tips |
39
- | h | Hide/show the navigation/help cards beneath the logs |
40
- | s | Toggle the structure guide listing the manifests per language |
40
+ | Ctrl+H | Show/hide the navigation/help cards beneath the logs |
41
+ | Ctrl+S | Toggle the structure guide listing the manifests per language |
42
+ | Ctrl+Q | Quit the app |
41
43
  | Typing while running | Sends stdin to the running command (buffer shows the text, Enter submits, Ctrl+C aborts) |
42
44
  | Ctrl+C | Interrupt a running command (works while streaming output) |
43
- | Q | Quit |
44
45
 
45
46
  ## Framework & plugin support
46
47
 
@@ -74,13 +75,18 @@ Project Compass now opens with a rounded art board that shuffles your glyph row
74
75
 
75
76
  ## Layout, output & help
76
77
 
77
- Projects and details now occupy the same row, while the output panel takes its own full-width band beneath so long logs no longer stretch the rest of the UI. The output pane scrolls independently (Shift+↑/↓ or mouse wheel), feeds keystrokes into stdin while a command runs (type like normal, Enter submits, Ctrl+C aborts), and the buffer below shows exactly what you are typing. A trio of help tiles highlights navigation cues, command flow, and recent runs; press H to hide/show those tiles if you need more space, S to open the structure guide that lists the manifest files for each language detection, `?` to open the overlay with extra tips, and L to rerun the previous command.
78
+ Projects and details now occupy the same row, while the output panel takes its own full-width band beneath so long logs no longer stretch the rest of the UI. The output pane scrolls independently (Shift+↑/↓), feeds keystrokes into stdin while a command runs (type like normal, Enter submits, Ctrl+C aborts), and the buffer below shows exactly what you are typing. A trio of help tiles highlights navigation cues, command flow, and recent runs; they stay hidden by defaultβ€”press Ctrl+H to reveal the cards, Ctrl+S to show the structure guide that lists the manifest files for each language detection, `?` to open the overlay with extra tips, Ctrl+L to rerun the previous command, and Ctrl+Q to quit.
78
79
 
79
80
  ## Structure guide
80
81
 
81
82
  Press `S` to reveal the structure guide that lists which manifest files trigger each language detection (Node.js looks for `package.json`, Python looks for `pyproject.toml` or `requirements.txt`, Rust needs `Cargo.toml`, etc.). Use `H` to hide the help cards if you need every pixel for your output, then bring them back when you want a refresher.
82
83
 
83
84
 
85
+ ## Project detection & setup hints
86
+
87
+ Project Compass now points at a dedicated detection module (`src/projectDetection.js`). It runs a set of SCHEMAS that look for Node.js, Python, Rust, Go, Java, Scala, PHP, Ruby, .NET, and shell/Makefile projects (plus a generic fallback), and it discovers any plugins you drop under `~/.project-compass/plugins.json`. Each detected project carries `setupHints` (e.g., `npm install`, `pip install -r requirements.txt`, `cargo fetch`) so you know what to do before running the commands listed in the detail view.
88
+
89
+
84
90
  ## Developer notes
85
91
 
86
92
  - `npm start` launches the Ink UI in the current directory.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "project-compass",
3
- "version": "1.0.9",
3
+ "version": "2.0.0",
4
4
  "description": "Ink-based project explorer that detects local repos and lets you build/test/run them without memorizing commands.",
5
5
  "main": "src/cli.js",
6
6
  "type": "module",