[Qute] Create a Qute Language Server #176

angelozerr · 2020-01-03T13:42:31Z

To support completion, validation, hover, etc for Qute, we need to create a Qute Language Server (in a new project like com.redhat.quarkus.qute.ls).

https://github.com/quarkusio/quarkus/blob/master/independent-projects/qute/core/src/main/java/io/quarkus/qute/Parser.java

This Qute Language Server requires a QuteAST which contains all position of Qute expressions. Take a sample:

{@org.acme.Item item} 
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>{item.name}</title> 
</head>
<body>
    <h1>{item.name}</h1>
    <div>Price: {item.price}</div>
    {#if item.price > 100} 
    <div>Discounted Price: {item.discountedPrice}</div> 
    {/if}
</body>
</html>

The QuteAST must store each Qute node with proper range (start (character, line) , end(character, line) of node.

QuteAST
-> {@org.acme.Item item }
/\ /\
| |
start (line=1, character = 1) start (line=1, character = 40)
-> {item.name}
-> {item.price}
-> {#if item.price > 100}
-> {item.discountedPrice}
-> {/if}

The parse to compute this QuteAST must:

stores each range (start, end) line character for each Qute nodes (expression, if condition, loop, etc)
tolerant : when user is typing some content in the editor, the Qute template cannot be valid but we must keep as soon as possible the following content. For instance if we have this template (item.name is not closed):

<h1>{item.name</h1>
<div>Price: {item.price}</div>

the QuteAST must contains:

-> {item.name
-> {item.price}

incremental parser. To avoid rebuilding the QuteAST on each changes (when user is typing in the editor), the Qute parser should be able to update a given QuteAST with a new content. But incremental parser is very hard to implement, we can live without this support for the moment.

To manage this QuteAST (build by the tolerant parser + store ranges) we have 2 solutions

implement our own Qute parser. I have already done that in LSP4XML because we could not use SAX and DOM parser since they don't manage tolerant parser and ranges (SAX parser throws an error as soon as there is an error and manages only offset not ranges). It's possible but it's a long and hard task.
use the existing Qute parser. I hope we could do that, but Qute parser is not tolerant and doesn't manage ranges (just line information). Indeed Qute parser returns a instance of Template in https://github.com/quarkusio/quarkus/blob/c730ce9683d4f06b75e5c71f63b1f2fd41e0d9f6/independent-projects/qute/core/src/main/java/io/quarkus/qute/Parser.java#L83

but

this parser is not tolerant
template maintains only line information in
https://github.com/quarkusio/quarkus/blob/57c68549f60be3ad954a385561a3291f7cf73011/independent-projects/qute/core/src/main/java/io/quarkus/qute/TemplateNode.java#L37 It should maintain ranges (start, end positions (line + character).

Do you think @mkouba is there any chance to support tolerant parser and manages ranges ? It should be really fantastic to do that to integrates Qute parser in an editor.

The text was updated successfully, but these errors were encountered:

angelozerr · 2020-01-05T12:43:25Z

@mkouba if you are aware to support tolerant parser I suggest you see https://github.com/microsoft/tolerant-php-parser and read the section https://github.com/microsoft/tolerant-php-parser/blob/master/docs/HowItWorks.md#how-it-works to design the parser with tolerant mode.

If you think it's a feature that you don't want to support in Qute parser, please tell us, thanks!

mkouba · 2020-01-08T10:19:43Z

Hi @angelozerr and thanks for the summary!

Few comments:

{item.name in fact does not qualify as an error - it's just ignored.
the current parser is a simple "fail-fast" parser, ie. an exception is thrown when an error is found
user errors include:
- unterminated tag
- end tag does not match the start tag
- non-existent "section helper"/tag
- and few others

The reason why we did it this way is that some of the errors can completely break the parser, e.g. it's not possible to correctly parse the rest of the template.

If you think it's a feature that you don't want to support in Qute parser, please tell us, thanks!

I'll need to look at your links with tolerant parser examples.

angelozerr · 2020-01-08T11:44:22Z

The reason why we did it this way is that some of the errors can completely break the parser, e.g. it's not possible to correctly parse the rest of the template.

Indeed, I understand this behaviour but IMHO I think it should be better to report several errors than the first error (like Java editor code for instance, you can see several problems than the first error in your file).

I'll need to look at your links with tolerant parser examples.

Thanks! I have started something on my side. When I will have something I will push it in my github repository.

angelozerr · 2020-01-11T00:41:24Z

@mkouba @maxandersen please see my POC with Qute parser at https://github.com/angelozerr/tolerant-qute-parser

I did that by copying/pasting code from our XML tolerant parser for LSP4XML and adapt it for Qute syntax.

I did that to help more our discussion and it is a kind of parser required for the Qute Language Server.

maxandersen · 2020-01-11T10:29:18Z

How about making a pr to the qute parser directly?

angelozerr · 2020-01-11T12:25:58Z

It was more easy for me to do a parser from scratch than trying to modify the qute parser ans i would like to know if @mkouba likes my parser before doing a pr

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

See redhat-developer/quarkus-ls#176 Signed-off-by: azerr <azerr@redhat.com>

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

Fixes #176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr mentioned this issue Jan 3, 2020

[Qute] Add language support for qute redhat-developer/vscode-quarkus#178

Closed

angelozerr added the qute label Jan 10, 2020

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Jan 12, 2020

[Qute] Create a Qute Language Server

b16a91c

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Jan 12, 2020

[Qute] Create a Qute Language Server

282b2c5

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/vscode-quarkus that referenced this issue Jan 12, 2020

[Qute] Create a Qute Language Server

4a4d6eb

See redhat-developer/quarkus-ls#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Jan 12, 2020

[Qute] Create a Qute Language Server

fd22991

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Jan 12, 2020

[Qute] Create a Qute Language Server

d0bc5f8

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Jan 13, 2020

[Qute] Create a Qute Language Server

01529ce

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

fbricon mentioned this issue Mar 27, 2020

Edit TextMate grammar to allow whitespaces before braces redhat-developer/vscode-quarkus#235

Merged

jeffmaury mentioned this issue Jun 10, 2021

Add Qute support redhat-developer/intellij-quarkus#415

Closed

angelozerr mentioned this issue Nov 10, 2021

Provide Qute language Server #427

Closed

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 10, 2021

[Qute] Create a Qute Language Server

9f9bac3

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr self-assigned this Nov 10, 2021

angelozerr mentioned this issue Nov 10, 2021

[Qute] Create a Qute Language Server #428

Merged

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 10, 2021

[Qute] Create a Qute Language Server

4b3a5b0

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 10, 2021

[Qute] Create a Qute Language Server

d4ab0f9

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 10, 2021

[Qute] Create a Qute Language Server

2434f01

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 10, 2021

[Qute] Create a Qute Language Server

cf062a1

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 10, 2021

[Qute] Create a Qute Language Server

732aeff

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

fbricon pushed a commit to fbricon/quarkus-ls that referenced this issue Nov 16, 2021

[Qute] Create a Qute Language Server

ca09eea

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 16, 2021

[Qute] Create a Qute Language Server

87419d2

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 16, 2021

[Qute] Create a Qute Language Server

02b4a7d

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 16, 2021

[Qute] Create a Qute Language Server

4cce3ed

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 16, 2021

[Qute] Create a Qute Language Server

f40449b

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

bb6b51b

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

bd05f8d

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

e574a55

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

cace542

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

4bc3cb9

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

8dacf06

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

029d564

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

7529f02

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

03eabfc

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

6ead7e2

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 22, 2021

[Qute] Create a Qute Language Server

194ee87

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

63e1bf4

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

634e9f9

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

2ab5181

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

467f1c3

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

fbb49a3

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

40d2cde

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

28831e0

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

e6d792e

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 23, 2021

[Qute] Create a Qute Language Server

4d8d185

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

4a0a3cc

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

038cb2e

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

4b5a0dc

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

0ad5b14

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

75b01e3

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

7fa7e8f

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr pushed a commit to angelozerr/quarkus-ls that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

6d20871

Fixes redhat-developer#176 Signed-off-by: azerr <azerr@redhat.com>

fbricon closed this as completed in #428 Nov 24, 2021

fbricon pushed a commit that referenced this issue Nov 24, 2021

[Qute] Create a Qute Language Server

79fe7b9

Fixes #176 Signed-off-by: azerr <azerr@redhat.com>

angelozerr added this to the v0.11.0 milestone Nov 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Qute] Create a Qute Language Server #176

[Qute] Create a Qute Language Server #176

angelozerr commented Jan 3, 2020

angelozerr commented Jan 5, 2020

mkouba commented Jan 8, 2020

angelozerr commented Jan 8, 2020

angelozerr commented Jan 11, 2020

maxandersen commented Jan 11, 2020

angelozerr commented Jan 11, 2020

[Qute] Create a Qute Language Server #176

[Qute] Create a Qute Language Server #176

Comments

angelozerr commented Jan 3, 2020

angelozerr commented Jan 5, 2020

mkouba commented Jan 8, 2020

angelozerr commented Jan 8, 2020

angelozerr commented Jan 11, 2020

maxandersen commented Jan 11, 2020

angelozerr commented Jan 11, 2020