mui-lsp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac0edc6ad5bdcfb8d3c4705d7246ee8d49ea823e4693de1bf437a5ba4d60e264
+  data.tar.gz: 59e0fb00ab3c379304615e114fc94bc02e1693bb856d4c908f4f3b62b3b0d170
+SHA512:
+  metadata.gz: df47053646164f89d037b3b8fcc06a08cf77243efe6ded43ce7571cee66a32d355b7d628466eb1f7879f55e18bfdc5fabb7386bcd73d101866c4263843998c94
+  data.tar.gz: 4231151ca03b149edf198725ee8e82b42a57db7bc99f0e8f8e85c77fb124ff981976b40180f1c4512716c97750d2b8ae3ecc6669c60a745c365ba7e8d0c10a11

data/.rubocop_todo.yml

@@ -0,0 +1,73 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-12-11 11:19:34 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/mui/lsp/highlighters/diagnostic_highlighter.rb'
+
+# Offense count: 16
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 44
+
+# Offense count: 6
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 361
+
+# Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 26
+
+# Offense count: 42
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 61
+
+# Offense count: 4
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 6
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 2
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: nonzero?
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/mui/lsp/manager.rb'
+    - 'lib/mui/lsp/request_manager.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowComments.
+# SupportedStyles: empty, nil, both
+Style/EmptyElse:
+  Exclude:
+    - 'lib/mui/lsp/client.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/mui/lsp/json_rpc_io.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 131

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-11
+
+### Added
+
+- **Core Protocol Support**
+  - Position, Range, Location, Diagnostic data types
+  - JSON-RPC 2.0 communication layer with Content-Length header framing
+  - Request/response callback management
+
+- **LSP Client**
+  - Async request/response handling
+  - Automatic server initialization
+  - Server capability negotiation
+
+- **Text Document Synchronization**
+  - didOpen, didChange, didSave, didClose notifications
+  - Debounced change notifications (300ms default)
+  - Full document sync mode
+
+- **Feature Handlers**
+  - Hover: Display documentation for symbol under cursor
+  - Definition: Jump to symbol definition
+  - References: Find all references to a symbol
+  - Completion: Code completion suggestions
+  - Diagnostics: Error/warning display with custom highlighter support
+
+- **Pre-configured Servers**
+  - Solargraph (`solargraph stdio`)
+  - ruby-lsp (`ruby-lsp`)
+  - Kanayago (`kanayago`)
+  - RuboCop LSP mode (`rubocop --lsp`)
+
+- **Plugin Integration**
+  - Commands: `:LspStart`, `:LspStop`, `:LspStatus`, `:LspHover`, `:LspDefinition`, `:LspReferences`, `:LspCompletion`, `:LspDiagnostics`
+  - Keymaps: `K` (hover), `gd` (definition), `gr` (references)
+  - Buffer hooks for automatic document synchronization
+  - Auto-start servers when opening matching files
+- Diagnostic underline highlighting:
+  - `DiagnosticHighlighter` class for displaying LSP diagnostics with underlines
+  - Error (red), warning (yellow), information (blue), and hint (cyan) severity styles
+  - Automatic highlight refresh when diagnostics change
+  - Requires Mui's dynamic custom highlighter support
+- Floating window hover display:
+  - Hover information now shown in floating popup window (requires Mui floating window support)
+  - Falls back to echo area display for older Mui versions
+- `:LspDiagnosticShow` command to display diagnostic at cursor in floating window
+- `\e` keymap to show diagnostic at cursor position
+- `sync_on_change` option for ServerConfig:
+  - Controls whether `didChange` notifications are sent to the server
+  - Useful for running multiple LSP servers without conflicts
+  - ruby-lsp defaults to `sync_on_change: false`
+- Multiple LSP server support:
+  - Notifications (didOpen, didChange, didSave, didClose) broadcast to all matching servers
+  - Each server can be configured independently with `sync_on_change` option
+- Pending document queue for server startup:
+  - Documents opened before server is ready are queued
+  - Queued documents are sent automatically when server finishes initialization
+  - Fixes issue where diagnostics weren't shown for files opened during server startup
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 S-H-GAMELINKS
+
+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.

data/README.md

@@ -0,0 +1,188 @@
+# mui-lsp
+
+LSP (Language Server Protocol) plugin for [Mui](https://github.com/S-H-GAMELINKS/mui) editor.
+
+## 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`)
+- **Diagnostics**: Display errors and warnings from LSP server (`:LspDiagnostics`)
+
+## Supported Language Servers
+
+Pre-configured servers for Ruby:
+
+- **Solargraph** - Full-featured Ruby language server
+- **ruby-lsp** - Shopify's Ruby language server
+- **Kanayago** - Realtime Ruby Syntax Check server
+- **RuboCop** (LSP mode) - Ruby linter with LSP support
+
+Custom servers can be configured for other languages.
+
+## Installation
+
+Add to your `.muirc`:
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp"
+```
+
+Or if installing from a local path:
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp", path: "/path/to/mui-lsp"
+```
+
+## Configuration (Required)
+
+**Important**: mui-lsp does not auto-detect LSP servers. You must explicitly configure which server(s) to use in your `.muirc`.
+
+### Quick Setup
+
+Use the `Mui.lsp` DSL block to configure servers:
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp"
+
+Mui.lsp do
+  use :solargraph
+end
+```
+
+Available pre-configured servers:
+- `:solargraph` - Solargraph (full-featured Ruby LSP)
+- `:ruby_lsp` - ruby-lsp (Shopify's Ruby LSP)
+- `:rubocop` - RuboCop in LSP mode
+- `:kanayago` - Kanayago (Japanese Ruby LSP)
+
+### Custom Server Configuration
+
+For other languages or custom setups, use the `server` method:
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp"
+
+Mui.lsp do
+  # TypeScript/JavaScript
+  server name: "typescript",
+         command: "typescript-language-server --stdio",
+         language_ids: ["typescript", "javascript"],
+         file_patterns: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"]
+
+  # Python (pyright)
+  server name: "pyright",
+         command: "pyright-langserver --stdio",
+         language_ids: ["python"],
+         file_patterns: ["**/*.py"]
+end
+```
+
+### Multiple Servers
+
+You can enable multiple servers for different file types:
+
+```ruby
+# ~/.muirc
+Mui.use "mui-lsp"
+
+Mui.lsp do
+  # Ruby
+  use :solargraph
+
+  # TypeScript/JavaScript
+  server name: "typescript",
+         command: "typescript-language-server --stdio",
+         language_ids: ["typescript", "javascript"],
+         file_patterns: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"]
+end
+```
+
+## Usage
+
+### Starting LSP Server
+
+LSP servers are automatically started when you open a file that matches their configured file patterns.
+
+To manually start a server:
+
+```vim
+:LspStart solargraph
+:LspStart ruby-lsp
+:LspStart rubocop
+```
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `:LspStart <name>` | Start a specific LSP server |
+| `:LspStop [name]` | Stop a server (all if no name given) |
+| `:LspStatus` | Show running and registered servers |
+| `:LspHover` | Show hover information |
+| `:LspDefinition` | Go to definition |
+| `:LspReferences` | Find all references |
+| `:LspCompletion` | Show completion menu |
+| `:LspDiagnostics` | Show diagnostics for current file |
+| `:LspDiagnosticShow` | Show diagnostic at cursor in floating window |
+| `: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 |
+
+## Architecture
+
+```
+mui-lsp/
+  lib/mui/lsp/
+    protocol/          # LSP protocol definitions
+      position.rb      # Position (line, character)
+      range.rb         # Range (start, end positions)
+      location.rb      # Location (URI, range)
+      diagnostic.rb    # Diagnostic (error/warning/info)
+    handlers/          # Response handlers
+      base.rb          # Base handler class
+      hover.rb         # Hover response handler
+      definition.rb    # Definition response handler
+      references.rb    # References response handler
+      diagnostics.rb   # Diagnostics notification handler
+      completion.rb    # Completion 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
+    client.rb          # LSP client (manages server process)
+    text_document_sync.rb # Document synchronization
+    manager.rb         # Multi-server manager
+    plugin.rb          # Mui plugin integration
+```
+
+## Development
+
+```bash
+cd mui-lsp
+bundle install
+bundle exec rake test
+bundle exec rubocop
+```
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/mui/lsp/client.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Mui
+  module Lsp
+    # LSP Client - manages connection to a language server
+    class Client
+      attr_reader :server_capabilities, :initialized, :root_uri, :last_stderr
+
+      def initialize(command:, root_path:, on_notification: nil)
+        @command = command
+        @root_path = root_path
+        @root_uri = "file://#{root_path}"
+        @on_notification = on_notification
+        @initialized = false
+        @server_capabilities = {}
+        @process = nil
+        @io = nil
+        @request_manager = RequestManager.new
+        @reader_thread = nil
+        @running = false
+      end
+
+      def start
+        return if @running
+
+        # Split command into array for proper shell handling
+        cmd_parts = @command.is_a?(Array) ? @command : @command.split(/\s+/)
+        stdin, stdout, stderr, @process = Open3.popen3(*cmd_parts)
+        @io = JsonRpcIO.new(input: stdout, output: stdin)
+        @stderr = stderr
+        @running = true
+        @init_mutex = Mutex.new
+        @init_cv = ConditionVariable.new
+
+        start_reader_thread
+        start_stderr_thread
+        initialize_server
+
+        # Wait for initialization to complete (with timeout)
+        @init_mutex.synchronize do
+          unless @initialized
+            @init_cv.wait(@init_mutex, 10) # 10 second timeout
+          end
+        end
+      end
+
+      def stop
+        return unless @running
+
+        @running = false
+        shutdown
+        @reader_thread&.join(2)
+        begin
+          @process&.kill
+        rescue StandardError
+          nil
+        end
+        @request_manager.cancel_all
+      end
+
+      def running?
+        @running && @initialized
+      end
+
+      def started?
+        @running
+      end
+
+      def request(method, params = nil, &callback)
+        return nil unless @running
+
+        id = @request_manager.register(callback)
+        message = JsonRpcIO.build_request(id: id, method: method, params: params)
+        unless @io.write_message(message)
+          @running = false
+          @request_manager.cancel(id)
+          return nil
+        end
+        id
+      end
+
+      def notify(method, params = nil)
+        return unless @running
+
+        message = JsonRpcIO.build_notification(method: method, params: params)
+        return if @io.write_message(message)
+
+        @running = false
+      end
+
+      def hover(uri:, line:, character:, &callback)
+        request("textDocument/hover", {
+                  textDocument: { uri: uri },
+                  position: { line: line, character: character }
+                }, &callback)
+      end
+
+      def definition(uri:, line:, character:, &callback)
+        request("textDocument/definition", {
+                  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 },
+                  position: { line: line, character: character },
+                  context: { includeDeclaration: include_declaration }
+                }, &callback)
+      end
+
+      def completion(uri:, line:, character:, &callback)
+        request("textDocument/completion", {
+                  textDocument: { uri: uri },
+                  position: { line: line, character: character }
+                }, &callback)
+      end
+
+      def did_open(uri:, language_id:, version:, text:)
+        notify("textDocument/didOpen", {
+                 textDocument: {
+                   uri: uri,
+                   languageId: language_id,
+                   version: version,
+                   text: text
+                 }
+               })
+      end
+
+      def did_change(uri:, version:, changes:)
+        notify("textDocument/didChange", {
+                 textDocument: { uri: uri, version: version },
+                 contentChanges: changes
+               })
+      end
+
+      def did_save(uri:, text: nil)
+        params = { textDocument: { uri: uri } }
+        params[:text] = text if text
+        notify("textDocument/didSave", params)
+      end
+
+      def did_close(uri:)
+        notify("textDocument/didClose", {
+                 textDocument: { uri: uri }
+               })
+      end
+
+      private
+
+      def start_reader_thread
+        @reader_thread = Thread.new do
+          while @running
+            begin
+              message = @io.read_message
+              break if message.nil?
+
+              handle_message(message)
+            rescue IOError, Errno::EPIPE
+              # Pipe closed, server exited
+              break
+            rescue StandardError
+              # Log error but continue reading
+              break unless @running
+            end
+          end
+        end
+      end
+
+      def start_stderr_thread
+        @stderr_lines = []
+        @stderr_thread = Thread.new do
+          while @running
+            begin
+              line = @stderr.gets
+              break if line.nil?
+
+              # Store stderr for debugging
+              @stderr_lines << line.chomp
+              @last_stderr = @stderr_lines.last(10).join("\n")
+            rescue IOError
+              break
+            end
+          end
+        end
+      end
+
+      def handle_message(message)
+        if JsonRpcIO.response?(message)
+          handle_response(message)
+        elsif JsonRpcIO.notification?(message)
+          handle_notification(message)
+        elsif JsonRpcIO.request?(message)
+          handle_server_request(message)
+        end
+      end
+
+      def handle_response(message)
+        id = message["id"]
+        result = message["result"]
+        error = message["error"]
+        @request_manager.handle_response(id, result: result, error: error)
+      end
+
+      def handle_notification(message)
+        @on_notification&.call(message["method"], message["params"])
+      end
+
+      def handle_server_request(message)
+        # Handle server-initiated requests (e.g., workspace/configuration)
+        id = message["id"]
+        method = message["method"]
+
+        response = JsonRpcIO.build_response(id: id, result: nil)
+        case method
+        when "window/workDoneProgress/create"
+        # Accept progress token creation
+        when "client/registerCapability"
+        # Accept capability registration
+        else
+          # Return empty result for unknown requests
+        end
+        @io.write_message(response)
+      end
+
+      def initialize_server
+        request("initialize", {
+                  processId: Process.pid,
+                  rootUri: @root_uri,
+                  rootPath: @root_path,
+                  capabilities: client_capabilities,
+                  workspaceFolders: [
+                    { uri: @root_uri, name: File.basename(@root_path) }
+                  ]
+                }) do |result, error|
+          if error
+            @running = false
+          else
+            @server_capabilities = result&.dig("capabilities") || {}
+            notify("initialized", {})
+            @initialized = true
+          end
+          @init_mutex.synchronize { @init_cv.signal }
+        end
+      end
+
+      def shutdown
+        request("shutdown") do |_result, _error|
+          notify("exit")
+        end
+      rescue StandardError
+        # Ignore errors during shutdown
+      end
+
+      def client_capabilities
+        {
+          textDocument: {
+            hover: {
+              contentFormat: %w[plaintext markdown]
+            },
+            completion: {
+              completionItem: {
+                snippetSupport: false,
+                documentationFormat: %w[plaintext markdown]
+              }
+            },
+            definition: {
+              linkSupport: false
+            },
+            references: {},
+            publishDiagnostics: {
+              relatedInformation: true
+            },
+            synchronization: {
+              didSave: true,
+              willSave: false,
+              willSaveWaitUntil: false
+            }
+          },
+          workspace: {
+            workspaceFolders: true
+          }
+        }
+      end
+    end
+  end
+end