mui 0.1.0 → 0.3.0

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

data/docs/configuration.md

@@ -0,0 +1,301 @@
+---
+title: Configuration
+layout: default
+nav_order: 4
+---
+
+# Configuration
+{: .no_toc }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+## Configuration Files
+
+Mui supports two configuration files:
+
+| File | Scope |
+|------|-------|
+| `~/.muirc` | Global settings (all projects) |
+| `.lmuirc` | Local settings (current directory) |
+
+Local settings (`.lmuirc`) override global settings (`~/.muirc`).
+
+Configuration files are written in Ruby using Mui's DSL.
+
+## Basic Settings
+
+### Color Scheme
+
+```ruby
+Mui.set :colorscheme, "tokyo_night"
+```
+
+Available themes:
+- `mui` (default)
+- `solarized_dark`
+- `solarized_light`
+- `monokai`
+- `nord`
+- `gruvbox_dark`
+- `dracula`
+- `tokyo_night`
+
+### Indentation
+
+```ruby
+# Number of spaces for Tab display
+Mui.set :tabstop, 4
+
+# Number of spaces for indent operations (>, <)
+Mui.set :shiftwidth, 4
+
+# Use spaces instead of tabs
+Mui.set :expandtab, true
+```
+
+### Syntax Highlighting
+
+```ruby
+# Enable/disable syntax highlighting
+Mui.set :syntax, true
+```
+
+### Leader Key
+
+```ruby
+# Set leader key (default: backslash)
+Mui.set :leader, " "  # Space as leader
+```
+
+### Key Timeout
+
+```ruby
+# Timeout for multi-key sequences (milliseconds)
+Mui.set :timeoutlen, 1000
+```
+
+---
+
+## Custom Key Mappings
+
+Define custom key bindings with `Mui.keymap`:
+
+```ruby
+Mui.keymap :mode, "key" do |ctx|
+  # action
+end
+```
+
+### Modes
+
+- `:normal` - Normal mode
+- `:insert` - Insert mode
+- `:visual` - Visual mode
+- `:command` - Command mode
+
+### Examples
+
+```ruby
+# Save with <Leader>w
+Mui.keymap :normal, "<Leader>w" do |ctx|
+  ctx.editor.execute_command("w")
+end
+
+# Quick escape in Insert mode
+Mui.keymap :insert, "jk" do |ctx|
+  ctx.change_mode(:normal)
+end
+
+# Close buffer with <Leader>q
+Mui.keymap :normal, "<Leader>q" do |ctx|
+  ctx.editor.execute_command("q")
+end
+```
+
+### Special Key Notation
+
+| Notation | Key |
+|----------|-----|
+| `<Leader>` | Leader key |
+| `<Space>` | Space bar |
+| `<Tab>` | Tab key |
+| `<CR>`, `<Enter>` | Enter key |
+| `<Esc>` | Escape key |
+| `<BS>` | Backspace |
+| `<C-x>` | Ctrl+x |
+| `<C-S-x>` | Ctrl+Shift+x |
+| `<S-x>` | Shift+x |
+
+### Multi-key Sequences
+
+```ruby
+# <Leader>ff for find files
+Mui.keymap :normal, "<Leader>ff" do |ctx|
+  ctx.editor.execute_command("Files")
+end
+
+# <Leader>fg for grep
+Mui.keymap :normal, "<Leader>fg" do |ctx|
+  ctx.editor.execute_command("Rg")
+end
+
+# Ctrl-x Ctrl-s to save (Emacs style)
+Mui.keymap :normal, "<C-x><C-s>" do |ctx|
+  ctx.editor.execute_command("w")
+end
+```
+
+---
+
+## Custom Commands
+
+Define custom Ex commands with `Mui.command`:
+
+```ruby
+Mui.command :name do |ctx|
+  # action
+end
+```
+
+### Examples
+
+```ruby
+# Simple greeting
+Mui.command :hello do |ctx|
+  ctx.set_message("Hello, World!")
+end
+
+# Command with arguments
+Mui.command :echo do |ctx, *args|
+  ctx.set_message(args.join(" "))
+end
+
+# Open configuration file
+Mui.command :config do |ctx|
+  ctx.editor.execute_command("e ~/.muirc")
+end
+```
+
+---
+
+## Autocmd Events
+
+Execute code when events occur with `Mui.autocmd`:
+
+```ruby
+Mui.autocmd :event, pattern: "*.ext" do |ctx|
+  # action
+end
+```
+
+### Available Events
+
+| Event | Trigger |
+|-------|---------|
+| `BufEnter` | When entering a buffer |
+| `BufLeave` | When leaving a buffer |
+| `BufWrite` | When writing a buffer |
+| `BufWritePre` | Before writing a buffer |
+| `BufWritePost` | After writing a buffer |
+| `ModeChanged` | When mode changes |
+| `CursorMoved` | When cursor moves |
+| `TextChanged` | When text is modified |
+| `InsertEnter` | When entering Insert mode |
+| `InsertLeave` | When leaving Insert mode |
+| `InsertCompletion` | When completion is triggered |
+| `JobStarted` | When a job starts |
+| `JobCompleted` | When a job completes |
+| `JobFailed` | When a job fails |
+| `JobCancelled` | When a job is cancelled |
+
+### Examples
+
+```ruby
+# Auto-save on leaving Insert mode
+Mui.autocmd :InsertLeave do |ctx|
+  ctx.editor.execute_command("w") if ctx.buffer.modified?
+end
+
+# Show message when opening Ruby files
+Mui.autocmd :BufEnter, pattern: "*.rb" do |ctx|
+  ctx.set_message("Ruby file loaded")
+end
+
+# Format before saving
+Mui.autocmd :BufWritePre, pattern: "*.rb" do |ctx|
+  # Run formatter
+end
+```
+
+---
+
+## Using Plugins
+
+Load plugins with `Mui.use`:
+
+```ruby
+Mui.use "mui-lsp"
+Mui.use "mui-git"
+Mui.use "mui-fzf"
+```
+
+See [Plugins]({{ site.baseurl }}/plugins) for more details.
+
+---
+
+## Complete Example
+
+```ruby
+# ~/.muirc
+
+# Appearance
+Mui.set :colorscheme, "tokyo_night"
+Mui.set :syntax, true
+
+# Indentation
+Mui.set :tabstop, 2
+Mui.set :shiftwidth, 2
+Mui.set :expandtab, true
+
+# Leader key
+Mui.set :leader, " "
+
+# Plugins
+Mui.use "mui-lsp"
+Mui.use "mui-fzf"
+
+# Key mappings
+Mui.keymap :normal, "<Leader>w" do |ctx|
+  ctx.editor.execute_command("w")
+end
+
+Mui.keymap :normal, "<Leader>q" do |ctx|
+  ctx.editor.execute_command("q")
+end
+
+Mui.keymap :normal, "<Leader>ff" do |ctx|
+  ctx.editor.execute_command("Files")
+end
+
+# Custom commands
+Mui.command :reload do |ctx|
+  ctx.editor.execute_command("e")
+  ctx.set_message("File reloaded")
+end
+
+# LSP configuration
+Mui.lsp do
+  use :ruby
+
+  # TypeScript (requires typescript-language-server)
+  server :typescript,
+    command: ["typescript-language-server", "--stdio"],
+    filetypes: ["typescript", "typescriptreact", "javascript", "javascriptreact"]
+end
+```