resolves #1084 preserve newlines in linewise formatter #1156
Conversation
mojavelinux
commented
Jun 4, 2019
mojavelinux
commented
- allow tag name to be configured using :tag_name option
- preserve newlines
- delegate to stream method instead of span method on inner formatter
- allow tag name to be configured using :tag_name option - preserve newlines - delegate to stream method instead of span method on inner formatter
|
Note that the newline is inserted before the closing tag for the line. This is done to avoid cluttering up the end of the line so it's clear where the content of the line ends. This is consistent with how Pygments does linewise formatting. It also allows postprocessors to more easily find the end of each line for further processing, such as adding annotations. (The start of the line is already clear because the enclosing tag has a CSS class). |
|
Maybe a little late to comment but I am a little concerned about backwards compatibility with this, given that the line may be contained in |
|
I can assure you that won't happen. I have tested this extensively when integrating Rouge and Pygments into Asciidoctor. HTML guarantees that the final newline before the closing tag of a block element is insignificant, and browsers honor this. I'll share the example I shared with Michael to prove this: Single-line example: <!DOCTYPE html>
<pre style="background-color: gray"><div>foo
</div></pre>Multi-line example: <!DOCTYPE html>
<pre style="background-color: gray"><div>foo
</div><div>bar
</div></pre>The same is true if you use span as the tag (but then you don't have to force the enclosing element to display as a block). The key benefit of using the newline + closing tag is that the number of lines stays the same, which is important for line counting either inside of Rouge or in postprocessing. If we drop the newlines, we end up with something fundamentally different and rely on the block styling on the wrapping div to put the newline back. |
|
@jneen Well, @mojavelinux beat me to it! I was just writing a comment saying I'd spoken with him about the PR to better understand its consequences (I'm very opposed to anything that would be a breaking change, too!) and he explained that it would not have that effect (using the examples above). |
mojavelinux
deleted the
issue-1084-preserve-newlines-in-linewise-formatter
branch
