From 57b25a55fe71fcd39bc5f2b70c710dd426a687a3 Mon Sep 17 00:00:00 2001
From: Levi Gruspe <mail.levig@gmail.com>
Date: Wed, 20 Sep 2023 14:16:37 +0800
Subject: [PATCH 1/3] Todo highlighting in html comments

---
 syntax/markdown.vim |  2 ++
 test/syntax.vader   | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)

diff --git a/syntax/markdown.vim b/syntax/markdown.vim
index 4d54d3c3..2835e284 100644
--- a/syntax/markdown.vim
+++ b/syntax/markdown.vim
@@ -116,6 +116,7 @@ syn region mkdNonListItemBlock start="\(\%^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@!\|\n\(
 syn match  mkdRule         /^\s*\*\s\{0,1}\*\s\{0,1}\*\(\*\|\s\)*$/
 syn match  mkdRule         /^\s*-\s\{0,1}-\s\{0,1}-\(-\|\s\)*$/
 syn match  mkdRule         /^\s*_\s\{0,1}_\s\{0,1}_\(_\|\s\)*$/
+syn keyword mkdTodo TODO FIXME XXX TBD contained containedin=htmlComment,htmlCommentPart
 
 " YAML frontmatter
 if get(g:, 'vim_markdown_frontmatter', 0)
@@ -179,6 +180,7 @@ HtmlHiLink mkdLinkDef          mkdID
 HtmlHiLink mkdLinkDefTarget    mkdURL
 HtmlHiLink mkdLinkTitle        htmlString
 HtmlHiLink mkdDelimiter        Delimiter
+HtmlHiLink mkdTodo             Todo
 
 let b:current_syntax = 'mkd'
 
diff --git a/test/syntax.vader b/test/syntax.vader
index 3d1a9911..2f8e8f39 100644
--- a/test/syntax.vader
+++ b/test/syntax.vader
@@ -1302,3 +1302,40 @@ Execute (HTML tag in text):
   AssertEqual SyntaxOf('span'), 'htmlTagName'
   AssertEqual SyntaxOf('<span>'), 'htmlTag'
   AssertEqual SyntaxOf('</span>'), 'htmlEndTag'
+
+Given markdown;
+<!--TODO FIXME XXX TBD hello -->
+
+Execute (todo inside HTML comment):
+  AssertEqual SyntaxOf('TODO'), 'mkdTodo'
+  AssertEqual SyntaxOf('FIXME'), 'mkdTodo'
+  AssertEqual SyntaxOf('XXX'), 'mkdTodo'
+  AssertEqual SyntaxOf('TBD'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('hello'), 'mkdTodo'
+
+Given markdown;
+<!--ATODO BFIXME CXXX DTBD -->
+
+Execute (fake todo inside HTML comment):
+  AssertNotEqual SyntaxOf('TODO'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('FIXME'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('XXX'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('TBD'), 'mkdTodo'
+
+Given markdown;
+TODO FIXME XXX TBD
+
+Execute (todo outside HTML comment):
+  AssertNotEqual SyntaxOf('TODO'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('FIXME'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('XXX'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('TBD'), 'mkdTodo'
+
+Given markdown;
+> TODO FIXME XXX TBD
+
+Execute (todo inside non-HTML comment):
+  AssertNotEqual SyntaxOf('TODO'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('FIXME'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('XXX'), 'mkdTodo'
+  AssertNotEqual SyntaxOf('TBD'), 'mkdTodo'

From b6008143c3d70b020fddcee44a15c3860c19a6bc Mon Sep 17 00:00:00 2001
From: Greg Hurrell <greg@hurrell.net>
Date: Sun, 27 Aug 2023 09:18:32 +0200
Subject: [PATCH 2/3] docs: fix a couple of small typos in code comments

---
 ftplugin/markdown.vim | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/ftplugin/markdown.vim b/ftplugin/markdown.vim
index 60505cd3..fc3fa4d9 100644
--- a/ftplugin/markdown.vim
+++ b/ftplugin/markdown.vim
@@ -1,6 +1,6 @@
 "TODO print messages when on visual mode. I only see VISUAL, not the messages.
 
-" Function interface phylosophy:
+" Function interface philosophy:
 "
 " - functions take arbitrary line numbers as parameters.
 "    Current cursor line is only a suitable default parameter.
@@ -56,7 +56,7 @@ let s:levelRegexpDict = {
     \ 6: '\v^######[^#]@='
 \ }
 
-" Maches any header level of any type.
+" Matches any header level of any type.
 "
 " This could be deduced from `s:levelRegexpDict`, but it is more
 " efficient to have a single regexp for this.

From 8434dfeaff72b360f0c3559a210431bcf66dc5cc Mon Sep 17 00:00:00 2001
From: Levi Gruspe <mail.levig@gmail.com>
Date: Fri, 22 Sep 2023 10:32:12 +0800
Subject: [PATCH 3/3] Make todo comment tests pass

---
 test/syntax.vader | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/test/syntax.vader b/test/syntax.vader
index 320cf159..4619617e 100644
--- a/test/syntax.vader
+++ b/test/syntax.vader
@@ -1304,7 +1304,7 @@ Execute (HTML tag in text):
   AssertEqual SyntaxOf('</span>'), 'htmlEndTag'
 
 Given markdown;
-<!--TODO FIXME XXX TBD hello -->
+<!-- TODO FIXME XXX TBD hello -->
 
 Execute (todo inside HTML comment):
   AssertEqual SyntaxOf('TODO'), 'mkdTodo'
@@ -1314,7 +1314,7 @@ Execute (todo inside HTML comment):
   AssertNotEqual SyntaxOf('hello'), 'mkdTodo'
 
 Given markdown;
-<!--ATODO BFIXME CXXX DTBD -->
+<!-- ATODO BFIXME CXXX DTBD -->
 
 Execute (fake todo inside HTML comment):
   AssertNotEqual SyntaxOf('TODO'), 'mkdTodo'