sord 0.9.0 → 3.0.0.beta.2

data/lib/sord/parlour_plugin.rb

@@ -10,7 +10,7 @@ module Sord
       @parlour = nil
       @options = options
 
-      options[:comments] = true if options[:comments].nil?
+      options[:sord_comments] = true if options[:sord_comments].nil?
       options[:regenerate] = true if options[:regenerate].nil?
       options[:replace_errors_with_untyped] ||= false
       options[:replace_unresolved_with_untyped] ||= false
@@ -37,11 +37,21 @@ module Sord
         end
         Sord::Logging.enabled_types = Sord::Logging::AVAILABLE_TYPES - blacklist
       end
+
+      if !(options[:rbi] || options[:rbs])
+        Sord::Logging.error('No output format given; please specify --rbi or --rbs')
+        exit 1
+      end
+  
+      if (options[:rbi] && options[:rbs])
+        Sord::Logging.error('You cannot specify both --rbi and --rbs; please use only one')
+        exit 1
+      end
   
       if options[:regenerate]
         begin
           Sord::Logging.info('Running YARD...')
-          Bundler.with_clean_env do
+          Sord::ParlourPlugin.with_clean_env do
             system('bundle exec yard')
           end
         rescue Errno::ENOENT
@@ -52,12 +62,23 @@ module Sord
         end
       end
 
+      options[:mode] = \
+        if options[:rbi] then :rbi elsif options[:rbs] then :rbs end 
       options[:parlour] = @parlour
       options[:root] = root
 
-      Sord::RbiGenerator.new(options).run
+      Sord::Generator.new(options).run
 
       true
     end
+
+    def self.with_clean_env &block
+      meth = if Bundler.respond_to?(:with_unbundled_env)
+               :with_unbundled_env
+             else
+               :with_clean_env
+            end
+      Bundler.send meth, &block
+    end
   end
 end

data/lib/sord/type_converter.rb

@@ -2,11 +2,12 @@
 require 'yaml'
 require 'sord/logging'
 require 'sord/resolver'
+require 'parlour'
 
 module Sord
-  # Contains methods to convert YARD types to Sorbet types.
+  # Contains methods to convert YARD types to Parlour types.
   module TypeConverter
-    # A regular expression which matches Ruby namespaces and identifiers. 
+    # A regular expression which matches Ruby namespaces and identifiers.
     # "Foo", "Foo::Bar", and "::Foo::Bar" are all matches, whereas "Foo.Bar"
     # or "Foo#bar" are not.
     SIMPLE_TYPE_REGEX =
@@ -19,27 +20,26 @@ module Sord
     # "Hash{String => Symbol}", etc.
     GENERIC_TYPE_REGEX =
       /(#{SIMPLE_TYPE_REGEX})\s*[<{]\s*(.*)\s*[>}]/
-    
+
     # Match duck types which require the object implement one or more methods,
     # like '#foo', '#foo & #bar', '#foo&#bar&#baz', and '#foo&#bar&#baz&#foo_bar'.
     DUCK_TYPE_REGEX =
       /^\#[a-zA-Z_][\w]*(?:[a-zA-Z_][\w=]*)*(?:( ?\& ?\#)*[a-zA-Z_][\w=]*)*$/
-    
+
     # A regular expression which matches ordered lists in the format of
     # either "Array(String, Symbol)" or "(String, Symbol)".
     ORDERED_LIST_REGEX = /^(?:Array|)\((.*)\s*\)$/
 
-    # A regular expression which matches the shorthand Hash syntax, 
+    # A regular expression which matches the shorthand Hash syntax,
     # "{String => Symbol}".
     SHORTHAND_HASH_SYNTAX = /^{\s*(.*)\s*}$/
 
-    # A regular expression which matches the shorthand Array syntax, 
+    # A regular expression which matches the shorthand Array syntax,
     # "<String>".
     SHORTHAND_ARRAY_SYNTAX = /^<\s*(.*)\s*>$/
 
-    # An array of built-in generic types supported by Sorbet.
-    SORBET_SUPPORTED_GENERIC_TYPES = %w{Array Set Enumerable Enumerator Range Hash Class}
-    SORBET_SINGLE_ARG_GENERIC_TYPES = %w{Array Set Enumerable Enumerator Range}
+    # Built in parlour single arg generics
+    SINGLE_ARG_GENERIC_TYPES = %w{Array Set Enumerable Enumerator Range}
 
     # Given a string of YARD type parameters (without angle brackets), splits
     # the string into an array of each type parameter.
@@ -50,7 +50,7 @@ module Sord
       buffer = ""
       current_bracketing_level = 0
       character_pointer = 0
-      
+
       while character_pointer < params.length
         should_buffer = true
 
@@ -90,7 +90,7 @@ module Sord
       result
     end
 
-    # Converts a YARD type into a Sorbet type.
+    # Converts a YARD type into a Parlour type.
     # @param [Boolean, Array, String] yard The YARD type.
     # @param [YARD::CodeObjects::Base] item The CodeObject which the YARD type
     #   is associated with. This is used for logging and can be nil, but this
@@ -99,30 +99,34 @@ module Sord
     #   instead of SORD_ERROR_ constants for unknown types.
     # @param [Boolean] replace_unresolved_with_untyped If true, T.untyped is used
     #   when Sord is unable to resolve a constant.
-    # @return [String]
-    def self.yard_to_sorbet(yard, item = nil, replace_errors_with_untyped = false, replace_unresolved_with_untyped = false)
+    # @return [Parlour::Types::Type]
+    def self.yard_to_parlour(yard, item = nil, replace_errors_with_untyped = false, replace_unresolved_with_untyped = false)
       case yard
       when nil # Type not specified
-        "T.untyped"
+        Parlour::Types::Untyped.new
       when  "bool", "Bool", "boolean", "Boolean", "true", "false"
-        "T::Boolean"
+        Parlour::Types::Boolean.new
       when 'self'
-        item.parent.path
+        Parlour::Types::Self.new
       when Array
         # If there's only one element, unwrap it, otherwise allow for a
         # selection of any of the types
         types = yard
           .reject { |x| x == 'nil' }
-          .map { |x| yard_to_sorbet(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
-          .uniq
-        result = types.length == 1 ? types.first : "T.any(#{types.join(', ')})"
-        result = "T.nilable(#{result})" if yard.include?('nil')
+          .map { |x| yard_to_parlour(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
+          .uniq(&:hash)
+        result = types.length == 1 \
+          ? types.first
+          : Parlour::Types::Union.new(types)
+        result = Parlour::Types::Nilable.new(result) if yard.include?('nil')
         result
       when /^#{SIMPLE_TYPE_REGEX}$/
-        if SORBET_SINGLE_ARG_GENERIC_TYPES.include?(yard)
-          return "T::#{yard}[T.untyped]"
+        if SINGLE_ARG_GENERIC_TYPES.include?(yard)
+          return Parlour::Types.const_get(yard).new(Parlour::Types::Untyped.new)
         elsif yard == "Hash"
-          return "T::Hash[T.untyped, T.untyped]"
+          return Parlour::Types::Hash.new(
+            Parlour::Types::Untyped.new, Parlour::Types::Untyped.new
+          )
         end
         # If this doesn't begin with an uppercase letter, warn
         if /^[_a-z]/ === yard
@@ -136,78 +140,79 @@ module Sord
             new_path = Resolver.path_for(yard)
             Logging.infer("#{yard} was resolved to #{new_path}", item) \
               unless yard == new_path
-            new_path
+            Parlour::Types::Raw.new(new_path)
           else
             if replace_unresolved_with_untyped
-              Logging.warn("#{yard} wasn't able to be resolved to a constant in this project, replaced with T.untyped", item)
-              'T.untyped'
+              Logging.warn("#{yard} wasn't able to be resolved to a constant in this project, replaced with untyped", item)
+              Parlour::Types::Untyped.new
             else
               Logging.warn("#{yard} wasn't able to be resolved to a constant in this project", item)
-              yard
+              Parlour::Types::Raw.new(yard)
             end
           end
         else
-          yard
+          Parlour::Types::Raw.new(yard)
         end
       when DUCK_TYPE_REGEX
-        Logging.duck("#{yard} looks like a duck type, replacing with T.untyped", item)
-        'T.untyped'
+        Logging.duck("#{yard} looks like a duck type, replacing with untyped", item)
+        Parlour::Types::Untyped.new
       when /^#{GENERIC_TYPE_REGEX}$/
         generic_type = $1
         type_parameters = $2
 
-        if SORBET_SUPPORTED_GENERIC_TYPES.include?(generic_type)
-          parameters = split_type_parameters(type_parameters)
-            .map { |x| yard_to_sorbet(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
-          if SORBET_SINGLE_ARG_GENERIC_TYPES.include?(generic_type) && parameters.length > 1
-            "T::#{generic_type}[T.any(#{parameters.join(', ')})]"
-          elsif generic_type == 'Class' && parameters.length == 1
-            "T.class_of(#{parameters.first})"
-          elsif generic_type == 'Hash'
-            if parameters.length == 2
-              "T::Hash[#{parameters.join(', ')}]"
-            else
-              handle_sord_error(parameters.join, "Invalid hash, must have exactly two types: #{yard.inspect}.", item, replace_errors_with_untyped)
-            end
+        parameters = split_type_parameters(type_parameters)
+          .map { |x| yard_to_parlour(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
+        if SINGLE_ARG_GENERIC_TYPES.include?(generic_type) && parameters.length > 1
+          Parlour::Types.const_get(generic_type).new(Parlour::Types::Union.new(parameters))
+        elsif generic_type == 'Class' && parameters.length == 1
+          Parlour::Types::Class.new(parameters.first)
+        elsif generic_type == 'Hash'
+          if parameters.length == 2
+            Parlour::Types::Hash.new(*parameters)
           else
-            "T::#{generic_type}[#{parameters.join(', ')}]"
+            handle_sord_error(parameters.map(&:describe).join, "Invalid hash, must have exactly two types: #{yard.inspect}.", item, replace_errors_with_untyped)
           end
         else
-          return handle_sord_error(
-            generic_type,
-            "unsupported generic type #{generic_type.inspect} in #{yard.inspect}",
-            item,
-            replace_errors_with_untyped
-          )
+          if Parlour::Types.const_defined?(generic_type)
+            # This generic is built in to parlour, but sord doesn't
+            # explicitly know about it.
+            Parlour::Types.const_get(generic_type).new(*parameters)
+          else
+            # This is a user defined generic
+            Parlour::Types::Generic.new(
+              yard_to_parlour(generic_type),
+              parameters
+            )
+          end
         end
       # Converts ordered lists like Array(Symbol, String) or (Symbol, String)
-      # into Sorbet Tuples like [Symbol, String].
+      # into tuples.
       when ORDERED_LIST_REGEX
         type_parameters = $1
         parameters = split_type_parameters(type_parameters)
-          .map { |x| yard_to_sorbet(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
-        "[#{parameters.join(', ')}]"
+          .map { |x| yard_to_parlour(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
+        Parlour::Types::Tuple.new(parameters)
       when SHORTHAND_HASH_SYNTAX
         type_parameters = $1
         parameters = split_type_parameters(type_parameters)
-          .map { |x| yard_to_sorbet(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
+          .map { |x| yard_to_parlour(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
         # Return a warning about an invalid hash when it has more or less than two elements.
         if parameters.length == 2
-          "T::Hash[#{parameters.join(', ')}]"
+          Parlour::Types::Hash.new(*parameters)
         else
-          handle_sord_error(parameters.join, "Invalid hash, must have exactly two types: #{yard.inspect}.", item, replace_errors_with_untyped)
+          handle_sord_error(parameters.map(&:describe).join, "Invalid hash, must have exactly two types: #{yard.inspect}.", item, replace_errors_with_untyped)
         end
       when SHORTHAND_ARRAY_SYNTAX
         type_parameters = $1
         parameters = split_type_parameters(type_parameters)
-          .map { |x| yard_to_sorbet(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
+          .map { |x| yard_to_parlour(x, item, replace_errors_with_untyped, replace_unresolved_with_untyped) }
         parameters.one? \
-          ? "T::Array[#{parameters.first}]"
-          : "T::Array[T.any(#{parameters.join(', ')})]"
+          ? Parlour::Types::Array.new(parameters.first)
+          : Parlour::Types::Array.new(Parlour::Types::Union.new(parameters))
       else
         # Check for literals
         from_yaml = YAML.load(yard) rescue nil
-        return from_yaml.class.to_s \
+        return Parlour::Types::Raw.new(from_yaml.class.to_s) \
           if [Symbol, Float, Integer].include?(from_yaml.class)
 
         return handle_sord_error(yard.to_s, "#{yard.inspect} does not appear to be a type", item, replace_errors_with_untyped)
@@ -216,14 +221,17 @@ module Sord
 
     # Handles SORD_ERRORs.
     #
-    # @param [String] name
+    # @param [String, Parlour::Types::Type] name
     # @param [String] log_warning
     # @param [YARD::CodeObjects::Base] item
     # @param [Boolean] replace_errors_with_untyped
-    # @return [String]
+    # @return [Parlour::Types::Type]
     def self.handle_sord_error(name, log_warning, item, replace_errors_with_untyped)
       Logging.warn(log_warning, item)
-      return replace_errors_with_untyped ? "T.untyped" : "SORD_ERROR_#{name.gsub(/[^0-9A-Za-z_]/i, '')}"
+      str = name.is_a?(Parlour::Types::Type) ? name.describe : name
+      return replace_errors_with_untyped \
+        ? Parlour::Types::Untyped.new
+        : Parlour::Types::Raw.new("SORD_ERROR_#{name.gsub(/[^0-9A-Za-z_]/i, '')}")
     end
   end
 end

data/lib/sord/version.rb

@@ -1,4 +1,4 @@
 # typed: strong
 module Sord
-  VERSION = '0.9.0'
+  VERSION = '3.0.0.beta.2'
 end

data/rbi/sord.rbi

@@ -1,29 +1,56 @@
 # typed: strong
 module Sord
-  VERSION = T.let('0.8.0', T.untyped)
+  VERSION = T.let('3.0.0.beta.2', T.untyped)
 
+  # Handles writing logs to stdout and any other classes which request them.
   module Logging
     AVAILABLE_TYPES = T.let([:warn, :info, :duck, :error, :infer, :omit, :done].freeze, T.untyped)
 
+    # _@return_ — The hooks registered on the logger.
     sig { returns(T::Array[Proc]) }
     def self.hooks; end
 
+    # _@return_ — Whether log messages should be printed or not. This is
+    # used for testing.
     sig { returns(T::Boolean) }
     def self.silent?; end
 
+    # Sets whether log messages should be printed or not.
+    # 
+    # _@param_ `value`
     sig { params(value: T::Boolean).void }
     def self.silent=(value); end
 
+    # Sets the array of log messages types which should be processed. Any not on
+    # this list will be discarded. This should be a subset of AVAILABLE_TYPES.
+    # 
+    # _@param_ `value`
     sig { params(value: T::Array[Symbol]).void }
     def self.enabled_types=(value); end
 
+    # Gets the array of log messages types which should be processed. Any not on
+    # this list will be discarded.
     sig { returns(T::Array[Symbol]) }
     def self.enabled_types; end
 
+    # Returns a boolean indicating whether a given array is a valid value for 
+    # #enabled_types.
+    # 
+    # _@param_ `value`
     sig { params(value: T::Array[Symbol]).void }
     def self.valid_types?(value); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # A generic log message writer which is called by all other specific logging
+    # methods. This shouldn't be called outside of the Logging class itself.
+    # 
+    # _@param_ `kind` — The kind of log message this is.
+    # 
+    # _@param_ `header` — The prefix for this log message. For consistency, it should be up to five uppercase characters wrapped in square brackets, with some unique colour applied.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig do
       params(
         kind: Symbol,
@@ -35,38 +62,91 @@ module Sord
     def self.generic(kind, header, msg, item); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print a warning message. This should be used for things which require the
+    # user's attention but do not prevent the process from stopping.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.warn(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print an info message. This should be used for generic informational
+    # messages which the user doesn't need to act on.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.info(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print a duck-typing message. This should be used when the YARD 
+    # documentation contains duck typing, which isn't supported by Sorbet, so
+    # it is substituted for something different.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.duck(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print an error message. This should be used for things which require the
+    # current process to stop.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.error(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print an infer message. This should be used when the user should be told
+    # that some information has been filled in or guessed for them, and that 
+    # information is likely correct.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.infer(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print an omit message. This should be used as a special type of warning
+    # to alert the user that there is some information missing, but this
+    # information is not critical to the completion of the process.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.omit(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Print a done message. This should be used when a process completes
+    # successfully.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base)).void }
     def self.done(msg, item = nil); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Invokes all registered hooks on the logger.
+    # 
+    # _@param_ `kind` — The kind of log message this is.
+    # 
+    # _@param_ `msg` — The log message to write.
+    # 
+    # _@param_ `item` — The CodeObject which this log  is associated with, if any. This is shown before the log message if it is specified.
     sig { params(kind: Symbol, msg: String, item: YARD::CodeObjects::Base).void }
     def self.invoke_hooks(kind, msg, item); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Adds a hook to the logger.
     sig { params(blk: T.proc.params(kind: Symbol, msg: String, item: YARD::CodeObjects::Base).void).void }
     def self.add_hook(&blk); end
   end
@@ -78,85 +158,159 @@ module Sord
     sig { void }
     def self.clear; end
 
+    # _@param_ `name`
     sig { params(name: String).returns(T::Array[String]) }
     def self.paths_for(name); end
 
+    # _@param_ `name`
     sig { params(name: String).returns(T.nilable(String)) }
     def self.path_for(name); end
 
     sig { returns(T::Array[String]) }
     def self.builtin_classes; end
 
+    # _@param_ `name`
+    # 
+    # _@param_ `item`
     sig { params(name: String, item: Object).returns(T::Boolean) }
     def self.resolvable?(name, item); end
   end
 
-  class RbiGenerator
+  # Converts the current working directory's YARD registry into an type
+  # signature file.
+  class Generator
+    VALID_MODES = T.let([:rbi, :rbs], T.untyped)
+
+    # _@return_ — The number of objects this generator has processed so 
+    # far.
     sig { returns(Integer) }
     def object_count; end
 
-    # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
-    sig { returns(T::Array[[String, YARD::CodeObjects::Base, Integer]]) }
-    def warnings; end
-
+    # Create a new generator.
+    # 
+    # _@param_ `options`
     sig { params(options: T::Hash[T.untyped, T.untyped]).void }
     def initialize(options); end
 
+    # Increment the namespace counter.
     sig { void }
     def count_namespace; end
 
+    # Increment the method counter.
     sig { void }
     def count_method; end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # Given a YARD CodeObject, add lines defining its mixins (that is, extends
+    # and includes) to the current file. Returns the number of mixins.
+    # 
+    # _@param_ `item`
     sig { params(item: YARD::CodeObjects::Base).returns(Integer) }
     def add_mixins(item); end
 
     # sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
+    # Given a YARD NamespaceObject, add lines defining constants.
+    # 
+    # _@param_ `item`
     sig { params(item: YARD::CodeObjects::NamespaceObject).void }
     def add_constants(item); end
 
     # sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
+    # sord warn - Parlour::TypedObject wasn't able to be resolved to a constant in this project
+    # Adds comments to an object based on a docstring.
+    # 
+    # _@param_ `item`
+    # 
+    # _@param_ `typed_object`
+    sig { params(item: YARD::CodeObjects::NamespaceObject, typed_object: Parlour::TypedObject).void }
+    def add_comments(item, typed_object); end
+
+    # sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
+    # Given a YARD NamespaceObject, add lines defining its methods and their
+    # signatures to the current file.
+    # 
+    # _@param_ `item`
     sig { params(item: YARD::CodeObjects::NamespaceObject).void }
     def add_methods(item); end
 
     # sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
+    # Given a YARD NamespaceObject, add lines defining either its class
+    # and instance attributes and their signatures to the current file.
+    # 
+    # _@param_ `item`
+    sig { params(item: YARD::CodeObjects::NamespaceObject).void }
+    def add_attributes(item); end
+
+    # sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
+    # Given a YARD NamespaceObject, add lines defining its mixins, methods
+    # and children to the file.
+    # 
+    # _@param_ `item`
     sig { params(item: YARD::CodeObjects::NamespaceObject).void }
     def add_namespace(item); end
 
+    # Populates the generator with the contents of the YARD registry. You 
+    # must load the YARD registry first!
     sig { void }
     def populate; end
 
+    # Populates the generator with the contents of the YARD registry, then
+    # uses the loaded Parlour::Generator to generate the file. You must
+    # load the YARD registry first!
     sig { void }
     def generate; end
 
+    # Loads the YARD registry, populates the file, and prints any relevant
+    # final logs.
     sig { void }
     def run; end
-  end
-
-  class ParlourPlugin < Parlour::Plugin
-    # sord omit - no YARD return type given, using T.untyped
-    sig { returns(T.untyped) }
-    def options; end
 
-    # sord omit - no YARD return type given, using T.untyped
-    sig { returns(T.untyped) }
-    def parlour; end
+    # Given two pairs of arrays representing method parameters, in the form
+    # of ["variable_name", "default_value"], sort the parameters so they're
+    # valid for Sorbet. Sorbet requires that, e.g. required kwargs go before
+    # optional kwargs.
+    # 
+    # _@param_ `pair1`
+    # 
+    # _@param_ `pair2`
+    # 
+    # _@return_ — Integer
+    sig { params(pair1: T::Array[T.untyped], pair2: T::Array[T.untyped]).returns(T.untyped) }
+    def sort_params(pair1, pair2); end
 
-    # sord omit - no YARD return type given, using T.untyped
-    sig { params(value: T.untyped).returns(T.untyped) }
-    def parlour=(value); end
+    # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # _@return_ — The 
+    # errors encountered by by the generator. Each element is of the form
+    # [message, item, line].
+    sig { returns(T::Array[[String, YARD::CodeObjects::Base, Integer]]) }
+    attr_reader :warnings
+  end
 
-    # sord omit - no YARD type given for "options", using T.untyped
-    sig { params(options: T.untyped).returns(ParlourPlugin) }
+  class ParlourPlugin < Parlour::Plugin
+    # sord omit - no YARD type given for "options", using untyped
+    sig { params(options: T.untyped).void }
     def initialize(options); end
 
-    # sord omit - no YARD type given for "root", using T.untyped
-    # sord omit - no YARD return type given, using T.untyped
+    # sord omit - no YARD type given for "root", using untyped
+    # sord omit - no YARD return type given, using untyped
     sig { params(root: T.untyped).returns(T.untyped) }
     def generate(root); end
+
+    # sord omit - no YARD return type given, using untyped
+    sig { params(block: T.untyped).returns(T.untyped) }
+    def self.with_clean_env(&block); end
+
+    # sord omit - no YARD type given for :options, using untyped
+    # Returns the value of attribute options.
+    sig { returns(T.untyped) }
+    attr_reader :options
+
+    # Returns the value of attribute parlour.
+    sig { returns(T.untyped) }
+    attr_accessor :parlour
   end
 
+  # Contains methods to convert YARD types to Parlour types.
   module TypeConverter
     SIMPLE_TYPE_REGEX = T.let(/(?:\:\:)?[a-zA-Z_][\w]*(?:\:\:[a-zA-Z_][\w]*)*/, T.untyped)
     GENERIC_TYPE_REGEX = T.let(/(#{SIMPLE_TYPE_REGEX})\s*[<{]\s*(.*)\s*[>}]/, T.untyped)
@@ -164,32 +318,58 @@ module Sord
     ORDERED_LIST_REGEX = T.let(/^(?:Array|)\((.*)\s*\)$/, T.untyped)
     SHORTHAND_HASH_SYNTAX = T.let(/^{\s*(.*)\s*}$/, T.untyped)
     SHORTHAND_ARRAY_SYNTAX = T.let(/^<\s*(.*)\s*>$/, T.untyped)
-    SORBET_SUPPORTED_GENERIC_TYPES = T.let(%w{Array Set Enumerable Enumerator Range Hash Class}, T.untyped)
-    SORBET_SINGLE_ARG_GENERIC_TYPES = T.let(%w{Array Set Enumerable Enumerator Range}, T.untyped)
-
+    SINGLE_ARG_GENERIC_TYPES = T.let(%w{Array Set Enumerable Enumerator Range}, T.untyped)
+
+    # Given a string of YARD type parameters (without angle brackets), splits
+    # the string into an array of each type parameter.
+    # 
+    # _@param_ `params` — The type parameters.
+    # 
+    # _@return_ — The split type parameters.
     sig { params(params: String).returns(T::Array[String]) }
     def self.split_type_parameters(params); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
+    # Converts a YARD type into a Parlour type.
+    # 
+    # _@param_ `yard` — The YARD type.
+    # 
+    # _@param_ `item` — The CodeObject which the YARD type is associated with. This is used for logging and can be nil, but this will lead to less informative log messages.
+    # 
+    # _@param_ `replace_errors_with_untyped` — If true, T.untyped is used instead of SORD_ERROR_ constants for unknown types.
+    # 
+    # _@param_ `replace_unresolved_with_untyped` — If true, T.untyped is used when Sord is unable to resolve a constant.
     sig do
       params(
         yard: T.any(T::Boolean, T::Array[T.untyped], String),
         item: T.nilable(YARD::CodeObjects::Base),
         replace_errors_with_untyped: T::Boolean,
         replace_unresolved_with_untyped: T::Boolean
-      ).returns(String)
+      ).returns(Parlour::Types::Type)
     end
-    def self.yard_to_sorbet(yard, item = nil, replace_errors_with_untyped = false, replace_unresolved_with_untyped = false); end
+    def self.yard_to_parlour(yard, item = nil, replace_errors_with_untyped = false, replace_unresolved_with_untyped = false); end
 
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
+    # Handles SORD_ERRORs.
+    # 
+    # _@param_ `name`
+    # 
+    # _@param_ `log_warning`
+    # 
+    # _@param_ `item`
+    # 
+    # _@param_ `replace_errors_with_untyped`
     sig do
       params(
-        name: String,
+        name: T.any(String, Parlour::Types::Type),
         log_warning: String,
         item: YARD::CodeObjects::Base,
         replace_errors_with_untyped: T::Boolean
-      ).returns(String)
+      ).returns(Parlour::Types::Type)
     end
     def self.handle_sord_error(name, log_warning, item, replace_errors_with_untyped); end
   end
-end
+end