steep 1.7.0.dev.3 → 1.7.0

data/sig/steep/path_helper.rbs

@@ -1,15 +0,0 @@
-module Steep
-  module PathHelper
-    # Receives a String that represents a *file* URI and returns a Pathname
-    #
-    # Returns `nil` when the schema of given URI is not `file://`.
-    #
-    def self?.to_pathname: (String uri, ?dosish: bool) -> Pathname?
-
-    def self?.to_pathname!: (String uri, ?dosish: bool) -> Pathname
-
-    # Receives a Pathname and returns a *file* URI
-    #
-    def self?.to_uri: (Pathname | String path, ?dosish: bool) -> URI::File
-  end
-end

data/sig/steep/project/dsl.rbs

@@ -1,108 +0,0 @@
-use Steep::Diagnostic::Ruby::template
-
-module Steep
-  class Project
-    class DSL
-      class TargetDSL
-        attr_reader name: Symbol
-
-        attr_reader sources: Array[String]
-
-        attr_reader libraries: Array[String]
-
-        attr_reader signatures: Array[String]
-
-        attr_reader ignored_sources: Array[String]
-
-        attr_reader stdlib_root: Pathname?
-
-        attr_reader core_root: Pathname?
-
-        attr_reader repo_paths: Array[Pathname]
-
-        attr_reader code_diagnostics_config: untyped
-
-        attr_reader project: Project?
-
-        # Attribute to keep track of collection configuration
-        #
-        # * `Pathname` means loading the configuration from the path
-        # * `nil` means no configuration is given
-        # * `false` means rbs-collection is disabled
-        #
-        attr_reader collection_config_path: Pathname | nil | false
-
-        def project!: () -> Project
-
-        def initialize: (Symbol name, ?sources: Array[String], ?libraries: Array[String], ?signatures: Array[String], ?ignored_sources: Array[String], ?repo_paths: Array[Pathname], ?code_diagnostics_config: ::Hash[untyped, untyped], ?project: Project?, ?collection_config_path: Pathname?) -> void
-
-        def initialize_copy: (instance other) -> void
-
-        def check: (*String args) -> void
-
-        def ignore: (*String args) -> void
-
-        def library: (*String args) -> void
-
-        def typing_options: (?untyped level, **untyped hash) -> void
-
-        def signature: (*String args) -> void
-
-        def update: (?name: Symbol, ?sources: Array[String], ?libraries: Array[String], ?signatures: Array[String], ?ignored_sources: Array[String], ?project: Project?) -> TargetDSL
-
-        def no_builtin!: (?bool value) -> void
-
-        def vendor: (?::String dir, ?stdlib: untyped?, ?gems: untyped?) -> void
-
-        def stdlib_path: (core_root: String, stdlib_root: String) -> void
-
-        def repo_path: (*String paths) -> void
-
-        # 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)
-        # configure_code_diagnostics(D::Ruby.strict) do |config|
-        #   config[D::Ruby::NoMethod] = nil
-        # end
-        # ```
-        #
-        def configure_code_diagnostics: (template hash) ?{ (template) -> void }-> void
-                                      | () { (template) -> void }-> void
-
-        def collection_config: (Pathname path) -> void
-
-        def disable_collection: () -> void
-      end
-
-      attr_reader project: Project
-
-      @@templates: Hash[Symbol, TargetDSL]
-
-      def self.templates: () -> Hash[Symbol, TargetDSL]
-
-      def initialize: (project: Project) -> void
-
-      def self.register_template: (Symbol name, TargetDSL target) -> void
-
-      def self.parse: (Project project, String code, ?filename: String) -> void
-
-      def target: (Symbol name, ?template: Symbol?) ?{ (TargetDSL) [self: TargetDSL] -> void } -> void
-    end
-  end
-end

data/sig/steep/project/options.rbs

@@ -1,47 +0,0 @@
-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

data/sig/steep/project/pattern.rbs

@@ -1,47 +0,0 @@
-module Steep
-  class Project
-    # `Pattern` class represents a pair of *positive* and *negative* patterns that may match with a pathname
-    #
-    # ```rb
-    # pat = Pattern.new(patterns: ["app/models"], ignores: ["app/models/account.rb"], ext: ".rbs")
-    #
-    # pat =~ "app/models/group.rb"    # => true
-    # pat =~ "app/models/account.rb"  # => false
-    # ```
-    #
-    # The pattern may be:
-    #
-    # 1. Directory name pattern -- `lib`, or
-    # 2. *Glob* pattern -- `foo/**/bar.rb`
-    #
-    class Pattern
-      # Positive patterns, which is tested with `fnmatch`
-      attr_reader patterns: Array[String]
-
-      # Negative patterns, which is tested with `fnmatch`
-      attr_reader ignores: Array[String]
-
-      # Positive *dir name* pattern constructed from `#patterns`, which is tested with `start_with?`
-      attr_reader prefixes: Array[String]
-
-      # Negative *dir name* pattern constructed from `#ignores`, which is tested with `start_with?`
-      attr_reader ignore_prefixes: Array[String]
-
-      attr_reader ext: String
-
-      def initialize: (patterns: Array[String], ext: String, ?ignores: Array[String]) -> void
-
-      # Returns `true` if given path matches to *positive* pattern, but doesn't match to *negative* pattern
-      #
-      def =~: (Pathname | String path) -> bool
-
-      # Returns true if given `Pathname` matches to *positive* pattern
-      def match?: (Pathname path) -> bool
-
-      # Returns true if given `Pathname` matches to *negative* pattern
-      def ignore?: (Pathname path) -> bool
-
-      def test_string: (Pathname path, Array[String] patterns, Array[String] prefixes) -> bool
-    end
-  end
-end

data/sig/steep/project/target.rbs

@@ -1,25 +0,0 @@
-module Steep
-  class Project
-    class Target
-      attr_reader name: Symbol
-
-      attr_reader options: Options
-
-      attr_reader source_pattern: Pattern
-
-      attr_reader signature_pattern: Pattern
-
-      attr_reader code_diagnostics_config: untyped
-
-      def initialize: (name: Symbol, options: Options, source_pattern: Pattern, signature_pattern: Pattern, code_diagnostics_config: untyped) -> void
-
-      def possible_source_file?: (Pathname path) -> bool
-
-      def possible_signature_file?: (Pathname path) -> bool
-
-      def new_env_loader: (project: Project) -> RBS::EnvironmentLoader
-
-      def self.construct_env_loader: (options: Options, project: Project) -> RBS::EnvironmentLoader
-    end
-  end
-end

data/sig/steep/project.rbs

@@ -1,26 +0,0 @@
-module Steep
-  class Project
-    attr_reader targets: Array[Target]
-
-    attr_reader steepfile_path: Pathname?
-
-    attr_reader base_dir: Pathname
-
-    def initialize: (steepfile_path: Pathname?, ?base_dir: Pathname?) -> void
-
-    def relative_path: (Pathname path) -> Pathname
-
-    def absolute_path: (Pathname path) -> Pathname
-
-    def target_for_source_path: (Pathname path) -> Target?
-
-    # Returns target or array of targets that *can* contain given path
-    #
-    # * `Target` will return if `path` is a source code
-    # * `Array[Target]` will return if `path` is a signature
-    #
-    # `path` can be non-existent file.
-    #
-    def targets_for_path: (Pathname path) -> (Target | Array[Target] | nil)
-  end
-end

data/sig/steep/range_extension.rbs

@@ -1,7 +0,0 @@
-class RBS::Location[in RK, in OK]
-  def as_lsp_range: () -> LanguageServer::Protocol::Interface::Range::json
-end
-
-class Parser::Source::Range
-  def as_lsp_range: () -> LanguageServer::Protocol::Interface::Range::json
-end

data/sig/steep/server/base_worker.rbs

@@ -1,49 +0,0 @@
-module Steep
-  module Server
-    class BaseWorker
-      interface _Queue[A]
-        def pop: () -> A?
-
-        def <<: (A) -> A
-
-        def close: () -> void
-      end
-
-      module LSP = LanguageServer::Protocol
-
-      @skip_jobs_after_shutdown: bool
-
-      @skip_job: bool
-
-      @shutdown: bool
-
-      attr_reader project: Project
-
-      attr_reader reader: LanguageServer::Protocol::Transport::Io::Reader
-
-      attr_reader writer: LanguageServer::Protocol::Transport::Io::Writer
-
-      attr_reader queue: _Queue[untyped]
-
-      class ShutdownJob
-        attr_reader id: String
-
-        def initialize: (id: String) -> void
-      end
-
-      def initialize: (project: Project, reader: LanguageServer::Protocol::Transport::Io::Reader, writer: LanguageServer::Protocol::Transport::Io::Writer) -> void
-
-      def skip_jobs_after_shutdown!: (?bool flag) -> void
-
-      def skip_jobs_after_shutdown?: () -> bool
-
-      def skip_job?: () -> bool
-
-      def handle_request: (untyped request) -> void
-
-      def handle_job: (untyped job) -> void
-
-      def run: () -> void
-    end
-  end
-end

data/sig/steep/server/change_buffer.rbs

@@ -1,38 +0,0 @@
-module Steep
-  module Server
-    module ChangeBuffer : _WithProject, _WithMutex
-      interface _WithProject
-        def project: () -> Project
-      end
-
-      interface _WithMutex
-        def mutex: () -> Mutex
-      end
-
-      type changes = Hash[Pathname, Array[Services::ContentChange]]
-
-      attr_reader buffered_changes: changes
-
-      # Yields `buffered_changes` to modify with synchronization
-      #
-      def push_buffer: [A] () { (changes) -> A } -> A
-
-      # Yields or returns a copy of `buffered_changes` after clearing `buffered_changes` content
-      #
-      def pop_buffer: [A] () { (changes) -> A } -> A
-                    | () -> changes
-
-      # Load files from `project` to `buffered_changes`
-      #
-      def load_files: (project: Project, commandline_args: Array[String]) -> void
-
-      # Load changes from a request with `DidChangeTextDocumentParams` into `buffered_changes`
-      #
-      def collect_changes: (untyped request) -> void
-
-      # Reset the content of `uri` to `text`
-      #
-      def reset_change: (uri: String, text: String) -> void
-    end
-  end
-end

data/sig/steep/server/delay_queue.rbs

@@ -1,37 +0,0 @@
-module Steep
-  module Server
-    # DelayQueue provides a queue that delays running given job
-    #
-    # 1. The `delay` is specific to a DelayQueue instance, not job specific
-    # 2. It executes only the last job
-    #
-    # ```ruby
-    # queue = DelayQueue.new(delay: 0.5)
-    # queue.execute { pp 1 }
-    # queue.execute { pp 2 }
-    # queue.execute { pp 3 }
-    #
-    # # => Will print only `3`, and the jobs printing `1` and `2` will be discarded
-    # ```
-    #
-    # The job will run on `#thread`.
-    #
-    class DelayQueue
-      attr_reader delay: Float
-
-      attr_reader thread: Thread
-
-      attr_reader queue: Thread::Queue
-
-      attr_reader last_task: Proc
-
-      def initialize: (delay: Float) -> void
-
-      # The `#execute` method is not thread safe
-      #
-      # You should synchronize yourself if you want to call the method from multiple threads.
-      #
-      def execute: () { () -> void } -> void
-    end
-  end
-end

data/sig/steep/server/interaction_worker.rbs

@@ -1,90 +0,0 @@
-use LanguageServer::Protocol::Transport::Io::*, Thread::Queue, RBS::AST::Comment
-use Steep::Services::CompletionProvider, Steep::Services::TypeNameCompletion
-use RBS::TypeName, RBS::Namespace
-
-module Steep
-  module Server
-    class InteractionWorker < BaseWorker
-      include ChangeBuffer
-
-      class ApplyChangeJob
-      end
-
-      class HoverJob
-        attr_reader id: String
-
-        attr_reader path: Pathname
-
-        attr_reader line: Integer
-
-        attr_reader column: Integer
-
-        def initialize: (id: String, path: Pathname, line: Integer, column: Integer) -> void
-      end
-
-      class CompletionJob
-        attr_reader id: String
-
-        attr_reader path: Pathname
-
-        attr_reader line: Integer
-
-        attr_reader column: Integer
-
-        attr_reader trigger: String
-
-        def initialize: (id: String, path: Pathname, line: Integer, column: Integer, trigger: String) -> void
-      end
-
-      class SignatureHelpJob
-        attr_reader id: String
-
-        attr_reader path: Pathname
-
-        attr_reader line: Integer
-
-        attr_reader column: Integer
-
-        def initialize: (id: String, path: Pathname, line: Integer, column: Integer) -> void
-      end
-
-      type job = ApplyChangeJob | HoverJob | CompletionJob | SignatureHelpJob
-
-      module LSP = LanguageServer::Protocol
-
-      @last_signature_help_line: Integer
-
-      @last_signature_help_result: LanguageServer::Protocol::Interface::SignatureHelp
-
-      attr_reader service: Services::TypeCheckService
-
-      attr_reader mutex: Mutex
-
-      def initialize: (project: Project, reader: Reader, writer: Writer, ?queue: Queue) -> void
-
-      def handle_job: (job) -> void
-
-      @last_job_mutex: Mutex
-
-      @last_job: job?
-
-      def process_latest_job: [T] (job) { () -> T } -> T?
-
-      def queue_job: (job) -> void
-
-      type lsp_request = { id: String, method: String, params: untyped }
-
-      def handle_request: (lsp_request) -> void
-
-      def process_hover: (HoverJob job) -> LanguageServer::Protocol::Interface::Hover?
-
-      def process_completion: (CompletionJob job) -> LanguageServer::Protocol::Interface::CompletionList?
-
-      def process_signature_help: (SignatureHelpJob) -> LanguageServer::Protocol::Interface::SignatureHelp?
-
-      def format_completion_item_for_rbs: (Services::SignatureService, RBS::TypeName, CompletionJob job, String complete_text, Integer prefix_size) -> LanguageServer::Protocol::Interface::CompletionItem
-
-      def format_completion_item: (CompletionProvider::item item) -> LanguageServer::Protocol::Interface::CompletionItem
-    end
-  end
-end

data/sig/steep/server/lsp_formatter.rbs

@@ -1,63 +0,0 @@
-use RBS::TypeName
-
-module Steep
-  module Server
-    # LSPFormatter translates hover content and completion item to markdown string
-    #
-    # The class has four main methods:
-    #
-    # * `markup_content` translates a string to `MarkupContent` object
-    # * `format_hover_content` translates a hover content to Markdown string
-    # * `format_completion_docs` translates a completion item to a documentation
-    # * `format_rbs_competion_docs` generates docs for completion item of RBS
-    #
-    module LSPFormatter
-      include Services
-
-      module LSP = LanguageServer::Protocol
-
-      # Translate given String to MarkupContent
-      #
-      def self?.markup_content: (String?) -> LanguageServer::Protocol::Interface::MarkupContent?
-                              | () { () -> String? } -> LanguageServer::Protocol::Interface::MarkupContent?
-
-      # Translates a hover content to String
-      #
-      def self?.format_hover_content: (Services::HoverProvider::Ruby::content | Services::HoverProvider::RBS::content) -> String
-
-      # Translates a completion item to String
-      def self?.format_completion_docs: (Services::CompletionProvider::item) -> String
-
-      # Translates a completion item for RBS to String
-      def self?.format_rbs_completion_docs: (TypeName, summarizable_decl, Array[RBS::AST::Comment]) -> String
-
-      def self?.format_comment: (RBS::AST::Comment?, ?header: String?) -> String?
-                              | (RBS::AST::Comment?, ?header: String?) { (String) -> void } -> void
-
-      def self?.format_comments: (Array[[String, RBS::AST::Comment?]]) -> String
-
-      def self?.local_variable: (Symbol, AST::Types::t) -> String
-
-      def self?.instance_variable: (Symbol, AST::Types::t) -> String
-
-      # Renders type application
-      def self?.name_and_args: (TypeName name, Array[RBS::Types::t] args) -> String
-
-      # Renders generic type definition
-      def self?.name_and_params: (TypeName name, Array[RBS::AST::TypeParam] params) -> String
-
-      type summarizable_decl = RBS::AST::Declarations::Class
-                             | RBS::AST::Declarations::Module
-                             | RBS::AST::Declarations::Interface
-                             | RBS::AST::Declarations::TypeAlias
-                             | RBS::AST::Declarations::ClassAlias
-                             | RBS::AST::Declarations::ModuleAlias
-                             | RBS::AST::Declarations::Global
-                             | RBS::AST::Declarations::Constant
-
-      def self?.declaration_summary: (summarizable_decl) -> String
-
-      def self?.format_method_item_doc: (Array[_ToS], Array[method_name], Hash[method_name, RBS::AST::Comment?], ?String footer) -> String
-    end
-  end
-end