Merge pull request #2 from jdbaldry/2023-07-add-support-for-escaped-shortcodes

Ignore tokens in shortcodes with comment syntax

Author: jdkato

testdata/shortcodes/.vale.ini

@@ -2,11 +2,11 @@
 BasedOnStyles = Vale
 
 # Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
-TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
-(\[.+\]\({{< .+ >}}\)), \
-({{[%<] .+ [%>]}})
+TokenIgnores = ({{[%<](?:/\*)? .* (?:\*/)?[%>]}}.*?{{[%<](?:/\*| )?/.* (?:\*/)?[%>]}}), \
+(\[.+\]\({{<(?:/\*)? .+ (?:\*/)?>}}\)), \
+({{[%<](?:/\*)? .+ (?:\*/)?[%>]}})
 
 # Exclude `{{<  myshortcode `This is some <b>HTML</b>, ... >}}`
-BlockIgnores = (?sm)^({{[%<] [^{]*? [%>]}})\n$, \
-(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}}), \
-({{[%<] .+ [%>]}})
+BlockIgnores = (?sm)^({{[%<](?:/\*)? [^{]*? (?:\*/)?[%>]}})\n$, \
+(?s) *({{<(?:/\*)? highlight [^>]*(?:\*/| )?>}}.*?{{<(?:/\*| )?/ ?highlight (?:\*/)?>}}), \
+({{[%<](?:/\*)? .+ (?:\*/)?[%>]}})

testdata/shortcodes/test.md

@@ -60,3 +60,11 @@ Shortcodes are non-standard markup that appears within normal Markdown.
 Shortcodes can be used {{< myshortcode src="/media/spf13.jpg" title="Steve Francia" >}} inside a paragraph.
 
 Shortcodes are non-standard markup that appears within normal Markdown.
+
+To escape shortcodes, use the Hugo comment syntax.
+For example:
+
+- {{</* commentedoutshortcode */>}}
+- {{</* /closecommentedoutshortcode */>}}
+- {{%/* commentedoutshortcodemd */%}}
+- {{%/* /closecommentedoutshortcodemd */%}}

testdata/test.ct

@@ -1,5 +1,5 @@
 $ cdf ${ROOTDIR}/shortcodes
-$ vale --output=line --sort --normalize --relative --no-exit test.md
+$ vale --config .vale.ini --output=line --sort --normalize --relative --no-exit test.md
 test.md:1:3:Vale.Spelling:Did you really mean 'Shortcodes'?
 test.md:3:3:Vale.Spelling:Did you really mean 'Shortcodes'?
 test.md:8:1:Vale.Spelling:Did you really mean 'Shortcodes'?
@@ -15,3 +15,4 @@ test.md:54:1:Vale.Spelling:Did you really mean 'Shortcodes'?
 test.md:58:1:Vale.Spelling:Did you really mean 'Shortcodes'?
 test.md:60:1:Vale.Spelling:Did you really mean 'Shortcodes'?
 test.md:62:1:Vale.Spelling:Did you really mean 'Shortcodes'?
+test.md:64:11:Vale.Spelling:Did you really mean 'shortcodes'?