ink-prompt 0.2.4 → 0.2.5

package/README.md

@@ -60,7 +60,7 @@ render(<App />);
 `MultilineInput` supports typical editing controls:
 
 - **Arrow keys** for navigation
-- `Ctrl+J` or typing `\` before **Enter** to add a newline
+- **Shift+Enter**, `Ctrl+J`, or typing `\` before **Enter** to add a newline (Shift+Enter requires a terminal that distinguishes it — most emit `ESC + CR` or the kitty `CSI 13;2u` sequence)
 - `Ctrl+Z` / `Ctrl+Y` for undo/redo
 - `Ctrl+A` / `Ctrl+E` for jump to line start/end
 - **Home** / **End** keys for line start/end

package/dist/components/MultilineInput/KeyHandler.js

@@ -125,6 +125,15 @@ const BACKSPACE_SEQUENCES = ['\u0008', '\u007f'];
 function isBackspaceSequence(seq) {
     return !!seq && BACKSPACE_SEQUENCES.includes(seq);
 }
+/**
+ * Raw sequences that represent Shift+Enter across terminal emulators.
+ * - `\x1b\r` / `\x1b\n`: ESC + CR/LF emitted by terminals like iTerm2 / WezTerm when configured.
+ * - `\x1b[13;2u`: kitty keyboard protocol encoding for Shift+Enter.
+ */
+const SHIFT_ENTER_SEQUENCES = ['\x1b\r', '\x1b\n', '\x1b[13;2u'];
+function isShiftEnterSequence(seq) {
+    return !!seq && SHIFT_ENTER_SEQUENCES.includes(seq);
+}
 /**
  * Handles keyboard input and maps it to text input actions.
  *
@@ -223,6 +232,15 @@ export function handleKey(key, input, buffer, actions, cursor, rawInput, width)
         actions.deleteForward();
         return;
     }
+    // Shift+Enter inserts a newline regardless of buffer state.
+    // Detected via Ink's shift+return flags or raw escape sequences emitted by
+    // terminals that distinguish Shift+Enter from Enter.
+    if ((key.shift && key.return) ||
+        (key.meta && key.return) ||
+        isShiftEnterSequence(rawInput)) {
+        actions.newLine();
+        return;
+    }
     // Submission / New Line
     if (key.return) {
         log(`[KEYHANDLER] return key, cursor=${JSON.stringify(cursor)}, currentLine="${(cursor ? buffer.lines[cursor.line || 0] : 'no cursor').replace(/[\x00-\x1F\x7F-\uFFFF]/g, c => `\\x${c.charCodeAt(0).toString(16)}`)}" endsWithBackslash=${cursor ? buffer.lines[cursor.line || 0].endsWith('\\') : false}`);

package/dist/components/MultilineInput/__tests__/KeyHandler.test.js

@@ -289,6 +289,24 @@ describe('KeyHandler', () => {
             expect(actions.newLine).not.toHaveBeenCalled();
             expect(actions.submit).not.toHaveBeenCalled();
         });
+        it('handles Shift+Enter as newline', () => {
+            buffer = { lines: ['hello'] };
+            handleKey({ shift: true, return: true }, '', buffer, actions);
+            expect(actions.newLine).toHaveBeenCalledTimes(1);
+            expect(actions.submit).not.toHaveBeenCalled();
+        });
+        it('handles ESC+CR raw sequence (Shift+Enter) as newline', () => {
+            buffer = { lines: ['hello'] };
+            handleKey({ meta: true, return: true }, '', buffer, actions, undefined, '\x1b\r');
+            expect(actions.newLine).toHaveBeenCalledTimes(1);
+            expect(actions.submit).not.toHaveBeenCalled();
+        });
+        it('handles kitty Shift+Enter CSI u sequence as newline', () => {
+            buffer = { lines: ['hello'] };
+            handleKey({}, '', buffer, actions, undefined, '\x1b[13;2u');
+            expect(actions.newLine).toHaveBeenCalledTimes(1);
+            expect(actions.submit).not.toHaveBeenCalled();
+        });
         it('handles Enter as newline if line ends with backslash (multiple lines)', () => {
             const cursor = { line: 1, column: 7 };
             buffer = { lines: ['first', 'second\\'] };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ink-prompt",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "A React Ink component for prompts",
   "type": "module",
   "main": "./dist/index.js",

package/dist/components/MultilineInput/ImageSentinel.d.ts

@@ -1,15 +0,0 @@
-export declare function generateImageId(): string;
-export declare function createSentinel(id: string, displayNumber: number): string;
-export interface SentinelInfo {
-    id: string;
-    displayNumber: number;
-    start: number;
-    end: number;
-}
-export declare function parseSentinels(text: string): SentinelInfo[];
-export declare function findSentinelAt(text: string, offset: number): SentinelInfo | null;
-export declare function isInsideSentinel(text: string, offset: number): boolean;
-export declare function removeSentinel(text: string, offset: number): string;
-export declare function getPlaceholderText(displayNumber: number): string;
-export declare function getPlaceholderVisualWidth(displayNumber: number): number;
-export declare function getSentinelVisualWidthFromText(text: string, offset: number): number | null;

package/dist/components/MultilineInput/ImageSentinel.js

@@ -1,62 +0,0 @@
-import { SENTINEL_OPEN, SENTINEL_CLOSE } from './ImageTypes.js';
-export function generateImageId() {
-    return Math.random().toString(36).substring(2, 10) + Math.random().toString(36).substring(2, 6);
-}
-export function createSentinel(id, displayNumber) {
-    return `${SENTINEL_OPEN}${id}:${displayNumber}${SENTINEL_CLOSE}`;
-}
-export function parseSentinels(text) {
-    const result = [];
-    let i = 0;
-    while (i < text.length) {
-        const openIdx = text.indexOf(SENTINEL_OPEN, i);
-        if (openIdx === -1)
-            break;
-        const closeIdx = text.indexOf(SENTINEL_CLOSE, openIdx + 1);
-        if (closeIdx === -1)
-            break;
-        const raw = text.substring(openIdx + 1, closeIdx);
-        const colonIdx = raw.lastIndexOf(':');
-        const id = colonIdx >= 0 ? raw.substring(0, colonIdx) : raw;
-        const displayNumber = colonIdx >= 0 ? parseInt(raw.substring(colonIdx + 1), 10) || 1 : 1;
-        result.push({ id, displayNumber, start: openIdx, end: closeIdx + 1 });
-        i = closeIdx + 1;
-    }
-    return result;
-}
-export function findSentinelAt(text, offset) {
-    const sentinels = parseSentinels(text);
-    for (const s of sentinels) {
-        if (offset >= s.start && offset <= s.end) {
-            return s;
-        }
-    }
-    return null;
-}
-export function isInsideSentinel(text, offset) {
-    const sentinels = parseSentinels(text);
-    for (const s of sentinels) {
-        if (offset >= s.start && offset < s.end) {
-            return true;
-        }
-    }
-    return false;
-}
-export function removeSentinel(text, offset) {
-    const sentinel = findSentinelAt(text, offset);
-    if (!sentinel)
-        return text;
-    return text.slice(0, sentinel.start) + text.slice(sentinel.end);
-}
-export function getPlaceholderText(displayNumber) {
-    return `[Pasted Image #${displayNumber}]`;
-}
-export function getPlaceholderVisualWidth(displayNumber) {
-    return getPlaceholderText(displayNumber).length;
-}
-export function getSentinelVisualWidthFromText(text, offset) {
-    const s = findSentinelAt(text, offset);
-    if (!s)
-        return null;
-    return getPlaceholderVisualWidth(s.displayNumber);
-}

package/dist/components/MultilineInput/__tests__/ImageSentinel.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/components/MultilineInput/__tests__/ImageSentinel.test.js

@@ -1,154 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { generateImageId, createSentinel, parseSentinels, findSentinelAt, isInsideSentinel, removeSentinel, getPlaceholderText, getPlaceholderVisualWidth, } from '../ImageSentinel.js';
-import { SENTINEL_OPEN, SENTINEL_CLOSE } from '../ImageTypes.js';
-describe('ImageSentinel', () => {
-    describe('generateImageId', () => {
-        it('generates a string id', () => {
-            const id = generateImageId();
-            expect(typeof id).toBe('string');
-            expect(id.length).toBeGreaterThan(0);
-        });
-        it('generates unique ids', () => {
-            const ids = new Set(Array.from({ length: 100 }, () => generateImageId()));
-            expect(ids.size).toBe(100);
-        });
-    });
-    describe('createSentinel', () => {
-        it('creates a sentinel block with the given id and display number', () => {
-            const result = createSentinel('abc123', 1);
-            expect(result).toBe(`${SENTINEL_OPEN}abc123:1${SENTINEL_CLOSE}`);
-        });
-        it('creates a sentinel with higher display number', () => {
-            const result = createSentinel('def456', 42);
-            expect(result).toBe(`${SENTINEL_OPEN}def456:42${SENTINEL_CLOSE}`);
-        });
-    });
-    describe('parseSentinels', () => {
-        it('returns empty array for text without sentinels', () => {
-            expect(parseSentinels('hello world')).toEqual([]);
-        });
-        it('finds a single sentinel', () => {
-            const text = `hello ${SENTINEL_OPEN}abc123:1${SENTINEL_CLOSE} world`;
-            const result = parseSentinels(text);
-            expect(result).toEqual([
-                { id: 'abc123', displayNumber: 1, start: 6, end: 16 },
-            ]);
-        });
-        it('finds multiple sentinels', () => {
-            const text = `${SENTINEL_OPEN}id1:1${SENTINEL_CLOSE}hello${SENTINEL_OPEN}id2:2${SENTINEL_CLOSE}`;
-            const result = parseSentinels(text);
-            expect(result).toEqual([
-                { id: 'id1', displayNumber: 1, start: 0, end: 7 },
-                { id: 'id2', displayNumber: 2, start: 12, end: 19 },
-            ]);
-        });
-        it('returns empty for unmatched opener', () => {
-            const text = `hello ${SENTINEL_OPEN}abc:1`;
-            const result = parseSentinels(text);
-            expect(result).toEqual([]);
-        });
-        it('returns empty for unmatched closer', () => {
-            const text = `hello abc:1${SENTINEL_CLOSE} world`;
-            const result = parseSentinels(text);
-            expect(result).toEqual([]);
-        });
-    });
-    describe('findSentinelAt', () => {
-        it('returns null when offset is not near a sentinel', () => {
-            const text = `hello ${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE} world`;
-            expect(findSentinelAt(text, 0)).toBeNull();
-        });
-        it('finds sentinel when offset is at the opener', () => {
-            const text = `hello ${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE} world`;
-            const result = findSentinelAt(text, 6);
-            expect(result).toMatchObject({ id: 'abc', displayNumber: 1, start: 6 });
-        });
-        it('finds sentinel when offset is inside the id', () => {
-            const text = `hello ${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE} world`;
-            const result = findSentinelAt(text, 8);
-            expect(result).toMatchObject({ id: 'abc', displayNumber: 1 });
-        });
-        it('finds sentinel when offset is at the closer', () => {
-            const text = `hello ${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE} world`;
-            const result = findSentinelAt(text, 12);
-            expect(result).toMatchObject({ id: 'abc', displayNumber: 1 });
-        });
-        it('finds sentinel when offset is right after the closer', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            const result = findSentinelAt(text, 7);
-            expect(result).toMatchObject({ id: 'abc', displayNumber: 1, start: 0, end: 7 });
-        });
-    });
-    describe('isInsideSentinel', () => {
-        it('returns false when offset is before any sentinel', () => {
-            const text = `hi ${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            expect(isInsideSentinel(text, 0)).toBe(false);
-        });
-        it('returns false when offset is after sentinel', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE} world`;
-            expect(isInsideSentinel(text, 10)).toBe(false);
-        });
-        it('returns true when offset is at the opener', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            expect(isInsideSentinel(text, 0)).toBe(true);
-        });
-        it('returns true when offset is inside the id', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            expect(isInsideSentinel(text, 2)).toBe(true);
-        });
-        it('returns true when offset is at the closer', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            expect(isInsideSentinel(text, 6)).toBe(true);
-        });
-        it('returns false when offset is after the closer', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            expect(isInsideSentinel(text, 7)).toBe(false);
-        });
-    });
-    describe('removeSentinel', () => {
-        it('removes sentinel block at cursor position', () => {
-            const text = `hello ${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE} world`;
-            const result = removeSentinel(text, 10);
-            expect(result).toBe('hello  world');
-        });
-        it('removes sentinel when cursor is at the opener', () => {
-            const text = `${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}hello`;
-            const result = removeSentinel(text, 0);
-            expect(result).toBe('hello');
-        });
-        it('removes sentinel when cursor is at the closer', () => {
-            const text = `hello${SENTINEL_OPEN}abc:1${SENTINEL_CLOSE}`;
-            const result = removeSentinel(text, 11);
-            expect(result).toBe('hello');
-        });
-        it('removes first sentinel when cursor is between two', () => {
-            const text = `${SENTINEL_OPEN}a:1${SENTINEL_CLOSE}${SENTINEL_OPEN}b:2${SENTINEL_CLOSE}`;
-            const result = removeSentinel(text, 1);
-            expect(result).toBe(`${SENTINEL_OPEN}b:2${SENTINEL_CLOSE}`);
-        });
-        it('returns text unchanged if no sentinel at offset', () => {
-            const text = 'hello world';
-            const result = removeSentinel(text, 3);
-            expect(result).toBe('hello world');
-        });
-    });
-    describe('getPlaceholderText', () => {
-        it('returns correct placeholder for display number 1', () => {
-            expect(getPlaceholderText(1)).toBe('[Pasted Image #1]');
-        });
-        it('returns correct placeholder for display number 42', () => {
-            expect(getPlaceholderText(42)).toBe('[Pasted Image #42]');
-        });
-    });
-    describe('getPlaceholderVisualWidth', () => {
-        it('returns correct width for display number 1', () => {
-            expect(getPlaceholderVisualWidth(1)).toBe(17);
-        });
-        it('returns correct width for display number 100', () => {
-            expect(getPlaceholderVisualWidth(100)).toBe(19);
-        });
-        it('returns correct width for display number 0', () => {
-            expect(getPlaceholderVisualWidth(0)).toBe(17);
-        });
-    });
-});