question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

formatters examples appear as html-encoded text

See original GitHub issue

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

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

image

But now it looks like this:

image

By checking deploy previews on PRs, it seems that this change was introduced by https://github.com/eslint/eslint/pull/16606

Issue Analytics

  • State:closed
  • Created 9 months ago
  • Reactions:1
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

3reactions
chenxsancommented, Dec 18, 2022

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.

1reaction
chenxsancommented, Dec 28, 2022

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 https://github.com/eslint/eslint/pull/16606, though #16669 is a follow-up of https://github.com/eslint/eslint/pull/16606. I think it’s better to fix in a separate PR.

Read more comments on GitHub >

github_iconTop Results From Across the Web

HTML Text Formatting - W3Schools
HTML contains several elements for defining text with a special meaning. Example. This text is bold. This text is italic. This is subscript...
Read more >
Declaring character encodings in HTML - W3C
Always declare the encoding of your document using a meta element with a charset attribute, or using the http-equiv and content attributes ( ......
Read more >
HTML - Formatting - Tutorialspoint
Bold Text. Anything that appears within <b>...</b> element, is displayed in bold as shown below −. Example. Live ...
Read more >
Encode and Decode Html - Word Counter
HTML Encode converts various characters that can be misinterpreted as HTML formatting to their HTML entity representation. Online HTML Encode: HTML Encode will ......
Read more >
HTML Encode - Code Beautify
HTML Encode is easy to use tool to encode plain HTML to encoded html which helps to show html text in HTML in...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found