gem.sh gem.sh
Home Gems Types Docs Community
  • Modules

    • module GCCounter
    • module Steep
    • module Steep::AST
    • module Steep::AST::Annotation
    • module Steep::AST::Annotation::Located
    • module Steep::AST::Builtin
    • module Steep::AST::Ignore
    • module Steep::AST::Node
    • module Steep::AST::Types
    • module Steep::AST::Types::Helper
    • module Steep::AST::Types::Helper::ChildrenLevel
    • module Steep::AST::Types::Helper::NoChild
    • module Steep::AST::Types::Helper::NoFreeVariables
    • module Steep::AST::Types::Logic
    • module Steep::AST::Types::Name
    • module Steep::AST::Types::SharedInstance
    • module Steep::Diagnostic
    • module Steep::Diagnostic::Helper
    • module Steep::Diagnostic::ResultPrinter2
    • module Steep::Diagnostic::Ruby
    • module Steep::Diagnostic::Ruby::ResultPrinter
    • module Steep::Diagnostic::Signature
    • module Steep::Drivers
    • module Steep::Drivers::Utils
    • module Steep::Drivers::Utils::DriverHelper
    • module Steep::Equatable
    • module Steep::Index
    • module Steep::Interface
    • module Steep::Interface::Function::Params::Utils
    • module Steep::ModuleHelper
    • module Steep::NodeHelper
    • module Steep::PathHelper
    • module Steep::Project::DSL::LibraryOptions
    • module Steep::Project::DSL::WithPattern
    • module Steep::Server
    • module Steep::Server::ChangeBuffer
    • module Steep::Server::CustomMethods
    • module Steep::Server::CustomMethods::FileLoad
    • module Steep::Server::CustomMethods::FileReset
    • module Steep::Server::CustomMethods::Groups
    • module Steep::Server::CustomMethods::Stats
    • module Steep::Server::CustomMethods::TypeCheck
    • module Steep::Server::CustomMethods::TypeCheckGroups
    • module Steep::Server::CustomMethods::TypeCheck__Progress
    • module Steep::Server::CustomMethods::TypeCheck__Start
    • module Steep::Server::LSPFormatter
    • module Steep::Server::Master::MessageUtils
    • module Steep::Services
    • module Steep::Services::GotoService::SourceHelper
    • module Steep::Services::HoverProvider
    • module Steep::Services::HoverProvider::SingletonMethods
    • module Steep::Services::TypeNameCompletion::Prefix
    • module Steep::Signature
    • module Steep::Subtyping
    • module Steep::Subtyping::Result
    • module Steep::Subtyping::Result::Helper
    • module Steep::TypeInference
    • module Steep::TypeInference::MethodCall
    • module Steep::TypeInference::TypeEnvBuilder::Command
  • Classes

    • class Object
    • class Parser::Source::Range
    • class RBS::Location
    • class Steep::AST::Annotation::BlockType
    • class Steep::AST::Annotation::BreakType
    • class Steep::AST::Annotation::Collection
    • class Steep::AST::Annotation::ConstType
    • class Steep::AST::Annotation::Dynamic
    • class Steep::AST::Annotation::Dynamic::Name
    • class Steep::AST::Annotation::Implements
    • class Steep::AST::Annotation::Implements::Module
    • class Steep::AST::Annotation::InstanceType
    • class Steep::AST::Annotation::IvarType
    • class Steep::AST::Annotation::MethodType
    • class Steep::AST::Annotation::ModuleType
    • class Steep::AST::Annotation::Named
    • class Steep::AST::Annotation::ReturnType
    • class Steep::AST::Annotation::SelfType
    • class Steep::AST::Annotation::Typed
    • class Steep::AST::Annotation::VarType
    • class Steep::AST::Builtin::Type
    • class Steep::AST::Ignore::BufferScanner
    • class Steep::AST::Ignore::IgnoreEnd
    • class Steep::AST::Ignore::IgnoreLine
    • class Steep::AST::Ignore::IgnoreStart
    • class Steep::AST::Node::TypeApplication
    • class Steep::AST::Node::TypeAssertion
    • class Steep::AST::Types::Any
    • class Steep::AST::Types::Boolean
    • class Steep::AST::Types::Bot
    • class Steep::AST::Types::Class
    • class Steep::AST::Types::Factory
    • class Steep::AST::Types::Instance
    • class Steep::AST::Types::Intersection
    • class Steep::AST::Types::Literal
    • class Steep::AST::Types::Logic::ArgEqualsReceiver
    • class Steep::AST::Types::Logic::ArgIsAncestor
    • class Steep::AST::Types::Logic::ArgIsReceiver
    • class Steep::AST::Types::Logic::Base
    • class Steep::AST::Types::Logic::Env
    • class Steep::AST::Types::Logic::Not
    • class Steep::AST::Types::Logic::ReceiverIsArg
    • class Steep::AST::Types::Logic::ReceiverIsNil
    • class Steep::AST::Types::Logic::ReceiverIsNotNil
    • class Steep::AST::Types::Name::Alias
    • class Steep::AST::Types::Name::Applying
    • class Steep::AST::Types::Name::Base
    • class Steep::AST::Types::Name::Instance
    • class Steep::AST::Types::Name::Interface
    • class Steep::AST::Types::Name::Singleton
    • class Steep::AST::Types::Nil
    • class Steep::AST::Types::Proc
    • class Steep::AST::Types::Record
    • class Steep::AST::Types::Self
    • class Steep::AST::Types::Top
    • class Steep::AST::Types::Tuple
    • class Steep::AST::Types::Union
    • class Steep::AST::Types::Var
    • class Steep::AST::Types::Void
    • class Steep::AnnotationParser
    • class Steep::AnnotationParser::SyntaxError
    • class Steep::CLI
    • class Steep::Diagnostic::LSPFormatter
    • class Steep::Diagnostic::Ruby::AnnotationSyntaxError
    • class Steep::Diagnostic::Ruby::ArgumentTypeMismatch
    • class Steep::Diagnostic::Ruby::Base
    • class Steep::Diagnostic::Ruby::BlockBodyTypeMismatch
    • class Steep::Diagnostic::Ruby::BlockTypeMismatch
    • class Steep::Diagnostic::Ruby::BreakTypeMismatch
    • class Steep::Diagnostic::Ruby::ClassModuleMismatch
    • class Steep::Diagnostic::Ruby::DifferentMethodParameterKind
    • class Steep::Diagnostic::Ruby::ElseOnExhaustiveCase
    • class Steep::Diagnostic::Ruby::FallbackAny
    • class Steep::Diagnostic::Ruby::FalseAssertion
    • class Steep::Diagnostic::Ruby::ImplicitBreakValueMismatch
    • class Steep::Diagnostic::Ruby::IncompatibleAnnotation
    • class Steep::Diagnostic::Ruby::IncompatibleArgumentForwarding
    • class Steep::Diagnostic::Ruby::IncompatibleAssignment
    • class Steep::Diagnostic::Ruby::InsufficientKeywordArguments
    • class Steep::Diagnostic::Ruby::InsufficientPositionalArguments
    • class Steep::Diagnostic::Ruby::InsufficientTypeArgument
    • class Steep::Diagnostic::Ruby::InvalidIgnoreComment
    • class Steep::Diagnostic::Ruby::MethodArityMismatch
    • class Steep::Diagnostic::Ruby::MethodBodyTypeMismatch
    • class Steep::Diagnostic::Ruby::MethodDefinitionMissing
    • class Steep::Diagnostic::Ruby::MethodParameterMismatch
    • class Steep::Diagnostic::Ruby::MethodReturnTypeAnnotationMismatch
    • class Steep::Diagnostic::Ruby::MultipleAssignmentConversionError
    • class Steep::Diagnostic::Ruby::NoMethod
    • class Steep::Diagnostic::Ruby::ProcHintIgnored
    • class Steep::Diagnostic::Ruby::ProcTypeExpected
    • class Steep::Diagnostic::Ruby::RBSError
    • class Steep::Diagnostic::Ruby::RequiredBlockMissing
    • class Steep::Diagnostic::Ruby::ReturnTypeMismatch
    • class Steep::Diagnostic::Ruby::SetterBodyTypeMismatch
    • class Steep::Diagnostic::Ruby::SetterReturnTypeMismatch
    • class Steep::Diagnostic::Ruby::SyntaxError
    • class Steep::Diagnostic::Ruby::TypeArgumentMismatchError
    • class Steep::Diagnostic::Ruby::UnannotatedEmptyCollection
    • class Steep::Diagnostic::Ruby::UnexpectedBlockGiven
    • class Steep::Diagnostic::Ruby::UnexpectedDynamicMethod
    • class Steep::Diagnostic::Ruby::UnexpectedError
    • class Steep::Diagnostic::Ruby::UnexpectedJump
    • class Steep::Diagnostic::Ruby::UnexpectedJumpValue
    • class Steep::Diagnostic::Ruby::UnexpectedKeywordArgument
    • class Steep::Diagnostic::Ruby::UnexpectedPositionalArgument
    • class Steep::Diagnostic::Ruby::UnexpectedSuper
    • class Steep::Diagnostic::Ruby::UnexpectedTypeArgument
    • class Steep::Diagnostic::Ruby::UnexpectedYield
    • class Steep::Diagnostic::Ruby::UnknownConstant
    • class Steep::Diagnostic::Ruby::UnknownConstantAssigned
    • class Steep::Diagnostic::Ruby::UnknownGlobalVariable
    • class Steep::Diagnostic::Ruby::UnknownInstanceVariable
    • class Steep::Diagnostic::Ruby::UnknownRecordKey
    • class Steep::Diagnostic::Ruby::UnreachableBranch
    • class Steep::Diagnostic::Ruby::UnreachableValueBranch
    • class Steep::Diagnostic::Ruby::UnresolvedOverloading
    • class Steep::Diagnostic::Ruby::UnsatisfiableConstraint
    • class Steep::Diagnostic::Ruby::UnsupportedSyntax
    • class Steep::Diagnostic::Signature::Base
    • class Steep::Diagnostic::Signature::ClassVariableDuplicationError
    • class Steep::Diagnostic::Signature::CyclicClassAliasDefinitionError
    • class Steep::Diagnostic::Signature::DuplicatedDeclaration
    • class Steep::Diagnostic::Signature::DuplicatedMethodDefinition
    • class Steep::Diagnostic::Signature::GenericParameterMismatch
    • class Steep::Diagnostic::Signature::InconsistentClassModuleAliasError
    • class Steep::Diagnostic::Signature::InheritModuleError
    • class Steep::Diagnostic::Signature::InstanceVariableTypeError
    • class Steep::Diagnostic::Signature::InvalidMethodOverload
    • class Steep::Diagnostic::Signature::InvalidTypeApplication
    • class Steep::Diagnostic::Signature::InvalidVarianceAnnotation
    • class Steep::Diagnostic::Signature::MixinClassError
    • class Steep::Diagnostic::Signature::ModuleSelfTypeError
    • class Steep::Diagnostic::Signature::NonregularTypeAlias
    • class Steep::Diagnostic::Signature::RecursiveAlias
    • class Steep::Diagnostic::Signature::RecursiveAncestor
    • class Steep::Diagnostic::Signature::RecursiveTypeAlias
    • class Steep::Diagnostic::Signature::SuperclassMismatch
    • class Steep::Diagnostic::Signature::SyntaxError
    • class Steep::Diagnostic::Signature::TypeParamDefaultReferenceError
    • class Steep::Diagnostic::Signature::UnexpectedError
    • class Steep::Diagnostic::Signature::UnknownMethodAlias
    • class Steep::Diagnostic::Signature::UnknownTypeName
    • class Steep::Diagnostic::Signature::UnsatisfiableGenericsDefaultType
    • class Steep::Diagnostic::Signature::UnsatisfiableTypeApplication
    • class Steep::Drivers::Annotations
    • class Steep::Drivers::Check
    • class Steep::Drivers::Checkfile
    • class Steep::Drivers::DiagnosticPrinter
    • class Steep::Drivers::Init
    • class Steep::Drivers::Langserver
    • class Steep::Drivers::PrintProject
    • class Steep::Drivers::Stats
    • class Steep::Drivers::Stats::CSVPrinter
    • class Steep::Drivers::Stats::TablePrinter
    • class Steep::Drivers::Utils::JobsOption
    • class Steep::Drivers::Vendor
    • class Steep::Drivers::Watch
    • class Steep::Drivers::Worker
    • class Steep::Expectations
    • class Steep::Expectations::Diagnostic
    • class Steep::Expectations::TestResult
    • class Steep::Index::RBSIndex
    • class Steep::Index::RBSIndex::Builder
    • class Steep::Index::RBSIndex::ConstantEntry
    • class Steep::Index::RBSIndex::GlobalEntry
    • class Steep::Index::RBSIndex::MethodEntry
    • class Steep::Index::RBSIndex::TypeEntry
    • class Steep::Index::SignatureSymbolProvider
    • class Steep::Index::SignatureSymbolProvider::SymbolInformation
    • class Steep::Index::SourceIndex
    • class Steep::Index::SourceIndex::ConstantEntry
    • class Steep::Index::SourceIndex::MethodEntry
    • class Steep::Interface::Block
    • class Steep::Interface::Builder
    • class Steep::Interface::Builder::Config
    • class Steep::Interface::Function
    • class Steep::Interface::Function::Params
    • class Steep::Interface::Function::Params::KeywordParams
    • class Steep::Interface::Function::Params::PositionalParams
    • class Steep::Interface::Function::Params::PositionalParams::Base
    • class Steep::Interface::Function::Params::PositionalParams::Optional
    • class Steep::Interface::Function::Params::PositionalParams::Required
    • class Steep::Interface::Function::Params::PositionalParams::Rest
    • class Steep::Interface::MethodType
    • class Steep::Interface::Shape
    • class Steep::Interface::Shape::Entry
    • class Steep::Interface::Shape::MethodOverload
    • class Steep::Interface::Shape::Methods
    • class Steep::Interface::Substitution
    • class Steep::Interface::Substitution::InvalidSubstitutionError
    • class Steep::Interface::TypeParam
    • class Steep::LocatedValue
    • class Steep::Project
    • class Steep::Project::DSL
    • class Steep::Project::DSL::GroupDSL
    • class Steep::Project::DSL::TargetDSL
    • class Steep::Project::Group
    • class Steep::Project::Options
    • class Steep::Project::Pattern
    • class Steep::Project::Target
    • class Steep::RakeTask
    • class Steep::RakeTask::CommandConfiguration
    • class Steep::RakeTask::TaskConfiguration
    • class Steep::Sampler
    • class Steep::Server::BaseWorker
    • class Steep::Server::DelayQueue
    • class Steep::Server::InteractionWorker
    • class Steep::Server::Master
    • class Steep::Server::Master::GroupHandler
    • class Steep::Server::Master::ResultController
    • class Steep::Server::Master::ResultHandler
    • class Steep::Server::Master::SendMessageJob
    • class Steep::Server::TargetGroupFiles
    • class Steep::Server::TypeCheckController
    • class Steep::Server::TypeCheckController::Request
    • class Steep::Server::TypeCheckWorker
    • class Steep::Server::TypeCheckWorker::GotoJob
    • class Steep::Server::WorkDoneProgress
    • class Steep::Server::WorkerProcess
    • class Steep::Services::CompletionProvider
    • class Steep::Services::CompletionProvider::TextItem
    • class Steep::Services::CompletionProvider::TypeNameItem
    • class Steep::Services::ContentChange
    • class Steep::Services::ContentChange::Position
    • class Steep::Services::FileLoader
    • class Steep::Services::GotoService
    • class Steep::Services::GotoService::ConstantQuery
    • class Steep::Services::GotoService::MethodQuery
    • class Steep::Services::GotoService::TypeNameQuery
    • class Steep::Services::HoverProvider::RBS
    • class Steep::Services::HoverProvider::Ruby
    • class Steep::Services::PathAssignment
    • class Steep::Services::SignatureHelpProvider
    • class Steep::Services::SignatureService
    • class Steep::Services::SignatureService::AncestorErrorStatus
    • class Steep::Services::SignatureService::LoadedStatus
    • class Steep::Services::SignatureService::SyntaxErrorStatus
    • class Steep::Services::StatsCalculator
    • class Steep::Services::StatsCalculator::ErrorStats
    • class Steep::Services::StatsCalculator::SuccessStats
    • class Steep::Services::TypeCheckService
    • class Steep::Services::TypeCheckService::SourceFile
    • class Steep::Services::TypeNameCompletion
    • class Steep::Signature::Validator
    • class Steep::Source
    • class Steep::Source::Builder
    • class Steep::Source::IgnoreRanges
    • class Steep::Subtyping::Cache
    • class Steep::Subtyping::Check
    • class Steep::Subtyping::Constraints
    • class Steep::Subtyping::Constraints::UnsatisfiableConstraint
    • class Steep::Subtyping::Constraints::UnsatisfiedInvariantError
    • class Steep::Subtyping::Constraints::UnsatisfiedInvariantError::UnknownsFreeVariableNotDisjoint
    • class Steep::Subtyping::Constraints::UnsatisfiedInvariantError::VariablesFreeVariablesNotDisjoint
    • class Steep::Subtyping::Constraints::UnsatisfiedInvariantError::VariablesUnknownsNotDisjoint
    • class Steep::Subtyping::Relation
    • class Steep::Subtyping::Result::All
    • class Steep::Subtyping::Result::Any
    • class Steep::Subtyping::Result::Base
    • class Steep::Subtyping::Result::Expand
    • class Steep::Subtyping::Result::Failure
    • class Steep::Subtyping::Result::Failure::BlockMismatchError
    • class Steep::Subtyping::Result::Failure::LoopAbort
    • class Steep::Subtyping::Result::Failure::MethodMissingError
    • class Steep::Subtyping::Result::Failure::ParameterMismatchError
    • class Steep::Subtyping::Result::Failure::PolyMethodSubtyping
    • class Steep::Subtyping::Result::Failure::SelfBindingMismatch
    • class Steep::Subtyping::Result::Failure::UnknownPairError
    • class Steep::Subtyping::Result::Failure::UnsatisfiedConstraints
    • class Steep::Subtyping::Result::Skip
    • class Steep::Subtyping::Result::Success
    • class Steep::Subtyping::VariableVariance
    • class Steep::ThreadWaiter
    • class Steep::TypeConstruction
    • class Steep::TypeConstruction::Pair
    • class Steep::TypeInference::BlockParams
    • class Steep::TypeInference::BlockParams::MultipleParam
    • class Steep::TypeInference::BlockParams::Param
    • class Steep::TypeInference::CaseWhen
    • class Steep::TypeInference::CaseWhen::WhenPatterns
    • class Steep::TypeInference::ConstantEnv
    • class Steep::TypeInference::Context
    • class Steep::TypeInference::Context::BlockContext
    • class Steep::TypeInference::Context::BreakContext
    • class Steep::TypeInference::Context::MethodContext
    • class Steep::TypeInference::Context::ModuleContext
    • class Steep::TypeInference::Context::TypeVariableContext
    • class Steep::TypeInference::LogicTypeInterpreter
    • class Steep::TypeInference::LogicTypeInterpreter::Result
    • class Steep::TypeInference::MethodCall::Base
    • class Steep::TypeInference::MethodCall::Error
    • class Steep::TypeInference::MethodCall::MethodDecl
    • class Steep::TypeInference::MethodCall::NoMethodError
    • class Steep::TypeInference::MethodCall::Special
    • class Steep::TypeInference::MethodCall::Typed
    • class Steep::TypeInference::MethodCall::Untyped
    • class Steep::TypeInference::MethodParams
    • class Steep::TypeInference::MethodParams::BaseParameter
    • class Steep::TypeInference::MethodParams::BaseRestParameter
    • class Steep::TypeInference::MethodParams::BlockParameter
    • class Steep::TypeInference::MethodParams::KeywordParameter
    • class Steep::TypeInference::MethodParams::KeywordRestParameter
    • class Steep::TypeInference::MethodParams::PositionalParameter
    • class Steep::TypeInference::MethodParams::PositionalRestParameter
    • class Steep::TypeInference::MultipleAssignment
    • class Steep::TypeInference::SendArgs
    • class Steep::TypeInference::SendArgs::BlockPassArg
    • class Steep::TypeInference::SendArgs::ForwardedArgs
    • class Steep::TypeInference::SendArgs::KeywordArgs
    • class Steep::TypeInference::SendArgs::KeywordArgs::ArgTypePairs
    • class Steep::TypeInference::SendArgs::KeywordArgs::MissingKeyword
    • class Steep::TypeInference::SendArgs::KeywordArgs::SplatArg
    • class Steep::TypeInference::SendArgs::KeywordArgs::UnexpectedKeyword
    • class Steep::TypeInference::SendArgs::PositionalArgs
    • class Steep::TypeInference::SendArgs::PositionalArgs::MissingArg
    • class Steep::TypeInference::SendArgs::PositionalArgs::NodeParamPair
    • class Steep::TypeInference::SendArgs::PositionalArgs::NodeTypePair
    • class Steep::TypeInference::SendArgs::PositionalArgs::SplatArg
    • class Steep::TypeInference::SendArgs::PositionalArgs::UnexpectedArg
    • class Steep::TypeInference::TypeEnv
    • class Steep::TypeInference::TypeEnvBuilder
    • class Steep::TypeInference::TypeEnvBuilder::Command::AnnotationsBase
    • class Steep::TypeInference::TypeEnvBuilder::Command::ImportConstantAnnotations
    • class Steep::TypeInference::TypeEnvBuilder::Command::ImportGlobalDeclarations
    • class Steep::TypeInference::TypeEnvBuilder::Command::ImportInstanceVariableAnnotations
    • class Steep::TypeInference::TypeEnvBuilder::Command::ImportInstanceVariableDefinition
    • class Steep::TypeInference::TypeEnvBuilder::Command::ImportLocalVariableAnnotations
    • class Steep::TypeInference::TypeEnvBuilder::Command::RBSBase
    • class Steep::Typing
    • class Steep::Typing::CursorContext
    • class Steep::Typing::UnknownNodeError
    Overview
    H
    Home
    G
    Guides
    R
    Reference
    T
    Types
    C
    Changelogs
  • Documentation
    • README
    • Narrowing
    • Shape
  • Guides
    • doc/narrowing.md
    • doc/shape.md
  • More
    • Versions
    • Source
    • Playground
    • Stats
    • Metadata
    • Wiki
    • Announcements
    Community
    • Articles
    • Tutorials
    • Videos
    • Community
  1. Gems
  2. steep
  3. 1.9.0

steep

Gradual Typing for Ruby

Types
Docs
Guides
Zeitwerk
Namespace
Optimized

Version

1.9.0

Authors

Soutaro Matsumoto

Dependencies

parser, activesupport, rainbow, listen, language_server-protocol, rbs, concurrent-ruby, terminal-table, securerandom, json, logger, fileutils, strscan, csv

Quick Start

bundle add steep

Getting Started

Learn more about the Steep gem.

Installation

Learn more about how to install and configure the gem

Documentation

Learn more about the details

Guides

Learn more about the gem in the written guides

Reference

Learn more about the classes and modules

Guides

guides/README.md

Read about "Readme" in steep

Read more

guides/src/gem-rbs-collection/gem-rbs-collection.md

Read about "Gem-RBS-collection" in steep

Read more

guides/src/getting-started/getting-started.md

Read about "Getting-started" in steep

Read more

guides/src/nil-optional/nil-optional.md

Read about "Nil-optional" in steep

Read more

Playground

Test, play and inspect the gem for yourself

irb(main):001:0>

            

Playground

Run a Ruby playground with the steep gem pre-installed

Play

Top-Level Modules

  • GCCounter
  • Steep

Top-Level Classes

  • Object

Top-Level Class Methods

  • :: new

Top-Level Instance Methods

  • # -
  • # ==
  • # ==
  • # class?
  • # class_alias
  • # class_decl
  • # class_or_module?
  • # comment
  • # comments
  • # comments
  • # const_name?
  • # const_name?
  • # constant?
  • # constant_decl
  • # customized_core?
  • # customized_stdlib?
  • # decl
  • # defining_method_name
  • # each
  • # hash
  • # hash
  • # method_definitions
  • # method_names
  • # module?
  • # parameters
  • # relative
  • # relative
  • # response?
  • # size
  • # to_s
  • # to_s
  • # to_s
  • # to_s
  • # to_s
  • # to_s
Home
Gems
Docs
Contribute
Monitoring
Twitter GitHub Mastodon

© 2025 gem.sh - Beautiful documentation for any Ruby gem