Contents

# typed: strict
# frozen_string_literal: true

module Tapioca
  class RBIFormatter < RBI::Formatter
    extend T::Sig

    sig do
      params(
        file: RBI::File,
        command: String,
        reason: T.nilable(String),
      ).void
    end
    def write_header!(file, command, reason: nil)
      file.comments << RBI::Comment.new("DO NOT EDIT MANUALLY")
      file.comments << RBI::Comment.new("This is an autogenerated file for #{reason}.") unless reason.nil?
      file.comments << RBI::Comment.new("Please instead update this file by running `#{command}`.")
      # Prevent the header from being attached to the top-level node when generating YARD docs
      file.comments << RBI::BlankLine.new
    end

    sig { params(file: RBI::File).void }
    def write_empty_body_comment!(file)
      file.comments << RBI::BlankLine.new unless file.comments.empty?
      file.comments << RBI::Comment.new("THIS IS AN EMPTY RBI FILE.")
      file.comments << RBI::Comment.new("see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem")
    end
  end

  DEFAULT_RBI_FORMATTER = T.let(
    RBIFormatter.new(
      add_sig_templates: false,
      group_nodes: true,
      max_line_length: nil,
      nest_singleton_methods: true,
      nest_non_public_methods: true,
      sort_nodes: true,
    ),
    RBIFormatter,
  )
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
tapioca-0.16.1	lib/tapioca/rbi_formatter.rb
tapioca-0.16.0	lib/tapioca/rbi_formatter.rb
tapioca-0.15.1	lib/tapioca/rbi_formatter.rb
tapioca-0.15.0	lib/tapioca/rbi_formatter.rb
tapioca-0.14.4	lib/tapioca/rbi_formatter.rb
tapioca-0.14.3	lib/tapioca/rbi_formatter.rb