steep 1.8.3 → 1.9.0.dev.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97696cd49dd790a9b26f7682c1a1afc930ae0e16015b68f0a5b171851551f66
-  data.tar.gz: f2bb9e1a958fe0da3c8b92cf3710bbaeb2eaa6267e38717d46727583e4322638
+  metadata.gz: 89c207623c288c2142cdcf7d7de7f404da4d160b5bc40c84210116a721ec4029
+  data.tar.gz: dfd95e726115676f4d293d312bd1f06afa6ea89336911e9887c8e4b5ee1167ff
 SHA512:
-  metadata.gz: 69365a7f7bd5919a26bd769c7fa800b51845a93d7dbdbd5c436e72a510098168dbc3ed3d9699399b2a8f0d16f9066d0d3e0ffff835fef0bcf9bce96cfd04d8bf
-  data.tar.gz: 5de2dbf818393ec2544a189062f0cad66f5c1b348543ff58861f96f65db53aa55e4e9928f1898ae6afd386116124d4b8554df3180983afe771b6c46f1d77ac3f
+  metadata.gz: c9800ef17d4108ff391642510701e12a0ec4e63035c74765ed1203fa9b62d964be10441d60890ab3c643dc8d0295dd2a68be5285126307f3cb401f517eaa799f
+  data.tar.gz: 3ef2c5d7bac4dd2d492df8e5c60322de6c06d9c33cec21e2a97e4608f235e41729f0383e0817cfd324213853cad4c34308b14f5a582eedda71d36828545d6840

data/CHANGELOG.md

@@ -1,27 +1,5 @@
 # CHANGELOG
 
-## 1.8.3 (2024-10-29)
-
-### Type checker core
-
-* Fix untyped hash typing ([#1299](https://github.com/soutaro/steep/pull/1299), Backport in [#1301](https://github.com/soutaro/steep/pull/1301))
-
-### Language server
-
-* Handle file deletion notification ([#1300](https://github.com/soutaro/steep/pull/1300), Backport in [#1301](https://github.com/soutaro/steep/pull/1301))
-
-## 1.8.2 (2024-10-24)
-
-### Language server
-
-* Ignore `didChangeWatchedFiles notification` for open files ([#1290](https://github.com/soutaro/steep/pull/1290))
-
-## 1.8.1 (2024-10-08)
-
-### Language server
-
-* Skip sending response to `$/steep/typecheck` request from `steep langserver` ([#1268](https://github.com/soutaro/steep/pull/1268), backport [#1267](https://github.com/soutaro/steep/pull/1267))
-
 ## 1.8.0 (2024-09-30)
 
 ### Type checker core

data/Steepfile

@@ -1,42 +1,51 @@
 D = Steep::Diagnostic
 
+FileUtils.mkpath("tmp")
+tmp_rbs_dir = Pathname("tmp/rbs-sig")
+
+definition = Bundler::Definition.build(Pathname("Gemfile"), Pathname("Gemfile.lock"), nil)
+rbs_dep = definition.dependencies.find {|dep| dep.name == "rbs" }
+if (source = rbs_dep&.source).is_a?(Bundler::Source::Path)
+  unless tmp_rbs_dir.directory?
+    FileUtils.ln_s(Pathname.pwd + source.path + "sig", tmp_rbs_dir.to_s, force: true)
+  end
+else
+  FileUtils.rm_f(tmp_rbs_dir)
+  library "rbs"
+end
+
 target :app do
+  collection_config "rbs_collection.steep.yaml"
+
   check "lib"
   ignore "lib/steep/shims"
 
   signature "sig"
-
-  collection_config "rbs_collection.steep.yaml"
+  ignore_signature "sig/test"
 
   configure_code_diagnostics(D::Ruby.strict) do |hash|
   end
 
-  FileUtils.mkpath("tmp")
-  tmp_rbs_dir = File.join("tmp", "rbs-sig")
-
-  definition = Bundler::Definition.build(Pathname("Gemfile"), Pathname("Gemfile.lock"), nil)
-  rbs_dep = definition.dependencies.find {|dep| dep.name == "rbs" }
-  if (source = rbs_dep&.source).is_a?(Bundler::Source::Path)
-    unless Pathname(tmp_rbs_dir).exist?
-      FileUtils.ln_s(Pathname.pwd + source.path + "sig", tmp_rbs_dir, force: true)
-    end
-    signature tmp_rbs_dir
+  if tmp_rbs_dir.directory?
+    signature tmp_rbs_dir.to_s
   else
-    FileUtils.rm_f(tmp_rbs_dir)
     library "rbs"
   end
+end
+
+target :test do
+  collection_config "rbs_collection.steep.yaml"
+
+  unreferenced!
+
+  check "test"
+  signature "sig/test"
 
-  library(
-    "rdoc",
-    "monitor",
-    "tsort",
-    "uri",
-    'yaml',
-    'pstore',
-    'singleton',
-    'shellwords',
-    'find',
-    'digest',
-    "optparse",
-  )
+  configure_code_diagnostics(D::Ruby.lenient)
+
+  if tmp_rbs_dir.directory?
+    signature tmp_rbs_dir.to_s
+  else
+    library "rbs"
+  end
 end

data/bin/rbs-inline

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+BINSTUB_DIR=$(cd $(dirname $0); pwd)
+GEMFILE=$(readlink -f ${BINSTUB_DIR}/../gemfile_steep/Gemfile)
+ROOT_DIR=$(readlink -f ${BINSTUB_DIR}/..)
+
+RBSINLINE="bundle exec --gemfile=${GEMFILE} rbs-inline"
+
+if type "rbenv" > /dev/null 2>&1; then
+  RBSINLINE="rbenv exec ${RBSINLINE}"
+else
+  if type "rvm" > /dev/null 2>&1; then
+    if [ -e ${ROOT_DIR}/.ruby-version ]; then
+      RBS="rvm ${ROOT_DIR} do ${RBSINLINE}"
+    fi
+  fi
+fi
+
+exec $RBSINLINE $@

data/lib/steep/cli.rb

@@ -126,6 +126,39 @@ module Steep
           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
           end
+
+          opts.on("--group=GROUP", "Specify target/group name to type check") do |arg|
+            # @type var group: String
+            target, group = arg.split(".")
+            target or raise
+            command.active_group_names << [target.to_sym, group&.to_sym]
+          end
+
+          opts.on("--[no-]type-check", "Type check Ruby code") do |v|
+            command.type_check_code = v ? true : false
+          end
+
+          opts.on("--validate=OPTION", ["skip", "group", "project", "library"], "Validation levels of signatures (default: group, options: skip,group,project,library)") do |level|
+            case level
+            when "skip"
+              command.validate_group_signatures = false
+              command.validate_project_signatures = false
+              command.validate_library_signatures = false
+            when "group"
+              command.validate_group_signatures = true
+              command.validate_project_signatures = false
+              command.validate_library_signatures = false
+            when "project"
+              command.validate_group_signatures = true
+              command.validate_project_signatures = true
+              command.validate_library_signatures = false
+            when "library"
+              command.validate_group_signatures = true
+              command.validate_project_signatures = true
+              command.validate_library_signatures = true
+            end
+          end
+
           handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
@@ -179,11 +212,8 @@ module Steep
     end
 
     def process_validate
-      Drivers::Validate.new(stdout: stdout, stderr: stderr).tap do |command|
-        OptionParser.new do |opts|
-          handle_logging_options opts
-        end.parse!(argv)
-      end.run
+      stderr.puts "`steep validate` is deprecated. Use `steep check` with `--validate` option instead."
+      1
     end
 
     def process_annotations
@@ -202,6 +232,9 @@ module Steep
         OptionParser.new do |opts|
           opts.banner = "Usage: steep project [options]"
           opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          opts.on("--[no-]print-files", "Print files") {|v|
+            command.print_files = v ? true : false
+          }
           handle_logging_options opts
         end.parse!(argv)
       end.run

data/lib/steep/diagnostic/ruby.rb

@@ -458,22 +458,6 @@ module Steep
         end
       end
 
-      class IncompatibleMethodTypeAnnotation < Base
-        attr_reader :interface_method
-        attr_reader :annotation_method
-        attr_reader :result
-
-        include ResultPrinter
-
-        def initialize(node:, interface_method:, annotation_method:, result:)
-          raise
-          super(node: node)
-          @interface_method = interface_method
-          @annotation_method = annotation_method
-          @result = result
-        end
-      end
-
       class MethodReturnTypeAnnotationMismatch < Base
         attr_reader :method_type
         attr_reader :annotation_type
@@ -697,25 +681,6 @@ module Steep
         end
       end
 
-      class IncompatibleTypeCase < Base
-        attr_reader :var_name
-        attr_reader :result
-        attr_reader :relation
-
-        def initialize(node:, var_name:, result:, relation:)
-          super(node: node)
-          @var_name = var_name
-          @result = result
-          @relation = relation
-        end
-
-        include ResultPrinter
-
-        def header_line
-          "Type annotation for branch about `#{var_name}` is incompatible since #{relation} doesn't hold"
-        end
-      end
-
       class UnreachableBranch < Base
         def header_line
           "The branch is unreachable"
@@ -735,19 +700,6 @@ module Steep
         end
       end
 
-      class UnexpectedSplat < Base
-        attr_reader :type
-
-        def initialize(node:, type:)
-          super(node: node)
-          @type = type
-        end
-
-        def header_line
-          "Hash splat is given with object other than `Hash[X, Y]`"
-        end
-      end
-
       class ProcTypeExpected < Base
         attr_reader :type
 
@@ -965,6 +917,13 @@ module Steep
         end
       end
 
+      class UnannotatedEmptyCollection < Base
+        def header_line
+          node or raise
+          "Empty #{node.type} doesn't have type annotation"
+        end
+      end
+
       ALL = ObjectSpace.each_object(Class).with_object([]) do |klass, array|
         if klass < Base
           array << klass
@@ -991,8 +950,6 @@ module Steep
             IncompatibleAnnotation => :hint,
             IncompatibleArgumentForwarding => :warning,
             IncompatibleAssignment => :hint,
-            IncompatibleMethodTypeAnnotation => :hint,
-            IncompatibleTypeCase => :hint,
             InsufficientKeywordArguments => :error,
             InsufficientPositionalArguments => :error,
             InsufficientTypeArgument => :hint,
@@ -1013,6 +970,7 @@ module Steep
             SetterReturnTypeMismatch => :information,
             SyntaxError => :hint,
             TypeArgumentMismatchError => :hint,
+            UnannotatedEmptyCollection => :warning,
             UnexpectedBlockGiven => :warning,
             UnexpectedDynamicMethod => :hint,
             UnexpectedError => :hint,
@@ -1020,7 +978,6 @@ module Steep
             UnexpectedJumpValue => :hint,
             UnexpectedKeywordArgument => :error,
             UnexpectedPositionalArgument => :error,
-            UnexpectedSplat => :hint,
             UnexpectedSuper => :information,
             UnexpectedTypeArgument => :hint,
             UnexpectedYield => :warning,
@@ -1050,8 +1007,6 @@ module Steep
             IncompatibleAnnotation => :error,
             IncompatibleArgumentForwarding => :error,
             IncompatibleAssignment => :error,
-            IncompatibleMethodTypeAnnotation => :error,
-            IncompatibleTypeCase => :error,
             InsufficientKeywordArguments => :error,
             InsufficientPositionalArguments => :error,
             InsufficientTypeArgument => :error,
@@ -1072,6 +1027,7 @@ module Steep
             SetterReturnTypeMismatch => :error,
             SyntaxError => :hint,
             TypeArgumentMismatchError => :error,
+            UnannotatedEmptyCollection => :error,
             UnexpectedBlockGiven => :error,
             UnexpectedDynamicMethod => :information,
             UnexpectedError => :information,
@@ -1079,7 +1035,6 @@ module Steep
             UnexpectedJumpValue => :error,
             UnexpectedKeywordArgument => :error,
             UnexpectedPositionalArgument => :error,
-            UnexpectedSplat => :warning,
             UnexpectedSuper => :error,
             UnexpectedTypeArgument => :error,
             UnexpectedYield => :error,
@@ -1109,8 +1064,6 @@ module Steep
             IncompatibleAnnotation => nil,
             IncompatibleArgumentForwarding => :information,
             IncompatibleAssignment => :hint,
-            IncompatibleMethodTypeAnnotation => nil,
-            IncompatibleTypeCase => nil,
             InsufficientKeywordArguments => :information,
             InsufficientPositionalArguments => :information,
             InsufficientTypeArgument => nil,
@@ -1131,6 +1084,7 @@ module Steep
             SetterReturnTypeMismatch => nil,
             SyntaxError => :hint,
             TypeArgumentMismatchError => nil,
+            UnannotatedEmptyCollection => :hint,
             UnexpectedBlockGiven => :hint,
             UnexpectedDynamicMethod => nil,
             UnexpectedError => :hint,
@@ -1138,7 +1092,6 @@ module Steep
             UnexpectedJumpValue => nil,
             UnexpectedKeywordArgument => :information,
             UnexpectedPositionalArgument => :information,
-            UnexpectedSplat => nil,
             UnexpectedSuper => nil,
             UnexpectedTypeArgument => nil,
             UnexpectedYield => :information,
@@ -1155,7 +1108,7 @@ module Steep
       end
 
       def self.silent
-        @silent ||= ALL.each.with_object({}) do |klass, hash|
+        @silent ||= ALL.each.with_object({}) do |klass, hash| #$ template
           hash[klass] = nil
         end.freeze
       end

data/lib/steep/drivers/annotations.rb

@@ -21,7 +21,7 @@ module Steep
 
         project.targets.each do |target|
           Steep.logger.tagged "target=#{target.name}" do
-            service = Services::SignatureService.load_from(target.new_env_loader(project: project))
+            service = Services::SignatureService.load_from(target.new_env_loader())
 
             sigs = loader.load_changes(target.signature_pattern, changes: {})
             service.update(sigs)

data/lib/steep/drivers/check.rb

@@ -10,6 +10,12 @@ module Steep
       attr_accessor :save_expectations_path
       attr_accessor :severity_level
       attr_reader :jobs_option
+      attr_reader :targets
+      attr_reader :active_group_names
+      attr_accessor :type_check_code
+      attr_accessor :validate_group_signatures
+      attr_accessor :validate_project_signatures
+      attr_accessor :validate_library_signatures
 
       include Utils::DriverHelper
 
@@ -19,6 +25,27 @@ module Steep
         @command_line_patterns = []
         @severity_level = :warning
         @jobs_option = Utils::JobsOption.new()
+        @active_group_names = []
+        @type_check_code = true
+        @validate_group_signatures = true
+        @validate_project_signatures = false
+        @validate_library_signatures = false
+      end
+
+      def active_group?(group)
+        return true if active_group_names.empty?
+
+        case group
+        when Project::Target
+          active_group_names.any? {|target_name, group_name|
+            target_name == group.name && group_name == nil
+          }
+        when Project::Group
+          active_group_names.any? {|target_name, group_name|
+            target_name == group.target.name &&
+              (group_name == group.name || group_name.nil?)
+          }
+        end
       end
 
       def run
@@ -64,9 +91,54 @@ module Steep
         client_writer.write({ method: :initialize, id: initialize_id, params: DEFAULT_CLI_LSP_INITIALIZE_PARAMS })
         wait_for_response_id(reader: client_reader, id: initialize_id)
 
+        params = { library_paths: [], signature_paths: [], code_paths: [] } #: Server::CustomMethods::TypeCheck::params
+
+        if command_line_patterns.empty?
+          files = Server::TargetGroupFiles.new(project)
+          loader = Services::FileLoader.new(base_dir: project.base_dir)
+
+          project.targets.each do |target|
+            target.new_env_loader.each_dir do |_, dir|
+              RBS::FileFinder.each_file(dir, skip_hidden: true) do |path|
+                files.add_library_path(target, path)
+              end
+            end
+
+            loader.each_path_in_target(target) do |path|
+              files.add_path(path)
+            end
+          end
+
+          project.targets.each do |target|
+            target.groups.each do |group|
+              if active_group?(group)
+                load_files(files, group.target, group, params: params)
+              end
+            end
+            if active_group?(target)
+              load_files(files, target, target, params: params)
+            end
+          end
+        else
+          command_line_patterns.each do |pattern|
+            path = Pathname(pattern)
+            path = project.absolute_path(path)
+            next unless path.file?
+            if target = project.target_for_source_path(path)
+              params[:code_paths] << [target.name.to_s, path.to_s]
+            end
+            if target = project.target_for_signature_path(path)
+              params[:signature_paths] << [target.name.to_s, path.to_s]
+            end
+          end
+        end
+
+        Steep.logger.info { "Starting type check with #{params[:code_paths].size} Ruby files and #{params[:signature_paths].size} RBS signatures..." }
+        Steep.logger.debug { params.inspect }
+
         request_guid = SecureRandom.uuid
         Steep.logger.info { "Starting type checking: #{request_guid}" }
-        client_writer.write(Server::CustomMethods::TypeCheck.request(request_guid, { guid: request_guid}))
+        client_writer.write(Server::CustomMethods::TypeCheck.request(request_guid, params))
 
         diagnostic_notifications = [] #: Array[LanguageServer::Protocol::Interface::PublishDiagnosticsParams]
         error_messages = [] #: Array[String]
@@ -132,6 +204,36 @@ module Steep
         return 1
       end
 
+      def load_files(files, target, group, params:)
+        if type_check_code
+          files.each_group_source_path(group) do |path|
+            params[:code_paths] << [target.name.to_s, target.project.absolute_path(path).to_s]
+          end
+        end
+        if validate_group_signatures
+          files.each_group_signature_path(group) do |path|
+            params[:signature_paths] << [target.name.to_s, target.project.absolute_path(path).to_s]
+          end
+        end
+        if validate_project_signatures
+          files.each_project_signature_path(target) do |path|
+            if path_target = files.signature_path_target(path)
+              params[:signature_paths] << [path_target.name.to_s, target.project.absolute_path(path).to_s]
+            end
+          end
+          if group.is_a?(Project::Group)
+            files.each_target_signature_path(target, group) do |path|
+              params[:signature_paths] << [target.name.to_s, target.project.absolute_path(path).to_s]
+            end
+          end
+        end
+        if validate_library_signatures
+          files.each_library_path(target) do |path|
+            params[:library_paths] << [target.name.to_s, path.to_s]
+          end
+        end
+      end
+
       def print_expectations(project:, all_files:, expectations_path:, notifications:)
         expectations = Expectations.load(path: expectations_path, content: expectations_path.read)
 

data/lib/steep/drivers/checkfile.rb

@@ -53,7 +53,7 @@ module Steep
               nil
             else
               command_line_args
-            end
+            end #: Array[String]?
 
           if ruby_patterns
             loader.each_path_in_patterns(target.source_pattern, ruby_patterns) do |path|
@@ -69,7 +69,7 @@ module Steep
               nil
             else
               command_line_args
-            end
+            end #: Array[String]
 
           if rbs_patterns
             loader.each_path_in_patterns(target.signature_pattern, rbs_patterns) do |path|
@@ -79,10 +79,10 @@ module Steep
         end
 
         stdin_input.each_key do |path|
-          case ts = project.targets_for_path(path)
-          when Array
+          case
+          when project.target_for_signature_path(path)
             signature_paths << path
-          when Project::Target
+          when project.target_for_source_path(path)
             target_paths << path
           end
         end
@@ -156,13 +156,15 @@ module Steep
 
         request_guid = master.fresh_request_id()
         progress = master.work_done_progress(request_guid)
-        request = Server::Master::TypeCheckRequest.new(guid: request_guid, progress: progress)
+        request = Server::TypeCheckController::Request.new(guid: request_guid, progress: progress)
 
         target_paths.each do |path|
-          request.code_paths << project.absolute_path(path)
+          target = project.target_for_source_path(path) or next
+          request.code_paths << [target.name, project.absolute_path(path)]
         end
         signature_paths.each do |path|
-          request.signature_paths << project.absolute_path(path)
+          target = project.target_for_signature_path(path) or next
+          request.signature_paths << [target.name, project.absolute_path(path)]
         end
 
         request.needs_response = true