formatters examples appear as html-encoded text

[mdjermanovic]

See https://eslint.org/docs/latest/user-guide/formatters/

For example, the checkstyle example used to look like this:

But now it looks like this:

By checking deploy previews on PRs, it seems that this change was introduced by #16606

[amareshsm]

let me check this issue.

[chenxsan]

When using text language, we were actually opting-out of 11ty syntax highlighting. But I don't think that's the standard way to handle it.

Here's how GitHub renders text language https://github.com/eslint/eslint/blob/main/docs/src/user-guide/formatters/index.md:

And this is how markdown-it renders it:

So I think it maybe more reasonable to decode the code block in the markdown source code instead of hacking on the new syntax highlighter with non-standard trick. Another benefit would be more readable code block.

[mdjermanovic]

So, before #16606 contents of text blocks were not being html-escaped during the generation of html files from markdown, but now they are? In that case, it seems that we should skip html-escaping the formatters' output when generating the markdown file.

eslint/templates/formatter-examples.md.ejs

Line 69 in e5ecfef

<%= formatterResults[formatterName].result %>

- <%= formatterResults[formatterName].result %>
+ <%- formatterResults[formatterName].result %>

[amareshsm]

As @chenxsan mentioned

So I think it maybe more reasonable to decode the code block in the markdown source code instead of hacking on the new syntax highlighter with non-standard trick. Another benefit would be more readable code block.

Can we do this? @mdjermanovic thoughts?

@chenxsan can we fix this issue as part of #16669 PR itself?

[chenxsan]

So, before #16606 contents of text blocks were not being html-escaped during the generation of html files from markdown, but now they are?

Exactly, actually I can found some issues due to not being html-escaped before #16606. Here's a preview page from #16605,

And here's the source code:

As you can see, texts like <relative/path/to/filename> are missing in the rendered result before #16606.

And here's the rendered version of #16606:

Back to this formatters' examples, I believe you're right. We no longer need to escape them here formatter-examples.md.ejs. I've pushed a fix in #16669

[mdjermanovic]

Back to this formatters' examples, I believe you're right. We no longer need to escape them here formatter-examples.md.ejs. I've pushed a fix in #16669

Is this problem related to #16669? If not, it would be better to fix this in a separate PR.

[chenxsan]

Back to this formatters' examples, I believe you're right. We no longer need to escape them here formatter-examples.md.ejs. I've pushed a fix in #16669

Is this problem related to #16669? If not, it would be better to fix this in a separate PR.

More like an issue should be caught and fixed in #16606, though #16669 is a follow-up of #16606. I think it's better to fix in a separate PR.