ruby-lsp-typeprof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a3567db20f05419823a0f84a7779f77e9ef39606302242851232ba78bc7cc3f
+  data.tar.gz: 7ff4ba5760b46ac3e51c7b21294c04c84ce65c52921a3a00d900523d519930c6
+SHA512:
+  metadata.gz: f586a90f9ade8046de2de872eabc7ba41554b18b1553e919e675daa9aa6d737f40a4b82b342f5c63f9f6892c70bed314db701bc020d4c8c83427f64b74bcf284
+  data.tar.gz: acba530fb0638a864b644f6d3f2b1aa07a54047e048d3dfbd5feda2f88ca2be2b47276b2bf8e11d5abfd072ec36d1db5ecb1895a134b245cf9569949a97f845b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-04-27
+
+- feat: Display type declarations using Code Lens

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"ruby-lsp-typeprof" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["sinsoku.listy@gmail.com"](mailto:"sinsoku.listy@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Takumi Shotoku
+
+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,33 @@
+# TypeProf add-on
+
+The TypeProf add-on is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) [add-on](https://shopify.github.io/ruby-lsp/add-ons.html) to provide type inference features.
+
+## Installation
+
+Add `ruby-lsp-typeprof` to your Gemfile:
+
+```ruby
+group :development do
+  gem "ruby-lsp-typeprof", require: false
+end
+```
+
+After running `bundle install`, restart Ruby LSP.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sinsoku/ruby-lsp-typeprof. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sinsoku/ruby-lsp-typeprof/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby::Lsp::Typeprof project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sinsoku/ruby-lsp-typeprof/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/ruby-lsp-typeprof.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "ruby_lsp_typeprof/version"

data/lib/ruby_lsp/ruby_lsp_typeprof/addon.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "ruby-lsp-typeprof"
+require "ruby_lsp/addon"
+require "uri"
+
+require_relative "code_lens_listener"
+
+module RubyLsp
+  module Typeprof
+    class Addon < ::RubyLsp::Addon
+      def initialize
+        super
+        @service = nil
+        @mutex = Mutex.new
+      end
+
+      def activate(global_state, _outgoing_queue)
+        require "typeprof"
+
+        @service = build_service(global_state.workspace_path)
+      rescue StandardError => e
+        warn "ruby-lsp-typeprof: Failed to activate: #{e.message}"
+      end
+
+      def deactivate
+        @service = nil
+      end
+
+      def name
+        "TypeProf"
+      end
+
+      def version
+        VERSION
+      end
+
+      def create_code_lens_listener(response_builder, uri, dispatcher)
+        return unless @service
+
+        CodeLensListener.new(response_builder, uri, dispatcher, @service, @mutex)
+      end
+
+      def workspace_did_change_watched_files(changes)
+        return unless @service
+
+        @mutex.synchronize do
+          changes.each { |change| update_changed_file(change) }
+        end
+      end
+
+      private
+
+      def build_service(workspace_path)
+        conf = load_typeprof_conf(workspace_path) || default_conf
+        rbs_dir = File.expand_path(conf[:rbs_dir], workspace_path)
+
+        service = TypeProf::Core::Service.new(conf)
+        conf[:analysis_unit_dirs].each do |dir|
+          service.add_workspace(File.expand_path(dir, workspace_path), rbs_dir)
+        end
+        service
+      end
+
+      def default_conf
+        { analysis_unit_dirs: ["."], rbs_dir: "sig/" }
+      end
+
+      def load_typeprof_conf(workspace_path)
+        conf_path = ["typeprof.conf.json", "typeprof.conf.jsonc"].find do |name|
+          File.readable?(File.join(workspace_path, name))
+        end
+        return unless conf_path
+
+        conf = TypeProf::LSP.load_json_with_comments(File.join(workspace_path, conf_path), symbolize_names: true)
+        exclude = conf.delete(:exclude)
+        conf[:exclude_patterns] = exclude if exclude
+        conf
+      end
+
+      def update_changed_file(change)
+        path = URI.parse(change[:uri]).path
+        return unless path&.end_with?(".rb", ".rbs")
+
+        @service.update_file(path, nil)
+      rescue StandardError => e
+        warn "ruby-lsp-typeprof: Failed to update file #{path}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_typeprof/code_lens_listener.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Typeprof
+    class CodeLensListener
+      def initialize(response_builder, uri, dispatcher, service, mutex)
+        @response_builder = response_builder
+        @path = uri.to_standardized_path
+        @lens_cache = {}
+
+        cache_code_lens_results(service, mutex)
+        dispatcher.register(self, :on_def_node_enter) unless @lens_cache.empty?
+      end
+
+      def on_def_node_enter(node)
+        line = node.location.start_line
+        hint = @lens_cache[line]
+        return unless hint
+
+        @response_builder << build_code_lens(line, hint)
+      end
+
+      private
+
+      def build_code_lens(line, hint)
+        position = LanguageServer::Protocol::Interface::Position.new(line: line - 1, character: 0)
+
+        LanguageServer::Protocol::Interface::CodeLens.new(
+          range: LanguageServer::Protocol::Interface::Range.new(start: position, end: position),
+          command: LanguageServer::Protocol::Interface::Command.new(title: "#: #{hint}", command: "")
+        )
+      end
+
+      def cache_code_lens_results(service, mutex)
+        mutex.synchronize do
+          service.code_lens(@path) do |code_range, hint|
+            @lens_cache[code_range.first.lineno] = hint
+          end
+        end
+      rescue StandardError => e
+        warn "ruby-lsp-typeprof: Code lens error: #{e.message}"
+      end
+    end
+  end
+end

data/lib/ruby_lsp_typeprof/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Typeprof
+    VERSION = "0.1.0"
+  end
+end

data/sig/ruby_lsp/ruby_lsp_typeprof.rbs

@@ -0,0 +1,5 @@
+module RubyLsp
+  module Typeprof
+    VERSION: String
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-typeprof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takumi Shotoku
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+- !ruby/object:Gem::Dependency
+  name: typeprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.31.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.31.1
+description: A Ruby LSP addon that integrates TypeProf to provide type inference features.
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-lsp-typeprof.rb
+- lib/ruby_lsp/ruby_lsp_typeprof/addon.rb
+- lib/ruby_lsp/ruby_lsp_typeprof/code_lens_listener.rb
+- lib/ruby_lsp_typeprof/version.rb
+- sig/ruby_lsp/ruby_lsp_typeprof.rbs
+homepage: https://github.com/sinsoku/ruby-lsp-typeprof
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sinsoku/ruby-lsp-typeprof
+  source_code_uri: https://github.com/sinsoku/ruby-lsp-typeprof/tree/v0.1.0
+  changelog_uri: https://github.com/sinsoku/ruby-lsp-typeprof/blob/v0.1.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: A Ruby LSP addon for TypeProf
+test_files: []