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

Jump to bottom

[handlebars] correctly format custom "else if" blocks #13507

Merged
merged 5 commits into from Sep 26, 2022
Merged

[handlebars] correctly format custom "else if" blocks #13507

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
1d7f864
correctly format custom block else ifish
jamescdavis Sep 22, 2022
63a5ca7
add test/snapshot for custom else
jamescdavis Sep 22, 2022
9f09c67
add changelog
jamescdavis Sep 22, 2022
de73923
s/ifish/ifLike/
jamescdavis Sep 22, 2022
77d7fd7
Update 13507.md
fisker Sep 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions changelog_unreleased/handlebars/13507.md
View file
Open in desktop
@@ -0,0 +1,33 @@
#### Correctly format custom "else if" blocks (#13507 by @jamescdavis)

A template transform can be used to create custom block keywords that behave similar to `if`. This updates printer-glimmer to correctly recognize and format the "else if" case when "if" is a custom keyword.

<!-- prettier-ignore -->
```hbs
{{! Input }}
{{#when isAtWork}}
Ship that code!
{{else when isReading}}
You can finish War and Peace eventually...
{{else}}
Go to bed!
{{/when}}

{{! Prettier stable }}
{{#when isAtWork}}
Ship that code!
{{else}}{{#when isReading}}
You can finish War and Peace eventually...
{{else}}
Go to bed!
{{/when}}{{/when}}

{{! Prettier main }}
{{#when isAtWork}}
Ship that code!
{{else when isReading}}
You can finish War and Peace eventually...
{{else}}
Go to bed!
{{/when}}
```
20 changes: 11 additions & 9 deletions src/language-handlebars/printer-glimmer.js
View file
Open in desktop
Expand Up @@ -96,16 +96,16 @@ function print(path, options, print) {
case "BlockStatement": {
const pp = path.getParentNode(1);

const isElseIf =
const isElseIfLike =
pp &&
pp.inverse &&
pp.inverse.body.length === 1 &&
pp.inverse.body[0] === node &&
pp.inverse.body[0].path.parts[0] === "if";
pp.inverse.body[0].path.parts[0] === pp.path.parts[0];

if (isElseIf) {
if (isElseIfLike) {
return [
printElseIfBlock(path, print),
printElseIfLikeBlock(path, print, pp.inverse.body[0].path.parts[0]),
printProgram(path, print, options),
printInverse(path, print, options),
];
Expand Down Expand Up @@ -562,12 +562,14 @@ function printElseBlock(node, options) {
];
}

function printElseIfBlock(path, print) {
function printElseIfLikeBlock(path, print, ifLikeKeyword) {
const parentNode = path.getParentNode(1);

return [
printInverseBlockOpeningMustache(parentNode),
"else if ",
"else ",
ifLikeKeyword,
" ",
printParams(path, print),
printInverseBlockClosingMustache(parentNode),
];
Expand Down Expand Up @@ -603,12 +605,12 @@ function blockStatementHasOnlyWhitespaceInProgram(node) {
);
}

function blockStatementHasElseIf(node) {
function blockStatementHasElseIfLike(node) {
return (
blockStatementHasElse(node) &&
node.inverse.body.length === 1 &&
isNodeOfSomeType(node.inverse.body[0], ["BlockStatement"]) &&
node.inverse.body[0].path.parts[0] === "if"
node.inverse.body[0].path.parts[0] === node.path.parts[0]
);
}

Expand Down Expand Up @@ -641,7 +643,7 @@ function printInverse(path, print, options) {
? [hardline, inverse]
: inverse;

if (blockStatementHasElseIf(node)) {
if (blockStatementHasElseIfLike(node)) {
return printed;
}

Expand Down
225 changes: 225 additions & 0 deletions tests/format/handlebars/block-statement/__snapshots__/jsfmt.spec.js.snap
View file
Open in desktop
Expand Up @@ -159,6 +159,231 @@ printWidth: 80
================================================================================
`;
exports[`custom-else.hbs format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<h1>
{{#when isAtWork}}
Ship that code!
{{else when isReading}}
You can finish War and Peace eventually...
{{else}}
Go to bed!
{{/when}}
</h1>
<h2>
{{#when a}}
A
{{else}}
B
{{/when}}
</h2>
{{#when a}}
b
{{else when c}}
d
{{else}}
e
{{/when}}
{{#when a}}
b
{{else when c}}
d
{{else}}
hello
{{#when f}}
g
{{/when}}
e
{{/when}}
{{#when a}}
b
{{else when c}}
d
{{else when e}}
f
{{else when g}}
h
{{else}}
j
{{/when}}
<div>
{{#when a}}
b
{{else when c}}
d
{{else}}
e
{{/when}}
</div>
<div>
<div>
{{#when a}}
b
{{else when c}}
d
{{else}}
e
{{/when}}
</div>
</div>
{{#when a}}
b
{{else}}
{{#each c as |d|}}
e
{{/each}}
{{/when}}
{{#when a}}
{{#when b}}
ab
{{else when c}}
ac
{{/when}}
{{/when}}
{{#when a}}
a
<div>b</div>
c
{{else}}
{{#when c}}
a
b
<div>c</div>
{{/when}}
<div>a</div>
b
c
{{/when}}
{{~#when someCondition~}}
One thing
{{~else when anotherCondition~}}
Another thing
{{~/when~}}
=====================================output=====================================
<h1>
{{#when isAtWork}}
Ship that code!
{{else when isReading}}
You can finish War and Peace eventually...
{{else}}
Go to bed!
{{/when}}
</h1>
<h2>
{{#when a}}
A
{{else}}
B
{{/when}}
</h2>
{{#when a}}
b
{{else when c}}
d
{{else}}
e
{{/when}}
{{#when a}}
b
{{else when c}}
d
{{else}}
hello
{{#when f}}
g
{{/when}}
e
{{/when}}
{{#when a}}
b
{{else when c}}
d
{{else when e}}
f
{{else when g}}
h
{{else}}
j
{{/when}}
<div>
{{#when a}}
b
{{else when c}}
d
{{else}}
e
{{/when}}
</div>
<div>
<div>
{{#when a}}
b
{{else when c}}
d
{{else}}
e
{{/when}}
</div>
</div>
{{#when a}}
b
{{else}}
{{#each c as |d|}}
e
{{/each}}
{{/when}}
{{#when a}}
{{#when b}}
ab
{{else when c}}
ac
{{/when}}
{{/when}}
{{#when a}}
a
<div>b</div>
c
{{else}}
{{#when c}}
a b
<div>c</div>
{{/when}}
<div>a</div>
b c
{{/when}}
{{~#when someCondition~}}
One thing
{{~else when anotherCondition~}}
Another thing
{{~/when~}}
================================================================================
`;
exports[`each.hbs format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
Expand Down