mui-lsp 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990948dead05098d8add9c4fc12c55470b8361fcafc8ca8de025be882f81d0b8
-  data.tar.gz: 89e3a3c9c0bc688342fcfde30576b94d186ec1207a178af279eed1df73cd1076
+  metadata.gz: 263fd9cae12708ea5be41993083794357068d8af592bc9b7684f650cd9eb094d
+  data.tar.gz: 14d542c5978a50e0095acd951a418e43445208a7907024df7eb4dff8ead2e499
 SHA512:
-  metadata.gz: 05e02edfd2e6658e488d7b9b7f04dd97f9ec08aec3d7025ece92913a67e7a4ecb8dd7270b5cc2dc1e91622fb878e12b61452b150dcce3d78c61bd3c6f8130672
-  data.tar.gz: 2ba900393380934caa9392790791b19910ba2078db4e5a3a8851a8c64d983e12eb5acf1b18e3093c3aadfaa17777fd35f1b95c9741e24f79a467d35f50fa0808
+  metadata.gz: 488392ecc54c123a1a558def0e6b8ec326f85252f0ab95bb2dc97fc40f5a864e43a60563578d0e3b817207ae5122bcb1f5350a0cb884db5ea01549a9e42bfcf1
+  data.tar.gz: 8fd6da70ce1e5640e35f72d3d1239d0ec2d5fb76a3e5791a8b406f0efb1b3a3369a16bed112b1ba153d8ec9e96141fdcc0e6a3483470f2faeed10951864b6e26

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-12-11 11:19:34 UTC using RuboCop version 1.81.7.
+# on 2025-12-26 06:52:41 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,36 +12,54 @@ Lint/DuplicateBranch:
   Exclude:
     - 'lib/mui/lsp/highlighters/diagnostic_highlighter.rb'
 
-# Offense count: 16
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/EmptyClass:
+  Exclude:
+    - 'test/mui/lsp/handlers/test_completion.rb'
+
+# Offense count: 25
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 44
+  Max: 46
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 361
+  Max: 435
 
-# Offense count: 7
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 26
 
-# Offense count: 42
+# Offense count: 83
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 61
+  Max: 56
 
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 6
+# Offense count: 5
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 14
 
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/mui/lsp/handlers/completion.rb'
+
+# Offense count: 4
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'test/fixtures/sample.rb'
+
 # Offense count: 2
 # Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
 # AllowedMethods: call
@@ -65,7 +83,7 @@ Style/IfUnlessModifier:
   Exclude:
     - 'lib/mui/lsp/json_rpc_io.rb'
 
-# Offense count: 1
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -1,5 +1,64 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-12-26 
+
+### Added
+- Multiple LSP result merging:
+  - Definition, References, and Type Definition now query all matching LSP servers
+  - Results from all servers are merged and deduplicated
+  - Enables showing both Ruby source and RBS type definitions together
+- Steep pre-configured server:
+  - `use :steep` in `Mui.lsp` block to enable
+  - Requires `Steepfile` in project root
+  - Supports `.rb` and `.rbs` files
+- Ruby/RBS file toggle (`<Space>tf`):
+  - In Ruby files: jumps to corresponding RBS file in `sig/` directory
+  - In RBS files: jumps to corresponding Ruby file in `lib/` directory
+  - Searches multiple path patterns (e.g., `lib/mui/config.rb` → `sig/mui/config.rbs`)
+  - For non-Ruby files: uses LSP `textDocument/typeDefinition` as before
+- Type definition support (`textDocument/typeDefinition`):
+  - `:LspTypeDefinition` command to jump to type definition
+  - `<Space>tf` keymap for type definition
+  - Works with TypeProf, Sorbet, Steep and other Ruby type checkers
+  - Uses same picker UI as Definition when multiple candidates found
+- TypeProf pre-configured server:
+  - `use :typeprof` in `Mui.lsp` block to enable
+  - Requires `typeprof.conf.jsonc` in project root (run `typeprof --init` to create)
+- Format support (`textDocument/formatting`):
+  - `:LspFormat` command to format current file
+  - `<Space>ff` keymap for formatting
+  - Works with RuboCop LSP and other formatters
+- Location picker for Definition and References:
+  - When multiple definitions or references are found, opens a scratch buffer picker
+  - `j`/`k` - Navigate up/down (native cursor movement)
+  - `\` + `Enter` - Open selected location in current window
+  - `Ctrl+t` - Open selected location in new tab
+  - `\q` / `\` + `Esc` - Close picker
+
+### Fixed
+- Type definition now checks `typeDefinitionProvider` capability before sending requests
+  - Prevents sending requests to servers that don't support type definition (e.g., Solargraph)
+  - Shows helpful message when no server supports type definition
+
+### Changed
+- Keymaps changed from leader key (`\`) to `<Space>` prefix:
+  - `<Space>df` - Go to definition
+  - `<Space>rf` - Find references
+  - `<Space>hf` - Show hover information
+  - `<Space>cf` - Show completion
+  - `<Space>ef` - Show diagnostic at cursor
+- Removed manual `@leader_pending` state management in favor of Mui's native multi-key sequence support
+
+## [0.2.0] - 2025-12-12
+
+### Added
+- Insert mode LSP completion support:
+  - Auto-trigger completion after `.`, `@`, and `::` characters via `InsertCompletion` autocmd
+  - Uses `textEdit` for precise text replacement (e.g., `@user` replaces properly)
+  - `force_reopen` ensures LSP has latest buffer content before completion
+  - Completion items include `label`, `kind`, `detail`, `documentation`, and `text_edit`
+- `Ctrl+Space` keymap in Insert mode to manually trigger LSP completion
+
 ## [0.1.1] - 2025-12-11
 
 ### Changed

data/README.md

@@ -4,10 +4,12 @@ LSP (Language Server Protocol) plugin for [Mui](https://github.com/S-H-GAMELINKS
 
 ## Features
 
-- **Hover**: Show documentation for symbol under cursor (`K` or `\h` or `:LspHover`)
-- **Go to Definition**: Jump to symbol definition (`\d` or `:LspDefinition`)
-- **Find References**: Show all references to symbol (`\r` or `:LspReferences`)
-- **Completion**: Get code completion suggestions (`\c` or `:LspCompletion`)
+- **Hover**: Show documentation for symbol under cursor (`K` or `<Space>hf` or `:LspHover`)
+- **Go to Definition**: Jump to symbol definition (`<Space>df` or `:LspDefinition`)
+- **Go to Type Definition**: Jump to type definition or toggle between Ruby/RBS files (`<Space>tf` or `:LspTypeDefinition`)
+- **Find References**: Show all references to symbol (`<Space>rf` or `:LspReferences`)
+- **Completion**: Get code completion suggestions (`<Space>cf` or `:LspCompletion`)
+- **Format**: Format current file with LSP server (`<Space>ff` or `:LspFormat`)
 - **Diagnostics**: Display errors and warnings from LSP server (`:LspDiagnostics`)
 
 ## Supported Language Servers
@@ -18,6 +20,8 @@ Pre-configured servers for Ruby:
 - **ruby-lsp** - Shopify's Ruby language server
 - **Kanayago** - Realtime Ruby Syntax Check server
 - **RuboCop** (LSP mode) - Ruby linter with LSP support
+- **TypeProf** - Ruby type analysis and inference
+- **Steep** - Ruby type checker with RBS support
 
 Custom servers can be configured for other languages.
 
@@ -59,6 +63,42 @@ Available pre-configured servers:
 - `:ruby_lsp` - ruby-lsp (Shopify's Ruby LSP)
 - `:rubocop` - RuboCop in LSP mode
 - `:kanayago` - Kanayago (Japanese Ruby LSP)
+- `:typeprof` - TypeProf (Ruby type analysis)
+- `:steep` - Steep (Ruby type checker with RBS)
+
+### TypeProf Setup
+
+TypeProf requires a configuration file in your project root. Run:
+
+```bash
+typeprof --init
+```
+
+This creates `typeprof.conf.jsonc` with default settings:
+
+```jsonc
+{
+  "typeprof_version": "experimental",
+  "rbs_dir": "sig/",
+  "analysis_unit_dirs": ["lib"]
+}
+```
+
+TypeProf will only analyze files in the directories specified in `analysis_unit_dirs`. Without this configuration file, TypeProf will not track documents and type definition features will not work.
+
+### Steep Setup
+
+Steep requires a `Steepfile` in your project root. Create one with:
+
+```ruby
+# Steepfile
+target :lib do
+  signature "sig"
+  check "lib"
+end
+```
+
+Place your RBS type definitions in the `sig/` directory.
 
 ### Custom Server Configuration
 
@@ -126,27 +166,40 @@ To manually start a server:
 | `:LspStatus` | Show running and registered servers |
 | `:LspHover` | Show hover information |
 | `:LspDefinition` | Go to definition |
+| `:LspTypeDefinition` | Go to type definition |
 | `:LspReferences` | Find all references |
 | `:LspCompletion` | Show completion menu |
 | `:LspDiagnostics` | Show diagnostics for current file |
 | `:LspDiagnosticShow` | Show diagnostic at cursor in floating window |
+| `:LspFormat` | Format current file |
 | `:LspLog` | Show LSP server logs in a buffer |
 | `:LspDebug` | Show debug information |
 | `:LspOpen` | Manually notify LSP server about current file |
 
 ### Keymaps
 
-Leader key is `\` (backslash).
-
 | Key | Mode | Description |
 |-----|------|-------------|
 | `K` | Normal | Show hover information (in floating window) |
-| `\h` | Normal | Show hover information (alternative) |
-| `\d` | Normal | Go to definition |
-| `\r` | Normal | Find references |
-| `\c` | Normal | Show completion |
-| `\e` | Normal | Show diagnostic at cursor (in floating window) |
-| `Esc` | Normal | Cancel leader pending state / Close floating window |
+| `<Space>df` | Normal | Go to definition |
+| `<Space>tf` | Normal | Go to type definition (Ruby: toggle .rb/.rbs) |
+| `<Space>rf` | Normal | Find references |
+| `<Space>hf` | Normal | Show hover information (alternative to K) |
+| `<Space>cf` | Normal | Show completion |
+| `<Space>ef` | Normal | Show diagnostic at cursor (in floating window) |
+| `<Space>ff` | Normal | Format current file |
+| `Esc` | Normal | Close floating window / picker |
+
+#### Location Picker (for Definition/References with multiple candidates)
+
+When multiple definitions or references are found, a picker buffer opens. Use standard Vim navigation:
+
+| Key | Description |
+|-----|-------------|
+| `j`/`k` | Navigate up/down (native cursor movement) |
+| `\` + `Enter` | Open selected location in current window |
+| `Ctrl+t` | Open selected location in new tab |
+| `\q` / `\` + `Esc` | Close picker |
 
 ## Architecture
 
@@ -162,9 +215,11 @@ mui-lsp/
       base.rb          # Base handler class
       hover.rb         # Hover response handler
       definition.rb    # Definition response handler
+      type_definition.rb # Type definition response handler
       references.rb    # References response handler
       diagnostics.rb   # Diagnostics notification handler
       completion.rb    # Completion response handler
+      formatting.rb    # Formatting response handler
     json_rpc_io.rb     # JSON-RPC 2.0 over stdio
     request_manager.rb # Request ID and callback management
     server_config.rb   # Server configuration presets

data/lib/mui/lsp/client.rb

@@ -104,6 +104,13 @@ module Mui
                 }, &callback)
       end
 
+      def type_definition(uri:, line:, character:, &callback)
+        request("textDocument/typeDefinition", {
+                  textDocument: { uri: uri },
+                  position: { line: line, character: character }
+                }, &callback)
+      end
+
       def references(uri:, line:, character:, include_declaration: true, &callback)
         request("textDocument/references", {
                   textDocument: { uri: uri },
@@ -119,6 +126,16 @@ module Mui
                 }, &callback)
       end
 
+      def formatting(uri:, tab_size: 2, insert_spaces: true, &callback)
+        request("textDocument/formatting", {
+                  textDocument: { uri: uri },
+                  options: {
+                    tabSize: tab_size,
+                    insertSpaces: insert_spaces
+                  }
+                }, &callback)
+      end
+
       def did_open(uri:, language_id:, version:, text:)
         notify("textDocument/didOpen", {
                  textDocument: {
@@ -270,7 +287,13 @@ module Mui
             definition: {
               linkSupport: false
             },
+            typeDefinition: {
+              linkSupport: false
+            },
             references: {},
+            formatting: {
+              dynamicRegistration: false
+            },
             publishDiagnostics: {
               relatedInformation: true
             },

data/lib/mui/lsp/handlers/completion.rb

@@ -84,8 +84,30 @@ module Mui
         end
 
         def display_completions(items)
-          # For now, show first few items in message
-          # TODO: Integrate with Mui's popup menu or completion system
+          # Use Mui's insert completion API if available
+          if @editor.respond_to?(:start_insert_completion)
+            prefix = get_current_prefix
+            @editor.start_insert_completion(items, prefix:)
+          else
+            # Fallback: show message
+            show_message_fallback(items)
+          end
+        end
+
+        def get_current_prefix
+          window = @editor.window
+          buffer = window.buffer
+          line = buffer.line(window.cursor_row)
+          col = window.cursor_col
+
+          # Find word start
+          start_col = col
+          start_col -= 1 while start_col.positive? && line[start_col - 1] =~ /\w/
+
+          line[start_col...col] || ""
+        end
+
+        def show_message_fallback(items)
           count = items.length
 
           # Build a summary message
@@ -94,13 +116,6 @@ module Mui
           summary += ", ..." if count > 3
 
           @editor.message = "#{count} completion#{"s" unless count == 1}: #{summary}"
-
-          # Store items for potential insertion
-          store_completions(items)
-        end
-
-        def store_completions(items)
-          @editor.instance_variable_set(:@lsp_completions, items)
         end
 
         def kind_to_string(kind)

data/lib/mui/lsp/handlers/definition.rb

@@ -83,15 +83,22 @@ module Mui
         end
 
         def show_location_list(locations)
-          # Show a list of locations for the user to choose from
-          items = locations.map do |loc|
+          # Store locations for picker navigation
+          @editor.instance_variable_set(:@lsp_picker_locations, locations)
+          @editor.instance_variable_set(:@lsp_picker_type, :definition)
+
+          # Build picker content
+          lines = []
+          locations.each_with_index do |loc, idx|
             file_path = loc.file_path || loc.uri
-            line = loc.range.start.line + 1
-            "#{file_path}:#{line}"
+            display_path = File.basename(file_path.to_s)
+            line_num = loc.range.start.line + 1
+            lines << "#{idx + 1}. #{display_path}:#{line_num}"
           end
 
-          @editor.message = "Found #{locations.length} definitions: #{items.first}..."
-          # TODO: Integrate with quickfix list or popup menu when available
+          # Open scratch buffer for picker
+          content = "Definitions (\\Enter:open, Ctrl+t:tab, \\q:close)\n\n#{lines.join("\n")}"
+          @editor.open_scratch_buffer("[LSP Picker]", content)
         end
       end
     end

data/lib/mui/lsp/handlers/formatting.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Mui
+  module Lsp
+    module Handlers
+      # Handler for textDocument/formatting responses
+      class Formatting < Base
+        protected
+
+        def handle_result(result)
+          return handle_empty unless result.is_a?(Array) && !result.empty?
+
+          apply_text_edits(result)
+        end
+
+        def handle_empty
+          @editor.message = "No formatting changes"
+        end
+
+        private
+
+        def apply_text_edits(edits)
+          buffer = @editor.buffer
+          return @editor.message = "No buffer" unless buffer
+
+          # Sort edits in reverse order (bottom to top) to avoid position shifts
+          sorted_edits = edits.sort_by do |edit|
+            range = edit["range"]
+            start_line = range["start"]["line"]
+            start_char = range["start"]["character"]
+            [-start_line, -start_char]
+          end
+
+          # Apply each edit
+          changes_count = 0
+          sorted_edits.each do |edit|
+            apply_single_edit(buffer, edit)
+            changes_count += 1
+          end
+
+          @editor.message = "Formatted (#{changes_count} change#{"s" unless changes_count == 1})"
+        end
+
+        def apply_single_edit(buffer, edit)
+          range = edit["range"]
+          new_text = edit["newText"]
+
+          start_line = range["start"]["line"]
+          start_char = range["start"]["character"]
+          end_line = range["end"]["line"]
+          end_char = range["end"]["character"]
+
+          # Get current lines
+          lines = buffer.lines
+
+          # Build new content
+          # Get text before the edit range
+          before_text = if start_line < lines.length
+                          line = lines[start_line] || ""
+                          line[0, start_char] || ""
+                        else
+                          ""
+                        end
+
+          # Get text after the edit range
+          after_text = if end_line < lines.length
+                         line = lines[end_line] || ""
+                         line[end_char..] || ""
+                       else
+                         ""
+                       end
+
+          # Split new_text into lines
+          new_lines = new_text.split("\n", -1)
+
+          new_lines = [""] if new_lines.empty?
+
+          # Combine before_text with first new line
+          new_lines[0] = before_text + new_lines[0]
+
+          # Combine last new line with after_text
+          new_lines[-1] = new_lines[-1] + after_text
+
+          # Replace lines in buffer
+          # Delete old lines
+          delete_count = end_line - start_line + 1
+          delete_count.times do
+            buffer.delete_line(start_line) if start_line < buffer.lines.length
+          end
+
+          # Insert new lines
+          new_lines.each_with_index do |line, idx|
+            buffer.insert_line(start_line + idx, line)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mui/lsp/handlers/references.rb

@@ -11,7 +11,12 @@ module Mui
           return handle_empty unless result.is_a?(Array) && !result.empty?
 
           locations = result.map { |loc| Protocol::Location.from_hash(loc) }
-          show_references(locations)
+
+          if locations.length == 1
+            jump_to_location(locations.first)
+          else
+            show_location_list(locations)
+          end
         end
 
         def handle_empty
@@ -20,44 +25,52 @@ module Mui
 
         private
 
-        def show_references(locations)
-          count = locations.length
-
-          # Build message with first few references
-          lines = ["Found #{count} reference#{"s" unless count == 1}"]
-
-          # Group by file for display
-          by_file = locations.group_by(&:file_path)
-
-          # Display first few references
-          displayed = 0
-          max_display = 3
-
-          by_file.each do |file_path, file_locations|
-            break if displayed >= max_display
+        def jump_to_location(location)
+          file_path = location.file_path
+          unless file_path
+            @editor.message = "Cannot open: #{location.uri}"
+            return
+          end
 
-            file_locations.each do |loc|
-              break if displayed >= max_display
+          line = location.range.start.line
+          character = location.range.start.character
 
-              line = loc.range.start.line + 1
-              lines << "  #{file_path || loc.uri}:#{line}"
-              displayed += 1
-            end
+          # Open the file in current window
+          current_buffer = @editor.buffer
+          if current_buffer.file_path != file_path
+            new_buffer = Mui::Buffer.new
+            new_buffer.load(file_path)
+            @editor.window.buffer = new_buffer
           end
 
-          lines << "  ... and #{count - max_display} more" if count > max_display
+          # Jump to position
+          window = @editor.window
+          return unless window
 
-          @editor.message = lines.first
+          window.cursor_row = line
+          window.cursor_col = character
+          window.ensure_cursor_visible
 
-          # TODO: Integrate with quickfix list when available
-          # Store references for navigation
-          store_references(locations)
+          @editor.message = "#{File.basename(file_path)}:#{line + 1}"
         end
 
-        def store_references(locations)
-          # Store references for potential :cnext/:cprev navigation
-          # This could be integrated with Mui's quickfix system if available
-          @editor.instance_variable_set(:@lsp_references, locations)
+        def show_location_list(locations)
+          # Store locations for picker navigation
+          @editor.instance_variable_set(:@lsp_picker_locations, locations)
+          @editor.instance_variable_set(:@lsp_picker_type, :references)
+
+          # Build picker content
+          lines = []
+          locations.each_with_index do |loc, idx|
+            file_path = loc.file_path || loc.uri
+            display_path = File.basename(file_path.to_s)
+            line_num = loc.range.start.line + 1
+            lines << "#{idx + 1}. #{display_path}:#{line_num}"
+          end
+
+          # Open scratch buffer for picker
+          content = "References (#{locations.length} found) (\\Enter:open, Ctrl+t:tab, \\q:close)\n\n#{lines.join("\n")}"
+          @editor.open_scratch_buffer("[LSP Picker]", content)
         end
       end
     end