Class: Parlour::RbiGenerator
- Inherits:
-
Object
- Object
- Parlour::RbiGenerator
- Extended by:
- T::Sig
- Defined in:
- lib/parlour/rbi_generator.rb,
lib/parlour/rbi_generator/method.rb,
lib/parlour/rbi_generator/options.rb,
lib/parlour/rbi_generator/attribute.rb,
lib/parlour/rbi_generator/namespace.rb,
lib/parlour/rbi_generator/parameter.rb,
lib/parlour/rbi_generator/rbi_object.rb,
lib/parlour/rbi_generator/class_namespace.rb,
lib/parlour/rbi_generator/module_namespace.rb
Overview
The RBI generator.
Defined Under Namespace
Classes: Attribute, ClassNamespace, Method, ModuleNamespace, Namespace, Options, Parameter, RbiObject
Instance Attribute Summary collapse
-
#current_plugin ⇒ Plugin?
The plugin which is currently generating new definitions.
-
#options ⇒ Options
readonly
The formatting options for this generator.
-
#root ⇒ Namespace
readonly
The root Namespace of this generator.
Instance Method Summary collapse
-
#initialize(break_params: 4, tab_size: 2) ⇒ void
constructor
Creates a new RBI generator.
-
#rbi ⇒ String
Returns the complete contents of the generated RBI file as a string.
Constructor Details
Instance Attribute Details
#current_plugin ⇒ Plugin?
The plugin which is currently generating new definitions. Plugin.run_plugins controls this value.
39 40 41 |
# File 'lib/parlour/rbi_generator.rb', line 39 def current_plugin @current_plugin end |
#options ⇒ Options (readonly)
The formatting options for this generator.
28 29 30 |
# File 'lib/parlour/rbi_generator.rb', line 28 def @options end |
Instance Method Details
#rbi ⇒ String
Returns the complete contents of the generated RBI file as a string.
45 46 47 |
# File 'lib/parlour/rbi_generator.rb', line 45 def rbi root.generate_rbi(0, ).join("\n") end |