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

jamescdavis · 2022-09-22T17:10:09Z

Description

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.

{{! 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}}

Checklist

I’ve added tests to confirm my change works.
~~(If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory).~~
(If the change is user-facing) I’ve added my changes to changelog_unreleased/*/XXXX.md file following changelog_unreleased/TEMPLATE.md.
I’ve read the contributing guidelines.

✨Try the playground for this PR✨

fisker · 2022-09-22T17:39:07Z

@dcyriller Can you review?

fisker · 2022-09-22T17:45:33Z

Prettier pr-13507
Playground link

--parser glimmer

Input:

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

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

Output:

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

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

jamescdavis · 2022-09-22T19:55:25Z

if has same behavior in stable: playground link

fisker · 2022-09-26T03:04:35Z

Thank you! @jamescdavis @dcyriller

jamescdavis · 2022-09-26T14:23:38Z

Thanks @fisker! How long before we can expect to see this in a release? 🙂

fisker · 2022-09-27T03:07:29Z

@sosukesuzuki ^

sosukesuzuki · 2022-09-27T06:36:36Z

Sorry, we are still undecided: the current version of Prettier is 2.7, and I'm thinking of releasing 3.0 instead of 2.8. You can check the progress of 3.0 at #13142.

kachkaev · 2022-11-16T16:45:15Z

@sosukesuzuki this PR is mentioned in 2.8 blog draft: #13813 (FYI).

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [prettier](https://prettier.io) ([source](https://github.com/prettier/prettier)) | devDependencies | patch | [`2.8.1` -> `2.8.2`](https://renovatebot.com/diffs/npm/prettier/2.8.1/2.8.2) | --- ### Release Notes <details> <summary>prettier/prettier</summary> ### [`v2.8.2`](https://github.com/prettier/prettier/blob/HEAD/CHANGELOG.md#282) [Compare Source](prettier/prettier@2.8.1...2.8.2) [diff](prettier/prettier@2.8.1...2.8.2) ##### Don't lowercase link references ([#13155](prettier/prettier#13155) by [@DerekNonGeneric](https://github.com/DerekNonGeneric) & [@fisker](https://github.com/fisker))  ```markdown  We now don't strictly follow the release notes format suggested by [Keep a Changelog]. [Keep a Changelog]: https://example.com/  We now don't strictly follow the release notes format suggested by [Keep a Changelog]. [keep a changelog]: https://example.com/   <Same as input> ``` ##### Preserve self-closing tags ([#13691](prettier/prettier#13691) by [@dcyriller](https://github.com/dcyriller))  ```hbs {{! Input }} <div /> <div></div> <custom-component /> <custom-component></custom-component> <i /> <i></i> <Component /> <Component></Component> {{! Prettier 2.8.1 }} <div></div> <div></div> <custom-component></custom-component> <custom-component></custom-component> <i></i> <i></i> <Component /> <Component /> {{! Prettier 2.8.2 }} <div /> <div></div> <custom-component /> <custom-component></custom-component> <i /> <i></i> <Component /> <Component /> ``` ##### Allow custom "else if"-like blocks with block params ([#13930](prettier/prettier#13930) by [@jamescdavis](https://github.com/jamescdavis)) [#13507](prettier/prettier#13507) added support for custom block keywords used with `else`, but failed to allow block params. This updates printer-glimmer to allow block params with custom "else if"-like blocks.  ```hbs {{! Input }} {{#when isAtWork as |work|}} Ship that {{work}}! {{else when isReading as |book|}} You can finish {{book}} eventually... {{else}} Go to bed! {{/when}} {{! Prettier 2.8.1 }} {{#when isAtWork as |work|}} Ship that {{work}}! {{else when isReading}} You can finish {{book}} eventually... {{else}} Go to bed! {{/when}} {{! Prettier 2.8.2 }} {{#when isAtWork as |work|}} Ship that {{work}}! {{else when isReading as |book|}} You can finish {{book}} eventually... {{else}} Go to bed! {{/when}} ``` ##### Preserve empty lines between nested SCSS maps ([#13931](prettier/prettier#13931) by [@jneander](https://github.com/jneander))  ```scss /* Input */ $map: ( 'one': ( 'key': 'value', ), 'two': ( 'key': 'value', ), ) /* Prettier 2.8.1 */ $map: ( 'one': ( 'key': 'value', ), 'two': ( 'key': 'value', ), ) /* Prettier 2.8.2 */ $map: ( 'one': ( 'key': 'value', ), 'two': ( 'key': 'value', ), ) ``` ##### Fix missing parentheses when an expression statement starts with `let[` ([#14000](prettier/prettier#14000), [#14044](prettier/prettier#14044) by [@fisker](https://github.com/fisker), [@thorn0](https://github.com/thorn0))  ```jsx // Input (let[0] = 2); // Prettier 2.8.1 let[0] = 2; // Prettier 2.8.1 (second format) SyntaxError: Unexpected token (1:5) > 1 | let[0] = 2; | ^ 2 | // Prettier 2.8.2 (let)[0] = 2; ``` ##### Fix semicolon duplicated at the end of LESS file ([#14007](prettier/prettier#14007) by [@mvorisek](https://github.com/mvorisek))  ```less // Input @variable: { field: something; }; // Prettier 2.8.1 @variable: { field: something; }; ; // Prettier 2.8.2 @variable: { field: something; }; ``` ##### Fix no space after unary minus when followed by opening parenthesis in LESS ([#14008](prettier/prettier#14008) by [@mvorisek](https://github.com/mvorisek))  ```less // Input .unary_minus_single { margin: -(@a); } .unary_minus_multi { margin: 0 -(@a); } .binary_minus { margin: 0 - (@a); } // Prettier 2.8.1 .unary_minus_single { margin: - (@a); } .unary_minus_multi { margin: 0 - (@a); } .binary_minus { margin: 0 - (@a); } // Prettier 2.8.2 .unary_minus_single { margin: -(@a); } .unary_minus_multi { margin: 0 -(@a); } .binary_minus { margin: 0 - (@a); } ``` ##### Do not change case of property name if inside a variable declaration in LESS ([#14034](prettier/prettier#14034) by [@mvorisek](https://github.com/mvorisek))  ```less // Input @var: { preserveCase: 0; }; // Prettier 2.8.1 @var: { preservecase: 0; }; // Prettier 2.8.2 @var: { preserveCase: 0; }; ``` ##### Fix formatting for auto-accessors with comments ([#14038](prettier/prettier#14038) by [@fisker](https://github.com/fisker))  ```jsx // Input class A { @dec() // comment accessor b; } // Prettier 2.8.1 class A { @dec() accessor // comment b; } // Prettier 2.8.1 (second format) class A { @dec() accessor; // comment b; } // Prettier 2.8.2 class A { @dec() // comment accessor b; } ``` ##### Add parentheses for TSTypeQuery to improve readability ([#14042](prettier/prettier#14042) by [@onishi-kohei](https://github.com/onishi-kohei))  ```tsx // Input a as (typeof node.children)[number] a as (typeof node.children)[] a as ((typeof node.children)[number])[] // Prettier 2.8.1 a as typeof node.children[number]; a as typeof node.children[]; a as typeof node.children[number][]; // Prettier 2.8.2 a as (typeof node.children)[number]; a as (typeof node.children)[]; a as (typeof node.children)[number][]; ``` ##### Fix displacing of comments in default switch case ([#14047](prettier/prettier#14047) by [@thorn0](https://github.com/thorn0)) It was a regression in Prettier 2.6.0.  ```jsx // Input switch (state) { default: result = state; // no change break; } // Prettier 2.8.1 switch (state) { default: // no change result = state; break; } // Prettier 2.8.2 switch (state) { default: result = state; // no change break; } ``` ##### Support type annotations on auto accessors via `babel-ts` ([#14049](prettier/prettier#14049) by [@sosukesuzuki](https://github.com/sosukesuzuki)) [The bug that `@babel/parser` cannot parse auto accessors with type annotations](babel/babel#15205) has been fixed. So we now support it via `babel-ts` parser.  ```tsx class Foo { accessor prop: number; } ``` ##### Fix formatting of empty type parameters ([#14073](prettier/prettier#14073) by [@fisker](https://github.com/fisker))  ```jsx // Input const foo: bar</* comment */> = () => baz; // Prettier 2.8.1 Error: Comment "comment" was not printed. Please report this error! // Prettier 2.8.2 const foo: bar</* comment */> = () => baz; ``` ##### Add parentheses to head of `ExpressionStatement` instead of the whole statement ([#14077](prettier/prettier#14077) by [@fisker](https://github.com/fisker))  ```jsx // Input ({}).toString.call(foo) === "[object Array]" ? foo.forEach(iterateArray) : iterateObject(foo); // Prettier 2.8.1 ({}.toString.call(foo) === "[object Array]" ? foo.forEach(iterateArray) : iterateObject(foo)); // Prettier 2.8.2 ({}).toString.call(foo.forEach) === "[object Array]" ? foo.forEach(iterateArray) : iterateObject(foo); ``` ##### Fix comments after directive ([#14081](prettier/prettier#14081) by [@fisker](https://github.com/fisker))  ```jsx // Input "use strict" /* comment */; // Prettier 2.8.1 (with other js parsers except `babel`) Error: Comment "comment" was not printed. Please report this error! // Prettier 2.8.2 <Same as input> ``` ##### Fix formatting for comments inside JSX attribute ([#14082](prettier/prettier#14082) with by [@fisker](https://github.com/fisker))  ```jsx // Input function MyFunctionComponent() { <button label=/*old*/"new">button</button> } // Prettier 2.8.1 Error: Comment "old" was not printed. Please report this error! // Prettier 2.8.2 function MyFunctionComponent() { <button label=/*old*/ "new">button</button>; } ``` ##### Quote numeric keys for json-stringify parser ([#14083](prettier/prettier#14083) by [@fisker](https://github.com/fisker))  ```jsx // Input {0: 'value'} // Prettier 2.8.1 { 0: "value" } // Prettier 2.8.2 { "0": "value" } ``` ##### Fix removing commas from function arguments in maps ([#14089](prettier/prettier#14089) by [@sosukesuzuki](https://github.com/sosukesuzuki))  ```scss /* Input */ $foo: map-fn( ( "#{prop}": inner-fn($first, $second), ) ); /* Prettier 2.8.1 */ $foo: map-fn(("#{prop}": inner-fn($first $second))); /* Prettier 2.8.2 */ $foo: map-fn( ( "#{prop}": inner-fn($first, $second), ) ); ``` ##### Do not insert space in LESS property access ([#14103](prettier/prettier#14103) by [@fisker](https://github.com/fisker))  ```less // Input a { color: @colors[@white]; } // Prettier 2.8.1 a { color: @colors[ @white]; } // Prettier 2.8.2 <Same as input> ``` </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1708 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

jamescdavis added 3 commits September 22, 2022 12:49

correctly format custom block else ifish

1d7f864

add test/snapshot for custom else

63a5ca7

add changelog

9f09c67

jamescdavis force-pushed the handlebars_support_custom_else_ifish branch from 3c9f279 to 9f09c67 Compare September 22, 2022 17:12

jamescdavis marked this pull request as ready for review September 22, 2022 17:14

s/ifish/ifLike/

de73923

fisker approved these changes Sep 23, 2022

View reviewed changes

Update 13507.md

77d7fd7

sosukesuzuki approved these changes Sep 23, 2022

View reviewed changes

dcyriller approved these changes Sep 23, 2022

View reviewed changes

fisker merged commit 38611cb into prettier:main Sep 26, 2022
28 checks passed

jamescdavis deleted the handlebars_support_custom_else_ifish branch September 26, 2022 13:27

kachkaev added this to the 2.8 milestone Nov 16, 2022

jamescdavis mentioned this pull request Dec 1, 2022

[handlebars] allow custom "else if"-like with block params #13930

Merged

4 tasks

jamescdavis mentioned this pull request Dec 30, 2022

[handlebars] group params in opening block statements #14067

Merged

4 tasks

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

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

jamescdavis commented Sep 22, 2022 •

edited

fisker commented Sep 22, 2022

fisker commented Sep 22, 2022

jamescdavis commented Sep 22, 2022

fisker commented Sep 26, 2022

jamescdavis commented Sep 26, 2022

fisker commented Sep 27, 2022

sosukesuzuki commented Sep 27, 2022

kachkaev commented Nov 16, 2022

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

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

Conversation

jamescdavis commented Sep 22, 2022 • edited

Description

Checklist

fisker commented Sep 22, 2022

fisker commented Sep 22, 2022

jamescdavis commented Sep 22, 2022

fisker commented Sep 26, 2022

jamescdavis commented Sep 26, 2022

fisker commented Sep 27, 2022

sosukesuzuki commented Sep 27, 2022

kachkaev commented Nov 16, 2022

jamescdavis commented Sep 22, 2022 •

edited