ruby_mod_kit 0.0.5 → 0.0.6

data/sig/generated/ruby_mod_kit/node/def_node.rbs

@@ -10,6 +10,8 @@ module RubyModKit
 
       @prev: Node::BaseNode | nil
 
+      @body_node: Node::StatementsNode | Node::BeginNode | nil
+
       attr_reader prism_node: Prism::DefNode
 
       attr_reader parent: Node::BaseNode
@@ -20,25 +22,47 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::DefNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize: (Prism::DefNode prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> void
 
       # @rbs return: Symbol
+      # @return [Symbol]
       def name: () -> Symbol
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def body_location: () -> (Prism::Location | nil)
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def lparen_loc: () -> (Prism::Location | nil)
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def rparen_loc: () -> (Prism::Location | nil)
 
       # @rbs return: Prism::Location
+      # @return [Prism::Location]
       def name_loc: () -> Prism::Location
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def end_keyword_loc: () -> (Prism::Location | nil)
+
+      # @rbs prism_child_node: Prism::Node
+      # @rbs prev: Node::BaseNode | nil
+      # @rbs return: Node::BaseNode
+      # @param prism_child_node [Prism::Node]
+      # @param prev [Node::BaseNode, nil]
+      # @return [Node::BaseNode]
+      def wrap: (Prism::Node prism_child_node, ?prev: Node::BaseNode | nil) -> Node::BaseNode
+
+      # @rbs return: Node::StatementsNode | Node::BeginNode | nil
+      # @return [Node::StatementsNode, Node::BeginNode, nil]
+      def body_node: () -> (Node::StatementsNode | Node::BeginNode | nil)
     end
   end
 end

data/sig/generated/ruby_mod_kit/node/def_parent_node.rbs

@@ -6,7 +6,7 @@ module RubyModKit
     class DefParentNode < Node::BaseNode
       @prism_node: Prism::ClassNode | Prism::ModuleNode
 
-      @body_node: nil | Node::StatementsNode
+      @body_node: Node::StatementsNode | nil
 
       @parent: Node::BaseNode
 
@@ -22,15 +22,23 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::ClassNode, Prism::ModuleNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize: (Prism::ClassNode | Prism::ModuleNode prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> void
 
       # @rbs prism_child_node: Prism::Node
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: Node::BaseNode
+      # @param prism_child_node [Prism::Node]
+      # @param prev [Node::BaseNode, nil]
+      # @return [Node::BaseNode]
       def wrap: (Prism::Node prism_child_node, ?prev: Node::BaseNode | nil) -> Node::BaseNode
 
-      # @rbs return: nil | Node::StatementsNode
-      def body_node: () -> (nil | Node::StatementsNode)
+      # @rbs return: Node::StatementsNode | nil
+      # @return [Node::StatementsNode, nil]
+      def body_node: () -> (Node::StatementsNode | nil)
     end
   end
 end

data/sig/generated/ruby_mod_kit/node/parameter_node.rbs

@@ -22,9 +22,14 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [prism_node]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize: (prism_node prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> void
 
       # @rbs return: Symbol | nil
+      # @return [Symbol, nil]
       def name: () -> (Symbol | nil)
     end
   end

data/sig/generated/ruby_mod_kit/node/program_node.rbs

@@ -10,9 +10,12 @@ module RubyModKit
 
       # @rbs prism_node: Prism::ProgramNode
       # @rbs return: void
+      # @param prism_node [Prism::ProgramNode]
+      # @return [void]
       def initialize: (Prism::ProgramNode prism_node) -> void
 
       # @rbs return: nil
+      # @return [nil]
       def parent: () -> nil
     end
   end

data/sig/generated/ruby_mod_kit/node/statements_node.rbs

@@ -20,6 +20,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::StatementsNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize: (Prism::StatementsNode prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> void
     end
   end

data/sig/generated/ruby_mod_kit/node/symbol_node.rbs

@@ -10,7 +10,7 @@ module RubyModKit
 
       @prev: Node::BaseNode | nil
 
-      @value: nil | Symbol
+      @value: Symbol | nil
 
       attr_reader prism_node: Prism::SymbolNode
 
@@ -22,10 +22,15 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::SymbolNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize: (Prism::SymbolNode prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> void
 
-      # @rbs return: nil | Symbol
-      def value: () -> (nil | Symbol)
+      # @rbs return: Symbol | nil
+      # @return [Symbol, nil]
+      def value: () -> (Symbol | nil)
     end
   end
 end

data/sig/generated/ruby_mod_kit/node/untyped_node.rbs

@@ -20,6 +20,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::Node]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize: (Prism::Node prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> void
     end
   end

data/sig/generated/ruby_mod_kit/node/wrap.rbs

@@ -7,6 +7,10 @@ module RubyModKit
     # @rbs parent: Node::BaseNode
     # @rbs prev: Node::BaseNode | nil
     # @rbs return: Node::BaseNode
+    # @param prism_node [Prism::Node]
+    # @param parent [Node::BaseNode]
+    # @param prev [Node::BaseNode, nil]
+    # @return [Node::BaseNode]
     def self.wrap: (Prism::Node prism_node, parent: Node::BaseNode, ?prev: Node::BaseNode | nil) -> Node::BaseNode
   end
 end

data/sig/generated/ruby_mod_kit/offset_diff.rbs

@@ -8,15 +8,21 @@ module RubyModKit
     @offsets: Array[Integer]
 
     # @rbs return: void
+    # @return [void]
     def initialize: () -> void
 
     # @rbs src_offset: Integer
     # @rbs return: Integer
+    # @param src_offset [Integer]
+    # @return [Integer]
     def []: (Integer src_offset) -> Integer
 
     # @rbs src_offset: Integer
     # @rbs new_diff: Integer
     # @rbs return: void
+    # @param src_offset [Integer]
+    # @param new_diff [Integer]
+    # @return [void]
     def insert: (Integer src_offset, Integer new_diff) -> void
   end
 end

data/sig/generated/ruby_mod_kit.rbs

@@ -2,46 +2,71 @@
 
 # The root namespace for ruby_mod_kit.
 module RubyModKit
+  # An internal error because of RubyModKit implementation
   class Error < StandardError
   end
 
+  # A SyntaxError of rbm script
   class SyntaxError < ::SyntaxError
   end
 
   # @rbs file: String
   # @rbs *args: String
   # @rbs output: String | nil
-  # @rbs config: nil | Config
+  # @rbs config: Config | nil
   # @rbs return: void
-  def self.execute_file: (String file, *String args, ?output: String | nil, ?config: nil | Config) -> void
+  # @param file [String]
+  # @param args [String]
+  # @param output [String, nil]
+  # @param config [Config, nil]
+  # @return [void]
+  def self.execute_file: (String file, *String args, ?output: String | nil, ?config: Config | nil) -> void
 
   # @rbs file: String
   # @rbs output: String | IO | nil
-  # @rbs config: nil | Config
+  # @rbs config: Config | nil
   # @rbs return: String
-  def self.transpile_file: (String file, ?output: String | IO | nil, ?config: nil | Config) -> String
+  # @param file [String]
+  # @param output [String, IO, nil]
+  # @param config [Config, nil]
+  # @return [String]
+  def self.transpile_file: (String file, ?output: String | IO | nil, ?config: Config | nil) -> String
 
   # @rbs src: String
   # @rbs filename: String | nil
-  # @rbs config: nil | Config
+  # @rbs config: Config | nil
   # @rbs return: String
-  def self.transpile: (String src, ?filename: String | nil, ?config: nil | Config) -> String
+  # @param src [String]
+  # @param filename [String, nil]
+  # @param config [Config, nil]
+  # @return [String]
+  def self.transpile: (String src, ?filename: String | nil, ?config: Config | nil) -> String
 
   # @rbs file: String
   # @rbs *args: String
   # @rbs return: void
+  # @param file [String]
+  # @param args [String]
+  # @return [void]
   def self.execute_rb_file: (String file, *String args) -> void
 
   # @rbs path: String
   # @rbs return: String
+  # @param path [String]
+  # @return [String]
   def self.rb_path: (String path) -> String
 
   # @rbs rb_script: String
   # @rbs *args: String
   # @rbs return: void
+  # @param rb_script [String]
+  # @param args [String]
+  # @return [void]
   def self.execute_rb: (String rb_script, *String args) -> void
 
   # @rbs type: String
   # @rbs return: String
+  # @param type [String]
+  # @return [String]
   def self.unify_type: (String type) -> String
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_mod_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - wanabe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".ruby_mod_kit.yml"
+- ".yardopts"
 - LICENSE.txt
 - README.md
 - examples/user.rb