fix: Code and heading after list without blank line #2483

kiyoka · 2022-05-28T02:11:50Z

fixed behavior of fenced code block following list.
fixed behavior of heading following list.

Marked version:
4.0.16

Markdown flavor:
GitHub Flavored Markdown

Description

Contributor

Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR)
If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

CI is green (no forced merge required).
Squash and Merge PR following conventional commit guidelines.

fix: behavior of fenced code block following list. fix: behavior of heading following list.

vercel · 2022-05-28T02:11:55Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
marked-website	✅ Ready (Inspect)	Visit Preview	Jun 12, 2022 at 1:48PM (UTC)

calculuschild · 2022-05-28T05:28:10Z

While this PR does work, at this point it's starting to look like we are going to end up replicating the entirety of the "Paragraph" interruption RegEx that we already have in rules.js. I don't think the Specs were clear on this, but now it is becoming clear that we should be interrupting list items with the same rules as paragraph interruptions, even though "tight" lists don't end up rendering a <p> tag.

For instance, we should also be interrupting list items with "headers", "blockquotes", and "HTML" which we don't do correctly if we compare to the commonmark Dingus: Marked Demo, Commonmark Demo

There must be some way we can just incorporate the existing interruption regex here rather than re-implementing each one, which results in code duplication and a lot of complexity to the Lists tokenizer. @UziTech thoughts?

UziTech · 2022-05-28T14:12:21Z

I agree. I think we should apply similar logic as the paragraph. It might still have to be duplicated since it won't be able to break on lists like the paragraph.

UziTech · 2022-05-30T15:11:36Z

test/specs/new/fences_following_list.html

@@ -0,0 +1,7 @@
+<ol>
+<li>abcd<pre><code>if {


The code is not supposed to be part of the list item. CommonMark demo

@UziTech
Thanks for the review.
My misunderstanding.
I thought that Marked's behavior of code blocks was aimed at a different behavior than CommonMark.

I will fix it and commit to it.
I will conform to CommonMark's behavior as follows.

No indentation
CommonMark demo1

With one blank line.

Indented.

Note: The CommonMark demo site cannot keep spaces in permalinks, so I have attached two images.

Followed the behavior of CommonMark.js.

kiyoka · 2022-06-10T12:03:37Z

@UziTech
I have corrected the pointed out issues.
Please review again.

UziTech · 2022-06-11T04:45:17Z

src/Tokenizer.js

@@ -223,6 +223,15 @@ export class Tokenizer {
          endEarly = true;
        }

+        const fencesBeginRegExp = new RegExp(`^( {0,${indent}})(\`\`\`|~~~)`);


Could you remove the 2nd if statement if this only checked {0, ${indent - 1}}?

calculuschild · 2022-06-12T05:35:26Z

src/Tokenizer.js

+        if (fencesBeginRegExp.test(src)) { // Items begin with at most one code block
+          const fenceBeginCap = fencesBeginRegExp.exec(src);
+          // if End list item if found non-indented fenced code block
+          if (fenceBeginCap[1].length < indent) {
+            endEarly = true;
+          }
+        }
+
        if (!endEarly) {
          const nextBulletRegex = new RegExp(`^ {0,${Math.min(3, indent - 1)}}(?:[*+-]|\\d{1,9}[.)])((?: [^\\n]*)?(?:\\n|$))`);
          const hrRegex = new RegExp(`^ {0,${Math.min(3, indent - 1)}}((?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$)`);


Suggested change

if (fencesBeginRegExp.test(src)) { // Items begin with at most one code block

const fenceBeginCap = fencesBeginRegExp.exec(src);

// if End list item if found non-indented fenced code block

if (fenceBeginCap[1].length < indent) {

endEarly = true;

}

}

if (!endEarly) {

const nextBulletRegex = new RegExp(`^ {0,${Math.min(3, indent - 1)}}(?:[*+-]|\\d{1,9}[.)])((?: [^\\n]*)?(?:\\n|$))`);

const hrRegex = new RegExp(`^ {0,${Math.min(3, indent - 1)}}((?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$)`);

if (!endEarly) {

const nextBulletRegex = new RegExp(`^ {0,${Math.min(3, indent - 1)}}(?:[*+-]|\\d{1,9}[.)])((?: [^\\n]*)?(?:\\n|$))`);

const hrRegex = new RegExp(`^ {0,${Math.min(3, indent - 1)}}((?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$)`);

const fencesBeginRegex = new RegExp(`^( {0,${Math.min(3, indent - 1)}})(\`\`\`|~~~)`);

Then below you can do a simpler test:

// End list item if found code fences if (fencesBeginRegex.test(line)) { break; }

kiyoka · 2022-06-12T13:51:22Z

@UziTech @calculuschild
Thank you for your review.
It made it simpler.
I have committed to the fix.

calculuschild

Yeah this is fine. I have ideas to maybe speed this up in the future but it will take a little more tinkering.

## [4.0.17](v4.0.16...v4.0.17) (2022-06-13) ### Bug Fixes * Code and heading after list without blank line ([#2483](#2483)) ([15f3f15](15f3f15))

github-actions · 2022-06-13T03:19:45Z

🎉 This PR is included in version 4.0.17 🎉

The release is available on:

Your semantic-release bot 📦🚀

fix issue markedjs#1590

bd14afa

fix: behavior of fenced code block following list. fix: behavior of heading following list.

vercel bot deployed to Preview May 28, 2022 02:12 View deployment

Fixed errors noted by eslint.

ec1e61a

vercel bot deployed to Preview May 28, 2022 06:38 View deployment

kiyoka mentioned this pull request May 28, 2022

Strange behaviour when code block under a list marktext/marktext#1736

Open

1 task

UziTech requested changes May 30, 2022

View reviewed changes

The review suggestions were applied.

6543d69

Followed the behavior of CommonMark.js.

vercel bot deployed to Preview June 5, 2022 07:14 View deployment

UziTech reviewed Jun 11, 2022

View reviewed changes

calculuschild reviewed Jun 12, 2022

View reviewed changes

The review suggestions were applied.

c4f112f

vercel bot deployed to Preview June 12, 2022 13:48 View deployment

UziTech approved these changes Jun 13, 2022

View reviewed changes

calculuschild approved these changes Jun 13, 2022

View reviewed changes

UziTech changed the title ~~Fix: Code after list without blank line (#1590) , Heading after list (#2406)~~ fix: Code and heading after list without blank line Jun 13, 2022

UziTech merged commit 15f3f15 into markedjs:master Jun 13, 2022

github-actions bot pushed a commit that referenced this pull request Jun 13, 2022

chore(release): 4.0.17 [skip ci]

a9c22e1

## [4.0.17](v4.0.16...v4.0.17) (2022-06-13) ### Bug Fixes * Code and heading after list without blank line ([#2483](#2483)) ([15f3f15](15f3f15))

github-actions bot added the released label Jun 13, 2022

chlafreniere mentioned this pull request Jun 18, 2022

Heading misalignment with markdown rendering in notebook microsoft/azuredatastudio#18678

Open

This was referenced Jul 2, 2022

False Positives for Anchor Links to Section Headers Following Fenced Code Blocks tcort/markdown-link-check#213

Closed

Comments Within Fenced Code Blocks Within Unordered Lists Are Parsed As Headings #2518

Closed

Koooooo-7 mentioned this pull request May 9, 2023

Code snippets not properly indented if included in numbered lists w/o empty newline docsifyjs/docsify#2057

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Code and heading after list without blank line #2483

fix: Code and heading after list without blank line #2483

kiyoka commented May 28, 2022 •

edited

Loading

vercel bot commented May 28, 2022 •

edited

Loading

calculuschild commented May 28, 2022 •

edited

Loading

UziTech commented May 28, 2022 •

edited

Loading

UziTech May 30, 2022

kiyoka Jun 2, 2022

kiyoka commented Jun 10, 2022

UziTech Jun 11, 2022

calculuschild Jun 12, 2022

kiyoka commented Jun 12, 2022

calculuschild left a comment

github-actions bot commented Jun 13, 2022

		@@ -0,0 +1,7 @@
		<ol>
		<li>abcd<pre><code>if {

fix: Code and heading after list without blank line #2483

fix: Code and heading after list without blank line #2483

Conversation

kiyoka commented May 28, 2022 • edited Loading

Description

Contributor

Committer

vercel bot commented May 28, 2022 • edited Loading

calculuschild commented May 28, 2022 • edited Loading

UziTech commented May 28, 2022 • edited Loading

UziTech May 30, 2022

Choose a reason for hiding this comment

kiyoka Jun 2, 2022

Choose a reason for hiding this comment

kiyoka commented Jun 10, 2022

UziTech Jun 11, 2022

Choose a reason for hiding this comment

calculuschild Jun 12, 2022

Choose a reason for hiding this comment

kiyoka commented Jun 12, 2022

calculuschild left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 13, 2022

kiyoka commented May 28, 2022 •

edited

Loading

vercel bot commented May 28, 2022 •

edited

Loading

calculuschild commented May 28, 2022 •

edited

Loading

UziTech commented May 28, 2022 •

edited

Loading