steep 0.50.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff552f6d8f112693dc9969f20d851ddbc6d7d2f16cebd45f802a5d703618b58
-  data.tar.gz: 723464fe34c81c3e83b66338dfc6fd3e7c3da2aaf30c1fc48116c7de794ca961
+  metadata.gz: 502d495f9b623c5d90a041a1e0bb7854be76251a8ac0f3567c1c91911eb641ee
+  data.tar.gz: 7845d6d26f38ceae87407d507f3f67b8d35bae18ecdd5f4ee9fdb841d434a4ad
 SHA512:
-  metadata.gz: bf9f83791cfb636c65a26f404fb164fa7fc3906376e36a79a1ca4ae7eeab8020e23c5b9ce5e649a38ed79080d0aa2c00fe53a5cce8a1c76c259237f38880bbf2
-  data.tar.gz: 25bd9e11db283acdfc957682860e674d544b82be1b5a68bc87ca96888907966b721301c937cdaa3e06bf0226ec82fa8c78eacfaf4987637a601f75ca8d8e950c
+  metadata.gz: e2e61987da5ef5d78381affeb2f4fbb8b84dd2a6fede0baa60c68f54a3464e3cb7eea0e2822f22a66d62f1de3b9f8b223cd6399dceb927397a3dab0bed3fea5d
+  data.tar.gz: ee91ba6b1a4d8f35ec1fbc157efd2fb54f27b11e398af09a7ef3d4f403ae0ae2fab3258404316c6ded646f688b61ff38b47a514fec83cd9fe1b4fcf136fdc441

data/CHANGELOG.md

@@ -2,7 +2,13 @@
 
 ## master
 
-# 0.50.0 (2022-03-22)
+## 0.51.0 (2022-04-01)
+
+* Completion for constant ([\#524](https://github.com/soutaro/steep/pull/524))
+* Better hover/completion message ([\#525](https://github.com/soutaro/steep/pull/525))
+* Show available commands when using `--help` ([\#523](https://github.com/soutaro/steep/pull/523))
+
+## 0.50.0 (2022-03-22)
 
 * CLI option for override steep command at spawn worker ([\#511](https://github.com/soutaro/steep/pull/511))
 * LSP related improvements for Sublime LSP ([\#513](https://github.com/soutaro/steep/pull/513))

data/Gemfile

@@ -12,3 +12,4 @@ gem "minitest-hooks"
 group :stackprof, optional: true do
   gem "stackprof"
 end
+gem 'minitest-slow_test'

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    steep (0.50.0)
+    steep (0.51.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 3.0)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.2.0)
+      rbs (>= 2.3.0)
       terminal-table (>= 2, < 4)
 
 PATH
@@ -30,7 +30,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     ffi (1.15.5)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
@@ -41,7 +41,9 @@ GEM
     minitest (5.15.0)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    parallel (1.22.0)
+    minitest-slow_test (0.2.0)
+      minitest (>= 5.0)
+    parallel (1.22.1)
     parser (3.1.1.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
@@ -49,7 +51,7 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.2.2)
+    rbs (2.3.0)
     stackprof (0.2.19)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -63,6 +65,7 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 5.15)
   minitest-hooks
+  minitest-slow_test
   rake
   stackprof
   steep!

data/lib/steep/ast/annotation/collection.rb

@@ -4,7 +4,7 @@ module Steep
       class Collection
         attr_reader :annotations
         attr_reader :factory
-        attr_reader :current_module
+        attr_reader :context
 
         attr_reader :var_type_annotations
         attr_reader :const_type_annotations
@@ -19,10 +19,10 @@ module Steep
         attr_reader :dynamic_annotations
         attr_reader :break_type_annotation
 
-        def initialize(annotations:, factory:, current_module:)
+        def initialize(annotations:, factory:, context:)
           @annotations = annotations
           @factory = factory
-          @current_module = current_module
+          @context = context
 
           @var_type_annotations = {}
           @method_type_annotations = {}
@@ -64,7 +64,7 @@ module Steep
 
         def absolute_type(type)
           if type
-            factory.absolute_type(type, namespace: current_module)
+            factory.absolute_type(type, context: context)
           end
         end
 
@@ -140,7 +140,7 @@ module Steep
         end
 
         def merge_block_annotations(annotations)
-          if annotations.current_module != current_module || annotations.factory != factory
+          if annotations.context != context || annotations.factory != factory
             raise "Cannot merge another annotation: self=#{self}, other=#{annotations}"
           end
 
@@ -148,9 +148,11 @@ module Steep
             annotation.is_a?(BlockType) || annotation.is_a?(BreakType)
           end
 
-          self.class.new(annotations: retained_annotations + annotations.annotations,
-                         factory: factory,
-                         current_module: current_module)
+          self.class.new(
+            annotations: retained_annotations + annotations.annotations,
+            factory: factory,
+            context: context
+          )
         end
 
         def any?(&block)

data/lib/steep/ast/types/factory.rb

@@ -18,7 +18,7 @@ module Steep
         end
 
         def type_name_resolver
-          @type_name_resolver ||= RBS::TypeNameResolver.from_env(definition_builder.env)
+          @type_name_resolver ||= RBS::Resolver::TypeNameResolver.new(definition_builder.env)
         end
 
         def type_opt(type)
@@ -810,15 +810,15 @@ module Steep
           @env ||= definition_builder.env
         end
 
-        def absolute_type(type, namespace:)
+        def absolute_type(type, context:)
           absolute_type = type_1(type).map_type_name do |name|
-            absolute_type_name(name, namespace: namespace) || name.absolute!
+            absolute_type_name(name, context: context) || name.absolute!
           end
           type(absolute_type)
         end
 
-        def absolute_type_name(type_name, namespace:)
-          type_name_resolver.resolve(type_name, context: namespace.ascend)
+        def absolute_type_name(type_name, context:)
+          type_name_resolver.resolve(type_name, context: context)
         end
 
         def instance_type(type_name, args: nil, location: nil)

data/lib/steep/cli.rb

@@ -23,6 +23,14 @@ module Steep
 
     def process_global_options
       OptionParser.new do |opts|
+        opts.banner = <<~USAGE
+          Usage: steep [options]
+
+          available commands: #{CLI.available_commands.join(', ')}
+
+          Options:
+        USAGE
+
         opts.on("--version") do
           process_version
           exit 0

data/lib/steep/diagnostic/deprecated/unknown_constant_assigned.rb

@@ -0,0 +1,28 @@
+Steep.logger.error "Diagnostic `Ruby::UnknownConstantAssigned` is deprecated. Use `Ruby::UnknownConstant` instead."
+
+module Steep
+  module Diagnostic
+    module Ruby
+      class UnknownConstantAssigned < Base
+        attr_reader :context
+        attr_reader :name
+
+        def initialize(node:, context:, name:)
+          const = node.children[0]
+          loc = if const
+                  const.loc.expression.join(node.loc.name)
+                else
+                  node.loc.name
+                end
+          super(node: node, location: loc)
+          @context = context
+          @name = name
+        end
+
+        def header_line
+          "Cannot find the declaration of constant `#{name}`"
+        end
+      end
+    end
+  end
+end

data/lib/steep/diagnostic/ruby.rb

@@ -551,27 +551,33 @@ module Steep
         end
       end
 
-      class UnknownConstantAssigned < Base
-        attr_reader :context
+      class UnknownConstant < Base
         attr_reader :name
+        attr_reader :kind
 
-        def initialize(node:, context:, name:)
-          const = node.children[0]
-          loc = if const
-                  const.loc.expression.join(node.loc.name)
-                else
-                  node.loc.name
-                end
-          super(node: node, location: loc)
-          @context = context
+        def initialize(node:, name:)
+          super(node: node, location: node.loc.name)
           @name = name
+          @kind = :constant
+        end
+
+        def class!
+          @kind = :class
+          self
+        end
+
+        def module!
+          @kind = :module
+          self
         end
 
         def header_line
-          "Cannot find the declaration of constant `#{name}`"
+          "Cannot find the declaration of #{kind}: `#{name}`"
         end
       end
 
+      autoload :UnknownConstantAssigned, "steep/diagnostic/deprecated/unknown_constant_assigned"
+
       class FallbackAny < Base
         def initialize(node:)
           super(node: node)
@@ -744,7 +750,7 @@ module Steep
             ImplicitBreakValueMismatch => :warning,
             FallbackAny => :information,
             ElseOnExhaustiveCase => :warning,
-            UnknownConstantAssigned => :warning,
+            UnknownConstant => :warning,
             MethodDefinitionMissing => :information
           }
         ).freeze
@@ -757,7 +763,7 @@ module Steep
             ImplicitBreakValueMismatch => nil,
             FallbackAny => nil,
             ElseOnExhaustiveCase => nil,
-            UnknownConstantAssigned => nil,
+            UnknownConstant => nil,
             MethodDefinitionMissing => nil
           }
         ).freeze
@@ -770,7 +776,7 @@ module Steep
             ImplicitBreakValueMismatch => nil,
             FallbackAny => nil,
             ElseOnExhaustiveCase => nil,
-            UnknownConstantAssigned => nil,
+            UnknownConstant => nil,
             MethodDefinitionMissing => nil,
             UnexpectedJump => nil
           }

data/lib/steep/index/source_index.rb

@@ -16,7 +16,7 @@ module Steep
 
         def add_definition(node)
           case node.type
-          when :casgn, :class, :module
+          when :casgn, :const
             @definitions << node
           else
             raise "Unexpected constant definition: #{node.type}"
@@ -145,6 +145,23 @@ module Steep
           raise
         end
       end
+
+      def reference(constant_node: nil)
+        case
+        when constant_node
+          constant_index.each do |name, entry|
+            if entry.references.include?(constant_node)
+              return name
+            end
+
+            if entry.definitions.include?(constant_node)
+              return name
+            end
+          end
+
+          nil
+        end
+      end
     end
   end
 end

data/lib/steep/module_helper.rb

@@ -1,12 +1,9 @@
 module Steep
   module ModuleHelper
-    def module_name_from_node(node)
-      case node.type
-      when :const, :casgn
-        namespace = namespace_from_node(node.children[0]) or return
-        name = node.children[1]
-        RBS::TypeName.new(name: name, namespace: namespace)
-      end
+    def module_name_from_node(parent_node, constant_name)
+      namespace = namespace_from_node(parent_node) or return
+      name = constant_name
+      RBS::TypeName.new(name: name, namespace: namespace)
     end
 
     def namespace_from_node(node)

data/lib/steep/server/interaction_worker.rb

@@ -175,6 +175,21 @@ HOVER
           end
 
           string
+        when Services::HoverContent::ConstantContent
+          ss = []
+          if content.class_or_module?
+            ss << ["```rbs", retrieve_decl_information(content.decl.primary.decl), "```"].join("\n")
+          end
+
+          if content.constant?
+            ss << ["```rbs", "#{content.full_name}: #{content.type}", "```"].join("\n")
+          end
+
+          if s = content.comment_string
+            ss << s
+          end
+
+          ss.join("\n\n----\n\n")
         when Services::HoverContent::TypeContent
           "`#{content.type}`"
         end
@@ -327,7 +342,16 @@ HOVER
         if comment
           LSP::Interface::MarkupContent.new(
             kind: LSP::Constant::MarkupKind::MARKDOWN,
-            value: comment.string
+            value: comment.string.gsub(/<!--(?~-->)-->/, "")
+          )
+        end
+      end
+
+      def format_comments(comments)
+        unless comments.empty?
+          LSP::Interface::MarkupContent.new(
+            kind: LSP::Constant::MarkupKind::MARKDOWN,
+            value: comments.map(&:string).join("\n----\n").gsub(/<!--(?~-->)-->/, "")
           )
         end
       end
@@ -408,6 +432,25 @@ HOVER
               new_text: item.identifier
             )
           )
+        when Services::CompletionProvider::ConstantItem
+          case
+          when item.class? || item.module?
+            kind = LanguageServer::Protocol::Constant::CompletionItemKind::CLASS
+            detail = item.full_name.to_s
+          else
+            kind = LanguageServer::Protocol::Constant::CompletionItemKind::CONSTANT
+            detail = item.type.to_s
+          end
+          LanguageServer::Protocol::Interface::CompletionItem.new(
+            label: item.identifier,
+            kind: kind,
+            detail: detail,
+            documentation: format_comments(item.comments),
+            text_edit: LanguageServer::Protocol::Interface::TextEdit.new(
+              range: range,
+              new_text: item.identifier
+            )
+          )
         when Services::CompletionProvider::MethodNameItem
           method_type_snippet = method_type_to_snippet(item.method_type)
           LanguageServer::Protocol::Interface::CompletionItem.new(
@@ -418,7 +461,7 @@ HOVER
               new_text: "#{item.identifier}#{method_type_snippet}",
               range: range
             ),
-            documentation: item.comment&.string,
+            documentation: format_comment(item.comment),
             insert_text_format: LanguageServer::Protocol::Constant::InsertTextFormat::SNIPPET,
             sort_text: item.inherited? ? 'z' : 'a' # Ensure language server puts non-inherited methods before inherited methods
           )

data/lib/steep/server/master.rb

@@ -501,7 +501,7 @@ module Steep
                         partialResult: true
                       },
                       completion_provider: LSP::Interface::CompletionOptions.new(
-                        trigger_characters: [".", "@"],
+                        trigger_characters: [".", "@", ":"],
                         work_done_progress: true
                       ),
                       workspace_symbol_provider: true,

data/lib/steep/services/completion_provider.rb

@@ -10,6 +10,30 @@ module Steep
 
       InstanceVariableItem = Struct.new(:identifier, :range, :type, keyword_init: true)
       LocalVariableItem = Struct.new(:identifier, :range, :type, keyword_init: true)
+      ConstantItem = Struct.new(:env, :identifier, :range, :type, :full_name, keyword_init: true) do
+        def class?
+          if decl = env.class_decls[full_name]
+            decl.primary.decl.is_a?(RBS::AST::Declarations::Class)
+          end
+        end
+
+        def module?
+          if decl = env.class_decls[full_name]
+            decl.primary.decl.is_a?(RBS::AST::Declarations::Module)
+          end
+        end
+
+        def comments
+          case
+          when decl = env.class_decls[full_name]
+            decl.decls.filter_map {|d| d.decl.comment }
+          when comment = env.constant_decls[full_name]&.decl&.comment
+            [comment]
+          else
+            []
+          end
+        end
+      end
       MethodNameItem = Struct.new(:identifier, :range, :receiver_type, :method_type, :method_decls, keyword_init: true) do
         def comment
           case method_decls.size
@@ -61,6 +85,10 @@ module Steep
         end
       end
 
+      def env
+        subtyping.factory.env
+      end
+
       def run(line:, column:)
         source_text = self.source_text.dup
         index = index_for(source_text, line:line, column: column)
@@ -92,6 +120,15 @@ module Steep
             source_text[index-1] = " "
             type_check!(source_text, line: line, column: column)
             items_for_atmark(position: position)
+          when ":"
+            if source_text[index-2] == ":"
+              source_text[index-1] = " "
+              source_text[index-2] = " "
+              type_check!(source_text, line: line, column: column)
+              items_for_colon2(position: position)
+            else
+              []
+            end
           else
             []
           end
@@ -170,8 +207,25 @@ module Steep
                                          prefix: prefix,
                                          position: position,
                                          items: items)
+          constant_items_for_context(context, prefix: prefix, position: position, items: items)
 
-        when node.type == :send && at_end?(position, of: node.loc.dot)
+        when node.type == :const && node.children[0] && at_end?(position, of: node.loc)
+          # Foo::Ba ← (const)
+          parent_node = node.children[0]
+          parent_type = typing.type_of(node: parent_node)
+
+          if parent_type
+            prefix = node.children[1].to_s
+
+            method_items_for_receiver_type(parent_type,
+                                           include_private: false,
+                                           prefix: prefix,
+                                           position: position,
+                                           items: items)
+            constant_items_for_context(context, parent: parent_node, prefix: prefix, position: position, items: items)
+          end
+
+        when node.type == :send && at_end?(position, of: node.loc.dot) && node.loc.dot.source == "."
           # foo.← ba
           receiver_type = case (type = typing.type_of(node: node.children[0]))
                           when AST::Types::Self
@@ -186,6 +240,10 @@ module Steep
                                          position: position,
                                          items: items)
 
+        when node.type == :send && at_end?(position, of: node.loc.dot) && node.loc.dot.source == "::"
+          # foo::← ba
+          items.push(*items_for_colon2(position: position))
+
         when node.type == :ivar && at_end?(position, of: node.loc)
           # @fo ←
           instance_variable_items_for_context(context, position: position, prefix: node.children[0].to_s, items: items)
@@ -198,6 +256,7 @@ module Steep
                                          items: items)
           local_variable_items_for_context(context, position: position, prefix: "", items: items)
           instance_variable_items_for_context(context, position: position, prefix: "", items: items)
+          constant_items_for_context(context, position: position, prefix: "", items: items)
         end
 
         items
@@ -236,6 +295,31 @@ module Steep
         end
       end
 
+      def items_for_colon2(position:)
+        # :: ←
+        shift_pos = position-2
+        node, *_ = source.find_nodes(line: shift_pos.line, column: shift_pos.column)
+        node ||= source.node
+
+        items = []
+        case node&.type
+        when :const
+          # Constant:: ←
+          context = typing.context_at(line: position.line, column: position.column)
+          constant_items_for_context(context, parent: node, position: position, items: items, prefix: "")
+        when nil
+          # :: ←
+          context = typing.context_at(line: position.line, column: position.column)
+          constant_items_for_context(context, parent: nil, position: position, items: items, prefix: "")
+        end
+
+        if node
+          items.push(*items_for_dot(position: position - 1))
+        end
+
+        items
+      end
+
       def items_for_atmark(position:)
         # @ ←
         shift_pos = position-1
@@ -290,6 +374,30 @@ module Steep
         end
       end
 
+      def constant_items_for_context(context, parent: nil, position:, prefix:, items:)
+        range = range_for(position, prefix: prefix)
+
+        if parent
+          case parent.type
+          when :const
+            const_name = typing.source_index.reference(constant_node: parent)
+            consts = context.module_context.const_env.children(const_name)
+          end
+        else
+          consts = context.module_context.const_env.constants
+        end
+
+        if consts
+          consts.each do |name, tuple|
+            type, full_name, _ = tuple
+
+            if name.to_s.start_with?(prefix)
+              items << ConstantItem.new(env: env, identifier: name, range: range, type: type, full_name: full_name)
+            end
+          end
+        end
+      end
+
       def instance_variable_items_for_context(context, position:, prefix:, items:)
         range = range_for(position, prefix: prefix)
         context.type_env.ivar_types.map do |name, type|

data/lib/steep/services/goto_service.rb

@@ -116,10 +116,8 @@ module Steep
               case node.type
               when :const, :casgn
                 if test_ast_location(node.location.name, line: line, column: column)
-                  if module_context = typing.context_at(line: line, column: column).module_context
-                    const_env = module_context.const_env
-                    const = const_env.lookup_constant(module_name_from_node(node))
-                    queries << ConstantQuery.new(name: const.name, from: :ruby)
+                  if name = typing.source_index.reference(constant_node: node)
+                    queries << ConstantQuery.new(name: name, from: :ruby)
                   end
                 end
               when :def, :defs
@@ -247,8 +245,8 @@ module Steep
             entry = typing.source_index.entry(constant: name)
             entry.definitions.each do |node|
               case node.type
-              when :class, :module
-                locations << node.children[0].location.expression
+              when :const
+                locations << node.location.expression
               when :casgn
                 parent = node.children[0]
                 location =