Fragment support between Java / Template file

[angelozerr]

Fragment support between Java / Template file

See redhat-developer/vscode-quarkus#563

Signed-off-by: azerr azerr@redhat.com

[angelozerr]

Here a demo with the current PR:

[ia3andy]

@angelozerr this looks amazing, great work!

[angelozerr]

@datho7561 if you have time you can start to review this PR. Code should be clean and there are tests for Qute LS side.

I need to write tests for Qute JDT side.

[datho7561]

The link from a Java file to the template opens the template file, but it doesn't seem to place the cursor on the corresponding fragment declaration section. Do you think it's possible to do that?

It looks like the fragment id is being passed as a part of the code lens data

[datho7561]

I can't seem to get the links that appear on fields to show the fact that they link to a fragment. For instance if I have the field:

@Inject
@Location("myCoolTemplate.html")
Template myCoolTemplate$myFragment;

I get a code lens that links to the template and clicking it works as expected, but nothing is listed about the fragment in the code lens message.

[angelozerr]

Is it allowed to write a field with $ to support fragment? I have not seen that in the doc.

[datho7561]

Then ignoreFragments should be true here, right?

[angelozerr]

According to my understand of the doc, the field name (which can contain $) has not the same behavior of method name of CheckedTemplate.

See https://quarkus.io/guides/qute-reference#fragments

@Inject
Template item;

String useTheFragment() {
   return item.getFragment("item_aliases") 
            .data("aliases", List.of("Foo","Bar")) 
            .render();
}

For field, fragment is supported when Template#getFragment is called. I don't support this usecase for the moment. But it makes no senses to write a Template instance field with $ to manage fragment.

[angelozerr]

The link from a Java file to the template opens the template file, but it doesn't seem to place the cursor on the corresponding fragment declaration section. Do you think it's possible to do that?

I think it is possible by implementing a custom command but I would like to do that in a separate PR.

It looks like the fragment id is being passed as a part of the code lens data

Indeed, it will be used in a future PR.

[angelozerr]

Ok now there are tests for codelens + diagnostics with fragment on Qute JDT side.

[datho7561]

If I reference a fragment with id "" in a Java file, a CodeLens appears:

@CheckedTemplate()
public static class MyTemplate {
    public static native TemplateInstance myTemplate$();
}

However, if I try to declare a template with id "" in a Qute file, then it gets marked as an error, and no link back to the Java file gets created. I think we shouldn't create a CodeLens in the Java file in this case.

[datho7561]

According to https://quarkus.io/guides/qute-reference#type_safe_fragments the fragment id is everything after the last $. However, if I have the follow:

public static native TemplateInstance myTemplate$otherText$fragment();

Then the CodeLens displays the fragment id as otherText$fragment instead of fragment

[angelozerr]

However, if I try to declare a template with id "" in a Qute file, then it gets marked as an error, and no link back to the Java file gets created. I think we shouldn't create a CodeLens in the Java file in this case.

I think in this usecase, the method should be bound with the Qute html template src/main/resources/.../myTemplate$.html, no?

[datho7561]

I think in this usecase, the method should be bound with the Qute html template src/main/resources/.../myTemplate$.html, no?

I don't think so. If I try to build the application with this in the code, then it gives the following compilation error:

[error]: Build step io.quarkus.qute.deployment.QuteProcessor#analyzeTemplates threw an exception: io.quarkus.qute.TemplateException: Fragment [] not defined in template GreetingResource/myTemplate.html

[angelozerr]

I don't think so. If I try to build the application with this in the code, then it gives the following compilation error:

Empty fragment should be take care of.

[datho7561]

Looks great. Thanks, Angelo!