fix: stable format for if/for/while/do/catch/switch with trailing comment #595

jtkiesel · 2023-08-06T02:34:51Z

What changed with this PR:

If/for/while/do/catch/switch statements whose parentheses have trailing comments are now formatted stably, and in general are formatted more closely to the way that Prettier JavaScript does.

Example

Input

class Example {

  void ifStatements() {
    if (true) // comment
      System.out.println("Oops");

    if (true) {
      // comment
    }

    if (true) // comment
    {}

    if (true) // comment
    {
      System.out.println("Oops");
    }

    if (true) // comment
    {
      if (true) {}
    }

    if (true) // comment
    ;

    if (true) /*comment*/;
  }

  void forLoops() {
    for (int i = 0; i < 1; i++) // comment
      System.out.println("Oops");

    for (int i = 0; i < 1; i++) {
      // comment
    }

    for (;;)/*comment*/;

    for (int i = 0;;) //comment
    ;

    for (int i = 0; i < 1;) // comment
    {}

    for (;;) // comment
    {}

    for (; i < 1;) // comment
    {}

    for (;; i++) // comment
    {}

    for (
      int i = 0;
      i < 1;
      i++ // hi
    ) // comment
    {
      System.out.println("Oops");
    }

    for (int i = 0; i < 1; i++) // comment
    {
      if (true) {}
    }

    for (int i = 0; i < 1; i++) /*comment*/;

    for (String s : strings) // comment
      System.out.println("Oops");

    for (String s : strings) {
      // comment
    }

    for (String s : strings) // comment
    {}

    for (
      String s : strings // comment
    ) {}

    for (String s : strings) // comment
    {
      System.out.println("Oops");
    }

    for (String s : strings) // comment
    {
      if (true) {}
    }
  }

  void whileLoops() {
    while (true) // comment
      System.out.println("Oops");

    while (true) {
      // comment
    }

    while (true) // comment
    {}

    while (true) // comment
    {
      System.out.println("Oops");
    }

    while (
      true // test
    ) // comment
    {
      if (true) {}
    }

    while (true) // comment
    ;

    while (true) /*comment*/;
  }

  void doLoops() {
    do {
      // comment
    } while (true);

    do // comment
    {} while (true);

    do // comment
    {
      System.out.println("Oops");
    } while (true);

    do // comment
    {
      if (true) {}
    } while (true);

    do {} while (true) // comment
    ;

    do {} while (true) /*comment*/;

    do {
      System.out.println("Oops");
    } while (true) // comment
    ;

    do {
      if (true) {}
    } while (true) // comment
    ;
  }

  void switchStatements() {
    switch (value) {
      // comment
    }

    switch (value) // comment
    {}

    switch (value) // comment
    {
      case "a":
        System.out.println("Oops");
    }
  }

  void catchStatements() {
    try {} catch (Exception e) {
      // comment
    }

    try {} catch (Exception e) // comment
    {}

    try {} catch (Exception e) // comment
    {
      System.out.println("Oops");
    }

    try {} catch (Exception e) // comment
    {
      if (true) {}
    }
  }
}

Output

class Example {

  void ifStatements() {
    if (true)
      // comment
      System.out.println("Oops");

    if (true) {
      // comment
    }

    if (true) {
      // comment
    }

    if (true) {
      // comment
      System.out.println("Oops");
    }

    if (true) {
      // comment
      if (true) {}
    }

    if (
      true // comment
    );

    if (true/*comment*/);
  }

  void forLoops() {
    for (
      int i = 0;
      i < 1;
      i++ // comment
    )
      System.out.println("Oops");

    for (int i = 0; i < 1; i++) {
      // comment
    }

    /*comment*/
    for (;;);

    for (
      int i = 0; //comment
      ;

    );

    for (
      int i = 0;
      i < 1; // comment

    ) {}

    // comment
    for (;;) {}

    for (
      ;
      i < 1; // comment

    ) {}

    for (
      ;
      ;
      i++ // comment
    ) {}

    for (
      int i = 0;
      i < 1;
      i++ // hi
      // comment
    ) {
      System.out.println("Oops");
    }

    for (
      int i = 0;
      i < 1;
      i++ // comment
    ) {
      if (true) {}
    }

    for (int i = 0; i < 1; i++/*comment*/);

    for (String s : strings)
      // comment
      System.out.println("Oops");

    for (String s : strings) {
      // comment
    }

    for (String s : strings) {
      // comment
    }

    for (String s : strings) {} // comment

    for (String s : strings) {
      // comment
      System.out.println("Oops");
    }

    for (String s : strings) {
      // comment
      if (true) {}
    }
  }

  void whileLoops() {
    while (true)
      // comment
      System.out.println("Oops");

    while (true) {
      // comment
    }

    while (true) {
      // comment
    }

    while (true) {
      // comment
      System.out.println("Oops");
    }

    while (
      true // test
    ) {
      // comment
      if (true) {}
    }

    while (
      true // comment
    );

    while (true/*comment*/);
  }

  void doLoops() {
    do {
      // comment
    } while (true);

    do {} while (true); // comment

    do { // comment
      System.out.println("Oops");
    } while (true);

    do { // comment
      if (true) {}
    } while (true);

    do {} while (
      true // comment
    );

    do {} while (true/*comment*/);

    do {
      System.out.println("Oops");
    } while (
      true // comment
    );

    do {
      if (true) {}
    } while (
      true // comment
    );
  }

  void switchStatements() {
    switch (value) {
      // comment
    }

    switch (
      value // comment
    ) {}

    switch (
      value // comment
    ) {
      case "a":
        System.out.println("Oops");
    }
  }

  void catchStatements() {
    try {} catch (Exception e) {
      // comment
    }

    try {} catch (
      Exception e // comment
    ) {}

    try {} catch (
      Exception e // comment
    ) {
      System.out.println("Oops");
    }

    try {} catch (
      Exception e // comment
    ) {
      if (true) {}
    }
  }
}

Relative issues or prs:

Closes #592

clementdessoude · 2023-08-12T14:35:29Z

packages/prettier-plugin-java/src/printers/blocks-and-statements.ts

@@ -192,12 +193,19 @@ export class BlocksAndStatementPrettierVisitor extends BaseCstPrettierPrinter {
  }

  ifStatement(ctx: IfStatementCtx) {
+    handleCommentsIfStatement(ctx);


Is this issue only happening on if statements ?

Looks like it also happens with for/while/do loops and switch/catch statements. I'll see about fixing those cases as well.

Latest push now handles for/while/do loops and switch/catch statements as well.

clementdessoude · 2023-08-15T20:47:25Z

Thank you, @jtkiesel ! It seems that quite a lot of logic is added in order to handle this edge case. I would like to dig a bit more into the issue to see if we can simplify some things before merging this. My objective would be to look at it by the end of the week (and the other pending PR) so we could release a new version of Prettier this weekend :)

…ment closes jhipster#592

clementdessoude · 2023-08-21T07:35:45Z

I looked at it more closely yesterday, but was not able to wrap it up, sorry. I propose to make a new release with the changes that were made since 2.2.0 (#600), and finish this afterwards.

jtkiesel · 2023-08-21T15:58:54Z

Sounds good! I'll try to take another look at it this week as well, and see if I can simplify it at all.

koppor · 2023-11-17T11:56:33Z

@clementdessoude @jtkiesel Did you find time to look into this? 😇

jtkiesel force-pushed the fix/stable-format-if-expression-trailing-comment branch from 01ee02b to 4a36754 Compare August 6, 2023 02:38

clementdessoude reviewed Aug 12, 2023

View reviewed changes

DanielFran added $100 https://www.jhipster.tech/bug-bounties/ $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ labels Aug 12, 2023

jtkiesel force-pushed the fix/stable-format-if-expression-trailing-comment branch from 4a36754 to 020b09e Compare August 15, 2023 04:19

jtkiesel changed the title ~~fix: stable format for if expression with trailing comment~~ fix: stable format for if/for/while/do/catch/switch with trailing comment Aug 15, 2023

jtkiesel requested a review from clementdessoude August 15, 2023 04:24

fix: stable format for if/for/while/do/catch/switch with trailing com…

a356f53

…ment closes jhipster#592

jtkiesel force-pushed the fix/stable-format-if-expression-trailing-comment branch from 020b09e to a356f53 Compare August 15, 2023 21:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: stable format for if/for/while/do/catch/switch with trailing comment #595

fix: stable format for if/for/while/do/catch/switch with trailing comment #595

jtkiesel commented Aug 6, 2023 •

edited

clementdessoude Aug 12, 2023

jtkiesel Aug 12, 2023 •

edited

jtkiesel Aug 15, 2023

clementdessoude commented Aug 15, 2023

clementdessoude commented Aug 21, 2023

jtkiesel commented Aug 21, 2023

koppor commented Nov 17, 2023

fix: stable format for if/for/while/do/catch/switch with trailing comment #595

Are you sure you want to change the base?

fix: stable format for if/for/while/do/catch/switch with trailing comment #595

Conversation

jtkiesel commented Aug 6, 2023 • edited

What changed with this PR:

Example

Input

Output

Relative issues or prs:

clementdessoude Aug 12, 2023

Choose a reason for hiding this comment

jtkiesel Aug 12, 2023 • edited

Choose a reason for hiding this comment

jtkiesel Aug 15, 2023

Choose a reason for hiding this comment

clementdessoude commented Aug 15, 2023

clementdessoude commented Aug 21, 2023

jtkiesel commented Aug 21, 2023

koppor commented Nov 17, 2023

jtkiesel commented Aug 6, 2023 •

edited

jtkiesel Aug 12, 2023 •

edited