Sha256: 7c3f49503e1c4c329ec5d85535a3a6c3ee6c1b5712d23cb31abacfcd0e189f65
Contents?: true
Size: 1.52 KB
Versions: 6
Compression:
Stored size: 1.52 KB
Contents
# typed: true
module Parlour
# The RBI generator.
class RbiGenerator
extend T::Sig
sig { params(break_params: Integer, tab_size: Integer).void }
# Creates a new RBI generator.
#
# @example Create a default generator.
# generator = Parlour::RbiGenerator.new
#
# @example Create a generator with a custom +tab_size+ of 3.
# generator = Parlour::RbiGenerator.new(tab_size: 3)
#
# @param break_params [Integer] If there are at least this many parameters in a
# Sorbet +sig+, then it is broken onto separate lines.
# @param tab_size [Integer] The number of spaces to use per indent.
# @return [void]
def initialize(break_params: 4, tab_size: 2)
@options = Options.new(break_params: break_params, tab_size: tab_size)
@root = Namespace.new(self)
end
sig { returns(Options) }
# The formatting options for this generator.
# @return [Options]
attr_reader :options
sig { returns(Namespace) }
# The root {Namespace} of this generator.
# @return [Namespace]
attr_reader :root
sig { returns(T.nilable(Plugin)) }
# The plugin which is currently generating new definitions.
# {Plugin#run_plugins} controls this value.
# @return [Plugin, nil]
attr_accessor :current_plugin
sig { returns(String) }
# Returns the complete contents of the generated RBI file as a string.
#
# @return [String] The generated RBI file
def rbi
"# typed: strong\n" + root.generate_rbi(0, options).join("\n")
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems