Closed anderskaplan closed 1 year ago
The suggestions seem reasonable, I will try to review them soon.
I guess there is an implicit expectation that suggested changes would change the output from renderers, making them possibly more consistent, isn't it?
The proposal will mainly affect the AST. I think the output from the renderers would only change very little, if at all. But it would be easier to make their output more consistent, too, if desired.
There are some inconsistencies among the block tokens that maybe should be fixed before stepping up to version 1.0:
CodeFence
andBlockCode
preserve them;Paragraph
andHTMLBlock
do not.CodeFence
andBlockCode
keep their content in a singleRawText
child node, whereas theHTMLBlock
keeps it in thecontent
property. In fact, theHTMLBlock
is the only block token to have acontent
property. It is typically used with span tokens.So what to do about it?
My suggestion would be to remove the trailing newlines from all block tokens. The other consistent option, to keep them for all block tokens, would add a trailing
LineBreak
to allParagraph
's, and that would just be a pain. Of course there's also the option to leave it as it is.I would also suggest to place the
HTMLBlock
content in a singleRawText
node, so it would be consistent with the other block tokens. Maybe keep itscontent
property, too, in order to not break the API. Thecontent
property could be turned into a property getter and marked as deprecated.Thoughts?