mui 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9515ecfb14d1a9ea5422a842fd22911c303f2465f35827b879117e3cce4d1551
-  data.tar.gz: e6daedc45ebb07f1e8b094f590ae9749bfae49e2ced12017cba16f1c1dc255c0
+  metadata.gz: f38d3d434535fc336c9b5394801e3fb49393f691b15878a1994758cfb73a6217
+  data.tar.gz: 220128d17afb0f711f2642cd7e64acc14364ca5e65de77c7130828e5a809796c
 SHA512:
-  metadata.gz: 4f493037291b8801dd2fc8a6101fb714110c12653ebb432900eebaa8f135d91597c8c862d5cf2b380e332d689decbada6d06f406e7f8c8eae859819d63887845
-  data.tar.gz: de2b83ea5a999760a171bb037bc264035ef1b43878b806a2b0577099b5601e6e94bdbf6d711604fd9d5a7df01d381665ed734526e1d0f643f896b40e89954604
+  metadata.gz: 82468df468d286b1b672b4c47257565f348661cf38633fdabfdc021cf42639d3637f1b6a1b233bd7af65b47fa426b15da2cd52e270cbe7be987dd071e4d785db
+  data.tar.gz: dbf19ebadd262acc004320ebcf55d25f404ce22ad7a77beb08f4363d5154dc2f9241834f531fa15b4b953d8768bc3c1ec8213441d3150ec803081b1be32590b0

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-12-11 15:57:29 UTC using RuboCop version 1.81.7.
+# on 2025-12-14 12:18:50 UTC using RuboCop version 1.81.7.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -12,10 +12,11 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'test/fixtures/mui-test-plugin/mui-test-plugin.gemspec'
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
 Lint/DuplicateBranch:
   Exclude:
+    - 'lib/mui/editor.rb'
     - 'lib/mui/key_handler/command_mode.rb'
     - 'lib/mui/plugin_manager.rb'
     - 'lib/mui/register.rb'
@@ -33,25 +34,26 @@ Lint/MissingSuper:
   Exclude:
     - 'test/test_helper.rb'
 
-# Offense count: 2
+# Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
 # NotImplementedExceptions: NotImplementedError
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/mui/terminal_adapter/base.rb'
+    - 'test/mui/highlighters/test_search_highlighter.rb'
 
 # Offense count: 1
 Lint/UselessConstantScoping:
   Exclude:
     - 'lib/mui/buffer_word_cache.rb'
 
-# Offense count: 32
+# Offense count: 33
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 49
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
   Max: 284
@@ -61,7 +63,7 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 12
+# Offense count: 14
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 19
@@ -90,7 +92,7 @@ Naming/MethodName:
     - 'test/mui/key_handler/test_visual_mode.rb'
     - 'test/mui/key_handler/test_window_command.rb'
 
-# Offense count: 41
+# Offense count: 45
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
@@ -108,13 +110,16 @@ Naming/MethodParameterName:
     - 'test/e2e/test_helper.rb'
     - 'test/test_helper.rb'
 
-# Offense count: 6
+# Offense count: 11
 # Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
 # AllowedMethods: call
 # WaywardPredicates: nonzero?
 Naming/PredicateMethod:
   Exclude:
+    - 'lib/mui/command_line.rb'
+    - 'lib/mui/editor.rb'
     - 'lib/mui/key_handler/insert_mode.rb'
+    - 'lib/mui/key_sequence_buffer.rb'
     - 'lib/mui/undo_manager.rb'
     - 'lib/mui/window_manager.rb'
 

data/CHANGELOG.md

@@ -1,5 +1,104 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-12-15
+
+### Added
+- Additional syntax highlighting for 7 languages:
+  - Go: keywords, types, constants, raw strings (backtick), block comments
+  - Rust: macros (`println!`), lifetimes (`'a`), attributes (`#[derive]`), doc comments (`///`), raw strings (`r#"..."#`)
+  - JavaScript: template literals, regex literals, BigInt (`123n`), ES6+ keywords (`const`, `let`, `async`, `await`)
+  - TypeScript: extends JavaScript with type keywords (`interface`, `type`, `enum`, `declare`, `abstract`)
+  - Markdown: headings, emphasis (`*italic*`, `**bold**`), code blocks, links, lists, blockquotes
+  - HTML: tags, attributes, comments (`<!-- -->`), DOCTYPE, entities (`&amp;`)
+  - CSS: selectors (`.class`, `#id`, `:pseudo`), properties, hex colors, @rules, functions (`calc`, `rgb`, `var`)
+  - Supported extensions: `.go`, `.rs`, `.js`/`.mjs`/`.cjs`/`.jsx`, `.ts`/`.tsx`/`.mts`/`.cts`, `.md`/`.markdown`, `.html`/`.htm`/`.xhtml`, `.css`/`.scss`/`.sass`
+- Multi-key sequence and leader key support (Vim-compatible):
+  - Leader key: `Mui.set :leader, "\\"` (default: backslash)
+  - `<Leader>` notation: `Mui.keymap :normal, "<Leader>gd" do ... end`
+  - Multi-key sequences: `<Leader>ff`, `<C-x><C-s>`, etc.
+  - Special key notation: `<Space>`, `<Tab>`, `<CR>`, `<Enter>`, `<Esc>`, `<BS>`
+  - Control key notation: `<C-x>`, `<Ctrl-x>`, `<C-S-x>` (Ctrl+Shift)
+  - Shift key notation: `<S-x>`, `<Shift-x>`
+  - Timeout setting: `Mui.set :timeoutlen, 1000` (milliseconds)
+  - All modes supported: Normal, Insert, Visual, Command, Search
+  - Built-in commands (dd, dw, gg, etc.) take priority over plugin keymaps
+  - Partial match waiting: typing `<Leader>g` waits for more keys if `<Leader>gd` is registered
+  - Exact match with longer possibilities: waits for timeout before executing
+  - Backward compatible with single-key keymaps
+- External shell command execution (`:!cmd`):
+  - `:!echo hello` to run shell commands asynchronously
+  - Output displayed in `[Shell Output]` scratch buffer (readonly)
+  - stdout/stderr/exit status formatted and displayed
+  - "Running: cmd" message shown during execution
+  - Subsequent `:!cmd` updates existing scratch buffer (doesn't create new windows)
+  - Supports pipes, redirects, and all shell features via Open3
+  - Empty command (`:!` or `:!   `) shows error: "E471: Argument required"
+- Case-insensitive command completion:
+  - `:git` now matches `:Git`, `:lsp` matches `:LspHover`, `:LspDefinition`, etc.
+  - Original command case is preserved in completion results
+  - Only applies to command completion (file path completion remains case-sensitive)
+- Command history with persistence:
+  - Up/Down arrow keys navigate through command history in command mode
+  - History saved to `~/.mui_history` (persists across sessions)
+  - Maximum 100 entries stored
+  - Duplicate commands move to most recent position
+  - Empty commands are not added to history
+  - Current input is preserved when browsing history (restored with Down at end)
+
+### Fixed
+- Fixed long lines not displaying correctly by implementing line wrapping
+  - Lines exceeding screen width are now automatically wrapped to next screen line
+  - Unicode width aware wrapping (Japanese characters count as 2 width)
+  - Removed broken horizontal scrolling (`scroll_col`) in favor of wrap mode
+  - Cursor position correctly calculated across wrapped lines
+  - Selection and search highlights work correctly across wrap boundaries
+  - Added `WrapCache` for performance optimization (content-based caching)
+  - Added `WrapHelper` module for wrap calculations
+- Fixed search returning "Pattern not found" after switching buffers via `:e`
+  - `execute_search` was using `@buffer` (initial buffer) instead of `buffer` method (current buffer)
+  - Now correctly searches in the current buffer after buffer switch
+- Search highlight now recalculates correctly when switching buffers via `:e`
+  - Previously, search highlight from old buffer remained visible in new buffer
+  - Now calls `find_all_matches` on buffer switch to recalculate matches (Vim-compatible behavior)
+  - Search pattern is preserved, only match positions are updated for new buffer content
+- Search highlight now recalculates correctly when opening files via `:sp`, `:vs`, `:tabnew`
+  - Previously, search highlight was not calculated for new buffers opened with split/tab commands
+  - Now calls `find_all_matches` when path is specified, consistent with `:e` behavior
+- Improved Escape key response time in Insert mode
+  - Set `ESCDELAY = 10` to reduce escape sequence detection delay from 1000ms to 10ms
+  - Use `timeout = 0` instead of `nodelay` for `getch_nonblock`
+- Insert mode completion now closes when pressing Left/Right arrow keys
+  - Previously, arrow keys would move cursor but completion popup remained open
+  - Now matches Vim behavior: completion closes on cursor movement
+- Undo/Redo now works correctly for buffers opened via `:e`, `:sp`, `:vs`, `:tabnew`
+  - Previously, buffers opened with these commands had no UndoManager set
+  - Each buffer now gets its own UndoManager (Vim-compatible: independent undo history per buffer)
+  - Handlers now use dynamic `undo_manager` reference to support buffer switching
+- Fixed screen remnants after `:e` command when new file has fewer lines
+  - Previously, lines from the old buffer would remain visible below the new content
+  - Now explicitly clears lines beyond buffer content during render
+- Fixed background color not applied to lines beyond buffer content
+  - Previously, when opening a file with fewer lines than the visible height, lines beyond buffer were rendered without background color (transparent)
+  - Now uses `put_with_style` with `:normal` color scheme to ensure consistent background color
+- Plugin commands now appear in command completion suggestions
+  - Previously, commands registered via `Mui.command` were not shown in Tab completion
+  - `CommandCompleter` now includes plugin commands from `Mui.config.commands`
+- Multi-line paste now undos as a single action (Vim-compatible)
+  - Previously, pasting multiple lines would undo one line at a time
+  - Now uses `begin_group`/`end_group` to group all paste operations into a single undo unit
+  - Fixed direct array assignment to use `replace_line` for proper undo recording
+- Search highlight now works correctly per buffer when switching tabs/windows
+  - Previously, search matches from old buffer remained when using `gt`/`gT` or `Ctrl+W` commands
+  - `SearchState` now caches matches per buffer (keyed by `object_id`) with lazy evaluation
+  - Each buffer maintains its own match positions while sharing the global search pattern
+  - Cache automatically invalidates when pattern changes or buffer content is modified
+  - Vim-compatible behavior: search pattern is global, highlights are buffer-specific
+- Plugin commands now recognized by CommandRegistry for alias configuration
+  - Previously, `CommandRegistry#exists?` and `#find` only checked built-in commands
+  - Now also checks `Mui.config.commands` for plugin-registered commands
+  - Enables setting command aliases for plugin commands without errors
+  - Built-in commands take precedence over plugin commands with the same name
+
 ## [0.2.0] - 2025-12-12
 
 ### Added

data/README.md

@@ -17,13 +17,316 @@ gem install mui
 mui [file]
 ```
 
-## Features (Planned)
+## Features
 
-- Vim-like modal editing (Normal, Insert, Visual, Command modes)
-- Plugin system via gems
-- LSP support (via `mui-lsp` gem)
-- Git integration (via `mui-git` gem)
-- Configurable via `.muirc`
+### Modal Editing
+
+Vim-like modal editing with five modes:
+
+- **Normal mode**: Navigation and text manipulation
+- **Insert mode**: Text input with auto-completion
+- **Command mode**: Ex commands (`:w`, `:q`, `:e`, etc.)
+- **Visual mode** (`v`): Character-wise selection
+- **Visual Line mode** (`V`): Line-wise selection
+
+### Tab Pages and Window Splits
+
+- **Tab pages**: `:tabnew`, `:tabclose`, `gt`/`gT` to switch
+- **Horizontal split**: `:sp [file]`
+- **Vertical split**: `:vs [file]`
+- **Window navigation**: `Ctrl-w h/j/k/l` or `Ctrl-w w`
+
+### Syntax Highlighting
+
+Supports 9 languages:
+
+- Ruby (`.rb`, `.rake`, `.gemspec`)
+- C (`.c`, `.h`, `.y`)
+- Go (`.go`)
+- Rust (`.rs`)
+- JavaScript (`.js`, `.mjs`, `.cjs`, `.jsx`)
+- TypeScript (`.ts`, `.tsx`, `.mts`, `.cts`)
+- Markdown (`.md`, `.markdown`)
+- HTML (`.html`, `.htm`, `.xhtml`)
+- CSS (`.css`, `.scss`, `.sass`)
+
+### Search
+
+- Forward search: `/pattern`
+- Backward search: `?pattern`
+- Next/previous match: `n`/`N`
+- Word under cursor: `*` (forward), `#` (backward)
+- Incremental search with real-time highlighting
+
+### Undo/Redo
+
+- Undo: `u`
+- Redo: `Ctrl-r`
+- Insert mode changes grouped as single undo unit
+
+### Named Registers
+
+- Named registers: `"a` - `"z`
+- Unnamed register: `""`
+- Yank register: `"0`
+- Delete history: `"1` - `"9`
+- Black hole register: `"_`
+
+### Completion
+
+- Command-line completion with popup
+- Buffer word completion in Insert mode (`Ctrl-n`/`Ctrl-p`)
+- LSP completion support (via [mui-lsp](https://github.com/S-H-GAMELINKS/mui-lsp) gem)
+
+### Multi-key Sequences and Leader Key
+
+```ruby
+# Set leader key (default: backslash)
+Mui.set :leader, " "  # Space as leader
+
+# Define multi-key mappings
+Mui.keymap :normal, "<Leader>ff" do |ctx|
+  # Find file
+end
+```
+
+Supports:
+- `<Leader>` notation
+- Control keys: `<C-x>`, `<C-S-x>`
+- Special keys: `<Space>`, `<Tab>`, `<CR>`, `<Esc>`, `<BS>`
+
+### Other Features
+
+- Japanese and multibyte character support (UTF-8)
+- Floating windows for hover info
+- Asynchronous job execution
+- External shell command execution (`:!cmd`)
+- Command history with persistence
+
+## Key Bindings
+
+### Normal Mode
+
+| Key | Action |
+|-----|--------|
+| `h`, `j`, `k`, `l` | Cursor movement |
+| `w`, `b`, `e` | Word movement |
+| `0`, `^`, `$` | Line movement |
+| `gg`, `G` | File start/end |
+| `f{char}`, `t{char}` | Find character |
+| `i`, `a`, `o`, `O` | Enter Insert mode |
+| `v`, `V` | Enter Visual mode |
+| `d`, `c`, `y` | Delete/Change/Yank operators |
+| `p`, `P` | Paste after/before |
+| `u`, `Ctrl-r` | Undo/Redo |
+| `/`, `?` | Search forward/backward |
+| `n`, `N` | Next/previous match |
+| `*`, `#` | Search word under cursor |
+| `gt`, `gT` | Next/previous tab |
+| `gv` | Reselect last visual selection |
+| `Ctrl-w` + `h/j/k/l` | Window navigation |
+
+### Visual Mode
+
+| Key | Action |
+|-----|--------|
+| `d` | Delete selection |
+| `c` | Change selection |
+| `y` | Yank selection |
+| `>`, `<` | Indent/unindent |
+| `Esc` | Exit to Normal mode |
+
+### Command Mode
+
+| Command | Action |
+|---------|--------|
+| `:w` | Save file |
+| `:q` | Quit |
+| `:wq` | Save and quit |
+| `:e <file>` | Open file |
+| `:sp [file]` | Horizontal split |
+| `:vs [file]` | Vertical split |
+| `:tabnew [file]` | New tab |
+| `:!cmd` | Run shell command |
+
+## Configuration
+
+Mui can be configured via `~/.muirc` (global) or `.lmuirc` (project-local).
+
+```ruby
+# ~/.muirc
+
+# Color scheme
+Mui.set :colorscheme, "tokyo_night"
+
+# Editor settings
+Mui.set :tabstop, 4
+Mui.set :shiftwidth, 4
+Mui.set :expandtab, true
+Mui.set :syntax, true
+
+# Leader key
+Mui.set :leader, " "
+
+# Custom keymaps
+Mui.keymap :normal, "<Leader>w" do |ctx|
+  ctx.editor.execute_command("w")
+end
+
+# Custom commands
+Mui.command :hello do |ctx|
+  ctx.set_message("Hello, World!")
+end
+
+# Autocmd
+Mui.autocmd :BufWritePre, pattern: "*.rb" do |ctx|
+  # Before saving Ruby files
+end
+```
+
+### Available Themes
+
+- `mui` (default)
+- `solarized_dark`
+- `solarized_light`
+- `monokai`
+- `nord`
+- `gruvbox_dark`
+- `dracula`
+- `tokyo_night`
+
+## Plugin System
+
+Mui supports plugins via Ruby gems.
+
+### Official Plugins
+
+- [mui-lsp](https://github.com/S-H-GAMELINKS/mui-lsp) - LSP (Language Server Protocol) support
+- [mui-git](https://github.com/S-H-GAMELINKS/mui-git) - Git integration
+- [mui-fzf](https://github.com/S-H-GAMELINKS/mui-fzf) - Fuzzy finder integration with fzf
+
+### Using Plugins
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp"
+Mui.use "mui-git"
+Mui.use "mui-fzf"
+```
+
+### Creating Plugins
+
+```ruby
+# Class-based plugin
+class MyPlugin < Mui::Plugin
+  name :my_plugin
+
+  def setup
+    command :greet do |ctx|
+      ctx.set_message("Hello from MyPlugin!")
+    end
+
+    keymap :normal, "<Leader>g" do |ctx|
+      ctx.editor.execute_command("greet")
+    end
+
+    autocmd :BufEnter, pattern: "*.txt" do |ctx|
+      ctx.set_message("Opened a text file")
+    end
+  end
+end
+```
+
+### Asynchronous Job Execution
+
+Plugins can run background tasks without blocking the editor:
+
+```ruby
+class MyAsyncPlugin < Mui::Plugin
+  name :my_async_plugin
+
+  def setup
+    # Run a shell command asynchronously
+    command :run_tests do |ctx|
+      ctx.run_shell_command("bundle exec rake test") do |result|
+        if result[:success]
+          ctx.open_scratch_buffer("[Test Results]", result[:stdout])
+        else
+          ctx.set_error("Tests failed: #{result[:stderr]}")
+        end
+      end
+    end
+
+    # Run a Ruby block asynchronously
+    command :fetch_data do |ctx|
+      ctx.run_async do
+        # This runs in a background thread
+        sleep 2  # Simulate long operation
+        "Data fetched!"
+      end
+    end
+
+    # Check if jobs are running
+    command :job_status do |ctx|
+      if ctx.jobs_running?
+        ctx.set_message("Jobs are running...")
+      else
+        ctx.set_message("No jobs running")
+      end
+    end
+  end
+end
+```
+
+Available job methods:
+- `ctx.run_async { ... }` - Run a Ruby block in background
+- `ctx.run_shell_command(cmd) { |result| ... }` - Run shell command asynchronously
+- `ctx.jobs_running?` - Check if any jobs are active
+- `ctx.cancel_job(id)` - Cancel a running job
+- `ctx.open_scratch_buffer(name, content)` - Display results in a scratch buffer
+
+Autocmd events for jobs:
+- `JobStarted` - When a job begins
+- `JobCompleted` - When a job finishes successfully
+- `JobFailed` - When a job fails
+- `JobCancelled` - When a job is cancelled
+
+### Interactive Command Execution
+
+Plugins can run interactive external commands:
+
+```ruby
+class FzfPlugin < Mui::Plugin
+  name :fzf
+
+  def setup
+    command :Files do |ctx|
+      if ctx.command_exists?("fzf")
+        result = ctx.run_interactive_command("fzf")
+        ctx.editor.execute_command("e #{result}") if result && !result.empty?
+      else
+        ctx.set_error("fzf is not installed")
+      end
+    end
+  end
+end
+```
+
+### LSP Configuration
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp"
+
+Mui.lsp do
+  use :ruby  # Use preset configuration
+
+  # Or custom server
+  server :custom_lsp,
+    command: ["my-lsp", "--stdio"],
+    filetypes: ["mylang"]
+end
+```
 
 ## Development
 

data/docs/_config.yml

@@ -0,0 +1,56 @@
+title: Mui(無為) Documentation
+description: A Vim-like TUI text editor written in Ruby
+baseurl: "/mui"
+url: "https://s-h-gamelinks.github.io"
+
+remote_theme: just-the-docs/just-the-docs
+
+color_scheme: dark
+
+permalink: pretty
+
+aux_links:
+  GitHub: https://github.com/S-H-GAMELINKS/mui
+  RubyGems: https://rubygems.org/gems/mui
+
+nav_external_links:
+  - title: GitHub
+    url: https://github.com/S-H-GAMELINKS/mui
+
+search_enabled: true
+search:
+  heading_level: 2
+  previews: 3
+  preview_words_before: 5
+  preview_words_after: 10
+  tokenizer_separator: /[\s/]+/
+  rel_url: true
+  button: false
+
+heading_anchors: true
+
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: "Copyright &copy; 2025 S-H-GAMELINKS. Distributed under the <a href=\"https://opensource.org/licenses/MIT\">MIT License</a>."
+
+last_edit_timestamp: true
+last_edit_time_format: "%Y-%m-%d"
+
+gh_edit_link: true
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/S-H-GAMELINKS/mui"
+gh_edit_branch: "master"
+gh_edit_source: docs
+gh_edit_view_mode: "edit"
+
+callouts:
+  warning:
+    title: Warning
+    color: yellow
+  note:
+    title: Note
+    color: blue
+  tip:
+    title: Tip
+    color: green