Skip to content

Todo highlighting in html comments #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Todo highlighting in html comments #642

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57b25a5
Todo highlighting in html comments
lggruspe Sep 20, 2023
d2eef03
Merge branch 'master' into todo-comment
alerque Sep 20, 2023
b600814
docs: fix a couple of small typos in code comments
wincent Aug 27, 2023
8434dfe
Make todo comment tests pass
lggruspe Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions syntax/markdown.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -179,6 +180,7 @@ HtmlHiLink mkdLinkDef mkdID
HtmlHiLink mkdLinkDefTarget mkdURL
HtmlHiLink mkdLinkTitle htmlString
HtmlHiLink mkdDelimiter Delimiter
HtmlHiLink mkdTodo Todo

let b:current_syntax = 'mkd'

Expand Down
37 changes: 37 additions & 0 deletions test/syntax.vader
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'