steep 0.43.0 → 0.45.0

data/lib/steep/server/interaction_worker.rb

@@ -7,6 +7,8 @@ module Steep
       HoverJob = Struct.new(:id, :path, :line, :column, keyword_init: true)
       CompletionJob = Struct.new(:id, :path, :line, :column, :trigger, keyword_init: true)
 
+      LSP = LanguageServer::Protocol
+
       attr_reader :service
 
       def initialize(project:, reader:, writer:, queue: Queue.new)
@@ -65,7 +67,7 @@ module Steep
           uri = URI.parse(params[:textDocument][:uri])
           path = project.relative_path(Pathname(uri.path))
           line, column = params[:position].yield_self {|hash| [hash[:line]+1, hash[:character]] }
-          trigger = params[:context][:triggerCharacter]
+          trigger = params.dig(:context, :triggerCharacter)
 
           queue << CompletionJob.new(id: id, path: path, line: line, column: column, trigger: trigger)
         end
@@ -77,11 +79,12 @@ module Steep
             Steep.logger.info { "path=#{job.path}, line=#{job.line}, column=#{job.column}" }
 
             hover = Services::HoverContent.new(service: service)
-            content = hover.content_for(path: job.path, line: job.line, column: job.column+1)
+            content = hover.content_for(path: job.path, line: job.line, column: job.column)
             if content
               range = content.location.yield_self do |location|
-                start_position = { line: location.line - 1, character: location.column }
-                end_position = { line: location.last_line - 1, character: location.last_column }
+                lsp_range = location.as_lsp_range
+                start_position = { line: lsp_range[:start][:line], character: lsp_range[:start][:character] }
+                end_position = { line: lsp_range[:end][:line], character: lsp_range[:end][:character] }
                 { start: start_position, end: end_position }
               end
 
@@ -99,6 +102,36 @@ module Steep
 
       def format_hover(content)
         case content
+        when Services::HoverContent::TypeAliasContent
+          comment = content.decl.comment&.string || ''
+
+          <<-MD
+#{comment}
+
+```rbs
+#{retrieve_decl_information(content.decl)}
+```
+          MD
+        when Services::HoverContent::InterfaceContent
+          comment = content.decl.comment&.string || ''
+
+          <<-MD
+#{comment}
+
+```rbs
+#{retrieve_decl_information(content.decl)}
+```
+          MD
+        when Services::HoverContent::ClassContent
+          comment = content.decl.comment&.string || ''
+
+          <<-MD
+#{comment}
+
+```rbs
+#{retrieve_decl_information(content.decl)}
+```
+          MD
         when Services::HoverContent::VariableContent
           "`#{content.name}`: `#{content.type.to_s}`"
         when Services::HoverContent::MethodCallContent
@@ -151,32 +184,207 @@ HOVER
         Steep.logger.tagged("#response_to_completion") do
           Steep.measure "Generating response" do
             Steep.logger.info "path: #{job.path}, line: #{job.line}, column: #{job.column}, trigger: #{job.trigger}"
+            case
+            when target = project.target_for_source_path(job.path)
+              file = service.source_files[job.path] or return
+              subtyping = service.signature_services[target.name].current_subtyping or return
+
+              provider = Services::CompletionProvider.new(source_text: file.content, path: job.path, subtyping: subtyping)
+              items = begin
+                        provider.run(line: job.line, column: job.column)
+                      rescue Parser::SyntaxError
+                        []
+                      end
+
+              completion_items = items.map do |item|
+                format_completion_item(item)
+              end
+
+              Steep.logger.debug "items = #{completion_items.inspect}"
+
+              LSP::Interface::CompletionList.new(
+                is_incomplete: false,
+                items: completion_items
+              )
+            when (_, targets = project.targets_for_path(job.path))
+              target = targets[0] or return
+              sig_service = service.signature_services[target.name]
+              relative_path = job.path
+              buffer = RBS::Buffer.new(name: relative_path, content: sig_service.files[relative_path].content)
+              pos = buffer.loc_to_pos([job.line, job.column])
+              prefix = buffer.content[0...pos].reverse[/\A[\w\d]*/].reverse
+
+              case sig_service.status
+              when Steep::Services::SignatureService::SyntaxErrorStatus, Steep::Services::SignatureService::AncestorErrorStatus
+                return
+              end
+
+              decls = sig_service.files[relative_path].decls
+              locator = RBS::Locator.new(decls: decls)
+
+              hd, tail = locator.find2(line: job.line, column: job.column)
+
+              namespace = []
+              tail.each do |t|
+                case t
+                when RBS::AST::Declarations::Module, RBS::AST::Declarations::Class
+                  namespace << t.name.to_namespace
+                end
+              end
+              context = []
 
-            target = project.target_for_source_path(job.path) or return
-            file = service.source_files[job.path] or return
-            subtyping = service.signature_services[target.name].current_subtyping or return
+              namespace.each do |ns|
+                context.map! { |n| ns + n }
+                context << ns
+              end
+
+              context.map!(&:absolute!)
+
+              class_items = sig_service.latest_env.class_decls.keys.map { |type_name|
+                format_completion_item_for_rbs(sig_service, type_name, context, job, prefix)
+              }.compact
+
+              alias_items = sig_service.latest_env.alias_decls.keys.map { |type_name|
+                format_completion_item_for_rbs(sig_service, type_name, context, job, prefix)
+              }.compact
+
+              interface_items = sig_service.latest_env.interface_decls.keys.map {|type_name|
+                format_completion_item_for_rbs(sig_service, type_name, context, job, prefix)
+              }.compact
 
-            provider = Services::CompletionProvider.new(source_text: file.content, path: job.path, subtyping: subtyping)
-            items = begin
-                      provider.run(line: job.line, column: job.column)
-                    rescue Parser::SyntaxError
-                      []
-                    end
+              completion_items = class_items + alias_items + interface_items
 
-            completion_items = items.map do |item|
-              format_completion_item(item)
+              LSP::Interface::CompletionList.new(
+                is_incomplete: false,
+                items: completion_items
+              )
             end
+          end
+        end
+      end
+
+      def format_completion_item_for_rbs(sig_service, type_name, context, job, prefix)
+        range = LanguageServer::Protocol::Interface::Range.new(
+          start: LanguageServer::Protocol::Interface::Position.new(
+            line: job.line - 1,
+            character: job.column - prefix.size
+          ),
+          end: LanguageServer::Protocol::Interface::Position.new(
+            line: job.line - 1,
+            character: job.column - prefix.size
+          )
+        )
 
-            Steep.logger.debug "items = #{completion_items.inspect}"
+        name = relative_name_in_context(type_name, context).to_s
 
-            LSP::Interface::CompletionList.new(
-              is_incomplete: false,
-              items: completion_items
-            )
+        return unless name.start_with?(prefix)
+
+        case type_name.kind
+        when :class
+          class_decl = sig_service.latest_env.class_decls[type_name]&.decls[0]&.decl or raise
+
+          LanguageServer::Protocol::Interface::CompletionItem.new(
+            label: "#{name}",
+            documentation:  format_comment(class_decl.comment),
+            text_edit: LanguageServer::Protocol::Interface::TextEdit.new(
+              range: range,
+              new_text: name
+            ),
+            kind: LSP::Constant::CompletionItemKind::CLASS,
+            insert_text_format: LSP::Constant::InsertTextFormat::SNIPPET
+
+          )
+        when :alias
+          alias_decl = sig_service.latest_env.alias_decls[type_name]&.decl or raise
+          LanguageServer::Protocol::Interface::CompletionItem.new(
+            label: "#{name}",
+            text_edit: LanguageServer::Protocol::Interface::TextEdit.new(
+              range: range,
+              new_text: name
+            ),
+            documentation: format_comment(alias_decl.comment),
+            # https://github.com/microsoft/vscode-languageserver-node/blob/6d78fc4d25719b231aba64a721a606f58b9e0a5f/client/src/common/client.ts#L624-L650
+            kind: LSP::Constant::CompletionItemKind::FIELD,
+            insert_text_format: LSP::Constant::InsertTextFormat::SNIPPET
+          )
+        when :interface
+          interface_decl = sig_service.latest_env.interface_decls[type_name]&.decl or raise
+
+          LanguageServer::Protocol::Interface::CompletionItem.new(
+            label: "#{name}",
+            text_edit: LanguageServer::Protocol::Interface::TextEdit.new(
+              range: range,
+              new_text: name
+            ),
+            documentation: format_comment(interface_decl.comment),
+            kind: LanguageServer::Protocol::Constant::CompletionItemKind::INTERFACE,
+            insert_text_format: LanguageServer::Protocol::Constant::InsertTextFormat::SNIPPET
+          )
+        end
+      end
+
+      def format_comment(comment)
+        if comment
+          LSP::Interface::MarkupContent.new(
+            kind: LSP::Constant::MarkupKind::MARKDOWN,
+            value: comment.string
+          )
+        end
+      end
+
+      def name_and_params(name, params)
+        if params.empty?
+          "#{name}"
+        else
+          ps = params.each.map do |param|
+            s = ""
+            if param.skip_validation
+              s << "unchecked "
+            end
+            case param.variance
+            when :invariant
+              # nop
+            when :covariant
+              s << "out "
+            when :contravariant
+              s << "in "
+            end
+            s + param.name.to_s
+          end
+
+          "#{name}[#{ps.join(", ")}]"
+        end
+      end
+
+      def name_and_args(name, args)
+        if name && args
+          if args.empty?
+            "#{name}"
+          else
+            "#{name}[#{args.join(", ")}]"
           end
         end
       end
 
+      def retrieve_decl_information(decl)
+        case decl
+        when RBS::AST::Declarations::Class
+          super_class = if super_class = decl.super_class
+                          " < #{name_and_args(super_class.name, super_class.args)}"
+                        end
+          "class #{name_and_params(decl.name, decl.type_params)}#{super_class}"
+        when RBS::AST::Declarations::Module
+          self_type = unless decl.self_types.empty?
+                        " : #{decl.self_types.join(", ")}"
+                      end
+          "module #{name_and_params(decl.name, decl.type_params)}#{self_type}"
+        when RBS::AST::Declarations::Alias
+          "type #{decl.name} = #{decl.type}"
+        when RBS::AST::Declarations::Interface
+          "interface #{name_and_params(decl.name, decl.type_params)}"
+        end
+    end
+
       def format_completion_item(item)
         range = LanguageServer::Protocol::Interface::Range.new(
           start: LanguageServer::Protocol::Interface::Position.new(
@@ -297,6 +505,17 @@ HOVER
 
         params.join(", ")
       end
+
+      def relative_name_in_context(type_name, context)
+        context.each do |namespace|
+          if (type_name.to_s == namespace.to_type_name.to_s || type_name.namespace.to_s == "::")
+            return RBS::TypeName.new(namespace: RBS::Namespace.empty, name: type_name.name)
+          elsif type_name.to_s.start_with?(namespace.to_s)
+            return TypeName(type_name.to_s.sub(namespace.to_type_name.to_s, '')).relative!
+          end
+        end
+        type_name
+      end
     end
   end
 end

data/lib/steep/server/master.rb

@@ -499,7 +499,11 @@ module Steep
                         trigger_characters: [".", "@"],
                         work_done_progress: true
                       ),
-                      workspace_symbol_provider: true
+                      workspace_symbol_provider: true,
+                      definition_provider: true,
+                      declaration_provider: false,
+                      implementation_provider: true,
+                      type_definition_provider: false
                     )
                   )
                 }
@@ -509,8 +513,9 @@ module Steep
 
         when "initialized"
           if typecheck_automatically
-            request = controller.make_request(include_unchanged: true)
-            start_type_check(request, last_request: nil, start_progress: request.total > 10)
+            if request = controller.make_request(include_unchanged: true)
+              start_type_check(request, last_request: nil, start_progress: request.total > 10)
+            end
           end
 
         when "textDocument/didChange"
@@ -520,12 +525,13 @@ module Steep
 
         when "textDocument/didSave"
           if typecheck_automatically
-            request = controller.make_request(last_request: current_type_check_request)
-            start_type_check(
-              request,
-              last_request: current_type_check_request,
-              start_progress: request.total > 10
-            )
+            if request = controller.make_request(last_request: current_type_check_request)
+              start_type_check(
+                request,
+                last_request: current_type_check_request,
+                start_progress: request.total > 10
+              )
+            end
           end
 
         when "textDocument/didOpen"
@@ -582,17 +588,37 @@ module Steep
             end
           end
 
+        when "textDocument/definition", "textDocument/implementation"
+          result_controller << group_request do |group|
+            typecheck_workers.each do |worker|
+              group << send_request(method: message[:method], params: message[:params], worker: worker)
+            end
+
+            group.on_completion do |handlers|
+              links = handlers.flat_map(&:result)
+              job_queue << SendMessageJob.to_client(
+                message: {
+                  id: message[:id],
+                  result: links
+                }
+              )
+            end
+          end
+
         when "$/typecheck"
           request = controller.make_request(
             guid: message[:params][:guid],
             last_request: current_type_check_request,
             include_unchanged: true
           )
-          start_type_check(
-            request,
-            last_request: current_type_check_request,
-            start_progress: true
-          )
+
+          if request
+            start_type_check(
+              request,
+              last_request: current_type_check_request,
+              start_progress: true
+            )
+          end
 
         when "shutdown"
           result_controller << group_request do |group|
@@ -637,11 +663,6 @@ module Steep
 
       def start_type_check(request, last_request:, start_progress:)
         Steep.logger.tagged "#start_type_check(#{request.guid}, #{last_request&.guid}" do
-          unless request
-            Steep.logger.info "Skip start type checking"
-            return
-          end
-
           if last_request
             Steep.logger.info "Cancelling last request"
 

data/lib/steep/server/type_check_worker.rb

@@ -11,6 +11,31 @@ module Steep
       TypeCheckCodeJob = Struct.new(:guid, :path, keyword_init: true)
       ValidateAppSignatureJob = Struct.new(:guid, :path, keyword_init: true)
       ValidateLibrarySignatureJob = Struct.new(:guid, :path, keyword_init: true)
+      GotoJob = Struct.new(:id, :kind, :params, keyword_init: true) do
+        def self.implementation(id:, params:)
+          new(
+            kind: :implementation,
+            id: id,
+            params: params
+          )
+        end
+
+        def self.definition(id:, params:)
+          new(
+            kind: :definition,
+            id: id,
+            params: params
+          )
+        end
+
+        def implementation?
+          kind == :implementation
+        end
+
+        def definition?
+          kind == :definition
+        end
+      end
 
       include ChangeBuffer
 
@@ -44,6 +69,10 @@ module Steep
         when "$/typecheck/start"
           params = request[:params]
           enqueue_typecheck_jobs(params)
+        when "textDocument/definition"
+          queue << GotoJob.definition(id: request[:id], params: request[:params])
+        when "textDocument/implementation"
+          queue << GotoJob.implementation(id: request[:id], params: request[:params])
         end
       end
 
@@ -179,6 +208,11 @@ module Steep
             id: job.id,
             result: stats_result().map(&:as_json)
           )
+        when GotoJob
+          writer.write(
+            id: job.id,
+            result: goto(job)
+          )
         end
       end
 
@@ -231,6 +265,40 @@ module Steep
           end
         end
       end
+
+      def goto(job)
+        path = Pathname(URI.parse(job.params[:textDocument][:uri]).path)
+        line = job.params[:position][:line] + 1
+        column = job.params[:position][:character]
+
+        goto_service = Services::GotoService.new(type_check: service)
+        locations =
+          case
+          when job.definition?
+            goto_service.definition(path: path, line: line, column: column)
+          when job.implementation?
+            goto_service.implementation(path: path, line: line, column: column)
+          else
+            raise
+          end
+
+        locations.map do |loc|
+          path =
+            case loc
+            when RBS::Location
+              Pathname(loc.buffer.name)
+            else
+              Pathname(loc.source_buffer.name)
+            end
+
+          path = project.absolute_path(path)
+
+          {
+            uri: URI.parse(path.to_s).tap {|uri| uri.scheme = "file" }.to_s,
+            range: loc.as_lsp_range
+          }
+        end
+      end
     end
   end
 end