project-compass 1.0.8 β 1.0.10
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 +4 -4
- package/package.json +1 -1
- package/src/cli.js +13 -14
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ 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+β/β
|
|
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.
|
|
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
12
|
- π§ Add bespoke commands via **C** in detail view and store them globally (`~/.project-compass/config.json`) so every workspace remembers your favorite invocations.
|
|
13
13
|
- π Extend detection via plugins (JSON specs under `~/.project-compass/plugins.json`) to teach Project Compass about extra frameworks or command sets.
|
|
@@ -33,12 +33,12 @@ project-compass [--dir /path/to/workspace]
|
|
|
33
33
|
| B / T / R | Run the workspace build/test/run shortcuts |
|
|
34
34
|
| 1β9 | Execute the numbered commands listed in detail view |
|
|
35
35
|
| C | Add a custom command (`label|cmd`) that saves to `~/.project-compass/config.json` |
|
|
36
|
-
| Shift β / β | Scroll the output buffer
|
|
36
|
+
| Shift β / β | Scroll the output buffer |
|
|
37
37
|
| L | Rerun the most recent command |
|
|
38
38
|
| ? | Toggle the help overlay with navigation tips |
|
|
39
39
|
| h | Hide/show the navigation/help cards beneath the logs |
|
|
40
40
|
| s | Toggle the structure guide listing the manifests per language |
|
|
41
|
-
| Typing while running | Sends stdin to the running command (Enter submits, Ctrl+C aborts) |
|
|
41
|
+
| Typing while running | Sends stdin to the running command (buffer shows the text, Enter submits, Ctrl+C aborts) |
|
|
42
42
|
| Ctrl+C | Interrupt a running command (works while streaming output) |
|
|
43
43
|
| Q | Quit |
|
|
44
44
|
|
|
@@ -74,7 +74,7 @@ Project Compass now opens with a rounded art board that shuffles your glyph row
|
|
|
74
74
|
|
|
75
75
|
## Layout, output & help
|
|
76
76
|
|
|
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
|
|
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; they start hidden by defaultβpress H to reveal the cards and hide them again when you need more space. Press 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
78
|
|
|
79
79
|
## Structure guide
|
|
80
80
|
|
package/package.json
CHANGED
package/src/cli.js
CHANGED
|
@@ -840,7 +840,7 @@ function Compass({rootPath}) {
|
|
|
840
840
|
const [customMode, setCustomMode] = useState(false);
|
|
841
841
|
const [customInput, setCustomInput] = useState('');
|
|
842
842
|
const [config, setConfig] = useState(() => loadConfig());
|
|
843
|
-
const [showHelpCards, setShowHelpCards] = useState(
|
|
843
|
+
const [showHelpCards, setShowHelpCards] = useState(false);
|
|
844
844
|
const [showStructureGuide, setShowStructureGuide] = useState(false);
|
|
845
845
|
const [stdinBuffer, setStdinBuffer] = useState('');
|
|
846
846
|
const [showHelp, setShowHelp] = useState(false);
|
|
@@ -1244,27 +1244,25 @@ const projectRows = [];
|
|
|
1244
1244
|
? visibleLogs.map((line, index) => create(Text, {key: index}, line))
|
|
1245
1245
|
: [create(Text, {dimColor: true}, 'Logs will appear here once you run a command.')];
|
|
1246
1246
|
|
|
1247
|
-
|
|
1248
|
-
// Using global SCHEMA_GUIDE
|
|
1249
|
-
|
|
1250
|
-
const helpCards = [
|
|
1247
|
+
const helpCards = [
|
|
1251
1248
|
{
|
|
1252
1249
|
label: 'Navigation',
|
|
1253
1250
|
color: 'magenta',
|
|
1254
1251
|
body: [
|
|
1255
|
-
'
|
|
1256
|
-
'
|
|
1257
|
-
'
|
|
1252
|
+
'β / β move the project focus',
|
|
1253
|
+
'Enter toggles detail view',
|
|
1254
|
+
'Shift + β / β scrolls the log buffer',
|
|
1255
|
+
'H toggles cards, ? opens the overlay'
|
|
1258
1256
|
]
|
|
1259
1257
|
},
|
|
1260
1258
|
{
|
|
1261
1259
|
label: 'Command flow',
|
|
1262
1260
|
color: 'cyan',
|
|
1263
1261
|
body: [
|
|
1264
|
-
'B/T/R
|
|
1265
|
-
'1-9 execute detail commands',
|
|
1266
|
-
'L reruns last command
|
|
1267
|
-
'
|
|
1262
|
+
'B / T / R run build / test / run',
|
|
1263
|
+
'1-9 execute the numbered detail commands',
|
|
1264
|
+
'L reruns the last command',
|
|
1265
|
+
'Ctrl+C aborts, typing feeds stdin (buffer mirrors text)'
|
|
1268
1266
|
]
|
|
1269
1267
|
},
|
|
1270
1268
|
{
|
|
@@ -1272,7 +1270,8 @@ const helpCards = [
|
|
|
1272
1270
|
color: 'yellow',
|
|
1273
1271
|
body: [
|
|
1274
1272
|
recentRuns.length ? `${recentRuns.length} runs recorded` : 'No runs yet Β· start with B/T/R',
|
|
1275
|
-
'Press S
|
|
1273
|
+
'Press S to show the structure guide',
|
|
1274
|
+
'Save custom commands with C β label|cmd'
|
|
1276
1275
|
]
|
|
1277
1276
|
}
|
|
1278
1277
|
];
|
|
@@ -1334,7 +1333,7 @@ const helpCards = [
|
|
|
1334
1333
|
},
|
|
1335
1334
|
create(Text, {color: 'cyan', bold: true}, 'Help overlay Β· press ? to hide'),
|
|
1336
1335
|
create(Text, null, 'Shift+arrows scroll the output buffer.'),
|
|
1337
|
-
create(Text, null, 'Run commands and type to feed stdin (Enter submits, Ctrl+C aborts).'),
|
|
1336
|
+
create(Text, null, 'Run commands and type to feed stdin (Enter submits, Ctrl+C aborts); the buffer shows what you type.'),
|
|
1338
1337
|
create(Text, null, 'H hides/shows the navigation cards, S shows structure tips, and L reruns the previous command.'),
|
|
1339
1338
|
create(Text, null, 'Projects + Details stay side-by-side while Output and the log buffer stay fixed in their own band.'),
|
|
1340
1339
|
create(Text, null, 'Structure guide lists the manifests that trigger each language detection (press S to toggle).')
|