steep 2.1.0.dev.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9985b9a834986497b037bbe836f6646aad30fcc1dfa33cf187a3f6aea572d5c6
-  data.tar.gz: a3ef68064767f01a511e48b02598f4dffa6c403554898b59a76762a732aaa448
+  metadata.gz: 3836d60ec7ec072655011df06539859dbbca90170c94a15a6f636537c486eba4
+  data.tar.gz: '01394e50e3759284559f635e5f2ef34d79a5b4716a6bbebbf07c383cffd14c41'
 SHA512:
-  metadata.gz: '018023551867526507d0b4a490a871c7b06e7bce17aedc87a1e6622d21fc5de212530fd34b94b4fc81fe45e618312433c5a4426969a27bd2144a9a84ee40c874'
-  data.tar.gz: 5d5c55850108f163260d34f0745e684efa15c922d22a9b417ac41272757c78b579656229ecf191d8e14e33b39cae015cc8fc876d8f4ccdd1fba99045e467a725
+  metadata.gz: 66603b9a15c9a6a5f34c1812969d32967d2755c60fe5470d225e13426bfec93f2ff6174a6675c15278fe99fe7d2fec17ae5dbf32d6ab4d9abc6c8bd96ba14166
+  data.tar.gz: 0c41cbcdf631c3d5528681b990cad4f36f1dce2ae029aa97ea6e6bbb6199b7af890470c4ca9358cd5152f267cf7f1797d10482e5d5f1e667ae2dce2434fd181f

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # CHANGELOG
 
+## 2.1.0 (2026-08-27)
+
+Steep 2.1 opens the running server to commands other than the editor's. `steep langserver` now binds
+the per-project UNIX socket that `steep server` serves, so `steep check` and `steep query` reach the
+language server the editor is already running instead of needing a daemon of their own, and the new
+`steep query diagnostics` reads the diagnostics that server has already computed rather than starting
+a type check of its own. Both are aimed at tools that edit files on disk and want fast feedback,
+coding agents in particular.
+
+The type checker gains support for Ruby 3.4's `it` block parameter, and RBS is updated to 4.2.0.
+
+### Type checker core
+
+* Infer tuple types for array literals against pair interface hints like `Hash::_Pair` ([#2253](https://github.com/soutaro/steep/pull/2253))
+* Accept a type alias as the type of a lambda's block parameter ([#2263](https://github.com/soutaro/steep/pull/2263))
+* Build expensive log tags only when something is logged ([#2271](https://github.com/soutaro/steep/pull/2271))
+* Accept block-pass arguments for optional blocks ([#2261](https://github.com/soutaro/steep/pull/2261))
+* feat: support the `it` block parameter ([#2238](https://github.com/soutaro/steep/pull/2238))
+* Fix `UnreachableBranch` on `==` against literal supertype (`Symbol` / `Integer` / `String`) ([#2223](https://github.com/soutaro/steep/pull/2223))
+
+### Commandline tool
+
+* Stop `steep query definition` from hanging on inline sources ([#2276](https://github.com/soutaro/steep/pull/2276))
+* Serve steep query/check through the language server's UNIX socket ([#2273](https://github.com/soutaro/steep/pull/2273))
+* Add `steep query diagnostics` ([#2274](https://github.com/soutaro/steep/pull/2274))
+* Point the Steepfile template, README and CLAUDE.md at rbs collection ([#2269](https://github.com/soutaro/steep/pull/2269))
+
+### Miscellaneous
+
+* Update RBS to 4.2.0 ([#2277](https://github.com/soutaro/steep/pull/2277))
+* Fix `bin/steep-check.rb` for the current API ([#2270](https://github.com/soutaro/steep/pull/2270))
+* Update RBS to 4.2.0.pre.1 ([#2267](https://github.com/soutaro/steep/pull/2267))
+* Fix Ruby warnings printed while running tests ([#2266](https://github.com/soutaro/steep/pull/2266))
+* Run test subprocesses outside the parent Bundler env ([#2225](https://github.com/soutaro/steep/pull/2225))
+
 ## 2.0.0 (2026-04-14)
 
 ### Summary

data/CLAUDE.md

@@ -98,8 +98,8 @@ bundle exec rake build
 **Steepfile**: Defines type checking targets
 - `check`: Directories to type check
 - `signature`: RBS signature directories
-- `library`: Standard library dependencies
-- `collection_config`: External RBS definitions
+- `library`: RBSs that rbs collection doesn't manage
+- `collection_config`: Path to `rbs_collection.yaml` (the project root one is read by default)
 - Multiple targets supported (app, test, bin)
 
 **RBS Collection**: Manages external type definitions via `rbs_collection.steep.yaml`

data/README.md

@@ -29,11 +29,11 @@ Edit the `Steepfile`:
 target :app do
   check "lib"
   signature "sig"
-
-  library "pathname"
 end
 ```
 
+RBSs for the gems in `Gemfile.lock` are loaded via [rbs collection](https://github.com/ruby/rbs/blob/master/docs/collection.md), which you set up with `rbs collection init` and `rbs collection install`. Add a `library` call only for an RBS that rbs collection doesn't manage.
+
 ### 1. Declare Types
 
 Declare types in `.rbs` files in `sig` directory.

data/bin/steep-check.rb

@@ -67,7 +67,7 @@ class Command
     target.options.load_collection_lock
 
     signature_service = Steep::Project::Target.construct_env_loader(options: target.options, project: project).yield_self do |loader|
-      Steep::Services::SignatureService.load_from(loader)
+      Steep::Services::SignatureService.load_from(loader, implicitly_returns_nil: target.implicitly_returns_nil)
     end
 
     env = signature_service.latest_env
@@ -76,8 +76,8 @@ class Command
 
     signature_files.each do |path, content|
       buffer = RBS::Buffer.new(name: path.to_s, content: content)
-      buffer, dirs, decls = RBS::Parser.parse_signature(buffer)
-      env.add_signature(buffer: buffer, directives: dirs, decls: decls)
+      _, dirs, decls = RBS::Parser.parse_signature(buffer)
+      env.add_source(RBS::Source::RBS.new(buffer, dirs, decls))
       new_decls.merge(decls)
     end
 
@@ -94,7 +94,7 @@ class Command
 
     definition_builder = RBS::DefinitionBuilder.new(env: env)
     factory = AST::Types::Factory.new(builder: definition_builder)
-    builder = Interface::Builder.new(factory)
+    builder = Interface::Builder.new(factory, implicitly_returns_nil: target.implicitly_returns_nil)
     subtyping = Subtyping::Check.new(builder: builder)
 
     typings = {}

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

@@ -4,7 +4,6 @@ module Steep
       module Helper
         module ChildrenLevel
           def level_of_children(children)
-            levels = children.map(&:level)
             children.map(&:level).sort {|a, b| (b.size <=> a.size) || 0 }.inject() do |a, b|
               a.zip(b).map do |x, y|
                 if x && y

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

@@ -88,7 +88,7 @@ module Steep
           def map_type(&block)
             args = self.args.map(&block)
 
-            _ = self.class.new(name: self.name, args: self.args)
+            _ = self.class.new(name: self.name, args: args)
           end
         end
 

data/lib/steep/cli.rb

@@ -355,6 +355,9 @@ Options:
 BANNER
           handle_steepfile_option(opts, command)
           opts.on("--refork") { command.refork = true }
+          opts.on("--[no-]command-socket", "Accept `steep query`/`steep check` connections on a UNIX socket (default: true)") do |v|
+            command.command_socket = v ? true : false
+          end
           handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
@@ -618,8 +621,9 @@ BANNER
               The user interface and output format may change without deprecation.
 
           Available subcommands:
-              hover      Get hover information (type, documentation) for a position
-              definition Get the definition(s) of a class, type alias, constant, or method name
+              hover       Get hover information (type, documentation) for a position
+              definition  Get the definition(s) of a class, type alias, constant, or method name
+              diagnostics Get the type check diagnostics the server has computed
 
           Options:
               --help    Show this help message
@@ -628,6 +632,7 @@ BANNER
               steep query hover lib/foo.rb:10:5
               steep query definition RBS::Location
               steep query definition RBS::Parser.parse_signature
+              steep query diagnostics lib/foo.rb sig/foo.rbs
         HELP
         return 0
       end
@@ -714,9 +719,33 @@ BANNER
         end
 
         Drivers::Query.new(stdout: stdout, stderr: stderr).run_definition(names: argv.dup)
+      when "diagnostics"
+        OptionParser.new do |opts|
+          opts.banner = <<BANNER
+Usage: steep query diagnostics [options] [FILE ...]
+
+Description:
+    Get the type check diagnostics the server has computed.
+    Connects to the running Steep server, reloads files changed on disk, waits for the
+    type checking to finish, and prints the diagnostics as JSONL (one JSON object per
+    line for each file).
+
+    When FILEs are given, only the diagnostics of those files are printed.
+    `"diagnostics": null` means the server has not type checked the file yet.
+
+Note:
+    This is an experimental command.
+    The user interface and output format may change without deprecation.
+
+Options:
+BANNER
+          handle_logging_options opts
+        end.parse!(argv)
+
+        Drivers::Query.new(stdout: stdout, stderr: stderr).run_diagnostics(paths: argv.dup)
       else
         stderr.puts "Unknown query subcommand: #{subcommand}"
-        stderr.puts "  available subcommands: hover, definition"
+        stderr.puts "  available subcommands: hover, definition, diagnostics"
         1
       end
     end

data/lib/steep/daemon.rb

@@ -43,18 +43,22 @@ module Steep
         false
       end
 
+      # Returns true when something is serving the socket, whether it is a daemon or a language server
+      #
+      # The socket is the only reliable signal: a language server records its pid elsewhere, so
+      # requiring `pid_path` here would hide it from `steep check` and `steep query`.
+      #
       def running?
-        return false unless File.exist?(pid_path) && File.exist?(socket_path)
+        return false unless File.exist?(socket_path)
 
-        pid = File.read(pid_path).to_i
-        Process.kill(0, pid)
         socket = UNIXSocket.new(socket_path)
         socket.close
         true
-      rescue Errno::ESRCH, Errno::ENOENT, Errno::ECONNREFUSED, Errno::ENOTSOCK
+      rescue Errno::ENOENT, Errno::ECONNREFUSED, Errno::ENOTSOCK
         false
       end
 
+
       def cleanup
         [socket_path, pid_path].each do |path|
           File.delete(path)
@@ -64,8 +68,13 @@ module Steep
       end
 
       def start(stderr:)
+        if pid = live_pid(pid_path)
+          stderr.puts "Steep server already running (PID: #{pid})"
+          return true
+        end
+
         if running?
-          stderr.puts "Steep server already running (PID: #{File.read(pid_path).strip})"
+          stderr.puts "Another process is already serving this project (e.g. `steep langserver`)"
           return true
         end
 
@@ -106,7 +115,12 @@ module Steep
 
       def stop(stderr:)
         unless File.exist?(pid_path)
-          stderr.puts "Steep server is not running"
+          if running?
+            stderr.puts "Steep server is not running. This project is served by another process"
+            stderr.puts "(e.g. `steep langserver`), which this command does not stop."
+          else
+            stderr.puts "Steep server is not running"
+          end
           return
         end
 
@@ -129,13 +143,29 @@ module Steep
         end
         cleanup
       rescue Errno::ESRCH
-        cleanup
-        stderr.puts "Steep server was not running (cleaned up stale files)"
+        # The pid file was stale. The socket may still belong to another live server,
+        # which `cleanup` would break by deleting it.
+        if running?
+          begin
+            File.delete(pid_path)
+          rescue Errno::ENOENT
+            # Already deleted
+          end
+          stderr.puts "Removed a stale pid file. This project is served by another process."
+        else
+          cleanup
+          stderr.puts "Steep server was not running (cleaned up stale files)"
+        end
       end
 
       def status(stderr:)
         if running?
-          pid = File.read(pid_path).to_i
+          unless pid = live_pid(pid_path)
+            stderr.puts "This project is served by another process (e.g. `steep langserver`)"
+            stderr.puts "  Socket: #{socket_path}"
+            return
+          end
+
           stderr.puts "Steep server running (PID: #{pid})"
           stderr.puts "  Socket: #{socket_path}"
           stderr.puts "  Log:    #{log_path}"
@@ -167,6 +197,16 @@ module Steep
 
       private
 
+      # The pid recorded in `path`, when the file exists and that process is alive
+      def live_pid(path)
+        pid = File.read(path).to_i
+        return nil unless pid > 0
+        Process.kill(0, pid)
+        pid
+      rescue Errno::ESRCH, Errno::ENOENT
+        nil
+      end
+
       def run_server(stderr:)
         project = load_project
         server = Server.new(config: config, project: project, stderr:)

data/lib/steep/drivers/init.rb

@@ -19,8 +19,9 @@ module Steep
       #   check "app/models/**/*.rb"        # Glob
       #   # ignore "lib/templates/*.rb"
       #
-      #   # library "pathname"              # Standard libraries
-      #   # library "strong_json"           # Gems
+      #   # RBSs for the gems in Gemfile.lock are loaded via rbs collection automatically.
+      #   # Set it up with `rbs collection init` and `rbs collection install`.
+      #   # library "monitor"               # Load an RBS that rbs collection doesn't manage
       #
       #   # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
       #   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
@@ -38,7 +39,7 @@ module Steep
       #
       #   configure_code_diagnostics(D::Ruby.lenient)      # Weak type checking for test code
       #
-      #   # library "pathname"              # Standard libraries
+      #   # library "monitor"               # Load an RBS that rbs collection doesn't manage
       # end
       EOF
 

data/lib/steep/drivers/langserver.rb

@@ -9,6 +9,7 @@ module Steep
       attr_reader :type_check_thread
       attr_reader :jobs_option
       attr_accessor :refork
+      attr_accessor :command_socket
 
       include Utils::DriverHelper
 
@@ -20,6 +21,7 @@ module Steep
         @type_check_queue = Queue.new
         @jobs_option = Utils::JobsOption.new(jobs_count_modifier: -1)
         @refork = false
+        @command_socket = true
       end
 
       def writer
@@ -50,10 +52,40 @@ module Steep
         )
         master.typecheck_automatically = true
 
-        master.start()
+        socket = start_command_socket(master)
+
+        begin
+          master.start()
+        ensure
+          socket&.stop
+        end
 
         0
       end
+
+      # Starts accepting `steep query`/`steep check` connections on the UNIX socket
+      #
+      # Returns `nil` when the command socket is disabled, is not supported on the platform,
+      # or is already served by another process.
+      #
+      def start_command_socket(master)
+        return nil unless command_socket
+
+        configuration = Daemon::Configuration.new(base_dir: project.base_dir.to_s)
+        socket = Server::CommandSocket.new(master: master, configuration: configuration)
+
+        if socket.start
+          stderr.puts "Steep command socket is ready: #{configuration.socket_path}"
+          socket
+        else
+          stderr.puts "Steep command socket is not available: #{configuration.socket_path}"
+          nil
+        end
+      rescue NotImplementedError, StandardError => error
+        Steep.logger.error { "Failed to start command socket: #{error.inspect}" }
+        stderr.puts "Failed to start Steep command socket: #{error.message}"
+        nil
+      end
     end
   end
 end

data/lib/steep/drivers/query.rb

@@ -15,7 +15,7 @@ module Steep
       # @rbs return: Integer
       def run_hover(locations:)
         unless Daemon.running?
-          stderr.puts "Error: Steep daemon is not running. Start it with `steep server start`."
+          stderr.puts "Error: Steep server is not running. Start it with `steep server start` or `steep langserver`."
           return 1
         end
 
@@ -51,7 +51,7 @@ module Steep
       # @rbs return: Integer
       def run_definition(names:)
         unless Daemon.running?
-          stderr.puts "Error: Steep daemon is not running. Start it with `steep server start`."
+          stderr.puts "Error: Steep server is not running. Start it with `steep server start` or `steep langserver`."
           return 1
         end
 
@@ -72,6 +72,44 @@ module Steep
         1
       end
 
+      def run_diagnostics(paths:)
+        unless Daemon.running?
+          stderr.puts "Error: Steep server is not running. Start it with `steep server start` or `steep langserver`."
+          return 1
+        end
+
+        absolute_paths = [] #: Array[Pathname]
+        paths.each do |path|
+          pathname = Pathname(path)
+          pathname = Pathname.pwd + pathname unless pathname.absolute?
+          absolute_paths << pathname
+        end
+
+        request = {
+          id: SecureRandom.uuid,
+          method: Server::CustomMethods::Query__Diagnostics::METHOD,
+          params: { paths: absolute_paths.empty? ? nil : absolute_paths.map(&:to_s) }
+        }
+
+        result = send_request(request) #: Array[{ uri: String, diagnostics: Array[untyped]? }]?
+
+        (result || []).each do |entry|
+          path = PathHelper.to_pathname(entry[:uri]) || Pathname(entry[:uri])
+          begin
+            path = path.relative_path_from(Pathname.pwd)
+          rescue ArgumentError
+            # Keep the absolute path of files outside of the current directory
+          end
+
+          stdout.puts JSON.generate({ path: path.to_s, diagnostics: entry[:diagnostics] })
+        end
+
+        0
+      rescue Errno::ECONNREFUSED, Errno::ENOENT => e
+        stderr.puts "Error: Failed to connect to Steep server: #{e.message}"
+        1
+      end
+
       private
 
       def to_absolute_path(path)

data/lib/steep/interface/builder.rb

@@ -65,7 +65,7 @@ module Steep
       end
 
       def shape(type, config)
-        Steep.logger.tagged "shape(#{type})" do
+        Steep.logger.tagged(-> { "shape(#{type})" }) do
           if shape = raw_shape(type, config)
             # Optimization that skips unnecessary substitution
             if type.free_variables.include?(AST::Types::Self.instance)
@@ -82,7 +82,7 @@ module Steep
       end
 
       def fetch_cache(cache, key)
-        if cache.key?(key) # steep:ignore ArgumentTypeMismatch
+        if cache.key?(key)
           return cache.fetch(key)
         end
 
@@ -277,7 +277,7 @@ module Steep
           definition = factory.definition_builder.build_singleton(type_name)
 
           definition.methods.each do |name, method|
-            Steep.logger.tagged "method = #{type_name}.#{name}" do
+            Steep.logger.tagged(-> { "method = #{type_name}.#{name}" }) do
               overloads = method.defs.map do |type_def|
                 method_name = method_name_for(type_def, name)
                 method_type = factory.method_type(type_def.type)
@@ -309,7 +309,7 @@ module Steep
           definition or raise
 
           definition.methods.each do |name, method|
-            Steep.logger.tagged "method = #{type_name}##{name}" do
+            Steep.logger.tagged(-> { "method = #{type_name}##{name}" }) do
               overloads = method.defs.map do |type_def|
                 method_name = method_name_for(type_def, name)
                 method_type = factory.method_type(type_def.type)
@@ -592,11 +592,31 @@ module Steep
           )
         end
 
+        to_ary_entry = Shape::Entry.new(
+          method_name: :to_ary,
+          private_method: false,
+          overloads: [
+            Shape::MethodOverload.new(
+              MethodType.new(
+                type_params: [],
+                type: Function.new(
+                  params: Function::Params.empty,
+                  return_type: tuple,
+                  location: nil
+                ),
+                block: nil
+              ),
+              []
+            )
+          ]
+        )
+
         shape.methods[:[]] = aref_entry
         shape.methods[:[]=] = aref_update_entry
         shape.methods[:fetch] = fetch_entry
         shape.methods[:first] = first_entry
         shape.methods[:last] = last_entry
+        shape.methods[:to_ary] = to_ary_entry
 
         shape
       end

data/lib/steep/server/base_worker.rb

@@ -56,6 +56,21 @@ module Steep
                     handle_job(job)
                   rescue => exn
                     Steep.log_error exn
+
+                    # Jobs that carry an `id` answer a request. Reply with an error response, or the
+                    # client would wait for a response that never arrives.
+                    if job.respond_to?(:id) && (id = job.id)
+                      writer.write(
+                        {
+                          id: id,
+                          error: {
+                            code: LSP::Constant::ErrorCodes::INTERNAL_ERROR,
+                            message: "Unexpected error: #{exn.message} (#{exn.class})"
+                          }
+                        }
+                      )
+                    end
+
                     writer.write(
                       {
                         method: "window/showMessage",