cliedit 0.1.0 → 0.1.2

package/ACKNOWLEDGEMENTS.md

@@ -0,0 +1,21 @@
+# Acknowledgements & Copyright (ACKNOWLEDGEMENTS)
+
+`cliedit` is an open-source project that utilizes components (or modified/converted versions thereof) from other open-source projects. We express our deep gratitude to the communities and authors who provided the foundation for these components.
+
+All components listed below are included as vendored code (integrated directly into the project source code) and have been adapted to fit **cliedit**'s TypeScript architecture and remove unnecessary features (e.g., mouse support).
+
+## Vendored Components List
+
+**Original Project Name: `keypress`**
+
+**Description & Origin:** Provides raw key event parsing logic for the TTY environment. The source code was converted from the original JavaScript version and optimized for Node.js.
+
+**Repository:** https://github.com/TooTallNate/keypress
+
+**License:** MIT
+
+**Copyright Notes:**
+
+- `keypress` was originally authored by **Nathan Rajlich** (tootallnate.net).
+- Copyright (c) 2012 Nathan Rajlich.
+- The module is based on the keypress logic found within the Node.js Core `readline` module.

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 CodeTease
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 CodeTease
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,88 +1,92 @@
-# cliedit
-
-A lightweight, zero-dependency (other than `keypress`), raw-mode terminal editor component for Node.js.
-
-`cliedit` is designed to be imported into your own CLI application to provide a full-featured, TTY-based text editing experience. It's perfect for applications that need to ask the user for multi-line input, edit configuration files, or write commit messages.
-
-It includes line wrapping, visual navigation, undo/redo, text selection, and clipboard support.
-
-## Features
-
-- **Raw Mode TTY:** Takes over the terminal for a full "app-like" feel.
-- **Visual Line Wrapping:** Text wraps to fit the terminal width.
-- **Visual Navigation:** `Up`/`Down` arrows move by visual rows, not logical lines.
-- **Undo/Redo:** `Ctrl+Z` / `Ctrl+Y` for persistent history.
-- **Text Selection:** `Ctrl+Arrow` keys to select text.
-- **Clipboard Support:** `Ctrl+C` (Copy), `Ctrl+X` (Cut), `Ctrl+V` (Paste) for system clipboard (macOS/Windows).
-- **File I/O:** Loads from and saves to the filesystem.
-- **Search:** `Ctrl+W` to find text.
-
-## Installation
-```bash
-npm install cliedit
-```
-
-## Usage
-
-The package exports an `async` function `openEditor` that returns a `Promise`. The promise resolves when the user quits the editor.
-```javascript
-import { openEditor } from 'cliedit';
-import path from 'path';
-
-async function getCommitMessage() {
-  const tempFile = path.resolve(process.cwd(), 'COMMIT_MSG.txt');
-  console.log('Opening editor for commit message...');
-
-  try {
-    const result = await openEditor(tempFile);
-
-    // Give the terminal a moment to restore
-    await new Promise(res => setTimeout(res, 50));
-
-    if (result.saved) {
-      console.log('Message saved!');
-      console.log('---------------------');
-      console.log(result.content);
-      console.log('---------------------');
-    } else {
-      console.log('Editor quit without saving.');
-    }
-  } catch (err) {
-    console.error('Editor failed to start:', err);
-  }
-}
-
-getCommitMessage();
-```
-
-## Public API
-
-`openEditor(filepath: string)`
-
-Opens the editor for the specified file. If the file doesn't exist, it will be created upon saving.
-- **Returns:** `Promise<{ saved: boolean; content: string }>`
-    * `saved`: `true` if the user saved (Ctrl+S), `false` otherwise (Ctrl+Q).
-    * `content`: The final content of the file as a string.
-
-`CliEditor`
-
-The main editor class. You can import this directly if you need to extend or instantiate the editor with custom logic.
-```javascript
-import { CliEditor } from 'cliedit';
-```
-
-### Types
-
-Key types are also exported for convenience:
-```javascript
-import type {
-  DocumentState,
-  VisualRow,
-  EditorMode,
-  NormalizedRange,
-} from 'cliedit';
-```
-
-## License
-
+# cliedit
+
+A lightweight, zero-dependency, raw-mode terminal editor component for Node.js.
+
+`cliedit` is designed to be imported into your own CLI application to provide a full-featured, TTY-based text editing experience. It's perfect for applications that need to ask the user for multi-line input, edit configuration files, or write commit messages.
+
+It includes line wrapping, visual navigation, undo/redo, text selection, and clipboard support.
+
+## Features
+
+- **Raw Mode TTY:** Takes over the terminal for a full "app-like" feel.
+- **Visual Line Wrapping:** Text wraps to fit the terminal width.
+- **Visual Navigation:** `Up`/`Down` arrows move by visual rows, not logical lines.
+- **Undo/Redo:** `Ctrl+Z` / `Ctrl+Y` for persistent history.
+- **Text Selection:** `Ctrl+Arrow` keys to select text.
+- **Clipboard Support:** `Ctrl+C` (Copy), `Ctrl+X` (Cut), `Ctrl+V` (Paste) for system clipboard (macOS/Windows).
+- **File I/O:** Loads from and saves to the filesystem.
+- **Search:** `Ctrl+W` to find text.
+
+## Installation
+```bash
+npm install cliedit
+```
+
+## Usage
+
+The package exports an `async` function `openEditor` that returns a `Promise`. The promise resolves when the user quits the editor.
+```javascript
+import { openEditor } from 'cliedit';
+import path from 'path';
+
+async function getCommitMessage() {
+  const tempFile = path.resolve(process.cwd(), 'COMMIT_MSG.txt');
+  console.log('Opening editor for commit message...');
+
+  try {
+    const result = await openEditor(tempFile);
+
+    // Give the terminal a moment to restore
+    await new Promise(res => setTimeout(res, 50));
+
+    if (result.saved) {
+      console.log('Message saved!');
+      console.log('---------------------');
+      console.log(result.content);
+      console.log('---------------------');
+    } else {
+      console.log('Editor quit without saving.');
+    }
+  } catch (err) {
+    console.error('Editor failed to start:', err);
+  }
+}
+
+getCommitMessage();
+```
+
+## Public API
+
+`openEditor(filepath: string)`
+
+Opens the editor for the specified file. If the file doesn't exist, it will be created upon saving.
+- **Returns:** `Promise<{ saved: boolean; content: string }>`
+    * `saved`: `true` if the user saved (Ctrl+S), `false` otherwise (Ctrl+Q).
+    * `content`: The final content of the file as a string.
+
+`CliEditor`
+
+The main editor class. You can import this directly if you need to extend or instantiate the editor with custom logic.
+```javascript
+import { CliEditor } from 'cliedit';
+```
+
+### Types
+
+Key types are also exported for convenience:
+```javascript
+import type {
+  DocumentState,
+  VisualRow,
+  EditorMode,
+  NormalizedRange,
+} from 'cliedit';
+```
+
+## Acknowledgements
+
+Please see the [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md) file for important copyright information regarding the vendored `keypress` component.
+
+## License
+
 [MIT](LICENSE)

package/dist/constants.d.ts

@@ -20,7 +20,9 @@ export declare const KEYS: {
     CTRL_Q: string;
     CTRL_S: string;
     CTRL_W: string;
+    CTRL_R: string;
     CTRL_G: string;
+    CTRL_L: string;
     CTRL_Z: string;
     CTRL_Y: string;
     CTRL_K: string;

package/dist/constants.js

@@ -22,7 +22,9 @@ export const KEYS = {
     CTRL_Q: '\x11', // Quit
     CTRL_S: '\x13', // Save
     CTRL_W: '\x17', // Find (Where is)
+    CTRL_R: '\x12', // Replace
     CTRL_G: '\x07', // Go to next
+    CTRL_L: '\x0c', // Go to Line (L)
     CTRL_Z: '\x1a', // Undo
     CTRL_Y: '\x19', // Redo
     CTRL_K: '\x0b', // Cut/Kill line

package/dist/editor.clipboard.js

@@ -15,8 +15,11 @@ function setClipboard(text) {
             case 'win32':
                 command = 'clip';
                 break;
+            case 'linux': // <--- THÊM HỖ TRỢ LINUX
+                command = 'xclip -selection clipboard';
+                break;
             default:
-                this.setStatusMessage('Clipboard only supported on macOS/Windows for now');
+                this.setStatusMessage('Clipboard not supported on this platform');
                 return resolve();
         }
         const process = exec(command, (error) => {
@@ -43,8 +46,11 @@ function getClipboard() {
             case 'win32':
                 command = 'powershell -command "Get-Clipboard"';
                 break;
+            case 'linux': // <--- THÊM HỖ TRỢ LINUX
+                command = 'xclip -selection clipboard -o'; // -o (hoặc -out) để đọc
+                break;
             default:
-                this.setStatusMessage('Clipboard only supported on macOS/Windows for now');
+                this.setStatusMessage('Clipboard not supported on this platform');
                 return resolve('');
         }
         exec(command, (error, stdout) => {

package/dist/editor.d.ts

@@ -1,14 +1,5 @@
 import { HistoryManager } from './history.js';
 import { VisualRow, EditorMode } from './types.js';
-declare module 'keypress' {
-    interface KeypressEvent {
-        name?: string;
-        ctrl: boolean;
-        meta: boolean;
-        shift: boolean;
-        sequence: string;
-    }
-}
 import { editingMethods } from './editor.editing.js';
 import { clipboardMethods } from './editor.clipboard.js';
 import { navigationMethods } from './editor.navigation.js';
@@ -51,8 +42,10 @@ export declare class CliEditor {
     statusTimeout: NodeJS.Timeout | null;
     isMessageCustom: boolean;
     quitConfirm: boolean;
-    readonly DEFAULT_STATUS = "HELP: Ctrl+S = Save & Quit | Ctrl+Q = Quit | Ctrl+C = Copy All | Ctrl+Arrow = Select";
+    readonly DEFAULT_STATUS = "HELP: Ctrl+S = Save | Ctrl+Q = Quit | Ctrl+W = Find | Ctrl+R = Replace | Ctrl+L = Go to Line";
     searchQuery: string;
+    replaceQuery: string | null;
+    goToLineQuery: string;
     searchResults: {
         y: number;
         x: number;

package/dist/editor.editing.d.ts

@@ -18,6 +18,7 @@ declare function insertCharacter(this: CliEditor, char: string): void;
 declare function insertSoftTab(this: CliEditor): void;
 /**
  * Inserts a new line, splitting the current line at the cursor position.
+ * Implements auto-indent.
  */
 declare function insertNewLine(this: CliEditor): void;
 /**

package/dist/editor.editing.js

@@ -51,14 +51,19 @@ function insertSoftTab() {
 }
 /**
  * Inserts a new line, splitting the current line at the cursor position.
+ * Implements auto-indent.
  */
 function insertNewLine() {
     const line = this.lines[this.cursorY] || '';
+    // Find indentation of the current line
+    const match = line.match(/^(\s*)/);
+    const indent = match ? match[1] : '';
     const remainder = line.slice(this.cursorX);
     this.lines[this.cursorY] = line.slice(0, this.cursorX);
-    this.lines.splice(this.cursorY + 1, 0, remainder);
+    // Add new line with the same indentation + remainder
+    this.lines.splice(this.cursorY + 1, 0, indent + remainder);
     this.cursorY++;
-    this.cursorX = 0;
+    this.cursorX = indent.length; // Move cursor to end of indent
     this.setDirty();
 }
 /**

package/dist/editor.js

@@ -1,6 +1,8 @@
-import keypress from 'keypress';
+// Cập nhật 1: Import từ ./vendor/keypress.js
+import keypress from './vendor/keypress.js';
 import { ANSI } from './constants.js';
 import { HistoryManager } from './history.js';
+// Block `declare module 'keypress'` đã bị xóa
 // Import all functional modules
 import { editingMethods } from './editor.editing.js';
 import { clipboardMethods } from './editor.clipboard.js';
@@ -11,7 +13,7 @@ import { historyMethods } from './editor.history.js';
 import { ioMethods } from './editor.io.js';
 import { keyHandlingMethods } from './editor.keys.js';
 import { selectionMethods } from './editor.selection.js';
-const DEFAULT_STATUS = 'HELP: Ctrl+S = Save & Quit | Ctrl+Q = Quit | Ctrl+C = Copy All | Ctrl+Arrow = Select';
+const DEFAULT_STATUS = 'HELP: Ctrl+S = Save | Ctrl+Q = Quit | Ctrl+W = Find | Ctrl+R = Replace | Ctrl+L = Go to Line';
 /**
  * Main editor class managing application state, TTY interaction, and rendering.
  */
@@ -34,6 +36,8 @@ export class CliEditor {
         this.quitConfirm = false;
         this.DEFAULT_STATUS = DEFAULT_STATUS;
         this.searchQuery = '';
+        this.replaceQuery = null; // null = Find mode, string = Replace mode
+        this.goToLineQuery = ''; // For Go to Line prompt
         this.searchResults = [];
         this.searchResultIndex = -1;
         this.isCleanedUp = false;

package/dist/editor.keys.d.ts

@@ -1,17 +1,10 @@
-import type { KeypressEvent } from 'keypress';
-declare module 'keypress' {
-    interface KeypressEvent {
-        name?: string;
-        ctrl: boolean;
-        meta: boolean;
-        shift: boolean;
-        sequence: string;
-    }
-}
+import type { KeypressEvent } from './vendor/keypress.js';
 export type TKeyHandlingMethods = {
     handleKeypressEvent: (ch: string, key: KeypressEvent) => void;
     handleEditKeys: (key: string) => boolean;
     handleSearchKeys: (key: string) => void;
+    handleSearchConfirmKeys: (key: string) => void;
+    handleGoToLineKeys: (key: string) => void;
     handleCtrlQ: () => void;
     handleCopy: () => Promise<void>;
     handleCharacterKey: (ch: string) => void;