Contents

module Steep
  class Project
    class Options
      class PathOptions
        attr_reader core_root: Pathname?

        attr_reader stdlib_root: Pathname?

        attr_reader repo_paths: Array[Pathname]

        def initialize: (?core_root: Pathname?, ?stdlib_root: Pathname?, ?repo_paths: Array[Pathname]) -> void

        def customized_stdlib?: () -> bool

        def customized_core?: () -> bool
      end

      attr_reader libraries: Array[String]

      attr_accessor paths: PathOptions

      attr_accessor collection_config_path: Pathname?

      def initialize: () -> void

      # Returns path of lockfile
      %a{pure} def collection_lock_path: () -> Pathname?

      # Returns `Lockfile` instance if it can be loaded
      #
      %a{pure} def collection_lock: () -> RBS::Collection::Config::Lockfile?

      @collection_lock: RBS::Collection::Config::Lockfile | Pathname | YAML::SyntaxError | RBS::Collection::Config::CollectionNotAvailable | nil

      # Load collection configuration
      #
      # * Returns `Lockfile` instance if successfully loaded
      # * Returns `nil` if collection is disabled
      # * Returns `Pathname` if a file is missing
      # * Returns `YAML::SyntaxError` or `CollectionNotAvailable` if an error is raised
      #
      # It keeps the last result unless `force: true` is specified.
      #
      def load_collection_lock: (?force: bool) -> (RBS::Collection::Config::Lockfile | Pathname | YAML::SyntaxError | RBS::Collection::Config::CollectionNotAvailable | nil)
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
steep-1.7.0.dev.3	sig/steep/project/options.rbs
steep-1.7.0.dev.2	sig/steep/project/options.rbs
steep-1.7.0.dev.1	sig/steep/project/options.rbs