steep 0.44.1 → 0.47.1

data/lib/steep/project/dsl.rb

@@ -7,21 +7,34 @@ module Steep
         attr_reader :libraries
         attr_reader :signatures
         attr_reader :ignored_sources
-        attr_reader :vendor_dir
-        attr_reader :strictness_level
-        attr_reader :typing_option_hash
+        attr_reader :stdlib_root
+        attr_reader :core_root
         attr_reader :repo_paths
+        attr_reader :code_diagnostics_config
+        attr_reader :project
+        attr_reader :collection_config_path
 
-        def initialize(name, sources: [], libraries: [], signatures: [], ignored_sources: [], repo_paths: [])
+        NONE = Object.new.freeze
+
+        def initialize(name, sources: [], libraries: [], signatures: [], ignored_sources: [], repo_paths: [], code_diagnostics_config: {}, project: nil, collection_config_path: NONE)
           @name = name
           @sources = sources
           @libraries = libraries
           @signatures = signatures
           @ignored_sources = ignored_sources
-          @vendor_dir = nil
-          @strictness_level = :default
-          @typing_option_hash = {}
+          @core_root = nil
+          @stdlib_root = nil
           @repo_paths = []
+          @code_diagnostics_config = code_diagnostics_config
+          @project = project
+          @collection_config_path =
+            case collection_config_path
+            when NONE
+              path = project&.absolute_path(RBS::Collection::Config::PATH)
+              path&.exist? ? path : nil
+            else
+              collection_config_path
+            end
         end
 
         def initialize_copy(other)
@@ -30,10 +43,12 @@ module Steep
           @libraries = other.libraries.dup
           @signatures = other.signatures.dup
           @ignored_sources = other.ignored_sources.dup
-          @vendor_dir = other.vendor_dir
-          @strictness_level = other.strictness_level
-          @typing_option_hash = other.typing_option_hash
           @repo_paths = other.repo_paths.dup
+          @core_root = other.core_root
+          @stdlib_root = other.stdlib_root
+          @code_diagnostics_config = other.code_diagnostics_config.dup
+          @project = other.project
+          @collection_config_path = other.collection_config_path
         end
 
         def check(*args)
@@ -48,40 +63,122 @@ module Steep
           libraries.push(*args)
         end
 
-        def typing_options(level = @strictness_level, **hash)
-          @strictness_level = level
-          @typing_option_hash = hash
+        def typing_options(level = nil, **hash)
+          Steep.logger.error "#typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting:"
+
+          messages = []
+
+          messages << "# D = Steep::Diagnostic                          # Define a constant to shorten namespace"
+
+          case level
+          when :strict
+            messages << "configure_code_diagnostics(D::Ruby.strict)       # :strict"
+          when :default
+            messages << "configure_code_diagnostics(D::Ruby.default)      # :default"
+          when :lenient
+            messages << "configure_code_diagnostics(D::Ruby.lenient)      # :lenient"
+          end
+
+          messages.each do |msg|
+            Steep.logger.error "  #{msg}"
+          end
+
+          config = []
+
+          if hash[:allow_missing_definitions]
+            config << "hash[D::Ruby::MethodDefinitionMissing] = nil   # allow_missing_definitions"
+          end
+
+          if hash[:allow_fallback_any]
+            config << "hash[D::Ruby::FallbackAny] = nil               # allow_fallback_any"
+          end
+
+          if hash[:allow_unknown_constant_assignment]
+            config << "hash[D::Ruby::UnknownConstantAssigned] = nil   # allow_unknown_constant_assignment"
+          end
+
+          if hash[:allow_unknown_method_calls]
+            config << "hash[D::Ruby::NoMethod] = nil                  # allow_unknown_method_calls"
+          end
+
+          unless config.empty?
+            Steep.logger.error "  configure_code_diagnostics do |hash|"
+            config.each do |c|
+              Steep.logger.error "    #{c}"
+            end
+            Steep.logger.error "  end"
+          end
+
         end
 
         def signature(*args)
           signatures.push(*args)
         end
 
-        def update(name: self.name, sources: self.sources, libraries: self.libraries, ignored_sources: self.ignored_sources, signatures: self.signatures)
+        def update(name: self.name, sources: self.sources, libraries: self.libraries, ignored_sources: self.ignored_sources, signatures: self.signatures, project: self.project)
           self.class.new(
             name,
             sources: sources,
             libraries: libraries,
             signatures: signatures,
-            ignored_sources: ignored_sources
+            ignored_sources: ignored_sources,
+            project: project,
           )
         end
 
         def no_builtin!(value = true)
-          Steep.logger.error "`no_builtin!` in Steepfile is deprecated and ignored. Use `vendor` instead."
+          Steep.logger.error "`#no_builtin!` in Steepfile is deprecated and ignored. Use `#stdlib_path` instead."
         end
 
         def vendor(dir = "vendor/sigs", stdlib: nil, gems: nil)
-          if stdlib || gems
-            Steep.logger.warn { "#vendor with stdlib: or gems: keyword is deprecated." }
-          end
+          Steep.logger.error "`#vendor` in Steepfile is deprecated and ignored. Use `#stdlib_path` instead."
+        end
 
-          @vendor_dir = Pathname(dir)
+        def stdlib_path(core_root:, stdlib_root:)
+          @core_root = core_root ? Pathname(core_root) : core_root
+          @stdlib_root = stdlib_root ? Pathname(stdlib_root) : stdlib_root
         end
 
         def repo_path(*paths)
           @repo_paths.push(*paths.map {|s| Pathname(s) })
         end
+
+        # Configure the code diagnostics printing setup.
+        #
+        # Yields a hash, and the update the hash in the block.
+        #
+        # ```rb
+        # D = Steep::Diagnostic
+        #
+        # configure_code_diagnostics do |hash|
+        #   # Assign one of :error, :warning, :information, :hint or :nil to error classes.
+        #   hash[D::Ruby::UnexpectedPositionalArgument] = :error
+        # end
+        # ```
+        #
+        # Passing a hash is also allowed.
+        #
+        # ```rb
+        # D = Steep::Diagnostic
+        #
+        # configure_code_diagnostics(D::Ruby.lenient)
+        # ```
+        #
+        def configure_code_diagnostics(hash = nil)
+          if hash
+            code_diagnostics_config.merge!(hash)
+          end
+
+          yield code_diagnostics_config if block_given?
+        end
+
+        def collection_config(path)
+          @collection_config_path = project.absolute_path(path)
+        end
+
+        def disable_collection
+          @collection_config_path = nil
+        end
       end
 
       attr_reader :project
@@ -107,40 +204,42 @@ module Steep
       end
 
       def self.parse(project, code, filename: "Steepfile")
-        self.new(project: project).instance_eval(code, filename)
+        Steep.logger.tagged filename do
+          self.new(project: project).instance_eval(code, filename)
+        end
       end
 
       def target(name, template: nil, &block)
         target = if template
-                   self.class.templates[template]&.dup&.update(name: name) or
+                   self.class.templates[template]&.dup&.update(name: name, project: project) or
                      raise "Unknown template: #{template}, available templates: #{@@templates.keys.join(", ")}"
                  else
-                   TargetDSL.new(name)
+                   TargetDSL.new(name, code_diagnostics_config: Diagnostic::Ruby.default.dup, project: project)
                  end
 
-        target.instance_eval(&block) if block_given?
+        Steep.logger.tagged "target=#{name}" do
+          target.instance_eval(&block) if block_given?
+        end
 
         source_pattern = Pattern.new(patterns: target.sources, ignores: target.ignored_sources, ext: ".rb")
         signature_pattern = Pattern.new(patterns: target.signatures, ext: ".rbs")
 
+        collection_lock = target.collection_config_path&.then { |p| RBS::Collection::Config.lockfile_of(p) }
+
         Project::Target.new(
           name: target.name,
           source_pattern: source_pattern,
           signature_pattern: signature_pattern,
           options: Options.new.tap do |options|
             options.libraries.push(*target.libraries)
-            options.repository_paths.push(*target.repo_paths)
-            options.vendor_path = target.vendor_dir
-
-            case target.strictness_level
-            when :strict
-              options.apply_strict_typing_options!
-            when :lenient
-              options.apply_lenient_typing_options!
-            end
-
-            options.merge!(target.typing_option_hash)
-          end
+            options.paths = Options::PathOptions.new(
+              core_root: target.core_root,
+              stdlib_root: target.stdlib_root,
+              repo_paths: target.repo_paths
+            )
+            options.collection_lock = collection_lock
+          end,
+          code_diagnostics_config: target.code_diagnostics_config
         ).tap do |target|
           project.targets << target
         end

data/lib/steep/project/options.rb

@@ -1,63 +1,23 @@
 module Steep
   class Project
     class Options
-      attr_accessor :allow_fallback_any
-      attr_accessor :allow_missing_definitions
-      attr_accessor :allow_unknown_constant_assignment
-      attr_accessor :allow_unknown_method_calls
-      attr_accessor :vendor_path
-      attr_reader :libraries
-      attr_reader :repository_paths
-
-      def initialize
-        apply_default_typing_options!
-        self.vendor_path = nil
-
-        @libraries = []
-        @repository_paths = []
-      end
-
-      def apply_default_typing_options!
-        self.allow_fallback_any = true
-        self.allow_missing_definitions = true
-        self.allow_unknown_constant_assignment = false
-        self.allow_unknown_method_calls = false
-      end
-
-      def apply_strict_typing_options!
-        self.allow_fallback_any = false
-        self.allow_missing_definitions = false
-        self.allow_unknown_constant_assignment = false
-        self.allow_unknown_method_calls = false
-      end
-
-      def apply_lenient_typing_options!
-        self.allow_fallback_any = true
-        self.allow_missing_definitions = true
-        self.allow_unknown_constant_assignment = true
-        self.allow_unknown_method_calls = true
-      end
+      PathOptions = Struct.new(:core_root, :stdlib_root, :repo_paths, keyword_init: true) do
+        def customized_stdlib?
+          stdlib_root != nil
+        end
 
-      def error_to_report?(error)
-        case
-        when error.is_a?(Diagnostic::Ruby::FallbackAny)
-          !allow_fallback_any
-        when error.is_a?(Diagnostic::Ruby::MethodDefinitionMissing)
-          !allow_missing_definitions
-        when error.is_a?(Diagnostic::Ruby::NoMethod)
-          !allow_unknown_method_calls
-        when error.is_a?(Diagnostic::Ruby::UnknownConstantAssigned)
-          !allow_unknown_constant_assignment
-        else
-          true
+        def customized_core?
+          core_root != nil
         end
       end
 
-      def merge!(hash)
-        self.allow_fallback_any = hash[:allow_fallback_any] if hash.key?(:allow_fallback_any)
-        self.allow_missing_definitions = hash[:allow_missing_definitions] if hash.key?(:allow_missing_definitions)
-        self.allow_unknown_constant_assignment = hash[:allow_unknown_constant_assignment] if hash.key?(:allow_unknown_constant_assignment)
-        self.allow_unknown_method_calls = hash[:allow_unknown_method_calls] if hash.key?(:allow_unknown_method_calls)
+      attr_reader :libraries
+      attr_accessor :paths
+      attr_accessor :collection_lock
+
+      def initialize
+        @paths = PathOptions.new(repo_paths: [])
+        @libraries = []
       end
     end
   end

data/lib/steep/project/target.rb

@@ -6,12 +6,14 @@ module Steep
 
       attr_reader :source_pattern
       attr_reader :signature_pattern
+      attr_reader :code_diagnostics_config
 
-      def initialize(name:, options:, source_pattern:, signature_pattern:)
+      def initialize(name:, options:, source_pattern:, signature_pattern:, code_diagnostics_config:)
         @name = name
         @options = options
         @source_pattern = source_pattern
         @signature_pattern = signature_pattern
+        @code_diagnostics_config = code_diagnostics_config
 
         @source_files = {}
         @signature_files = {}
@@ -30,20 +32,32 @@ module Steep
       end
 
       def self.construct_env_loader(options:, project:)
-        repo = RBS::Repository.new(no_stdlib: options.vendor_path)
-        options.repository_paths.each do |path|
+        repo = RBS::Repository.new(no_stdlib: options.paths.customized_stdlib?)
+
+        if options.paths.stdlib_root
+          repo.add(project.absolute_path(options.paths.stdlib_root))
+        end
+
+        options.paths.repo_paths.each do |path|
           repo.add(project.absolute_path(path))
         end
 
-        loader = RBS::EnvironmentLoader.new(
-          core_root: options.vendor_path ? nil : RBS::EnvironmentLoader::DEFAULT_CORE_ROOT,
-          repository: repo
-        )
-        loader.add(path: options.vendor_path) if options.vendor_path
+        core_root_path =
+          if options.paths.customized_core?
+            if options.paths.core_root
+              project.absolute_path(options.paths.core_root)
+            end
+          else
+            RBS::EnvironmentLoader::DEFAULT_CORE_ROOT
+          end
+
+        loader = RBS::EnvironmentLoader.new(core_root: core_root_path, repository: repo)
+
         options.libraries.each do |lib|
           name, version = lib.split(/:/, 2)
           loader.add(library: name, version: version)
         end
+        loader.add_collection(options.collection_lock) if options.collection_lock
 
         loader
       end