project-compass 1.0.8 โ†’ 1.0.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.
Files changed (3) hide show
  1. package/README.md +3 -3
  2. package/package.json +1 -1
  3. package/src/cli.js +12 -13
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+โ†‘/โ†“ or mouse wheel scrolls logs, typing feeds stdin (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), 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 (or use the mouse wheel) |
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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "project-compass",
3
- "version": "1.0.8",
3
+ "version": "1.0.9",
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",
package/src/cli.js CHANGED
@@ -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
- 'โ†‘/โ†“ move projects, Enter toggles detail view',
1256
- 'Shift+arrows scroll logs',
1257
- 'H hides/shows cards, ? opens overlay'
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 runs build/test/run quickly',
1265
- '1-9 execute detail commands',
1266
- 'L reruns last command, Ctrl+C aborts',
1267
- 'Type while running to feed stdin'
1262
+ 'B / T / R run build / test / run quickly',
1263
+ '1-9 execute the numbered detail commands',
1264
+ 'L reruns the last command, Ctrl+C aborts',
1265
+ 'Type while running to feed stdin (buffer below shows 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 for structure guide when you doubt the project layout'
1273
+ 'Press S for the structure guide if you doubt the layout',
1274
+ 'Add 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).')