Skip to content
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

Format: keep trailing spaces in macros #7099

Merged
merged 5 commits into from
Dec 16, 2018
Merged

Format: keep trailing spaces in macros #7099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
83dc32b
Format: keep trailing spaces in macros
makenowjust Nov 21, 2018
88fa586
Rewrite trailing spaces using interpolation
makenowjust Dec 12, 2018
fbb3742
Remove trailing spaces in macro expressions
makenowjust Dec 12, 2018
747d51c
Rewrite heredoc to string literal
makenowjust Dec 13, 2018
f52b90b
Separate indivisual samples
makenowjust Dec 13, 2018
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
64 changes: 56 additions & 8 deletions spec/compiler/formatter/formatter_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,20 +599,20 @@ describe Crystal::Formatter do
assert_format "macro foo( x = 1, y = 2, &block)\nend", "macro foo(x = 1, y = 2, &block)\nend"
assert_format "macro foo\n 1 + 2\nend"
assert_format "macro foo\n if 1\n 1 + 2\n end\nend"
assert_format "macro foo\n {{1 + 2}} \nend", "macro foo\n {{1 + 2}}\nend"
assert_format "macro foo\n {{ 1 + 2 }} \nend", "macro foo\n {{ 1 + 2 }}\nend"
assert_format "macro foo\n {% 1 + 2 %} \nend", "macro foo\n {% 1 + 2 %}\nend"
assert_format "macro foo\n {{ 1 + 2 }}\\ \nend", "macro foo\n {{ 1 + 2 }}\\\nend"
assert_format "macro foo\n {{ 1 + 2 }}\\ \n 1\n end", "macro foo\n {{ 1 + 2 }}\\\n 1\n end"
assert_format "macro foo\n {%1 + 2%}\\ \nend", "macro foo\n {% 1 + 2 %}\\\nend"
assert_format "macro foo\n {{1 + 2}}\nend", "macro foo\n {{1 + 2}}\nend"
assert_format "macro foo\n {{ 1 + 2 }}\nend", "macro foo\n {{ 1 + 2 }}\nend"
assert_format "macro foo\n {% 1 + 2 %}\nend", "macro foo\n {% 1 + 2 %}\nend"
assert_format "macro foo\n {{ 1 + 2 }}\\\nend", "macro foo\n {{ 1 + 2 }}\\\nend"
assert_format "macro foo\n {{ 1 + 2 }}\\\n 1\n end", "macro foo\n {{ 1 + 2 }}\\\n 1\n end"
assert_format "macro foo\n {%1 + 2%}\\\nend", "macro foo\n {% 1 + 2 %}\\\nend"
assert_format "macro foo\n {% if 1 %} 2 {% end %}\nend"
assert_format "macro foo\n {% unless 1 %} 2 {% end %}\nend"
assert_format "macro foo\n {% if 1 %} 2 {% else %} 3 {% end %}\nend"
assert_format "macro foo\n {% if 1 %}\\ 2 {% else %}\\ 3 {% end %}\\\nend"
assert_format "macro foo\n {% for x in y %} 2 {% end %}\nend"
assert_format "macro foo\n {% for x in y %}\\ 2 {% end %}\\\nend"
assert_format "macro foo\n %foo\nend"
assert_format "macro foo\n %foo{x.id+2} \nend", "macro foo\n %foo{x.id + 2}\nend"
assert_format "macro foo\n %foo{x.id+2}\nend", "macro foo\n %foo{x.id + 2}\nend"
assert_format "macro foo\n %foo{x,y}\nend", "macro foo\n %foo{x, y}\nend"
assert_format "def foo : Int32\n 1\nend"
assert_format "class Foo\n macro foo\n 1\n end\nend"
Expand All @@ -625,7 +625,7 @@ describe Crystal::Formatter do
assert_format "if 1\n {{1 + 2}}\nend"
assert_format "def foo : self | Nil\n nil\nend"
assert_format "macro foo(x)\n {% if 1 %} 2 {% end %}\nend"
assert_format "macro foo()\n {% if 1 %} 2 {% end %} \nend", "macro foo\n {% if 1 %} 2 {% end %}\nend"
assert_format "macro foo()\n {% if 1 %} 2 {% end %}\nend", "macro foo\n {% if 1 %} 2 {% end %}\nend"
assert_format "macro flags\n {% if 1 %}\\\n {% end %}\\\nend"
assert_format "macro flags\n {% if 1 %}\\\n 1 {% else %}\\\n {% end %}\\\nend"
assert_format "macro flags\n {% if 1 %}{{1}}a{{2}}{% end %}\\\nend"
Expand Down Expand Up @@ -1253,4 +1253,52 @@ describe Crystal::Formatter do
e.is_a?(Y)
end))
CODE

# Keep trailing spaces in macros.
assert_format(
"macro foo\n" +
" <<-FOO\n" +
" hello \n" +
" FOO\n" +
"end"
)
assert_format(
"{% verbatim do %}\n" +
" <<-FOO\n" +
" hello \n" +
" FOO\n" +
"{% end %}"
)
assert_format(
"{% if true %}\n" +
" <<-FOO\n" +
" hello \n" +
" FOO\n" +
"{% end %}"
)
assert_format(
"{% for a in %w() %}\n" +
" <<-FOO\n" +
" hello \n" +
" FOO\n" +
"{% end %}"
)

# But remove trailing space in macro expression.
assert_format(
"macro foo\n" +
" 1 \n" +
" {{ \n" +
" 42 \n" +
" }} \n" +
" 2 \n" +
"end",
"macro foo\n" +
" 1 \n" +
" {{\n" +
" 42\n" +
" }} \n" +
" 2 \n" +
"end"
)
end
6 changes: 6 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 @@ -1672,6 +1672,12 @@ module Crystal
end

def visit(node : MacroLiteral)
line = @line
@token.raw.scan("\n") do
line -= 1
@no_rstrip_lines.add line
end

write @token.raw
next_macro_token
false
Expand Down