feat: JDK 22 string templates #640

jtkiesel · 2024-01-22T04:13:00Z

What changed with this PR:

JDK 22 string templates are now supported. The printing of certain more complex embedded expressions is far from perfect, but I didn't want that to hold up this support and can make improvements to that in a subsequent PR.

Example

Input

class TemplateExpression {

  String info = STR."My name is \{name}";

  String s = STR."\{x} + \{y} = \{x + y}";

  String s = STR."You have a \{getOfferType()} waiting for you!";

  String msg = STR."The file \{filePath} \{file.exists() ? "does" : "does not"} exist";

  String time = STR."The time is \{
    // The java.time.format package is very useful
    DateTimeFormatter
      .ofPattern("HH:mm:ss")
      .format(LocalTime.now())
  } right now";

  String data = STR."\{index++}, \{index++}, \{index++}, \{index++}";

  String s = STR."\{fruit[0]}, \{STR."\{fruit[1]}, \{fruit[2]}"}";

  String html = STR."""
    <html>
      <head>
        <title>\{title}</title>
      </head>
      <body>
        <p>\{text}</p>
      </body>
    </html>
    """;

  String table = STR."""
    Description  Width  Height  Area
    \{zone[0].name}  \{zone[0].width}  \{zone[0].height}     \{zone[0].area()}
    \{zone[1].name}  \{zone[1].width}  \{zone[1].height}     \{zone[1].area()}
    \{zone[2].name}  \{zone[2].width}  \{zone[2].height}     \{zone[2].area()}
    Total \{zone[0].area() + zone[1].area() + zone[2].area()}
    """;

  String table = FMT."""
    Description     Width    Height     Area
    %-12s\{zone[0].name}  %7.2f\{zone[0].width}  %7.2f\{zone[0].height}     %7.2f\{zone[0].area()}
    %-12s\{zone[1].name}  %7.2f\{zone[1].width}  %7.2f\{zone[1].height}     %7.2f\{zone[1].area()}
    %-12s\{zone[2].name}  %7.2f\{zone[2].width}  %7.2f\{zone[2].height}     %7.2f\{zone[2].area()}
    \{" ".repeat(28)} Total %7.2f\{zone[0].area() + zone[1].area() + zone[2].area()}
    """;

  PreparedStatement ps = DB."SELECT * FROM Person p WHERE p.last_name = \{name}";
}

Output

class TemplateExpression {

  String info = STR."My name is \{name}";

  String s = STR."\{x} + \{y} = \{x + y}";

  String s = STR."You have a \{getOfferType()} waiting for you!";

  String msg =
    STR."The file \{filePath} \{file.exists() ? "does" : "does not"} exist";

  String time =
    STR."The time is \{
      // The java.time.format package is very useful
      DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalTime.now())
    } right now";

  String data = STR."\{index++}, \{index++}, \{index++}, \{index++}";

  String s = STR."\{fruit[0]}, \{STR."\{fruit[1]}, \{fruit[2]}"}";

  String html =
    STR."""
    <html>
      <head>
        <title>\{title}</title>
      </head>
      <body>
        <p>\{text}</p>
      </body>
    </html>
    """;

  String table =
    STR."""
    Description  Width  Height  Area
    \{zone[0].name}  \{zone[0].width}  \{zone[0].height}     \{zone[0].area()}
    \{zone[1].name}  \{zone[1].width}  \{zone[1].height}     \{zone[1].area()}
    \{zone[2].name}  \{zone[2].width}  \{zone[2].height}     \{zone[2].area()}
    Total \{zone[0].area() + zone[1].area() + zone[2].area()}
    """;

  String table =
    FMT."""
    Description     Width    Height     Area
    %-12s\{zone[0].name}  %7.2f\{zone[0].width}  %7.2f\{
      zone[0].height
    }     %7.2f\{zone[0].area()}
    %-12s\{zone[1].name}  %7.2f\{zone[1].width}  %7.2f\{
      zone[1].height
    }     %7.2f\{zone[1].area()}
    %-12s\{zone[2].name}  %7.2f\{zone[2].width}  %7.2f\{
      zone[2].height
    }     %7.2f\{zone[2].area()}
    \{" ".repeat(28)} Total %7.2f\{
      zone[0].area() + zone[1].area() + zone[2].area()
    }
    """;

  PreparedStatement ps =
    DB."SELECT * FROM Person p WHERE p.last_name = \{name}";
}

Relative issues or prs:

Closes #618

clementdessoude · 2024-01-22T15:36:01Z

I was struggling with if/else blocks when I checked a few weeks/months ago. I don't remember exactly, but I think that this snippet was causing some trouble :/

it("should still parse simple if/else", () => {
    const input = `
      String formatted = "unknown";
      if (o instanceof Integer i) {
          formatted = String.format("int %d", i);
      } else if (o instanceof Double d) {
          formatted = String.format("double %f", d);
      }
      `;

    javaParser.parse(input, "methodDeclaration");
    expect(() => javaParser.parse(input, "methodDeclaration")).to.not.throw();
  });

jtkiesel · 2024-01-22T15:47:56Z

@clementdessoude I ran into something similar to that as well. I ended up resolving it by leveraging Chevrotain's lexer modes (see the changes I made to allTokens in tokens.js). Still running into an issue with idempotency when the embedded expression contains comments, which I'll need to look into.

jtkiesel · 2024-02-10T23:35:07Z

The issue I mentioned above is now fixed. Tokens containing newlines are meant to be split into multiple docs with the newlines replaced with the literalline doc. When I wasn't doing so, I noticed that Prettier was determining line length (and therefore determining where to break) as if the newlines were nonexistent. Luckily, Prettier had a utility function that they use for this purpose that I was easily able to use.

clementdessoude · 2024-02-13T21:30:46Z

I will look at this tomorrow :)

jtkiesel force-pushed the feat/string-templates branch from 34f712f to 2bad5eb Compare January 22, 2024 04:14

jtkiesel marked this pull request as draft January 22, 2024 05:07

jtkiesel force-pushed the feat/string-templates branch from 2bad5eb to c776bef Compare February 10, 2024 23:20

jtkiesel marked this pull request as ready for review February 10, 2024 23:32

jtkiesel force-pushed the feat/string-templates branch from c776bef to ab8ddb7 Compare February 13, 2024 22:03

feat: JDK 22 string templates

ea8010a

jtkiesel force-pushed the feat/string-templates branch from ab8ddb7 to ea8010a Compare February 14, 2024 03:21

clementdessoude merged commit 2bdfbd2 into jhipster:main Feb 15, 2024
6 checks passed

jtkiesel deleted the feat/string-templates branch April 11, 2024 06:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: JDK 22 string templates #640

feat: JDK 22 string templates #640

jtkiesel commented Jan 22, 2024 •

edited

clementdessoude commented Jan 22, 2024

jtkiesel commented Jan 22, 2024 •

edited

jtkiesel commented Feb 10, 2024 •

edited

clementdessoude commented Feb 13, 2024

feat: JDK 22 string templates #640

feat: JDK 22 string templates #640

Conversation

jtkiesel commented Jan 22, 2024 • edited

What changed with this PR:

Example

Input

Output

Relative issues or prs:

clementdessoude commented Jan 22, 2024

jtkiesel commented Jan 22, 2024 • edited

jtkiesel commented Feb 10, 2024 • edited

clementdessoude commented Feb 13, 2024

jtkiesel commented Jan 22, 2024 •

edited

jtkiesel commented Jan 22, 2024 •

edited

jtkiesel commented Feb 10, 2024 •

edited