steep 1.9.4 → 1.10.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b23b392399196d67221acd72708ebe27ee3b7bbb7b54e4b5922e8ecbb6ceb5e3
-  data.tar.gz: a315e09c38f8736bc66aad3a57275f8546c28c75845fa33a9de375387cc63a13
+  metadata.gz: 2233f51ac985ee697a7f3617582dc034f32b1cd3b0732a87b8184210f2c1d7b0
+  data.tar.gz: 1298685cafa59f5074afa950df4c1f14cff9a8b6be9b99b914902b37e537aad3
 SHA512:
-  metadata.gz: 1fe50cd4df36c00affa8868857d55deeea0e58c36372260209d95fabec69eb9f005d37581c5184c0b44e3a5fb1d42bd5bb25a5630c5dfafa4552b08a8fb87377
-  data.tar.gz: bc41b2386db2d9a97dabf2c81ff2079c6fac875decc01ba223d1475473048945d81ba43cc17f0db24f6ba2da285954dff83e10910b5f3831716781698b458d9e
+  metadata.gz: 1cb518e2f5743330e58b0c6032ed99d22f29254b91d9c8e33e3bafc3cb1a9f46247f181ee5b9b078dba13768f675f03b1c2e8fb24b53609902d6534092625282
+  data.tar.gz: e26fde370f8d793b13138d71dc6295ffde59e781ed2d0a39cf73e639c8440517d7fa13586d871c9eab6880ae8864c31a711beb45c49280152416d0111935f3da

data/CHANGELOG.md

@@ -1,14 +1,45 @@
 # CHANGELOG
 
-## 1.9.4 (2025-02-04)
+## 1.10.0.pre.1 (2025-03-11)
+
+### Type checker core
+
+* Skip type checking forwarded argument if the method is undeclared ([#1519](https://github.com/soutaro/steep/pull/1519))
+* Dedup error message on ancestors check ([#1515](https://github.com/soutaro/steep/pull/1515))
+* Add deprecation validation on RBS ([#1518](https://github.com/soutaro/steep/pull/1518))
+* Fix union self type refinement based on method call ([#1517](https://github.com/soutaro/steep/pull/1517))
+* Check deprecations in Ruby code ([#1513](https://github.com/soutaro/steep/pull/1513))
+* Support `InvalidTypeApplication` on `#update_env` ([#1507](https://github.com/soutaro/steep/pull/1507))
+* Fix Source.parse crashes with selector-less sendish node ([#1433](https://github.com/soutaro/steep/pull/1433))
+* Fix steep:ignore does not work with CR/LF ([#1406](https://github.com/soutaro/steep/pull/1406))
+* Fix self union type checking ([#1467](https://github.com/soutaro/steep/pull/1467))
+* Type narrowing union types via return type of method call ([#1497](https://github.com/soutaro/steep/pull/1497))
+* Fix `else` clause of `case-when` syntax typing ([#1475](https://github.com/soutaro/steep/pull/1475))
+* Strict record and tuple subtyping ([#1460](https://github.com/soutaro/steep/pull/1460))
+* Allow to annotate "self" on toplevel ([#1455](https://github.com/soutaro/steep/pull/1455))
+* Let annotations in `when` clause without `cond` expression work ([#1459](https://github.com/soutaro/steep/pull/1459))
+* Fix `RuntimeError` on `when` clause with assertion ([#1458](https://github.com/soutaro/steep/pull/1458))
+* Add diagnostic for method definition without types ([#1457](https://github.com/soutaro/steep/pull/1457))
+
+### Commandline tool
+
+* Implement GitHub formatter ([#1516](https://github.com/soutaro/steep/pull/1516))
+* Refine `--help` messages ([#1463](https://github.com/soutaro/steep/pull/1463))
 
 ### Language server
 
-* Set up file watcher for groups ([#1485](https://github.com/soutaro/steep/pull/1485), Backported)
+* Reforking steep ([#1492](https://github.com/soutaro/steep/pull/1492))
+* Set up file watcher for groups ([#1485](https://github.com/soutaro/steep/pull/1485))
 
 ### Miscellaneous
 
-* Fix CI ([#1486](https://github.com/soutaro/steep/pull/1486), Backported)
+* Fix a runtime warning for ambiguous `/`; wrap regexp in parentheses or add a space after `/` operator ([#1438](https://github.com/soutaro/steep/pull/1438))
+* Fix a runtime warning for ambiguous `*` has been interpreted as an argument prefix ([#1439](https://github.com/soutaro/steep/pull/1439))
+* Fix a runtime warning for key :cursor is duplicated and overwritten on line 99 ([#1440](https://github.com/soutaro/steep/pull/1440))
+* Use release version of RBS ([#1511](https://github.com/soutaro/steep/pull/1511))
+* Prepare for rbs-3.9 ([#1510](https://github.com/soutaro/steep/pull/1510))
+* Fix typos ([#1506](https://github.com/soutaro/steep/pull/1506))
+* Fix CI ([#1486](https://github.com/soutaro/steep/pull/1486))
 
 ## 1.9.3 (2024-12-26)
 

data/Steepfile

@@ -13,7 +13,6 @@ if (source = rbs_dep&.source).is_a?(Bundler::Source::Path)
   end
 else
   FileUtils.rm_f(tmp_rbs_dir)
-  library "rbs"
 end
 
 target :app do
@@ -64,5 +63,9 @@ target :bin do
   check "bin/generate-diagnostics-docs.rb"
   signature "tmp/rbs-inline/bin"
 
-  library "rbs"
+  if tmp_rbs_dir.directory?
+    signature tmp_rbs_dir.to_s
+  else
+    library "rbs"
+  end
 end

data/lib/steep/annotations_helper.rb

@@ -0,0 +1,43 @@
+module Steep
+  module AnnotationsHelper
+    module_function
+
+    def deprecated_annotation?(annotations)
+      annotations.reverse_each do |annotation|
+        if match = annotation.string.match(/deprecated(:\s*(?<message>.+))?/)
+          return [annotation, match[:message]]
+        end
+        if match = annotation.string.match(/steep:deprecated(:\s*(?<message>.+))?/)
+          return [annotation, match[:message]]
+        end
+      end
+
+      nil
+    end
+
+    def deprecated_type_name?(type_name, env)
+      annotations =
+        case
+        when type_name.class?
+          case
+          when decl = env.class_decls.fetch(type_name, nil)
+            decl.decls.flat_map { _1.decl.annotations }
+          when decl = env.class_alias_decls.fetch(type_name, nil)
+            decl.decl.annotations
+          end
+        when type_name.interface?
+          if decl = env.interface_decls.fetch(type_name, nil)
+            decl.decl.annotations
+          end
+        when type_name.alias?
+          if decl = env.type_alias_decls.fetch(type_name, nil)
+            decl.decl.annotations
+          end
+        end
+
+      if annotations
+        deprecated_annotation?(annotations)
+      end
+    end
+  end
+end

data/lib/steep/ast/ignore.rb

@@ -93,15 +93,14 @@ module Steep
       def self.parse(comment, buffer)
         return unless comment.inline?
 
-        comment_location = RBS::Location.new(buffer, comment.loc.expression.begin_pos, comment.loc.expression.end_pos)
+        begin_pos = buffer.loc_to_pos([comment.loc.line, comment.loc.column])
+        end_pos = buffer.loc_to_pos([comment.loc.last_line, comment.loc.last_column])
+        comment_location = RBS::Location.new(buffer, begin_pos, end_pos)
         scanner = BufferScanner.new(comment_location)
 
         scanner.scan(/#/)
         scanner.skip(/\s*/)
 
-        begin_pos = comment.location.expression.begin_pos
-        end_pos = comment.location.expression.end_pos
-
         case
         when loc = scanner.scan(/steep:ignore:start\b/)
           scanner.skip(/\s*/)

data/lib/steep/cli.rb

@@ -24,12 +24,13 @@ module Steep
         opts.banner = <<~USAGE
           Usage: steep [options]
 
-          available commands: #{CLI.available_commands.join(', ')}
+          Available commands:
+              #{CLI.available_commands.join(', ')}
 
           Options:
         USAGE
 
-        opts.on("--version") do
+        opts.on("--version", "Print Steep version") do
           process_version
           exit 0
         end
@@ -60,6 +61,10 @@ module Steep
       __send__(:"process_#{command}")
     end
 
+    def handle_steepfile_option(opts, command)
+      opts.on("--steepfile=PATH", "Specify path to Steepfile") {|path| command.steepfile = Pathname(path) }
+    end
+
     def handle_logging_options(opts)
       opts.on("--log-level=LEVEL", "Specify log level: debug, info, warn, error, fatal") do |level|
         Steep.logger.level = level
@@ -101,10 +106,16 @@ module Steep
     def process_init
       Drivers::Init.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep init [options]"
+          opts.banner = <<BANNER
+Usage: steep init [options]
+
+Description:
+    Generates a Steepfile at specified path.
 
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
-          opts.on("--force") { command.force_write = true }
+Options:
+BANNER
+          handle_steepfile_option(opts, command)
+          opts.on("--force", "Overwrite the Steepfile if it already exists") { command.force_write = true }
 
           handle_logging_options opts
         end.parse!(argv)
@@ -114,9 +125,19 @@ module Steep
     def process_check
       Drivers::Check.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep check [options] [sources]"
+          opts.banner = <<BANNER
+Usage: steep check [options] [paths]
+
+Description:
+    Type check the program.
 
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+    If paths are specified, it type checks and validates the files at the given path.
+    Otherwise, it type checks and validates all files in the project or the groups if specified.
+
+Options:
+BANNER
+
+          handle_steepfile_option(opts, command)
           opts.on("--with-expectations[=PATH]", "Type check with expectations saved in PATH (or steep_expectations.yml)") do |path|
             command.with_expectations_path = Pathname(path || "steep_expectations.yml")
           end
@@ -166,22 +187,33 @@ module Steep
             end
           end
 
+          opts.on("--format=FORMATTER", ["code", "github"], "Output formatters (default: code, options: code,github)") do |formatter|
+            command.formatter = formatter
+          end
+
           handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
 
         setup_jobs_for_ci(command.jobs_option)
 
-        command.command_line_patterns.push *argv
+        command.command_line_patterns.push(*argv)
       end.run
     end
 
     def process_checkfile
       Drivers::Checkfile.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep checkfile [options] [files]"
+          opts.banner = <<BANNER
+Usage: steep checkfile [options] [files]
+
+Description:
+    Deprecated: Use `steep check` instead.
+
+Options:
+BANNER
 
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          handle_steepfile_option(opts, command)
           opts.on("--all-rbs", "Type check all RBS files") { command.all_rbs = true }
           opts.on("--all-ruby", "Type check all Ruby files") { command.all_ruby = true }
           opts.on("--stdin", "Read files to type check from stdin") do
@@ -197,16 +229,23 @@ module Steep
 
         setup_jobs_for_ci(command.jobs_option)
 
-        command.command_line_args.push *argv
+        command.command_line_args.push(*argv)
       end.run
     end
 
     def process_stats
       Drivers::Stats.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep stats [options] [sources]"
+          opts.banner = <<BANNER
+Usage: steep stats [options] [sources]
 
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+Description:
+    Displays statistics about the typing of method calls.
+
+Options:
+BANNER
+
+          handle_steepfile_option(opts, command)
           opts.on("--format=FORMAT", "Specify output format: csv, table") {|format| command.format = format }
           handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
@@ -214,7 +253,7 @@ module Steep
 
         setup_jobs_for_ci(command.jobs_option)
 
-        command.command_line_patterns.push *argv
+        command.command_line_patterns.push(*argv)
       end.run
     end
 
@@ -226,19 +265,33 @@ module Steep
     def process_annotations
       Drivers::Annotations.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep annotations [options] [sources]"
+          opts.banner = <<BANNER
+Usage: steep annotations [options] [sources]
+
+Description:
+    Prints the type annotations in the Ruby code.
+
+Options:
+BANNER
           handle_logging_options opts
         end.parse!(argv)
 
-        command.command_line_patterns.push *argv
+        command.command_line_patterns.push(*argv)
       end.run
     end
 
     def process_project
       Drivers::PrintProject.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep project [options]"
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          opts.banner = <<BANNER
+Usage: steep project [options]
+
+Description:
+    Prints the project configuration.
+
+Options:
+BANNER
+          handle_steepfile_option(opts, command)
           opts.on("--[no-]print-files", "Print files") {|v|
             command.print_files = v ? true : false
           }
@@ -250,7 +303,15 @@ module Steep
     def process_watch
       Drivers::Watch.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
-          opts.banner = "Usage: steep watch [options] [dirs]"
+          opts.banner = <<BANNER
+Usage: steep watch [options] [dirs]
+
+Description:
+    Monitors file changes and automatically type checks updated files.
+    Using LSP is recommended for better performance and more features.
+
+Options:
+BANNER
           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|
             # @type var level: String
             command.severity_level = _ = level.to_sym
@@ -269,7 +330,16 @@ module Steep
     def process_langserver
       Drivers::Langserver.new(stdout: stdout, stderr: stderr, stdin: stdin).tap do |command|
         OptionParser.new do |opts|
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          opts.banner = <<BANNER
+Usage: steep langserver [options]
+
+Description:
+    Starts language server, which is assumed to be invoked from language client.
+
+Options:
+BANNER
+          handle_steepfile_option(opts, command)
+          opts.on("--refork") { command.refork = true }
           handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
@@ -300,8 +370,8 @@ module Steep
         opts.banner = <<BANNER
 Usage: steep binstub [options]
 
-Generate a binstub to execute Steep with setting up Bundler and rbenv/rvm.
-Use the executable for LSP integration setup.
+Description:
+    Generate a binstub which set up ruby executables and bundlers.
 
 Options:
 BANNER
@@ -372,6 +442,15 @@ TEMPLATE
     end
 
     def process_version
+      OptionParser.new do |opts|
+        opts.banner = <<BANNER
+Usage: steep version [options]
+
+Description:
+    Prints Steep version.
+BANNER
+      end.parse!(argv)
+
       stdout.puts Steep::VERSION
       0
     end
@@ -384,7 +463,7 @@ TEMPLATE
 
           opts.on("--interaction") { command.worker_type = :interaction }
           opts.on("--typecheck") { command.worker_type = :typecheck }
-          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          handle_steepfile_option(opts, command)
           opts.on("--name=NAME") {|name| command.worker_name = name }
           opts.on("--delay-shutdown") { command.delay_shutdown = true }
           opts.on("--max-index=COUNT") {|count| command.max_index = Integer(count) }

data/lib/steep/diagnostic/lsp_formatter.rb

@@ -49,13 +49,27 @@ module Steep
             } #: LSP::Interface::CodeDescription::json
           end
 
-          {
+          tags = [] #: Array[LSP::Constant::DiagnosticTag::t]
+
+          case diagnostic
+          when Ruby::DeprecatedReference
+            tags << LSP::Constant::DiagnosticTag::DEPRECATED
+          when Signature::DeprecatedTypeName
+            tags << LSP::Constant::DiagnosticTag::DEPRECATED
+            severity = LSP::Constant::DiagnosticSeverity::WARNING
+          end
+
+          json = {
             message: diagnostic.full_message,
             code: diagnostic.diagnostic_code,
             severity: severity,
             range: range,
-            codeDescription: description
-          }
+            codeDescription: description,
+          } #: LSP::Interface::Diagnostic::json
+
+          json[:tags] = tags unless tags.empty?
+
+          json
         end
       end
 

data/lib/steep/diagnostic/ruby.rb

@@ -977,6 +977,72 @@ module Steep
         end
       end
 
+      class UndeclaredMethodDefinition < Base
+        attr_reader :method_name, :type_name
+
+        def initialize(method_name:, type_name:, node:)
+          @method_name = method_name
+          @type_name = type_name
+          super(node: node, location: (_ = node.loc).name)
+        end
+
+        def header_line
+          name =
+              case node.type
+              when :def
+                "#{type_name}##{method_name}"
+              when :defs
+                "#{type_name}.#{method_name}"
+              else
+                raise
+              end
+          "Method `#{name}` is not declared in RBS"
+        end
+      end
+
+      class MethodDefinitionInUndeclaredModule < Base
+        attr_reader :method_name
+
+        def initialize(method_name:, node:)
+          @method_name = method_name
+          super(node: node, location: (_ = node.loc).name)
+        end
+
+        def header_line
+          "Method `#{method_name}` is defined in undeclared module"
+        end
+      end
+
+      class DeprecatedReference < Base
+        attr_reader :message
+
+        def initialize(node:, location:, message:)
+          super(node: node, location: location)
+          @message = message
+        end
+
+        def header_line
+          header =
+            case node&.type
+            when :send, :csend, :block, :numblock
+              "The method is deprecated"
+            when :const, :casgn
+              "The constant is deprecated"
+            when :gvar, :gvasgn
+              "The global variable is deprecated"
+            else
+              raise "Unexpected node: #{node}"
+            end
+
+          if message
+            header = +header
+            header.concat(": ", message)
+          end
+
+          header
+        end
+      end
+
       ALL = ObjectSpace.each_object(Class).with_object([]) do |klass, array|
         if klass < Base
           array << klass
@@ -997,6 +1063,7 @@ module Steep
             BlockBodyTypeMismatch => :warning,
             BlockTypeMismatch => :warning,
             BreakTypeMismatch => :hint,
+            DeprecatedReference => :warning,
             DifferentMethodParameterKind => :hint,
             FallbackAny => :hint,
             FalseAssertion => :hint,
@@ -1010,6 +1077,7 @@ module Steep
             InvalidIgnoreComment => :warning,
             MethodArityMismatch => :error,
             MethodBodyTypeMismatch => :error,
+            MethodDefinitionInUndeclaredModule => :information,
             MethodDefinitionMissing => nil,
             MethodParameterMismatch => :error,
             MethodReturnTypeAnnotationMismatch => :hint,
@@ -1026,6 +1094,7 @@ module Steep
             SyntaxError => :information,
             TypeArgumentMismatchError => :hint,
             UnannotatedEmptyCollection => :warning,
+            UndeclaredMethodDefinition => :warning,
             UnexpectedBlockGiven => :warning,
             UnexpectedDynamicMethod => :hint,
             UnexpectedError => :hint,
@@ -1057,6 +1126,7 @@ module Steep
             BlockBodyTypeMismatch => :error,
             BlockTypeMismatch => :error,
             BreakTypeMismatch => :error,
+            DeprecatedReference => :warning,
             DifferentMethodParameterKind => :error,
             FallbackAny => :warning,
             FalseAssertion => :error,
@@ -1070,6 +1140,7 @@ module Steep
             InvalidIgnoreComment => :warning,
             MethodArityMismatch => :error,
             MethodBodyTypeMismatch => :error,
+            MethodDefinitionInUndeclaredModule => :warning,
             MethodDefinitionMissing => :hint,
             MethodParameterMismatch => :error,
             MethodReturnTypeAnnotationMismatch => :error,
@@ -1086,6 +1157,7 @@ module Steep
             SyntaxError => :information,
             TypeArgumentMismatchError => :error,
             UnannotatedEmptyCollection => :error,
+            UndeclaredMethodDefinition => :warning,
             UnexpectedBlockGiven => :error,
             UnexpectedDynamicMethod => :information,
             UnexpectedError => :information,
@@ -1117,6 +1189,7 @@ module Steep
             BlockBodyTypeMismatch => :information,
             BlockTypeMismatch => :information,
             BreakTypeMismatch => :hint,
+            DeprecatedReference => :warning,
             DifferentMethodParameterKind => nil,
             FallbackAny => nil,
             FalseAssertion => nil,
@@ -1130,6 +1203,7 @@ module Steep
             InvalidIgnoreComment => :warning,
             MethodArityMismatch => :information,
             MethodBodyTypeMismatch => :warning,
+            MethodDefinitionInUndeclaredModule => :hint,
             MethodDefinitionMissing => nil,
             MethodParameterMismatch => :warning,
             MethodReturnTypeAnnotationMismatch => nil,
@@ -1146,6 +1220,7 @@ module Steep
             SyntaxError => :information,
             TypeArgumentMismatchError => nil,
             UnannotatedEmptyCollection => :hint,
+            UndeclaredMethodDefinition => :information,
             UnexpectedBlockGiven => :hint,
             UnexpectedDynamicMethod => nil,
             UnexpectedError => :hint,

data/lib/steep/diagnostic/signature.rb

@@ -460,6 +460,26 @@ module Steep
         end
       end
 
+      class DeprecatedTypeName < Base
+        attr_reader :type_name
+        attr_reader :message
+
+        def initialize(type_name, message, location:)
+          super(location: location)
+          @type_name = type_name
+          @message = message
+        end
+
+        def header_line
+          buffer = "Type `#{type_name}` is deprecated"
+          if message
+            buffer = +buffer
+            buffer << ": " << message
+          end
+          buffer
+        end
+      end
+
 
       def self.from_rbs_error(error, factory:)
         case error

data/lib/steep/drivers/check.rb

@@ -16,6 +16,7 @@ module Steep
       attr_accessor :validate_group_signatures
       attr_accessor :validate_project_signatures
       attr_accessor :validate_library_signatures
+      attr_accessor :formatter
 
       include Utils::DriverHelper
 
@@ -30,6 +31,7 @@ module Steep
         @validate_group_signatures = true
         @validate_project_signatures = false
         @validate_library_signatures = false
+        @formatter = 'code'
       end
 
       def active_group?(group)
@@ -322,7 +324,7 @@ module Steep
           errors.each do |notification|
             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)
+            printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout, formatter: formatter)
 
             notification[:diagnostics].each do |diag|
               printer.print(diag)

data/lib/steep/drivers/diagnostic_printer/base_formatter.rb

@@ -0,0 +1,19 @@
+module Steep
+  module Drivers
+    class DiagnosticPrinter
+      class BaseFormatter
+        attr_reader :stdout
+        attr_reader :buffer
+
+        def initialize(stdout:, buffer:)
+          @stdout = stdout
+          @buffer = buffer
+        end
+
+        def path
+          Pathname(buffer.name)
+        end
+      end
+    end
+  end
+end