Add markdown extension

[mcruzdev]

Fixes #91

[mcruzdev]

Hi @ia3andy, this is the first draft, to see if I am on the right path

[ia3andy]

This looks good right @mkouba ?

[ia3andy]

Could you add this test:

<h1>some html</h2>

{#md}
# Hello markdown

Here is a list:
{#for item in items}
* an {item} as a list
{/for}

<a href="/path">some {html} in the markdown</a>
{/md}

[mkouba]

I think that it's a great start!

[mkouba]

I'd call the module just markdown.

[mcruzdev]

qute-markdown?

[mkouba]

+1 for markdown as the module directory name and the current quarkus-qute-web-markdown as the artifact id.

I will send a PR with the core dir where the runtime and deployment modules will be moved.

[mcruzdev]

I got it
+1

[mkouba]

commonmark is a dependency of quarkus-qute-web-markdown so there's no need to add it here. BTW this version should be in the <properties> of the quarkus-qute-web-parent's pom.xml.

[mkouba]

If you place this annotation on the Factory class then the QuteMarkdownConfigurator is superfluous.

If you do that, then the Factory class has to declare a no-args constructor (passing the CommonMarkConverter?).

[mkouba]

I wonder if this extension will be used without qute-web. Technically, it can be used standalone but it might make more sense to depend on quarkus-qute-web instead?

[ia3andy]

I think we should use the lowest working dependency (if that make sense) so it's alright

[mkouba]

The thing is that:
(1) it's not very consitent because this extension lives in quarkus-qute-web but does not depend on the core module (which is not moved yet -> runtime and deployment modules in the root dir should go in the core dir; will send PR later today)
(2) in many cases you will have to declare both quarkus-qute-web and quarkus-qute-web-markdown 🤷

[mcruzdev]

Could you add this test:

<h1>some html</h2>

{#md}
# Hello markdown

Here is a list:
{#for item in items}
* an {item} as a list
{/for}

<a href="/path">some {html} in the markdown</a>
{/md}

Probably this one will fail 😆

[mcruzdev]

Thank you for all your comments, I will take a look here

[mcruzdev]

Hi @mkouba and @ia3andy, actually when we are using this one:

  <h1>Quarkus and Qute</h1>
  {#md}
  # Qute and Roq
  Here is a list:
  {#for item in items}
  - an {item} as a list item
  {/for}
  {/md}

We are getting:

<h1>Quarkus and Qute</h1>
<h1>Qute and Roq</h1>
<p>Here is a list:</p>
<ul>
<li>an</li>
</ul>
<p>apple</p>
<p>as a list item</p>
<ul>
<li>an</li>
</ul>
<p>banana</p>
<p>as a list item</p>
<ul>
<li>an</li>
</ul>
<p>cherry</p>
<p>as a list item</p>

I think that the expected behavior is:

1. Resolve{#for} (more specific section);
2. Resolve {#md} with {#for} result;

In other words, resolve all sections inside the markdown first. I am new to qute API, do you know how to solve this one?

[mkouba]

In other words, resolve all sections inside the markdown first. I am new to qute API, do you know how to solve this one?

@mcruzdev Your code looks good. I think there's some problem with line separators or something like that. What does the content passed to the MarkdownConverter look like?

[mkouba]

Ah, I see where the problem is. You need to first collect all the results and then apply the converter:

    public CompletionStage<ResultNode> resolve(SectionResolutionContext context) {
        return context.execute().thenCompose(rn -> {
            StringBuilder sb = new StringBuilder();
            rn.process(sb::append);
            return CompletedStage.of(new SingleResultNode(markdownConverter.convert(sb.toString())));
        });
    }

[mkouba]

By the way, you don't need a QuarkusUnitTest to test the functionality of the section itself. A simple unit test would be enough:

public class MdTest {
    @Test
    public void testMd() {
        Engine engine = Engine.builder().addDefaults()
                .addSectionHelper(new MarkdownSectionHelper.Factory(new CommonMarkConverter())).build();
        assertEquals("...", engine.parse("{#md}...{/md}").data("items", List.of("apple", "pie")).render());
    }
}

[mkouba]

Hm, this interface is not used anymore, or?

[ia3andy]

is this needed? quarkus-qute-web-markdown should be enough?

[ia3andy]

@mkouba good?

[mkouba]

@mcruzdev Could you pls squash the commits? I'll merge the PR afterwards...