steep 1.4.0 → 1.5.0.pre.1

data/lib/steep/cli.rb

@@ -192,7 +192,8 @@ module Steep
         OptionParser.new do |opts|
           opts.banner = "Usage: steep watch [options] [dirs]"
           opts.on("--severity-level=LEVEL", /^error|warning|information|hint$/, "Specify the minimum diagnostic severity to be recognized as an error (defaults: warning): error, warning, information, or hint") do |level|
-            command.severity_level = level.to_sym
+            # @type var level: String
+            command.severity_level = _ = level.to_sym
           end
           handle_jobs_option command.jobs_option, opts
           handle_logging_options opts

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

@@ -0,0 +1,20 @@
+Steep.logger.error "Diagnostic `Ruby::ElseOnExhaustiveCase` is deprecated. Use `Ruby::UnreachableBranch` instead."
+
+module Steep
+  module Diagnostic
+    module Ruby
+      class ElseOnExhaustiveCase < Base
+        attr_reader :type
+
+        def initialize(node:, type:)
+          super(node: node)
+          @type = type
+        end
+
+        def header_line
+          "The branch is unreachable because the condition is exhaustive"
+        end
+      end
+    end
+  end
+end

data/lib/steep/diagnostic/lsp_formatter.rb

@@ -41,14 +41,14 @@ module Steep
         severity = severity_for(diagnostic)
 
         if severity
-          range = diagnostic.location&.as_lsp_range or raise "#{diagnostic.class} object (#{diagnostic.full_message}) instance must have `#location`"
+          range = diagnostic.location&.as_lsp_range || raise("#{diagnostic.class} object (#{diagnostic.full_message}) instance must have `#location`")
 
-          LSP::Interface::Diagnostic.new(
+          {
             message: diagnostic.full_message,
             code: diagnostic.diagnostic_code,
             severity: severity,
             range: range
-          ).to_hash
+          }
         end
       end
 

data/lib/steep/diagnostic/ruby.rb

@@ -322,6 +322,24 @@ module Steep
         end
       end
 
+      class SetterReturnTypeMismatch < Base
+        attr_reader :expected, :actual, :result, :method_name
+
+        include ResultPrinter
+
+        def initialize(node:, method_name:, expected:, actual:, result:)
+          super(node: node)
+          @method_name = method_name
+          @expected = expected
+          @actual = actual
+          @result = result
+        end
+
+        def header_line
+          "The setter method `#{method_name}` cannot return a value of type `#{actual}` because declared as type `#{expected}`"
+        end
+      end
+
       class UnexpectedBlockGiven < Base
         attr_reader :method_type
 
@@ -539,6 +557,24 @@ module Steep
         end
       end
 
+      class SetterBodyTypeMismatch < Base
+        attr_reader :expected, :actual, :result, :method_name
+
+        include ResultPrinter
+
+        def initialize(node:, expected:, actual:, result:, method_name:)
+          super(node: node, location: node.loc.name)
+          @expected = expected
+          @actual = actual
+          @result = result
+          @method_name = method_name
+        end
+
+        def header_line
+          "Setter method `#{method_name}` cannot have type `#{actual}` because declared as type `#{expected}`"
+        end
+      end
+
       class UnexpectedYield < Base
         def header_line
           "No block given for `yield`"
@@ -626,6 +662,7 @@ module Steep
       end
 
       autoload :UnknownConstantAssigned, "steep/diagnostic/deprecated/unknown_constant_assigned"
+      autoload :ElseOnExhaustiveCase, "steep/diagnostic/deprecated/else_on_exhaustive_case"
 
       class UnknownInstanceVariable < Base
         attr_reader :name
@@ -724,16 +761,9 @@ module Steep
         end
       end
 
-      class ElseOnExhaustiveCase < Base
-        attr_reader :type
-
-        def initialize(node:, type:)
-          super(node: node)
-          @type = type
-        end
-
+      class UnreachableBranch < Base
         def header_line
-          "The branch is unreachable because the condition is exhaustive"
+          "The branch is unreachable"
         end
       end
 
@@ -908,6 +938,19 @@ module Steep
         end
       end
 
+      class ProcHintIgnored < Base
+        attr_reader :hint_type, :block_node
+
+        def initialize(hint_type:, node:)
+          @hint_type = hint_type
+          super(node: node)
+        end
+
+        def header_line
+          "The type hint given to the block is ignored: `#{hint_type}`"
+        end
+      end
+
       ALL = ObjectSpace.each_object(Class).with_object([]) do |klass, array|
         if klass < Base
           array << klass
@@ -931,7 +974,11 @@ module Steep
             FalseAssertion => :information,
             UnexpectedTypeArgument => :information,
             InsufficientTypeArgument => :information,
-            UnexpectedTypeArgument => :information
+            UnexpectedTypeArgument => :information,
+            UnsupportedSyntax => nil,
+            ProcHintIgnored => :information,
+            SetterBodyTypeMismatch => nil,
+            SetterReturnTypeMismatch => nil
           }
         ).freeze
       end
@@ -944,7 +991,11 @@ module Steep
             FallbackAny => nil,
             ElseOnExhaustiveCase => nil,
             UnknownConstant => nil,
-            MethodDefinitionMissing => nil
+            MethodDefinitionMissing => nil,
+            UnsupportedSyntax => nil,
+            ProcHintIgnored => :warning,
+            SetterBodyTypeMismatch => :error,
+            SetterReturnTypeMismatch => :error
           }
         ).freeze
       end
@@ -959,10 +1010,20 @@ module Steep
             UnknownConstant => nil,
             MethodDefinitionMissing => nil,
             UnexpectedJump => nil,
-            FalseAssertion => :hint
+            FalseAssertion => :hint,
+            UnsupportedSyntax => nil,
+            ProcHintIgnored => :hint,
+            SetterBodyTypeMismatch => nil,
+            SetterReturnTypeMismatch => nil
           }
         ).freeze
       end
+
+      def self.silent
+        @silent ||= ALL.each.with_object({}) do |klass, hash|
+          hash[klass] = nil
+        end.freeze
+      end
     end
   end
 end

data/lib/steep/drivers/annotations.rb

@@ -37,6 +37,7 @@ module Steep
                 loc = node.loc
                 stdout.puts "#{path}:#{loc.line}:#{loc.column}:#{node.type}:\t#{node.loc.expression.source.lines.first}"
                 annotations.each do |annotation|
+                  annotation.location or raise
                   stdout.puts "  #{annotation.location.source}"
                 end
               end

data/lib/steep/drivers/check.rb

@@ -55,9 +55,9 @@ module Steep
         master.commandline_args.push(*command_line_patterns)
 
         main_thread = Thread.start do
+          Thread.current.abort_on_exception = true
           master.start()
         end
-        main_thread.abort_on_exception = true
 
         Steep.logger.info { "Initializing server" }
         initialize_id = request_id()
@@ -68,13 +68,13 @@ module Steep
         Steep.logger.info { "Starting type checking: #{request_guid}" }
         client_writer.write({ method: "$/typecheck", params: { guid: request_guid } })
 
-        diagnostic_notifications = []
-        error_messages = []
+        diagnostic_notifications = [] #: Array[LanguageServer::Protocol::Interface::PublishDiagnosticsParams]
+        error_messages = [] #: Array[String]
         client_reader.read do |response|
           case
           when response[:method] == "textDocument/publishDiagnostics"
             ds = response[:params][:diagnostics]
-            ds.select! {|d| keep_diagnostic?(d) }
+            ds.select! {|d| keep_diagnostic?(d, severity_level: severity_level) }
             if ds.empty?
               stdout.print "."
             else
@@ -130,6 +130,9 @@ module Steep
           stdout.puts Rainbow("Unexpected error reported. 🚨").red.bold
           1
         end
+      rescue Errno::EPIPE => error
+        stdout.puts Rainbow("Steep shutdown with an error: #{error.inspect}").red.bold
+        return 1
       end
 
       def print_expectations(project:, all_files:, expectations_path:, notifications:)
@@ -139,9 +142,11 @@ module Steep
         unexpected_count = 0
         missing_count = 0
 
-        ns = notifications.each.with_object({}) do |notification, hash|
-          path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]))
-          hash[path] = notification[:diagnostics]
+        ns = notifications.each.with_object({}) do |notification, hash| #$ Hash[Pathname, Array[Expectations::Diagnostic]]
+          path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]) || raise)
+          hash[path] = notification[:diagnostics].map do |diagnostic|
+            Expectations::Diagnostic.from_lsp(diagnostic)
+          end
         end
 
         all_files.sort.each do |path|
@@ -156,10 +161,10 @@ module Steep
               expected_count += 1
             when :unexpected
               unexpected_count += 1
-              printer.print(diag, prefix: Rainbow("+ ").green)
+              printer.print(diag.to_lsp, prefix: Rainbow("+ ").green)
             when :missing
               missing_count += 1
-              printer.print(diag, prefix: Rainbow("- ").red, source: false)
+              printer.print(diag.to_lsp, prefix: Rainbow("- ").red, source: false)
             end
           end
         end
@@ -186,9 +191,9 @@ module Steep
                          Expectations.empty()
                        end
 
-        ns = notifications.each.with_object({}) do |notification, hash|
-          path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]))
-          hash[path] = notification[:diagnostics]
+        ns = notifications.each.with_object({}) do |notification, hash| #$ Hash[Pathname, Array[Expectations::Diagnostic]]
+          path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]) || raise)
+          hash[path] = notification[:diagnostics].map {|diagnostic| Expectations::Diagnostic.from_lsp(diagnostic) }
         end
 
         all_files.sort.each do |path|
@@ -216,7 +221,7 @@ module Steep
           total = errors.sum {|notification| notification[:diagnostics].size }
 
           errors.each do |notification|
-            path = Steep::PathHelper.to_pathname(notification[:uri])
+            path = Steep::PathHelper.to_pathname(notification[:uri]) or raise
             buffer = RBS::Buffer.new(name: project.relative_path(path), content: path.read)
             printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout)
 

data/lib/steep/drivers/checkfile.rb

@@ -119,9 +119,9 @@ module Steep
         master.typecheck_automatically = false
 
         main_thread = Thread.start do
+          Thread.current.abort_on_exception = true
           master.start()
         end
-        main_thread.abort_on_exception = true
 
         Steep.logger.info { "Initializing server" }
         initialize_id = request_id()

data/lib/steep/drivers/diagnostic_printer.rb

@@ -12,7 +12,7 @@ module Steep
       end
 
       def path
-        buffer.name
+        Pathname(buffer.name)
       end
 
       def color_severity(string, severity:)
@@ -40,6 +40,8 @@ module Steep
                    "information"
                  when LSP::Constant::DiagnosticSeverity::HINT
                    "hint"
+                 else
+                  raise
                  end
 
         color_severity(string, severity: severity)
@@ -82,12 +84,12 @@ module Steep
 
         line = buffer.lines[start_pos[:line]]
 
-        leading = line[0...start_pos[:character]]
+        leading = line[0...start_pos[:character]] || ""
         if start_pos[:line] == end_pos[:line]
-          subject = line[start_pos[:character]...end_pos[:character]]
+          subject = line[start_pos[:character]...end_pos[:character]] || ""
           trailing = (line[end_pos[:character]...] || "").chomp
         else
-          subject = line[start_pos[:character]...].chomp
+          subject = (line[start_pos[:character]...] || "").chomp
           trailing = ""
         end
 

data/lib/steep/drivers/init.rb

@@ -20,9 +20,10 @@ module Steep
       #
       #   # library "pathname", "set"       # Standard libraries
       #   # library "strong_json"           # Gems
-      #   
+      #
       #   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
       #   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+      #   # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
       #   # configure_code_diagnostics do |hash|             # You can setup everything yourself
       #   #   hash[D::Ruby::NoMethod] = :information
       #   # end

data/lib/steep/drivers/print_project.rb

@@ -54,8 +54,10 @@ module Steep
               case lib
               when :core
                 stdout.puts "      - core: #{path}"
+              when Pathname
+                raise "Unexpected pathname from loader: path=#{path}"
               else
-                stdout.puts "      - #{lib.name}: #{path}"
+                stdout.puts "      - #{lib.name}(#{lib.version}): #{path}"
               end
             end
           end

data/lib/steep/drivers/stats.rb

@@ -145,9 +145,9 @@ module Steep
         master.commandline_args.push(*command_line_patterns)
 
         main_thread = Thread.start do
+          Thread.current.abort_on_exception = true
           master.start()
         end
-        main_thread.abort_on_exception = true
 
         initialize_id = request_id()
         client_writer.write({ method: :initialize, id: initialize_id })

data/lib/steep/drivers/utils/driver_helper.rb

@@ -10,13 +10,15 @@ module Steep
           steep_file_path = path.absolute? ? path : Pathname.pwd + path
           Project.new(steepfile_path: steep_file_path).tap do |project|
             Project::DSL.parse(project, path.read, filename: path.to_s)
-          end
-        end
 
-        def type_check(project)
-          project.targets.each do |target|
-            Steep.logger.tagged "target=#{target.name}" do
-              target.type_check
+            project.targets.each do |target|
+              if collection_lock = target.options.collection_lock
+                begin
+                  collection_lock.check_rbs_availability!
+                rescue RBS::Collection::Config::CollectionNotAvailable
+                  raise "Run `rbs collection install` to install type definitions"
+                end
+              end
             end
           end
         end
@@ -56,10 +58,10 @@ module Steep
           end
         end
 
-        def keep_diagnostic?(diagnostic)
+        def keep_diagnostic?(diagnostic, severity_level:)
           severity = diagnostic[:severity]
 
-          case self.severity_level
+          case severity_level
           when nil, :hint
             true
           when :error

data/lib/steep/drivers/utils/jobs_option.rb

@@ -13,7 +13,12 @@ module Steep
         end
 
         def jobs_count_value
-          jobs_count || default_jobs_count
+          count = jobs_count || default_jobs_count
+          if count >= 1
+            count
+          else
+            1
+          end
         end
       end
     end

data/lib/steep/drivers/validate.rb

@@ -33,21 +33,25 @@ module Steep
                 builder = Interface::Builder.new(factory)
                 check = Subtyping::Check.new(builder: builder)
                 Signature::Validator.new(checker: check).tap {|v| v.validate() }.each_error.to_a
+              else
+                raise
               end
             end
 
           any_error ||= !errors.empty?
 
           formatter = Diagnostic::LSPFormatter.new({})
-          diagnostics = errors.group_by {|e| e.location.buffer }.transform_values do |errors|
+          diagnostics = errors.group_by {|e| e.location&.buffer }.transform_values do |errors|
             errors.map {|error| formatter.format(error) }
           end
 
           diagnostics.each do |buffer, ds|
-            printer = DiagnosticPrinter.new(stdout: stdout, buffer: buffer)
-            ds.each do |d|
-              printer.print(d)
-              stdout.puts
+            if buffer
+              printer = DiagnosticPrinter.new(stdout: stdout, buffer: buffer)
+              ds.each do |d|
+                printer.print(d)
+                stdout.puts
+              end
             end
           end
         end

data/lib/steep/drivers/watch.rb

@@ -57,7 +57,6 @@ module Steep
         main_thread = Thread.start do
           master.start()
         end
-        main_thread.abort_on_exception = true
 
         initialize_id = request_id()
         client_writer.write(method: "initialize", id: initialize_id)
@@ -131,7 +130,7 @@ module Steep
               printer = DiagnosticPrinter.new(stdout: stdout, buffer: buffer)
 
               diagnostics = response[:params][:diagnostics]
-              diagnostics.filter! {|d| keep_diagnostic?(d) }
+              diagnostics.filter! {|d| keep_diagnostic?(d, severity_level: severity_level) }
 
               unless diagnostics.empty?
                 diagnostics.each do |diagnostic|
@@ -157,7 +156,13 @@ module Steep
           main_thread.join
         rescue Interrupt
           master.kill
-          main_thread.join
+          begin
+            main_thread.join
+          rescue
+            master.each_worker do |worker|
+              worker.kill(force: true)
+            end
+          end
         end
 
         0