refined-steep-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0c63912a979bde112ef66e36710f04338a7f2a48a7b8a5e3eedcab49ce5d1d1
+  data.tar.gz: c210c1c303407527894df79ec9080a3ba98832b8b3216fdf21d066ea9b1df75c
+SHA512:
+  metadata.gz: 85a0d7823de325492f7b94e3c76b242d5fecf63cfc165b2ad746b69ab2bf0bb48add4a97debc1102cfaf12dc678520150d7d0343feea667f4beb8d49cca2ff80
+  data.tar.gz: a94ed92dcad7a6081ca197fe4152514a45163bd2df73ca4f7913a3773714c0744b89e644caba9691e6c36fa6370beb230aadd3b3baf6970da68a39646ae95061

data/.claude/commands/add-stub.md

@@ -0,0 +1,7 @@
+Steepの内部APIを新たに利用するコードが追加された場合に、`sig/external/steep.rbs` に不足しているスタブRBSを追加して。
+
+手順:
+1. `bundle exec steep check` を実行してUnknownConstantやUnknownTypeNameエラーを確認
+2. エラーに対応するSteepの内部クラス・メソッドの実際のシグネチャを参照ソース（/home/joker/ghq/github.com/soutaro/steep）から調査
+3. `sig/external/steep.rbs` に必要最小限のスタブを追加
+4. 再度 `bundle exec steep check` を実行してエラーが解消されたことを確認

data/.claude/commands/check.md

@@ -0,0 +1,7 @@
+rbs-inline生成、steep型チェック、rspecテストを順に実行して結果を報告して。
+
+1. `bundle exec rbs-inline --output=sig/generated lib` でRBSを再生成
+2. `bundle exec steep check` で型チェック
+3. `bundle exec rspec` でテスト実行
+
+いずれかが失敗した場合はその時点で止めて、エラー内容を報告して。

data/.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  checks: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run rspec
+        run: bundle exec rspec --format documentation --format RspecJunitFormatter --out tmp/rspec-results.xml
+      - name: Upload test results
+        uses: dorny/test-reporter@v1
+        if: always()
+        with:
+          name: "RSpec Results (Ruby ${{ matrix.ruby }})"
+          path: tmp/rspec-results.xml
+          reporter: java-junit
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Generate RBS with rbs-inline
+        run: bundle exec rbs-inline --output=sig/generated lib
+      - name: Cache RBS collection
+        uses: actions/cache@v4
+        with:
+          path: .gem_rbs_collection
+          key: rbs-collection-${{ hashFiles('rbs_collection.lock.yaml') }}
+          restore-keys: |
+            rbs-collection-
+      - name: Install RBS collection
+        run: bundle exec rbs collection install
+      - name: Run steep check
+        run: bundle exec steep check

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/CLAUDE.md

@@ -0,0 +1,57 @@
+# refined-steep-server
+
+Steepをライブラリとして利用して、Steep組込みと同等の機能を持ったlanguage server。
+特にneovimとの親和性を意識している。
+但しlanguage serverの実装はruby-lspを参考にする。
+
+## 参照するソースコード
+
+- Steep: /home/joker/ghq/github.com/soutaro/steep
+- ruby-lsp: /home/joker/ghq/github.com/Shopify/ruby-lsp
+- rbs-inline: /home/joker/ghq/github.com/soutaro/rbs-inline
+
+## アーキテクチャ
+
+- ruby-lsp方式のシングルプロセス・マルチスレッドモデル
+  - メインスレッド: stdinからLSPメッセージ読み取り → incoming_queueへ
+  - ワーカースレッド: incoming_queueから取り出し → process_message → Steepサービス呼び出し
+  - ライタースレッド: outgoing_queueから取り出し → stdoutへJSON-RPC書き込み
+- Steepのサービス群（TypeCheckService, HoverProvider, CompletionProvider, GotoService, SignatureHelpProvider）をライブラリとして直接利用
+- PathAssignment.allで全ファイルを単一プロセスで処理
+
+## 対応LSP機能
+
+- textDocument/hover
+- textDocument/completion (トリガー: `.`, `@`, `:`)
+- textDocument/signatureHelp (トリガー: `(`)
+- textDocument/definition
+- textDocument/implementation
+- textDocument/typeDefinition
+- workspace/symbol
+- textDocument/publishDiagnostics
+
+## 型注釈
+
+- rbs-inline方式で型注釈を記述
+- 各Rubyファイル先頭に `# rbs_inline: enabled` マーカーを記述
+- `sig/generated/` にrbs-inlineで生成したRBSを出力（.gitignore対象）
+- `sig/external/steep.rbs` にsteep・language_server-protocol・parser gemの手書きスタブRBSを配置
+  - steep gemはsig/をgemパッケージに含めていないため、RBS collectionでは型定義を取得できない
+  - Steepの内部APIを新たに利用する場合はこのファイルにスタブを追加すること
+
+## テスト・型チェック
+
+- rspecを使用
+- 実装時は各ステップでテスト通過を確認しながら進める
+- steep checkはエラーなしの状態を維持する
+
+## コマンド
+
+- `bundle exec rspec` — テスト実行
+- `bundle exec rbs-inline --output=sig/generated lib` — rbs-inlineでRBS生成
+- `bundle exec steep check` — 型チェック
+- 実装変更後のワークフロー: `rbs-inline生成 → steep check → rspec` の順に実行
+
+## Commit Comment
+
+Conventional Commitsの規約に従う。

data/README.md

@@ -0,0 +1,147 @@
+# refined-steep-server
+
+[![CI](https://github.com/joker1007/refined-steep-server/actions/workflows/ci.yml/badge.svg)](https://github.com/joker1007/refined-steep-server/actions/workflows/ci.yml)
+
+Most of this project is written by Claude Code.
+
+A language server for Ruby type checking that uses [Steep](https://github.com/soutaro/steep) as a library. It provides the same type checking features as Steep's built-in language server, reimplemented with a single-process multi-threaded architecture inspired by [ruby-lsp](https://github.com/Shopify/ruby-lsp). Designed with Neovim compatibility in mind.
+
+## Motivation
+
+Steep ships with a built-in language server based on a multi-process architecture (master + interaction worker + type-check workers). While powerful, this design can be complex to manage and debug. It also type-checks the entire project on startup, which can cause significant delays in large codebases.
+
+refined-steep-server takes a different approach: it runs everything in a single process with multiple threads, directly calling Steep's internal services as a library. Instead of type-checking all files on startup, it only type-checks files as they are opened or modified. This results in a simpler, faster-starting server that is easier to integrate with editors like Neovim.
+
+## Features
+
+### Supported LSP Methods
+
+| Method | Description |
+|--------|-------------|
+| `textDocument/hover` | Show type information at cursor |
+| `textDocument/completion` | Code completion (triggers: `.`, `@`, `:`) |
+| `textDocument/signatureHelp` | Method signature help (trigger: `(`) |
+| `textDocument/definition` | Go to definition |
+| `textDocument/implementation` | Find implementations |
+| `textDocument/typeDefinition` | Go to type definition |
+| `workspace/symbol` | Workspace-wide symbol search |
+| `textDocument/publishDiagnostics` | Type error diagnostics |
+
+### Additional Features
+
+- Incremental text document synchronization
+- Type checking runs on file open and file save (not on every keystroke)
+- WorkDoneProgress notifications for type checking progress
+- Steepfile auto-discovery (searches parent directories)
+- Configurable logging with `--log-level` and `--log-file` options
+
+## Architecture
+
+```
+Client (editor)
+  |
+  v
+[Main Thread] reads stdin --> incoming_queue
+  |
+  v
+[Worker Thread] pops from incoming_queue --> process_message --> Steep services
+  |
+  v
+[Writer Thread] pops from outgoing_queue --> writes JSON-RPC to stdout
+```
+
+Steep's services (`TypeCheckService`, `HoverProvider`, `CompletionProvider`, `GotoService`, `SignatureHelpProvider`) are called directly as library APIs, with `PathAssignment.all` handling all files in a single process.
+
+## Requirements
+
+- Ruby >= 3.2.0
+- Steep ~> 1.10
+- A `Steepfile` in your project
+
+## Installation
+
+```bash
+gem install refined-steep-server
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "refined-steep-server"
+```
+
+## Usage
+
+### Basic
+
+```bash
+refined-steep-server
+```
+
+The server communicates over stdin/stdout using the LSP protocol. Point your editor's LSP client to this executable.
+
+### With Debug Logging
+
+```bash
+refined-steep-server --log-level debug
+```
+
+### With Log File
+
+```bash
+refined-steep-server --log-level debug --log-file /tmp/refined-steep.log
+```
+
+### Neovim Configuration (0.12+)
+
+Neovim 0.12+ has built-in LSP support via `vim.lsp.config()` and `vim.lsp.enable()`. No plugins required.
+
+```lua
+vim.lsp.config("refined_steep", {
+  cmd = { "refined-steep-server" },
+  filetypes = { "ruby" },
+  root_markers = { "Steepfile" },
+})
+
+vim.lsp.enable("refined_steep")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+### Commands
+
+```bash
+# Run tests
+bundle exec rspec
+
+# Generate RBS from inline annotations
+bundle exec rbs-inline --output=sig/generated lib
+
+# Run type checker
+bundle exec steep check
+
+# Recommended workflow after changes:
+bundle exec rbs-inline --output=sig/generated lib && bundle exec steep check && bundle exec rspec
+```
+
+### Project Structure
+
+```
+lib/refined/steep/server/
+  base_server.rb    # Abstract server with 3-thread model (reader/worker/writer)
+  lsp_server.rb     # Concrete LSP server with request routing and handlers
+  steep_state.rb    # Bridge to Steep: Project, TypeCheckService, change buffer
+  store.rb          # Document state management
+  message.rb        # LSP message types (Result, Error, Notification, Request)
+  io.rb             # JSON-RPC MessageReader/MessageWriter
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joker1007/refined-steep-server.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+namespace :rbs do
+  desc "Generate RBS files from rbs-inline annotations"
+  task :inline do
+    sh "bundle exec rbs-inline --output=sig/generated lib"
+  end
+end
+
+task default: %i[]

data/Steepfile

@@ -0,0 +1,5 @@
+target :lib do
+  check "lib"
+  signature "sig"
+  collection_config "rbs_collection.yaml"
+end

data/exe/refined-steep-server

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "logger"
+require "refined/steep/server"
+require "refined/steep/server/lsp_server"
+
+log_level = Logger::WARN
+log_output = $stderr
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: refined-steep-server [options]"
+
+  opts.on("--log-level LEVEL", %w[debug info warn error fatal], "Set log level (debug, info, warn, error, fatal)") do |level|
+    log_level = Logger.const_get(level.upcase)
+  end
+
+  opts.on("--log-file PATH", "Log to file instead of stderr") do |path|
+    log_output = File.open(path, "a")
+    log_output.sync = true
+  end
+end.parse!
+
+$stdin.sync = true
+$stdout.sync = true
+$stderr.sync = true
+$stdin.binmode
+$stdout.binmode
+$stderr.binmode
+
+logger = Refined::Steep::Server::BaseServer.create_default_logger(level: log_level, io: log_output)
+logger.info { "Starting refined-steep-server v#{Refined::Steep::Server::VERSION} (log_level=#{Logger::SEV_LABEL[log_level]})" }
+
+server = Refined::Steep::Server::LspServer.new(logger: logger)
+server.start

data/lib/refined/steep/server/base_server.rb

@@ -0,0 +1,171 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+require "logger"
+
+module Refined
+  module Steep
+    module Server
+      # @rbs!
+      #   type lsp_message = Hash[Symbol, untyped]
+
+      class BaseServer
+        # @rbs @reader: MessageReader
+        # @rbs @writer: MessageWriter
+        # @rbs @mutex: Mutex
+        # @rbs @incoming_queue: Thread::Queue
+        # @rbs @outgoing_queue: Thread::Queue
+        # @rbs @cancelled_requests: Array[Integer]
+        # @rbs @current_request_id: Integer
+        # @rbs @worker: Thread
+        # @rbs @outgoing_dispatcher: Thread
+
+        attr_reader :logger #: Logger
+
+        # @rbs reader: IO?
+        # @rbs writer: IO?
+        # @rbs logger: Logger?
+        # @rbs return: void
+        def initialize(reader: nil, writer: nil, logger: nil)
+          @logger = logger || self.class.create_default_logger
+          @reader = MessageReader.new(reader || $stdin)
+          @writer = MessageWriter.new(writer || $stdout)
+          @mutex = Mutex.new
+          @incoming_queue = Thread::Queue.new
+          @outgoing_queue = Thread::Queue.new
+          @cancelled_requests = []
+          @current_request_id = 1
+
+          @worker = start_worker_thread
+          @outgoing_dispatcher = start_outgoing_thread
+
+          Thread.main.priority = 1
+        end
+
+        # @rbs level: Integer
+        # @rbs io: IO
+        # @rbs return: Logger
+        def self.create_default_logger(level: Logger::WARN, io: $stderr)
+          l = Logger.new(io)
+          l.level = level
+          l.formatter = proc do |severity, datetime, _progname, msg|
+            "[#{datetime.strftime("%Y-%m-%d %H:%M:%S.%L")}] #{severity} -- #{msg}\n"
+          end
+          l
+        end
+
+        # @rbs return: void
+        def start
+          @reader.each_message do |message|
+            method = message[:method]
+            logger.debug { "Received: method=#{method} id=#{message[:id]}" }
+
+            case method
+            when "initialize", "initialized", "$/cancelRequest"
+              process_message(message)
+            when "shutdown"
+              @mutex.synchronize do
+                logger.info { "Shutting down refined-steep-server..." }
+                send_log_message("Shutting down refined-steep-server...")
+                shutdown
+                run_shutdown
+                @writer.write(Result.new(id: message[:id], response: nil).to_hash)
+              end
+            when "exit"
+              logger.info { "Exiting" }
+              exit(@incoming_queue.closed? ? 0 : 1)
+            else
+              @incoming_queue << message
+            end
+          end
+        end
+
+        # @rbs message: lsp_message
+        # @rbs return: void
+        def process_message(message)
+          raise NotImplementedError
+        end
+
+        # @rbs return: void
+        def run_shutdown
+          @incoming_queue.clear
+          @outgoing_queue.clear
+          @incoming_queue.close
+          @outgoing_queue.close
+          @cancelled_requests.clear
+
+          @worker.terminate
+          @outgoing_dispatcher.terminate
+        end
+
+        private
+
+        # @rbs return: void
+        def shutdown
+          raise NotImplementedError
+        end
+
+        # @rbs return: Thread
+        def start_worker_thread
+          Thread.new do
+            while (message = @incoming_queue.pop)
+              handle_incoming_message(message)
+            end
+          end
+        end
+
+        # @rbs return: Thread
+        def start_outgoing_thread
+          Thread.new do
+            while (message = @outgoing_queue.pop)
+              @mutex.synchronize { @writer.write(message.to_hash) }
+            end
+          end
+        end
+
+        # @rbs message: lsp_message
+        # @rbs return: void
+        def handle_incoming_message(message)
+          id = message[:id]
+
+          @mutex.synchronize do
+            if id && @cancelled_requests.delete(id)
+              logger.debug { "Request #{id} was cancelled, skipping" }
+              send_message(ErrorResponse.new(
+                id: id,
+                code: Constant::ErrorCodes::REQUEST_CANCELLED,
+                message: "Request #{id} was cancelled",
+              ))
+              return
+            end
+          end
+
+          process_message(message)
+          @cancelled_requests.delete(id)
+        end
+
+        # @rbs message: Result | ErrorResponse | Notification | Request
+        # @rbs return: void
+        def send_message(message)
+          return if @outgoing_queue.closed?
+
+          @outgoing_queue << message
+          @current_request_id += 1 if message.is_a?(Request)
+        end
+
+        # @rbs id: Integer
+        # @rbs return: void
+        def send_empty_response(id)
+          send_message(Result.new(id: id, response: nil))
+        end
+
+        # @rbs message: String
+        # @rbs type: Integer
+        # @rbs return: void
+        def send_log_message(message, type: Constant::MessageType::LOG)
+          send_message(Notification.window_log_message(message, type: type))
+        end
+      end
+    end
+  end
+end

data/lib/refined/steep/server/io.rb

@@ -0,0 +1,54 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+require "json"
+
+module Refined
+  module Steep
+    module Server
+      class MessageReader
+        # @rbs @io: IO
+
+        # @rbs io: IO
+        # @rbs return: void
+        def initialize(io)
+          @io = io
+        end
+
+        # @rbs &block: (Hash[Symbol, untyped]) -> void
+        # @rbs return: void
+        def each_message(&block)
+          while (headers = @io.gets("\r\n\r\n"))
+            content_length = headers[/Content-Length: (\d+)/i, 1]&.to_i
+            next unless content_length
+
+            raw_message = @io.read(content_length)
+            next unless raw_message
+
+            block.call(JSON.parse(raw_message, symbolize_names: true))
+          end
+        end
+      end
+
+      class MessageWriter
+        # @rbs @io: IO
+
+        # @rbs io: IO
+        # @rbs return: void
+        def initialize(io)
+          @io = io
+        end
+
+        # @rbs message: Hash[Symbol, untyped]
+        # @rbs return: void
+        def write(message)
+          message[:jsonrpc] = "2.0"
+          json_message = message.to_json
+
+          @io.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+          @io.flush
+        end
+      end
+    end
+  end
+end