Skip to content

(yaml) improve tag support; add verbatim tags #2487

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

Merged
merged 13 commits into from
Apr 27, 2020
Merged

(yaml) improve tag support; add verbatim tags #2487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
017f978
YAML parse non-word characters as part of tags #2486
pplantinga Apr 9, 2020
6a5668c
Add message for #2486 to CHANGES.md
pplantinga Apr 9, 2020
bfcbbd8
YAML add all characters for matching tags, plus tests
pplantinga Apr 10, 2020
53ce6e0
YAML tags double escape characters
pplantinga Apr 10, 2020
1992e51
YAML add back data type tags and disallow "!" in first character of tags
pplantinga Apr 13, 2020
a14893b
YAML clarify tag definition
pplantinga Apr 14, 2020
7e92cd0
Add named tag handles and clarify definition
pplantinga Apr 17, 2020
3466812
YAML fix order of applying regexes for tags
pplantinga Apr 17, 2020
7939322
Revert adding named tag handles, since they are captured by the local…
pplantinga Apr 17, 2020
6ca7314
Add named tag again
pplantinga Apr 18, 2020
05471b9
fixup comments, add verbatim tags
joshgoebel Apr 21, 2020
7e4d779
Merge branch 'master' into yaml_highlight_fix
joshgoebel Apr 27, 2020
677bf3a
Update CHANGES.md
joshgoebel Apr 27, 2020
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
9 changes: 9 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## Version 10.1.0 (in progress)

Language improvements:

- fix(yaml) Fix tags to include non-word characters (#2486) [Peter Plantinga][]

[Peter Plantinga]: https://github.com/pplantinga


## Version 10.0.1

Parser Engine Changes:
Expand Down
20 changes: 16 additions & 4 deletions src/languages/yaml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Category: common, config
export default function(hljs) {
var LITERALS = 'true false yes no null';

// YAML spec allows non-reserved URI characters in tags.
var URI_CHARACTERS = '[\\w#;/?:@&=+$,.~*\\\'()[\\]]+'

// Define keys as starting with a word character
// ...containing word chars, spaces, colons, forward-slashes, hyphens and periods
// ...and ending with a colon followed immediately by a space, tab or newline.
Expand Down Expand Up @@ -79,13 +82,22 @@ export default function(hljs) {
excludeEnd: true,
relevance: 0
},
{ // local tags
{ // named tags
className: 'type',
begin: '!\\w+!' + URI_CHARACTERS,
},
// https://yaml.org/spec/1.2/spec.html#id2784064
{ // verbatim tags
className: 'type',
begin: '!<' + URI_CHARACTERS + ">",
},
{ // primary tags
className: 'type',
begin: '!' + hljs.UNDERSCORE_IDENT_RE,
begin: '!' + URI_CHARACTERS,
},
{ // data type
{ // secondary tags
className: 'type',
begin: '!!' + hljs.UNDERSCORE_IDENT_RE,
begin: '!!' + URI_CHARACTERS,
},
{ // fragment id &ref
className: 'meta',
Expand Down
8 changes: 8 additions & 0 deletions test/markup/yaml/tag.expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,11 @@
<span class="hljs-attr">key:</span> <span class="hljs-type">!localtagname</span> <span class="hljs-string">test</span>
<span class="hljs-attr">key:</span> <span class="hljs-string">"!notatag"</span>
<span class="hljs-attr">key:</span> <span class="hljs-string">'!!notatageither'</span>
<span class="hljs-attr">key:</span> <span class="hljs-type">!!python/dict</span> <span class="hljs-string">test</span>
<span class="hljs-attr">key:</span> <span class="hljs-type">!!python/name:module.name</span> <span class="hljs-string">test</span>
<span class="hljs-attr">key:</span> <span class="hljs-type">!foo2.bar</span> <span class="hljs-string">test</span>
<span class="hljs-attr">key:</span> <span class="hljs-type">!(foo.bar?):tag</span> <span class="hljs-string">test</span>
<span class="hljs-attr">key:</span> <span class="hljs-type">!named!tag</span> <span class="hljs-string">test</span>

<span class="hljs-string">---</span> <span class="hljs-type">!&lt;tag:clarkevans.com,2002:invoice&gt;</span>
<span class="hljs-attr">invoice:</span> <span class="hljs-number">34843</span>
8 changes: 8 additions & 0 deletions test/markup/yaml/tag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,11 @@ key: !!builtintagname test
key: !localtagname test
key: "!notatag"
key: '!!notatageither'
key: !!python/dict test
key: !!python/name:module.name test
key: !foo2.bar test
key: !(foo.bar?):tag test
key: !named!tag test

--- !<tag:clarkevans.com,2002:invoice>
invoice: 34843