steep 1.8.2 → 1.9.0.dev.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f40f4acb0e71a6cfd2b751297f2fc1a9cd18a87545d24cec51c0da5f1e9792e
-  data.tar.gz: 947ea73b078a7c1b9dc37e2855a6e483d1bbc919414b97226a3393bf92cb6bf8
+  metadata.gz: 37bf13501b4d8d6e4b6fa5b0702e0a978a6488e674832e36168070788c1b3367
+  data.tar.gz: 6184ef95ab4f594841ee4d7ef775a68df571bb21b981beff18e0a7cddd53ae7e
 SHA512:
-  metadata.gz: b146bd6a93a59b5ec7a3029b061fc352c1e93c9bd87cfac89783b9a54175f076bc208a6f94adc32fa2a1802fdc94a422f1c64fbca555eb5ad93481ce7ff88b5d
-  data.tar.gz: d746bee9df6ab60f43811ec81a415348927bde046cba2cf7b2dd5e4204438e9dc317456ed9d61358fbbfe22125c569451687b9d528b17d1792e470e29dac43c1
+  metadata.gz: b1d51f5e77be8d2ea4ddb45982e2e4515afcb16453784feef442ec618ea9584bf75a52f12654ef63283367dc1d5a3cd5e10be71cd3e02f9cde71566402f86ed0
+  data.tar.gz: 92e5a0e27efbf0cfc629ed7fbce8576e8a8657c6abd5abc8b11f4e51c7087d2ca2d36c6ba7415ce9d1d53ea994e42068a857cbabb7a64940ec476321346a2829

data/CHANGELOG.md

@@ -1,17 +1,5 @@
 # CHANGELOG
 
-## 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

@@ -25,18 +25,4 @@ target :app do
     FileUtils.rm_f(tmp_rbs_dir)
     library "rbs"
   end
-
-  library(
-    "rdoc",
-    "monitor",
-    "tsort",
-    "uri",
-    'yaml',
-    'pstore',
-    'singleton',
-    'shellwords',
-    'find',
-    'digest',
-    "optparse",
-  )
 end

data/lib/steep/cli.rb

@@ -126,6 +126,48 @@ 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", "target", "project", "library"], "Validation levels of signatures (default: group, options: skip,group,target,project,library)") do |level|
+            case level
+            when "skip"
+              command.validate_group_signatures = false
+              command.validate_target_signatures = false
+              command.validate_project_signatures = false
+              command.validate_library_signatures = false
+            when "group"
+              command.validate_group_signatures = true
+              command.validate_target_signatures = false
+              command.validate_project_signatures = false
+              command.validate_library_signatures = false
+            when "target"
+              command.validate_group_signatures = true
+              command.validate_target_signatures = true
+              command.validate_project_signatures = false
+              command.validate_library_signatures = false
+            when "project"
+              command.validate_group_signatures = true
+              command.validate_target_signatures = true
+              command.validate_project_signatures = true
+              command.validate_library_signatures = false
+            when "library"
+              command.validate_group_signatures = true
+              command.validate_target_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 +221,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 +241,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
 
@@ -991,8 +943,6 @@ module Steep
             IncompatibleAnnotation => :hint,
             IncompatibleArgumentForwarding => :warning,
             IncompatibleAssignment => :hint,
-            IncompatibleMethodTypeAnnotation => :hint,
-            IncompatibleTypeCase => :hint,
             InsufficientKeywordArguments => :error,
             InsufficientPositionalArguments => :error,
             InsufficientTypeArgument => :hint,
@@ -1020,7 +970,6 @@ module Steep
             UnexpectedJumpValue => :hint,
             UnexpectedKeywordArgument => :error,
             UnexpectedPositionalArgument => :error,
-            UnexpectedSplat => :hint,
             UnexpectedSuper => :information,
             UnexpectedTypeArgument => :hint,
             UnexpectedYield => :warning,
@@ -1050,8 +999,6 @@ module Steep
             IncompatibleAnnotation => :error,
             IncompatibleArgumentForwarding => :error,
             IncompatibleAssignment => :error,
-            IncompatibleMethodTypeAnnotation => :error,
-            IncompatibleTypeCase => :error,
             InsufficientKeywordArguments => :error,
             InsufficientPositionalArguments => :error,
             InsufficientTypeArgument => :error,
@@ -1079,7 +1026,6 @@ module Steep
             UnexpectedJumpValue => :error,
             UnexpectedKeywordArgument => :error,
             UnexpectedPositionalArgument => :error,
-            UnexpectedSplat => :warning,
             UnexpectedSuper => :error,
             UnexpectedTypeArgument => :error,
             UnexpectedYield => :error,
@@ -1109,8 +1055,6 @@ module Steep
             IncompatibleAnnotation => nil,
             IncompatibleArgumentForwarding => :information,
             IncompatibleAssignment => :hint,
-            IncompatibleMethodTypeAnnotation => nil,
-            IncompatibleTypeCase => nil,
             InsufficientKeywordArguments => :information,
             InsufficientPositionalArguments => :information,
             InsufficientTypeArgument => nil,
@@ -1138,7 +1082,6 @@ module Steep
             UnexpectedJumpValue => nil,
             UnexpectedKeywordArgument => :information,
             UnexpectedPositionalArgument => :information,
-            UnexpectedSplat => nil,
             UnexpectedSuper => nil,
             UnexpectedTypeArgument => nil,
             UnexpectedYield => :information,
@@ -1155,7 +1098,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,13 @@ 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_target_signatures
+      attr_accessor :validate_project_signatures
+      attr_accessor :validate_library_signatures
 
       include Utils::DriverHelper
 
@@ -19,6 +26,28 @@ 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_target_signatures = false
+        @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 +93,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 +206,38 @@ 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_target_signatures
+          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_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
+        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

data/lib/steep/drivers/print_project.rb

@@ -1,68 +1,111 @@
+require "active_support/core_ext/hash/keys"
+
 module Steep
   module Drivers
     class PrintProject
       attr_reader :stdout
       attr_reader :stderr
 
+      attr_accessor :print_files
+      attr_reader :files
+
       include Utils::DriverHelper
 
       def initialize(stdout:, stderr:)
         @stdout = stdout
         @stderr = stderr
+        @print_files = false
       end
 
-      def run
-        project = load_config()
-
-        loader = Services::FileLoader.new(base_dir: project.base_dir)
-
-        project.targets.each do |target|
-          source_changes = loader.load_changes(target.source_pattern, changes: {})
-          signature_changes = loader.load_changes(target.signature_pattern, changes: {})
-
-          stdout.puts "Target:"
-          stdout.puts "  #{target.name}:"
-          stdout.puts "    sources:"
-          stdout.puts "      patterns:"
-          target.source_pattern.patterns.each do |pattern|
-            stdout.puts "        - #{pattern}"
-          end
-          stdout.puts "      ignores:"
-          target.source_pattern.ignores.each do |pattern|
-            stdout.puts "        - #{pattern}"
-          end
-          stdout.puts "      files:"
-          source_changes.each_key do |path|
-            stdout.puts "        - #{path}"
+      def as_json(project)
+        {
+          steepfile: project.steepfile_path.to_s,
+          targets: project.targets.map do |target|
+            target_as_json(target)
           end
-          stdout.puts "    signatures:"
-          stdout.puts "      patterns:"
-          target.signature_pattern.patterns.each do |pattern|
-            stdout.puts "        - #{pattern}"
-          end
-          stdout.puts "      files:"
-          signature_changes.each_key do |path|
-            stdout.puts "        - #{path}"
-          end
-          stdout.puts "    libraries:"
-          target.options.libraries.each do |lib|
-            stdout.puts "      - #{lib}"
-          end
-          stdout.puts "    library dirs:"
-          target.new_env_loader(project: project).tap do |loader|
+        }.stringify_keys
+      end
+
+      def target_as_json(target)
+        json = {
+          "name" => target.name.to_s,
+          "source_pattern" => pattern_as_json(target.source_pattern),
+          "signature_pattern" => pattern_as_json(target.signature_pattern),
+          "groups" => target.groups.map do |group|
+            group_as_json(group)
+          end,
+          "libraries" => target.new_env_loader().yield_self do |loader|
+            libs = [] #: Array[library_json]
             loader.each_dir do |lib, path|
               case lib
               when :core
-                stdout.puts "      - core: #{path}"
+                libs << { "name" => "__core__", "path" => path.to_s }
               when Pathname
                 raise "Unexpected pathname from loader: path=#{path}"
               else
-                stdout.puts "      - #{lib.name}(#{lib.version}): #{path}"
+                libs << { "name" => lib.name, "version" => lib.version, "path" => path.to_s }
               end
             end
+            libs
+          end,
+          "unreferenced" => target.unreferenced
+        } #: target_json
+
+        if files
+          files.each_group_signature_path(target, true) do |path|
+            (json["signature_paths"] ||= []) << path.to_s
+          end
+          files.each_group_source_path(target, true) do |path|
+            (json["source_paths"] ||= []) << path.to_s
           end
         end
 
+        json
+      end
+
+      def group_as_json(group)
+        json = {
+          "name" => group.name.to_s,
+          "source_pattern" => pattern_as_json(group.source_pattern),
+          "signature_pattern" => pattern_as_json(group.signature_pattern)
+        } #: group_json
+
+        if files
+          files.each_group_signature_path(group, true) do |path|
+            (json["signature_paths"] ||= []) << path.to_s
+
+          end
+          files.each_group_source_path(group, true) do |path|
+            (json["source_paths"] ||= []) << path.to_s
+          end
+        end
+
+        json
+      end
+
+      def pattern_as_json(pattern)
+        {
+          "pattern" => pattern.patterns,
+          "ignore" => pattern.ignores
+        }
+      end
+
+      def run
+        project = load_config()
+        if print_files
+          loader = Services::FileLoader.new(base_dir: project.base_dir)
+          @files = files = Server::TargetGroupFiles.new(project)
+          project.targets.each do |target|
+            loader.each_path_in_target(target) do |path|
+              files.add_path(path)
+            end
+          end
+        else
+          @files = nil
+        end
+
+        stdout.puts YAML.dump(as_json(project))
+
         0
       end
     end

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

@@ -13,9 +13,11 @@ module Steep
           else
             Steep.ui_logger.error { "Cannot find a configuration at #{path}: `steep init` to scaffold. Using current directory..." }
             Project.new(steepfile_path: nil, base_dir: Pathname.pwd).tap do |project|
-              Project::DSL.new(project: project).target :'.' do
-                check '.'
-                signature '.'
+              Project::DSL.eval(project) do
+                target :'.' do
+                  check '.'
+                  signature '.'
+                end
               end
             end
           end.tap do |project|

data/lib/steep/drivers/watch.rb

@@ -112,7 +112,19 @@ module Steep
             end
           end
 
-          client_writer.write(Server::CustomMethods::TypeCheck.request(SecureRandom.uuid, { guid: nil }))
+          params = { library_paths: [], signature_paths: [], code_paths: [] } #: Server::CustomMethods::TypeCheck::params
+
+          (modified + added).each do |path|
+            path = Pathname(path)
+            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
+
+          client_writer.write(Server::CustomMethods::TypeCheck.request(SecureRandom.uuid, params))
 
           stdout.puts Rainbow("done!").bold
         end.tap(&:start)
@@ -120,7 +132,17 @@ module Steep
         begin
           stdout.puts Rainbow("👀 Watching directories, Ctrl-C to stop.").bold
 
-          client_writer.write(Server::CustomMethods::TypeCheck.request(SecureRandom.uuid, { guid: nil }))
+          params = { library_paths: [], signature_paths: [], code_paths: [] } #: Server::CustomMethods::TypeCheck::params
+          file_loader = Services::FileLoader.new(base_dir: project.base_dir)
+          project.targets.each do |target|
+            file_loader.each_path_in_patterns(target.source_pattern, dirs.map(&:to_s)) do |path|
+              params[:code_paths] << [target.name.to_s, project.absolute_path(path).to_s]
+            end
+            file_loader.each_path_in_patterns(target.signature_pattern, dirs.map(&:to_s)) do |path|
+              params[:signature_paths] << [target.name.to_s, project.absolute_path(path).to_s]
+            end
+          end
+          client_writer.write(Server::CustomMethods::TypeCheck.request(SecureRandom.uuid, params))
 
           client_reader.read do |response|
             case response[:method]