HTML comments inside Markdown code blocks inside <!-- @component --> breaks the component

[webJose]

Describe the bug

I think the title summarizes it well. If you add documentation that includes a code block for example, and said code block contains an HTML comment, then the component breaks because of compilation picking up fragments of the sample as actual code. This is seen in the JS Output tab of the REPL.

Reproduction

REPL

Logs

System Info

REPL

Severity

annoyance

[7nik]

It is a general problem of multiline nested comments:

<!--
outer comment
<!-- inner comment -->
-->

/*
outer comment
/* inner comment */
*/

[dummdidumm]

Yes, there's no way around this - you gotta escape the comment somehow

[webJose]

What about a counting algorithm? For every <!-- you add one to the counter; for every --> you remove one. The counter is not allowed to be negative and the @component section is only finished once the counter reaches zero.

[dummdidumm]

Svelte is a superset of HTML, and HTML does not allow it, so we do not special-case it. It would also be incompatible with syntax highlighting and various other tooling

[webJose]

I see. Ok, no worries, then. I'll make sure README's that are appended to components don't contain this. 👍