@flowscripter/dynamic-cli-framework 1.4.0 → 1.4.2

package/README/development.md

@@ -18,7 +18,7 @@ Lint:
 
 Generate HTML API Documentation:
 
-`bunx typedoc --readme none index.ts`
+`bunx typedoc index.ts`
 
 ### Debug Logging
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",
@@ -39,5 +39,11 @@
   },
   "peerDependencies": {
     "typescript": "^6.0.3"
+  },
+  "typedocOptions": {
+    "readme": "none",
+    "exclude": [
+      "tests/**"
+    ]
   }
 }

package/src/api/BaseCLIFeatureOptions.ts

@@ -7,4 +7,5 @@ export default interface BaseCLIFeatureOptions {
   readonly completionServiceEnabled?: boolean;
   readonly imagePrinterServiceEnabled?: boolean;
   readonly validateAllCommands?: boolean;
+  readonly promptingEnabled?: boolean;
 }

package/src/cli/BaseCLI.ts

@@ -129,6 +129,7 @@ export default class BaseCLI implements CLI {
       completionServiceEnabled: false,
       imagePrinterServiceEnabled: false,
       validateAllCommands: false,
+      promptingEnabled: true,
       ...options,
     };
     this.#keyReader = keyReader;
@@ -219,6 +220,7 @@ export default class BaseCLI implements CLI {
       this.#keyReader,
       this.#printerService,
     );
+    prompterService.promptEnabled = this.#options.promptingEnabled;
     this.addServiceProvider(new PrompterServiceProvider(75, prompterService));
 
     if (this.#options.argumentPrompterServiceEnabled) {
@@ -233,7 +235,7 @@ export default class BaseCLI implements CLI {
     let completionService: DefaultCompletionService | undefined;
     if (this.#options.completionServiceEnabled) {
       completionService = new DefaultCompletionService();
-      this.addServiceProvider(new CompletionServiceProvider(60, completionService));
+      this.addServiceProvider(new CompletionServiceProvider(5, completionService));
     }
 
     const configurationServiceProvider = new ConfigurationServiceProvider(

package/src/cli/DefaultRuntimeCLI.ts

@@ -29,7 +29,7 @@ export default class DefaultRuntimeCLI extends BaseCLI {
         supportsHyperlinks(process.stderr),
       ),
       new TtyKeyReader(process.stdin),
-      options,
+      { promptingEnabled: process.stdin.isTTY === true, ...options },
     );
   }
 

package/src/service/prompter/prompt/PromptContext.ts

@@ -14,8 +14,10 @@ export interface PromptContext {
 export function physicalLineCount(terminal: Terminal, text: string): number {
   const cols = terminal.columns();
   if (cols <= 0) return 1;
-  const width = Bun.stringWidth(text);
-  return Math.max(1, Math.ceil(width / cols));
+  return text.split("\n").reduce((sum, segment) => {
+    const width = Bun.stringWidth(segment);
+    return sum + Math.max(1, Math.ceil(width / cols));
+  }, 0);
 }
 
 export function headerLineCount(terminal: Terminal, promptDef: Prompt): number {

package/src/terminal/TtyKeyReader.ts

@@ -27,6 +27,25 @@ export default class TtyKeyReader implements KeyReader {
     return new Promise((resolve) => {
       const onData = (data: Buffer): void => {
         this.#ttyReadStream.removeListener("data", onData);
+
+        // A lone 0x1b may be the start of a multi-byte escape sequence (e.g. arrow keys).
+        // Wait briefly for the rest of the sequence before decoding.
+        if (data.length === 1 && data[0] === 0x1b) {
+          const timeout = setTimeout(() => {
+            this.#ttyReadStream.removeListener("data", onMore);
+            resolve(TtyKeyReader.#decodeKeyEvent(data));
+          }, 20);
+
+          const onMore = (more: Buffer): void => {
+            clearTimeout(timeout);
+            this.#ttyReadStream.removeListener("data", onMore);
+            resolve(TtyKeyReader.#decodeKeyEvent(Buffer.concat([data, more])));
+          };
+
+          this.#ttyReadStream.once("data", onMore);
+          return;
+        }
+
         resolve(TtyKeyReader.#decodeKeyEvent(data));
       };
       this.#ttyReadStream.on("data", onData);

package/tests/service/prompter/prompt/PromptContext.test.ts

@@ -0,0 +1,61 @@
+import { describe, expect, test } from "bun:test";
+import { physicalLineCount } from "../../../../src/service/prompter/prompt/PromptContext.ts";
+import type Terminal from "../../../../src/terminal/Terminal.ts";
+
+class MockTerminal implements Terminal {
+  readonly #cols: number;
+  constructor(cols: number) {
+    this.#cols = cols;
+  }
+  columns(): number {
+    return this.#cols;
+  }
+  rows(): number {
+    return 24;
+  }
+  clearLine(): Promise<void> {
+    return Promise.resolve();
+  }
+  clearUpLines(): Promise<void> {
+    return Promise.resolve();
+  }
+  hideCursor(): Promise<void> {
+    return Promise.resolve();
+  }
+  showCursor(): Promise<void> {
+    return Promise.resolve();
+  }
+  write(): Promise<void> {
+    return Promise.resolve();
+  }
+}
+
+describe("physicalLineCount", () => {
+  test("single short text fits on one line", () => {
+    expect(physicalLineCount(new MockTerminal(80), "hello")).toBe(1);
+  });
+
+  test("text wider than terminal wraps", () => {
+    // 11 chars on a 10-col terminal => 2 lines
+    expect(physicalLineCount(new MockTerminal(10), "hello world")).toBe(2);
+  });
+
+  test("embedded newline on wide terminal counts as two lines", () => {
+    // Both parts fit on one line (terminal 300 cols > 127 and > 81),
+    // but the embedded \n always forces 2 rendered lines
+    const text =
+      "This will set up your terminal so that pressing TAB while typing commands will show possible options and autocomplete arguments.\n(Enabling autocompletion will modify configuration files in your home directory.)";
+    expect(physicalLineCount(new MockTerminal(300), text)).toBe(2);
+  });
+
+  test("embedded newline combined with wrapping", () => {
+    // "hello world" (11 chars) => ceil(11/10) = 2 lines
+    // "foo" (3 chars) => ceil(3/10) = 1 line
+    // total = 3
+    expect(physicalLineCount(new MockTerminal(10), "hello world\nfoo")).toBe(3);
+  });
+
+  test("zero columns returns 1", () => {
+    expect(physicalLineCount(new MockTerminal(0), "hello")).toBe(1);
+  });
+});