Skip to content

Handle formatting annotated method parameters #12446

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

Merged
beta-ziliani merged 4 commits into from
Sep 7, 2022
Merged

Handle formatting annotated method parameters #12446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a971e9e
Handle formatting annotated method parameters
Blacksmoke16 Sep 4, 2022
3f5344d
Handle block args
Blacksmoke16 Sep 4, 2022
9258c2d
PR comments
Blacksmoke16 Sep 5, 2022
31607ae
Simplify `format_parameter_annotations` logic
Blacksmoke16 Sep 6, 2022
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
171 changes: 171 additions & 0 deletions spec/compiler/formatter/formatter_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,177 @@ describe Crystal::Formatter do
assert_format "def foo\n 1 #\nrescue\nend"
assert_format "def foo\n 1\n #\n\n\nrescue\nend", "def foo\n 1\n #\nrescue\nend"

assert_format "def foo(@[MyAnn] v); end"
assert_format "def foo(@[MyAnn] &); end"
assert_format "def foo(@[MyAnn] &block); end"
assert_format "def foo(@[MyAnn] & : String -> Nil); end"
assert_format "def foo( @[MyAnn] v ); end", "def foo(@[MyAnn] v); end"
assert_format "def foo(@[AnnOne] @[AnnTwo] v); end"
assert_format "def foo(@[AnnOne] @[AnnTwo] v); end", "def foo(@[AnnOne] @[AnnTwo] v); end"
assert_format "def foo(@[AnnOne] @[AnnTwo] & ); end", "def foo(@[AnnOne] @[AnnTwo] &); end"
assert_format "def foo(@[AnnOne] @[AnnTwo] &block : Int32 -> ); end", "def foo(@[AnnOne] @[AnnTwo] &block : Int32 ->); end"
assert_format <<-CRYSTAL
def foo(
@[MyAnn] bar
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
foo,
@[MyAnn] &block
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
foo,
@[MyAnn]
&block
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
foo,

@[MyAnn]
&block
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
foo,

@[MyAnn]
@[MyAnn]
& : Nil -> Nil
); end
CRYSTAL

assert_format <<-BEFORE, <<-AFTER
def foo(
@[MyAnn] bar
); end
BEFORE
def foo(
@[MyAnn] bar
); end
AFTER

assert_format <<-CRYSTAL
def foo(
@[MyAnn]
bar
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
@[MyAnn]
@[MyAnn]
bar
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
@[MyAnn]
@[MyAnn]
bar,
@[MyAnn] baz
); end
CRYSTAL

assert_format <<-CRYSTAL
def foo(
@[MyAnn]
@[MyAnn]
bar,

@[MyAnn] baz
); end
CRYSTAL

assert_format <<-BEFORE, <<-AFTER
def foo(
@[MyAnn]
bar
); end
BEFORE
def foo(
@[MyAnn]
bar
); end
AFTER

assert_format <<-BEFORE, <<-AFTER
def foo(
@[MyAnn]
bar
); end
BEFORE
def foo(
@[MyAnn]
bar
); end
AFTER

assert_format <<-BEFORE
def foo(
@[MyAnn]
@[MyAnn]
bar,
@[MyAnn] @[MyAnn] baz,
@[MyAnn]
@[MyAnn]
biz
); end
BEFORE

assert_format <<-BEFORE
def foo(
@[MyAnn]
@[MyAnn]
bar,

@[MyAnn] @[MyAnn] baz,

@[MyAnn]
@[MyAnn]
biz
); end
BEFORE

assert_format <<-BEFORE, <<-AFTER
def foo(
@[MyAnn]
@[MyAnn]
bar,

@[MyAnn] @[MyAnn] baz,

@[MyAnn]

@[MyAnn]

biz
); end
BEFORE
def foo(
@[MyAnn]
@[MyAnn]
bar,

@[MyAnn] @[MyAnn] baz,

@[MyAnn]
@[MyAnn]
biz
); end
AFTER

assert_format "loop do\n 1\nrescue\n 2\nend"
assert_format "loop do\n 1\n loop do\n 2\n rescue\n 3\n end\n 4\nend"

Expand Down
28 changes: 28 additions & 0 deletions src/compiler/crystal/tools/formatter.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1548,6 +1548,8 @@ module Crystal
next if arg.external_name.empty? # skip empty splat argument.
end

format_parameter_annotations(arg)

arg.accept self
to_skip += 1 if @last_arg_is_skip
end
Expand All @@ -1565,6 +1567,7 @@ module Crystal

if block_arg
wrote_newline = format_def_arg(wrote_newline, false) do
format_parameter_annotations(block_arg)
write_token :OP_AMP
skip_space_or_newline

Expand All @@ -1591,6 +1594,31 @@ module Crystal
to_skip
end

private def format_parameter_annotations(node)
return unless (anns = node.parsed_annotations)

anns.each do |ann|
ann.accept self

skip_space

if @token.type.newline?
write_line
write_indent
else
write " "
end

skip_space_or_newline
end

if @token.type.newline?
skip_space_or_newline
write_line
write_indent
end
end

def format_def_arg(wrote_newline, has_more)
write_indent if wrote_newline

Expand Down