Skip to content

Fix RBS rewriting to preserve line numbers #861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Morriar wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −2
Draft

Fix RBS rewriting to preserve line numbers #861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,21 @@ def visit_call_node(node)

private

# Preserves line numbers by adding blank lines after the replacement string
# to match the number of lines in the original location
#: (Prism::Location, String) -> String
def preserve_line_numbers(location, replacement_string)
original_lines = location.end_line - location.start_line + 1
replacement_lines = replacement_string.lines.count

if original_lines > replacement_lines
padding = "\n" * (original_lines - replacement_lines)
replacement_string + padding
else
replacement_string
Copy link
Member

@paracycle paracycle Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if original_lines < replacement_lines? Could that ever happen? Should we handle that explicitly and raise if that is not expected?

end
end

#: (Prism::CallNode) -> void
def visit_attr(node)
comments = node_rbs_comments(node)
Expand Down Expand Up @@ -100,10 +115,13 @@ def visit_attr(node)

apply_member_annotations(comments.method_annotations, sig)

sig_string = sig.string(max_line_length: @max_line_length)
replacement = preserve_line_numbers(signature.location, sig_string)

@rewriter << Source::Replace.new(
signature.location.start_offset,
signature.location.end_offset,
sig.string(max_line_length: @max_line_length),
replacement,
)
rescue ::RBS::ParsingError, ::RBI::Error
# Ignore signatures with errors
Expand Down Expand Up @@ -139,10 +157,13 @@ def rewrite_def(def_node, comments)

apply_member_annotations(comments.method_annotations, sig)

sig_string = sig.string(max_line_length: @max_line_length)
replacement = preserve_line_numbers(signature.location, sig_string)

@rewriter << Source::Replace.new(
signature.location.start_offset,
signature.location.end_offset,
sig.string(max_line_length: @max_line_length),
replacement,
)
end
end
Expand Down
5 changes: 5 additions & 0 deletions test/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,14 @@ def foo(a, b); end

assert_equal(<<~RB, rbs_comments_to_sorbet_sigs(contents))
sig { returns(::T::Array[Integer]) }


attr_accessor :foo

sig { params(a: Integer, b: Integer).returns(Integer) }



def foo(a, b); end
RB
end
Expand Down
Loading