steep-relaxed 1.9.4.3 → 1.10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a2375aaccd85c970192b3cdaec8db80d183c631673e6d6d9b12e77f1d8d9105
-  data.tar.gz: 559f9c8e17a214295d9908c4d56e7e514dc4f37725afab3cbfc551d91455d68e
+  metadata.gz: 0dc09711ef505e121141424fa2ef9fd4c667ca78c4b3388ee1ec127f554b7d01
+  data.tar.gz: 269da170bef99f779ebcc6e9941e701edae2cea137fa2ba4be7ebe0ea67cfdc4
 SHA512:
-  metadata.gz: 3fcace45e6c372a8e445440295db3bec8336ae71235237110c0f37b64aff8db8094410c7849e146fdd890841ffee54416dd7996f2d237abec29a5b5bea143dd5
-  data.tar.gz: 7bb970fbaf54732f2bfdd64a6e495e86a07742001e9fb255c39f5386be9a2c0309c5c19f57cd6345487bacc905b85efea8ba0f411bbecf33ffcc95ef5b11b04c
+  metadata.gz: e8e473956dfbc61dee8b3c11eea08435172e6417415a0e95d15525b475f194f2d0eef3f0d5b874ad65f62b7412f048a3fc6a84f48cbc2ff4af339c45b802c9da
+  data.tar.gz: a593f998234e8bf4387dd6764dc715ac983803ce168eeb02b8f5b55c1872dc3600fa81a892f8e1673065be7dade8ef60ba4b95387096f9017ed698cc7a07c395

data/CHANGELOG.md

@@ -1,5 +1,65 @@
 # CHANGELOG
 
+## 3.10.0 (2025-03-18)
+
+Nothing changed since `1.10.0.pre.3`.
+
+## 1.10.0.pre.3 (2025-03-14)
+
+### Type checker core
+
+* Fix block type checking ([#1534](https://github.com/soutaro/steep/pull/1534))
+
+## 1.10.0.pre.2 (2025-03-14)
+
+### Type checker core
+
+* Fix `self` type handling at block-self-hint ([#1531](https://github.com/soutaro/steep/pull/1531))
+* Delay type variable resolution on method call with blocks ([#1530](https://github.com/soutaro/steep/pull/1530))
+* Fix type checking block calls on `untyped` receiver ([#1528](https://github.com/soutaro/steep/pull/1528))
+* Catch the message of VariableDuplicationError ([#1521](https://github.com/soutaro/steep/pull/1521))
+
+## 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
+
+* 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 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)
 
 ### Miscellaneous

data/Rakefile

@@ -225,3 +225,26 @@ NOTES
     end
   end
 end
+
+namespace :rbs do
+  task :watch do
+    require "listen"
+    listener = Listen.to('test') do |modified, added, removed|
+      paths = (modified + added).map do
+        Pathname(_1).relative_path_from(Pathname.pwd)
+      end
+      sh "rbs-inline", "--opt-out", "--output=sig", *paths.map(&:to_s)
+    end
+    listener.start
+    begin
+      sleep
+    rescue Interrupt
+      listener.stop
+    end
+  end
+
+  task :generate do
+    sh "rbs-inline --opt-out --output=sig test"
+    sh "rbs-inline --opt-out --output=tmp/rbs-inline bin/generate-diagnostics-docs.rb"
+  end
+end

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

@@ -1013,6 +1013,36 @@ module Steep
         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
@@ -1033,6 +1063,7 @@ module Steep
             BlockBodyTypeMismatch => :warning,
             BlockTypeMismatch => :warning,
             BreakTypeMismatch => :hint,
+            DeprecatedReference => :warning,
             DifferentMethodParameterKind => :hint,
             FallbackAny => :hint,
             FalseAssertion => :hint,
@@ -1095,6 +1126,7 @@ module Steep
             BlockBodyTypeMismatch => :error,
             BlockTypeMismatch => :error,
             BreakTypeMismatch => :error,
+            DeprecatedReference => :warning,
             DifferentMethodParameterKind => :error,
             FallbackAny => :warning,
             FalseAssertion => :error,
@@ -1157,6 +1189,7 @@ module Steep
             BlockBodyTypeMismatch => :information,
             BlockTypeMismatch => :information,
             BreakTypeMismatch => :hint,
+            DeprecatedReference => :warning,
             DifferentMethodParameterKind => nil,
             FallbackAny => nil,
             FalseAssertion => nil,

data/lib/steep/diagnostic/signature.rb

@@ -273,6 +273,30 @@ module Steep
         end
       end
 
+      class VariableDuplicationError < Base
+        attr_reader :type_name
+        attr_reader :variable_name
+        attr_reader :location
+
+        def initialize(type_name:, variable_name:, location:)
+          @type_name = type_name
+          @variable_name = variable_name
+          @location = location
+        end
+      end
+
+      class InstanceVariableDuplicationError < VariableDuplicationError
+        def header_line
+          "Duplicated instance variable name `#{variable_name}` in `#{type_name}`"
+        end
+      end
+
+      class ClassInstanceVariableDuplicationError < VariableDuplicationError
+        def header_line
+          "Duplicated class instance variable name `#{variable_name}` in `#{type_name}`"
+        end
+      end
+
       class ClassVariableDuplicationError < Base
         attr_reader :class_name
         attr_reader :other_class_name
@@ -460,6 +484,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
@@ -561,6 +605,10 @@ module Steep
           Diagnostic::Signature::CyclicClassAliasDefinitionError.new(decl: error.alias_entry.decl)
         when RBS::TypeParamDefaultReferenceError
           Diagnostic::Signature::TypeParamDefaultReferenceError.new(error.type_param, location: error.location)
+        when RBS::InstanceVariableDuplicationError
+          Diagnostic::Signature::InstanceVariableDuplicationError.new(type_name: error.type_name, variable_name: error.variable_name, location: error.location)
+        when RBS::ClassInstanceVariableDuplicationError
+          Diagnostic::Signature::ClassInstanceVariableDuplicationError.new(type_name: error.type_name, variable_name: error.variable_name, location: error.location)
         else
           raise error
         end

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