solargraph 0.58.3 → 0.59.0.dev.1

data/lib/solargraph/language_server/message/extended/document_gems.rb

@@ -1,32 +1,32 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module Extended
-        # Update YARD documentation for installed gems. If the `rebuild`
-        # parameter is true, rebuild existing yardocs.
-        #
-        class DocumentGems < Base
-          def process
-            cmd = [host.command_path, 'gems']
-            cmd.push '--rebuild' if params['rebuild']
-            o, s = Open3.capture2(*cmd)
-            if s != 0
-              host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
-              set_result({
-                status: 'err'
-              })
-            else
-              set_result({
-                status: 'ok'
-              })
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update YARD documentation for installed gems. If the `rebuild`
+        # parameter is true, rebuild existing yardocs.
+        #
+        class DocumentGems < Base
+          def process
+            cmd = [host.command_path, 'gems']
+            cmd.push '--rebuild' if params['rebuild']
+            o, s = Open3.capture2(*cmd)
+            if s != 0
+              host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
+              set_result({
+                status: 'err'
+              })
+            else
+              set_result({
+                status: 'ok'
+              })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/download_core.rb

@@ -1,19 +1,19 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module Extended
-        # Update core Ruby documentation.
-        #
-        class DownloadCore < Base
-          def process
-            host.show_message "Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation", LanguageServer::MessageTypes::INFO
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update core Ruby documentation.
+        #
+        class DownloadCore < Base
+          def process
+            host.show_message "Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation", LanguageServer::MessageTypes::INFO
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/search.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module Extended
-        class Search < Base
-          def process
-            results = host.search(params['query'])
-            page = Solargraph::Page.new(host.options['viewsPath'])
-            content = page.render('search', layout: true, locals: {query: params['query'], results: results})
-            set_result(
-              content: content
-            )
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        class Search < Base
+          def process
+            results = host.search(params['query'])
+            page = Solargraph::Page.new(host.options['viewsPath'])
+            content = page.render('search', layout: true, locals: {query: params['query'], results: results})
+            set_result(
+              content: content
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/initialize.rb

@@ -1,191 +1,191 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      class Initialize < Base
-        def process
-          host.configure params['initializationOptions']
-          host.client_capabilities = params['capabilities']
-          if support_workspace_folders?
-            host.prepare_folders params['workspaceFolders']
-          elsif params['rootUri']
-            host.prepare UriHelpers.uri_to_file(params['rootUri'])
-          else
-            host.prepare params['rootPath']
-          end
-          result = {
-            capabilities: {
-              textDocumentSync: 2, # @todo What should this be?
-              workspace: {
-                workspaceFolders: {
-                  supported: true,
-                  changeNotifications: true
-                }
-              }
-            }
-          }
-          # FIXME: lsp default is utf-16, may have different position
-          result[:capabilities][:positionEncoding] = "utf-32" if params.dig("capabilities", "general", "positionEncodings")&.include?("utf-32")
-          result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
-          result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
-          # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')
-          result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
-          result[:capabilities].merge! static_document_formatting unless dynamic_registration_for?('textDocument', 'formatting')
-          result[:capabilities].merge! static_document_symbols unless dynamic_registration_for?('textDocument', 'documentSymbol')
-          result[:capabilities].merge! static_definitions unless dynamic_registration_for?('textDocument', 'definition')
-          result[:capabilities].merge! static_type_definitions unless dynamic_registration_for?('textDocument', 'typeDefinition')
-          result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
-          result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
-          result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
-          result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
-          result[:capabilities].merge! static_highlights unless dynamic_registration_for?('textDocument', 'documentHighlight')
-          # @todo Temporarily disabled
-          # result[:capabilities].merge! static_code_action unless dynamic_registration_for?('textDocument', 'codeAction')
-          set_result result
-        end
-
-        private
-
-        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
-        # @sg-ignore
-        def support_workspace_folders?
-          params['capabilities'] &&
-            params['capabilities']['workspace'] &&
-            params['capabilities']['workspace']['workspaceFolders'] &&
-            params['workspaceFolders']
-        end
-
-        # @return [Hash{Symbol => undefined}]
-        def static_completion
-          return {} unless host.options['completion']
-          {
-            completionProvider: {
-              resolveProvider: true,
-              triggerCharacters: ['.', ':', '@']
-            }
-          }
-        end
-
-        # @return [Hash{Symbol => BasicObject}]
-        def static_code_action
-          {
-            codeActionProvider: true,
-            codeActionKinds: ["quickfix"]
-          }
-        end
-
-        # @return [Hash{Symbol => BasicObject}]
-        def static_signature_help
-          {
-            signatureHelpProvider: {
-              triggerCharacters: ['(', ',']
-            }
-          }
-        end
-
-        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
-        def static_on_type_formatting
-          {
-            documentOnTypeFormattingProvider: {
-              firstTriggerCharacter: '{',
-              moreTriggerCharacter: ['(']
-            }
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_hover
-          return {} unless host.options['hover']
-          {
-            hoverProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_document_formatting
-          return {} unless host.options['formatting']
-          {
-            documentFormattingProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_document_symbols
-          return {} unless host.options['symbols']
-          {
-            documentSymbolProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_workspace_symbols
-          {
-            workspaceSymbolProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_definitions
-          return {} unless host.options['definitions']
-          {
-            definitionProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_type_definitions
-          return {} unless host.options['typeDefinitions']
-          {
-            typeDefinitionProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
-        def static_rename
-          {
-            renameProvider: {prepareProvider: true}
-          }
-        end
-
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_references
-          return {} unless host.options['references']
-          {
-            referencesProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_folding_range
-          return {} unless host.options['folding']
-          {
-            foldingRangeProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_highlights
-          {
-            documentHighlightProvider: true
-          }
-        end
-
-        # @param section [String]
-        # @param capability [String]
-        # @todo Need support for RBS' boolish "type", which doesn't
-        #   enforce strict true/false-ness
-        # @sg-ignore
-        def dynamic_registration_for? section, capability
-          result = (params['capabilities'] &&
-            params['capabilities'][section] &&
-            params['capabilities'][section][capability] &&
-            params['capabilities'][section][capability]['dynamicRegistration'])
-          host.allow_registration("#{section}/#{capability}") if result
-          result
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Initialize < Base
+        def process
+          host.configure params['initializationOptions']
+          host.client_capabilities = params['capabilities']
+          if support_workspace_folders?
+            host.prepare_folders params['workspaceFolders']
+          elsif params['rootUri']
+            host.prepare UriHelpers.uri_to_file(params['rootUri'])
+          else
+            host.prepare params['rootPath']
+          end
+          result = {
+            capabilities: {
+              textDocumentSync: 2, # @todo What should this be?
+              workspace: {
+                workspaceFolders: {
+                  supported: true,
+                  changeNotifications: true
+                }
+              }
+            }
+          }
+          # FIXME: lsp default is utf-16, may have different position
+          result[:capabilities][:positionEncoding] = "utf-32" if params.dig("capabilities", "general", "positionEncodings")&.include?("utf-32")
+          result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
+          result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
+          # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')
+          result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
+          result[:capabilities].merge! static_document_formatting unless dynamic_registration_for?('textDocument', 'formatting')
+          result[:capabilities].merge! static_document_symbols unless dynamic_registration_for?('textDocument', 'documentSymbol')
+          result[:capabilities].merge! static_definitions unless dynamic_registration_for?('textDocument', 'definition')
+          result[:capabilities].merge! static_type_definitions unless dynamic_registration_for?('textDocument', 'typeDefinition')
+          result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
+          result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
+          result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
+          result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
+          result[:capabilities].merge! static_highlights unless dynamic_registration_for?('textDocument', 'documentHighlight')
+          # @todo Temporarily disabled
+          # result[:capabilities].merge! static_code_action unless dynamic_registration_for?('textDocument', 'codeAction')
+          set_result result
+        end
+
+        private
+
+        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
+        # @sg-ignore
+        def support_workspace_folders?
+          params['capabilities'] &&
+            params['capabilities']['workspace'] &&
+            params['capabilities']['workspace']['workspaceFolders'] &&
+            params['workspaceFolders']
+        end
+
+        # @return [Hash{Symbol => undefined}]
+        def static_completion
+          return {} unless host.options['completion']
+          {
+            completionProvider: {
+              resolveProvider: true,
+              triggerCharacters: ['.', ':', '@']
+            }
+          }
+        end
+
+        # @return [Hash{Symbol => BasicObject}]
+        def static_code_action
+          {
+            codeActionProvider: true,
+            codeActionKinds: ["quickfix"]
+          }
+        end
+
+        # @return [Hash{Symbol => BasicObject}]
+        def static_signature_help
+          {
+            signatureHelpProvider: {
+              triggerCharacters: ['(', ',']
+            }
+          }
+        end
+
+        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
+        def static_on_type_formatting
+          {
+            documentOnTypeFormattingProvider: {
+              firstTriggerCharacter: '{',
+              moreTriggerCharacter: ['(']
+            }
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_hover
+          return {} unless host.options['hover']
+          {
+            hoverProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_document_formatting
+          return {} unless host.options['formatting']
+          {
+            documentFormattingProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_document_symbols
+          return {} unless host.options['symbols']
+          {
+            documentSymbolProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_workspace_symbols
+          {
+            workspaceSymbolProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_definitions
+          return {} unless host.options['definitions']
+          {
+            definitionProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_type_definitions
+          return {} unless host.options['typeDefinitions']
+          {
+            typeDefinitionProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
+        def static_rename
+          {
+            renameProvider: {prepareProvider: true}
+          }
+        end
+
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_references
+          return {} unless host.options['references']
+          {
+            referencesProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_folding_range
+          return {} unless host.options['folding']
+          {
+            foldingRangeProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_highlights
+          {
+            documentHighlightProvider: true
+          }
+        end
+
+        # @param section [String]
+        # @param capability [String]
+        # @todo Need support for RBS' boolish "type", which doesn't
+        #   enforce strict true/false-ness
+        # @sg-ignore
+        def dynamic_registration_for? section, capability
+          result = (params['capabilities'] &&
+            params['capabilities'][section] &&
+            params['capabilities'][section][capability] &&
+            params['capabilities'][section][capability]['dynamicRegistration'])
+          host.allow_registration("#{section}/#{capability}") if result
+          result
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/completion.rb

@@ -15,6 +15,7 @@ module Solargraph
               items = []
               last_context = nil
               idx = -1
+              # @sg-ignore Need to add nil check here
               completion.pins.each do |pin|
                 idx += 1 if last_context != pin.context
                 items.push pin.completion_item.merge({
@@ -37,6 +38,7 @@ module Solargraph
             end
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             Logging.logger.warn e.backtrace.join("\n")
             set_result empty_result
           end

data/lib/solargraph/language_server/message/text_document/definition.rb

@@ -13,7 +13,9 @@ module Solargraph::LanguageServer::Message::TextDocument
     # @return [Array<Hash>, nil]
     def code_location
       suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
+      # @sg-ignore Need to add nil check here
       return nil if suggestions.empty?
+      # @sg-ignore Need to add nil check here
       suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
         {
           uri: file_to_uri(pin.best_location.filename),

data/lib/solargraph/language_server/message/text_document/document_highlight.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::TextDocument
-  class DocumentHighlight < Base
-    def process
-      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'], strip: true, only: true)
-      result = locs.map do |loc|
-        {
-          range: loc.range.to_hash,
-          kind: 1
-        }
-      end
-      set_result result
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class DocumentHighlight < Base
+    def process
+      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'], strip: true, only: true)
+      result = locs.map do |loc|
+        {
+          range: loc.range.to_hash,
+          kind: 1
+        }
+      end
+      set_result result
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/document_symbol.rb

@@ -13,7 +13,9 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {
+          # @sg-ignore Need to add nil check here
           uri: file_to_uri(pin.best_location.filename),
+          # @sg-ignore Need to add nil check here
           range: pin.best_location.range.to_hash
         },
         deprecated: pin.deprecated?

data/lib/solargraph/language_server/message/text_document/formatting.rb

@@ -98,9 +98,11 @@ module Solargraph
           end
 
           # @param value [Array, String]
+          #
           # @return [String, nil]
           def cop_list(value)
             # @type [String]
+            # @sg-ignore Translate to something flow sensitive typing understands
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)
             value

data/lib/solargraph/language_server/message/text_document/hover.rb

@@ -11,6 +11,7 @@ module Solargraph
             contents = []
             suggestions = host.definitions_at(params['textDocument']['uri'], line, col)
             last_link = nil
+            # @sg-ignore Need to add nil check here
             suggestions.each do |pin|
               parts = []
               this_link = host.options['enablePages'] ? pin.link_documentation : pin.text_documentation
@@ -31,6 +32,7 @@ module Solargraph
             )
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             Logging.logger.warn e.backtrace.join("\n")
             set_result nil
           end

data/lib/solargraph/language_server/message/text_document/prepare_rename.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::TextDocument
-  class PrepareRename < Base
-    def process
-      line = params['position']['line']
-      col = params['position']['character']
-      set_result host.sources.find(params['textDocument']['uri']).cursor_at(Solargraph::Position.new(line, col)).range.to_hash
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class PrepareRename < Base
+    def process
+      line = params['position']['line']
+      col = params['position']['character']
+      set_result host.sources.find(params['textDocument']['uri']).cursor_at(Solargraph::Position.new(line, col)).range.to_hash
+    end
+  end
+end