vim-sim 1.0.2 → 1.0.4

package/README.md

@@ -11,32 +11,32 @@ A complete, production-ready Vim editor simulation engine for Node.js. Implement
 ## Features
 
 ### Core Editing
-- ✅ **All Basic Motions**: `h`, `j`, `k`, `l`, `w`, `b`, `e`, `W`, `B`, `E`, `0`, `$`, `^`, `gg`, `G`, `{`, `}`, `(`, `)`, `%`
-- ✅ **Find & Till**: `f`, `F`, `t`, `T`, `;`, `,`
-- ✅ **Operators**: `d`, `c`, `y`, `>`, `<`, `=`, `g~`, `gu`, `gU`
-- ✅ **Visual Mode**: Character (`v`), Line (`V`), and Block (`<C-v>`) with all operators
-- ✅ **Text Objects**: `iw`, `aw`, `i"`, `a"`, `i'`, `a'`, `i(`, `a(`, `i{`, `a{`, `i[`, `a[`, `it`, `at`, `ip`, `ap`, `is`, `as`
-- ✅ **Insert Mode**: `i`, `I`, `a`, `A`, `o`, `O`, `s`, `S`, `c` commands
-- ✅ **Replace & Change**: `r`, `R`, `~`, `J`, `gJ`
+-  **All Basic Motions**: `h`, `j`, `k`, `l`, `w`, `b`, `e`, `W`, `B`, `E`, `0`, `$`, `^`, `gg`, `G`, `{`, `}`, `(`, `)`, `%`
+-  **Find & Till**: `f`, `F`, `t`, `T`, `;`, `,`
+-  **Operators**: `d`, `c`, `y`, `>`, `<`, `=`, `g~`, `gu`, `gU`
+-  **Visual Mode**: Character (`v`), Line (`V`), and Block (`<C-v>`) with all operators
+-  **Text Objects**: `iw`, `aw`, `i"`, `a"`, `i'`, `a'`, `i(`, `a(`, `i{`, `a{`, `i[`, `a[`, `it`, `at`, `ip`, `ap`, `is`, `as`
+-  **Insert Mode**: `i`, `I`, `a`, `A`, `o`, `O`, `s`, `S`, `c` commands
+-  **Replace & Change**: `r`, `R`, `~`, `J`, `gJ`
 
 ### Advanced Features
-- ✅ **Undo/Redo Tree**: Full vim-style undo tree with branches (`u`, `<C-r>`, `g-`, `g+`)
-- ✅ **Macros**: Record (`q`) and playback (`@`) with count support
-- ✅ **Marks**: Local and global marks (`m`, `'`, `` ` ``)
-- ✅ **Jump List**: `<C-o>`, `<C-i>` navigation
-- ✅ **Registers**: Named, numbered, and special registers
-- ✅ **Spell Checking**: Real-time with custom dictionaries
-- ✅ **Completion**: Keyword, line, file, and omni completion
-- ✅ **Folds**: Code folding support
-- ✅ **Multiple Windows**: Split, navigate, and resize
-- ✅ **Multiple Buffers**: File management and buffer navigation
+-  **Undo/Redo Tree**: Full vim-style undo tree with branches (`u`, `<C-r>`, `g-`, `g+`)
+-  **Macros**: Record (`q`) and playback (`@`) with count support
+-  **Marks**: Local and global marks (`m`, `'`, `` ` ``)
+-  **Jump List**: `<C-o>`, `<C-i>` navigation
+-  **Registers**: Named, numbered, and special registers
+-  **Spell Checking**: Real-time with custom dictionaries
+-  **Completion**: Keyword, line, file, and omni completion
+-  **Folds**: Code folding support
+-  **Multiple Windows**: Split, navigate, and resize
+-  **Multiple Buffers**: File management and buffer navigation
 
 ### Text Formatting
-- ✅ **Auto-indentation**: Smart indentation based on braces
-- ✅ **Text Wrapping**: Format text with `gq`, `gw`
-- ✅ **Alignment**: Column alignment support
-- ✅ **Comment Toggling**: Smart comment handling
-- ✅ **Digraphs**: 150+ special characters
+-  **Auto-indentation**: Smart indentation based on braces
+-  **Text Wrapping**: Format text with `gq`, `gw`
+-  **Alignment**: Column alignment support
+-  **Comment Toggling**: Smart comment handling
+-  **Digraphs**: 150+ special characters
 
 ## Installation
 
@@ -478,14 +478,14 @@ const session = new Session();
 
 | Feature | vim-sim | CodeMirror Vim | Monaco Vim |
 |---------|---------|----------------|------------|
-| Standalone | ✅ | ❌ (requires CodeMirror) | ❌ (requires Monaco) |
-| Node.js API | ✅ | ❌ | ❌ |
-| Undo Tree | ✅ | ❌ | ❌ |
-| Full Text Objects | ✅ | Partial | Partial |
-| Macros | ✅ | ✅ | ❌ |
-| Marks & Jumps | ✅ | Partial | Partial |
-| Spell Checking | ✅ | ❌ | ❌ |
-| TypeScript | ✅ | Partial | ✅ |
+| Standalone |  | ❌ (requires CodeMirror) | ❌ (requires Monaco) |
+| Node.js API |  | ❌ | ❌ |
+| Undo Tree |  | ❌ | ❌ |
+| Full Text Objects |  | Partial | Partial |
+| Macros |  |  | ❌ |
+| Marks & Jumps |  | Partial | Partial |
+| Spell Checking |  | ❌ | ❌ |
+| TypeScript |  | Partial |  |
 
 ## Contributing
 

package/dist/index.d.ts

@@ -634,6 +634,7 @@ declare class CompletionManager {
     lineCompletion(buffer: string, cursorLine: number, cursorCol: number): CompletionMatch[];
     /**
      * Start filename completion
+     * Note: This is a stub in browser environments. File system access requires Node.js.
      */
     fileNameCompletion(buffer: string, cursorLine: number, cursorCol: number, currentDir?: string): Promise<CompletionMatch[]>;
     /**
@@ -655,6 +656,7 @@ declare class CompletionManager {
     private extractKeywords;
     /**
      * Get file type information
+     * Note: Stub implementation for browser compatibility
      */
     private getFileTypeInfo;
     /**
@@ -785,6 +787,112 @@ declare class UndoTree {
     };
 }
 
+/**
+ * Vim configuration options
+ */
+interface VimConfig {
+    number: boolean;
+    relativenumber: boolean;
+    wrap: boolean;
+    cursorline: boolean;
+    tabstop: number;
+    shiftwidth: number;
+    expandtab: boolean;
+    autoindent: boolean;
+    smartindent: boolean;
+    ignorecase: boolean;
+    smartcase: boolean;
+    hlsearch: boolean;
+    incsearch: boolean;
+    wrapscan: boolean;
+    whichwrap: string;
+    startofline: boolean;
+    virtualedit: string;
+    undolevels: number;
+    clipboard: 'unnamed' | 'unnamedplus' | '';
+}
+type VimConfigKey = keyof VimConfig;
+/**
+ * Metadata about a config option
+ */
+interface VimConfigMetadata {
+    description: string;
+    vimDefault: string | number | boolean;
+    vimSimDefault: string | number | boolean;
+    category: 'display' | 'indentation' | 'search' | 'motion' | 'editing';
+    type: 'boolean' | 'number' | 'string';
+    differsFromVim: boolean;
+    validValues?: string[];
+}
+/**
+ * Manages Vim configuration options
+ */
+declare class ConfigManager {
+    private config;
+    private listeners;
+    constructor(initialConfig?: Partial<VimConfig>);
+    /**
+     * Get a config value
+     */
+    get<K extends VimConfigKey>(key: K): VimConfig[K];
+    /**
+     * Set a config value
+     */
+    set<K extends VimConfigKey>(key: K, value: VimConfig[K]): void;
+    /**
+     * Set multiple config values at once
+     */
+    setMultiple(updates: Partial<VimConfig>): void;
+    /**
+     * Get all config values
+     */
+    getAll(): Readonly<VimConfig>;
+    /**
+     * Reset to default configuration
+     */
+    reset(): void;
+    /**
+     * Toggle a boolean config option
+     */
+    toggle(key: VimConfigKey): void;
+    /**
+     * Subscribe to config changes
+     * @param key - Config key to watch, or '*' for all changes
+     * @param callback - Function to call when config changes
+     * @returns Unsubscribe function
+     */
+    onChange(key: VimConfigKey | '*', callback: (key: VimConfigKey, value: unknown) => void): () => void;
+    /**
+     * Notify all listeners of a config change
+     */
+    private notifyListeners;
+    /**
+     * Parse a Vim set command string (e.g., "number", "nonumber", "tabstop=4")
+     */
+    parseSetCommand(command: string): boolean;
+    /**
+     * Get a formatted string representation of a config value
+     */
+    formatValue(key: VimConfigKey): string;
+    /**
+     * Get metadata about a config option
+     */
+    getMetadata(key: VimConfigKey): VimConfigMetadata;
+    /**
+     * Get all options that differ from vanilla Vim
+     */
+    getDifferencesFromVim(): VimConfigKey[];
+    /**
+     * Get options by category
+     */
+    getByCategory(category: VimConfigMetadata['category']): VimConfigKey[];
+}
+/**
+ * Metadata for all config options
+ * Documents behavior, defaults, and differences from vanilla Vim
+ */
+declare const CONFIG_METADATA: Record<VimConfigKey, VimConfigMetadata>;
+
 interface LastVisualSelection {
     range: Range;
     mode: Mode.VISUAL | Mode.VISUAL_LINE | Mode.VISUAL_BLOCK;
@@ -820,7 +928,8 @@ declare class State {
     completionManager: CompletionManager;
     undoTree: UndoTree | null;
     lastCommand: LastCommand | null;
-    constructor(buffer: Buffer, cursor: Cursor, selection: Range | null, mode: Mode, commandLine?: string, desiredColumn?: number | null, viewport?: VimViewport, visualAnchor?: Cursor | null, lastVisualSelection?: LastVisualSelection | null, recordingRegister?: string | null, lastMacroRegister?: string | null, foldManager?: FoldManager, markManager?: MarkManager, jumpListManager?: JumpListManager, fileSystem?: FileSystemManager, windowManager?: WindowManager, lastSearch?: SearchState | null, spellChecker?: SpellChecker, completionManager?: CompletionManager, undoTree?: UndoTree | null, lastCommand?: LastCommand | null);
+    configManager: ConfigManager | null;
+    constructor(buffer: Buffer, cursor: Cursor, selection: Range | null, mode: Mode, commandLine?: string, desiredColumn?: number | null, viewport?: VimViewport, visualAnchor?: Cursor | null, lastVisualSelection?: LastVisualSelection | null, recordingRegister?: string | null, lastMacroRegister?: string | null, foldManager?: FoldManager, markManager?: MarkManager, jumpListManager?: JumpListManager, fileSystem?: FileSystemManager, windowManager?: WindowManager, lastSearch?: SearchState | null, spellChecker?: SpellChecker, completionManager?: CompletionManager, undoTree?: UndoTree | null, lastCommand?: LastCommand | null, configManager?: ConfigManager | null);
 }
 
 declare abstract class TextObject {
@@ -957,79 +1066,6 @@ declare class UndoStack {
     getCurrentIndex(): number;
 }
 
-/**
- * Vim configuration options
- */
-interface VimConfig {
-    number: boolean;
-    relativenumber: boolean;
-    wrap: boolean;
-    cursorline: boolean;
-    tabstop: number;
-    shiftwidth: number;
-    expandtab: boolean;
-    autoindent: boolean;
-    smartindent: boolean;
-    ignorecase: boolean;
-    smartcase: boolean;
-    hlsearch: boolean;
-    incsearch: boolean;
-    undolevels: number;
-    clipboard: 'unnamed' | 'unnamedplus' | '';
-}
-type VimConfigKey = keyof VimConfig;
-/**
- * Manages Vim configuration options
- */
-declare class ConfigManager {
-    private config;
-    private listeners;
-    constructor(initialConfig?: Partial<VimConfig>);
-    /**
-     * Get a config value
-     */
-    get<K extends VimConfigKey>(key: K): VimConfig[K];
-    /**
-     * Set a config value
-     */
-    set<K extends VimConfigKey>(key: K, value: VimConfig[K]): void;
-    /**
-     * Set multiple config values at once
-     */
-    setMultiple(updates: Partial<VimConfig>): void;
-    /**
-     * Get all config values
-     */
-    getAll(): Readonly<VimConfig>;
-    /**
-     * Reset to default configuration
-     */
-    reset(): void;
-    /**
-     * Toggle a boolean config option
-     */
-    toggle(key: VimConfigKey): void;
-    /**
-     * Subscribe to config changes
-     * @param key - Config key to watch, or '*' for all changes
-     * @param callback - Function to call when config changes
-     * @returns Unsubscribe function
-     */
-    onChange(key: VimConfigKey | '*', callback: (key: VimConfigKey, value: unknown) => void): () => void;
-    /**
-     * Notify all listeners of a config change
-     */
-    private notifyListeners;
-    /**
-     * Parse a Vim set command string (e.g., "number", "nonumber", "tabstop=4")
-     */
-    parseSetCommand(command: string): boolean;
-    /**
-     * Get a formatted string representation of a config value
-     */
-    formatValue(key: VimConfigKey): string;
-}
-
 interface CommandHistoryEntry {
     keys: string;
     timestamp: number;
@@ -1377,4 +1413,4 @@ declare function withContentAndCursor(state: State, content: string, cursor: Cur
  */
 declare function deleteRangeWithRegister(state: State, range: Range, context: CommandContext, isLinewise?: boolean): State;
 
-export { Buffer, Change, type CharClassifier, Command, type CommandContext, type CommandHistoryEntry, ConfigManager, Cursor, type IndentConfig, IndentationManager, Mode, ModeTransition, Motion, Operator, PatternRegistry, type Range, Register, RegisterManager, Session, State, TextObject, UndoStack, type VimConfig, type VimConfigKey, VimViewport, clampCursor, clampCursorNormalMode, clampCursorVerticalMotion, currentLine, deleteLine, deleteLines, deleteRange, deleteRangeWithRegister, expandRangeOuter, findFirstNonBlank, findLineEnd, findLineStart, findNext, findNextWORDEnd, findNextWORDStart, findNextWordEnd, findNextWordStart, findPrev, findPrevWORDEnd, findPrevWORDStart, findPrevWordEnd, findPrevWordStart, getCharAt, getCharAtOffset, getCount, getLine, getLines, getTextInRange, isAtBufferEnd, isAtBufferStart, isAtLineEnd, isAtLineStart, isInRange, isNewline, isOnChar, isOnPunctuation, isOnWhitespace, isOnWord, isPunctuation, isWhitespace, isWordChar, lastLine, lineCount, moveCursorBy, moveDown, moveLeft, moveRight, moveUp, normalizeRange, repeatCursorMotion, replaceRange, resolveOperatorRange, skipUntil, skipWhile, skipWhitespace, updateVisualSelection, withBufferContent, withContentAndCursor, withCursor, withCursorAndViewport, withCursorHorizontal, withCursorVertical, withViewport };
+export { Buffer, CONFIG_METADATA, Change, type CharClassifier, Command, type CommandContext, type CommandHistoryEntry, ConfigManager, Cursor, type IndentConfig, IndentationManager, Mode, ModeTransition, Motion, Operator, PatternRegistry, type Range, Register, RegisterManager, Session, State, TextObject, UndoStack, type VimConfig, type VimConfigKey, type VimConfigMetadata, VimViewport, clampCursor, clampCursorNormalMode, clampCursorVerticalMotion, currentLine, deleteLine, deleteLines, deleteRange, deleteRangeWithRegister, expandRangeOuter, findFirstNonBlank, findLineEnd, findLineStart, findNext, findNextWORDEnd, findNextWORDStart, findNextWordEnd, findNextWordStart, findPrev, findPrevWORDEnd, findPrevWORDStart, findPrevWordEnd, findPrevWordStart, getCharAt, getCharAtOffset, getCount, getLine, getLines, getTextInRange, isAtBufferEnd, isAtBufferStart, isAtLineEnd, isAtLineStart, isInRange, isNewline, isOnChar, isOnPunctuation, isOnWhitespace, isOnWord, isPunctuation, isWhitespace, isWordChar, lastLine, lineCount, moveCursorBy, moveDown, moveLeft, moveRight, moveUp, normalizeRange, repeatCursorMotion, replaceRange, resolveOperatorRange, skipUntil, skipWhile, skipWhitespace, updateVisualSelection, withBufferContent, withContentAndCursor, withCursor, withCursorAndViewport, withCursorHorizontal, withCursorVertical, withViewport };