Sha256: fec2c6158f86c7eee4ac4b992e7fd66c3730884e3ea21004d63118132396b1ce
Contents?: true
Size: 2 KB
Versions: 15
Compression:
Stored size: 2 KB
Contents
# typed: true
module Parlour
class RbiGenerator
# A set of immutable formatting options passed to all calls of
# {RbiObject#generate_rbi}.
class Options
extend T::Sig
sig { params(break_params: Integer, tab_size: Integer).void }
# Creates a new set of formatting options.
#
# @example Create Options with +break_params+ of +4+ and +tab_size+ of +2+.
# Parlour::RbiGenerator::Options.new(break_params: 4, tab_size: 2)
#
# @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:, tab_size:)
@break_params = break_params
@tab_size = tab_size
end
sig { returns(Integer) }
# If there are at least this many parameters in a Sorbet +sig+, then it
# is broken onto separate lines.
#
# # With break_params: 5
# sig { params(name: String, age: Integer, hobbies: T::Array(String), country: Symbol).void }
#
# # With break_params: 4
# sig do
# params(
# name: String,
# age: Integer,
# hobbies: T::Array(String),
# country: Symbol
# ).void
# end
#
# @return [Integer]
attr_reader :break_params
sig { returns(Integer) }
# The number of spaces to use per indent.
# @return [Integer]
attr_reader :tab_size
sig { params(level: Integer, str: String).returns(String) }
# Returns a string indented to the given indent level, according to the
# set {tab_size}.
#
# @param level [Integer] The indent level, as an integer. 0 is totally unindented.
# @param str [String] The string to indent.
# @return [String] The indented string.
def indented(level, str)
" " * (level * tab_size) + str
end
end
end
end
Version data entries
15 entries across 15 versions & 1 rubygems