mirror of
https://github.com/neovim/neovim.git
synced 2024-12-29 14:41:06 -07:00
feaab21c71
runtime(yaml): improve syntax highlighting for YAML
- Recognize block scalar style to avoid unexpected highlighting by `yamlFlowString` (fix vim/vim#11517)
- Improve performance of `yamlFlowMappingKey` by allowing execution by the NFA engine (fix vim/vim#10730)
- It was intentionally disabled before patterns were optimized by `s:SimplifyToAssumeAllPrintable`.
- Fix detection of flow style mapping indicators (fix vim/vim#8234).
- Enable highlighting of explicit mapping value indicators and node properties in flow style.
- Add syntax highlighting tests
closes: vim/vim#14354
cc7597c1ed
Co-authored-by: itchyny <itchyny@cybozu.co.jp>
276 lines
15 KiB
VimL
276 lines
15 KiB
VimL
" Vim syntax file
|
|
" Language: YAML (YAML Ain't Markup Language) 1.2
|
|
" Maintainer: Nikolai Pavlov <zyx.vim@gmail.com>
|
|
" First author: Nikolai Weibull <now@bitwi.se>
|
|
" Latest Revision: 2024-04-01
|
|
|
|
if exists('b:current_syntax')
|
|
finish
|
|
endif
|
|
|
|
let s:cpo_save = &cpo
|
|
set cpo&vim
|
|
|
|
" Choose the schema to use
|
|
" TODO: Validate schema
|
|
if !exists('b:yaml_schema')
|
|
if exists('g:yaml_schema')
|
|
let b:yaml_schema = g:yaml_schema
|
|
else
|
|
let b:yaml_schema = 'core'
|
|
endif
|
|
endif
|
|
|
|
let s:ns_char = '\%([\n\r\uFEFF \t]\@!\p\)'
|
|
let s:ns_word_char = '[[:alnum:]_\-]'
|
|
let s:ns_uri_char = '\%(%\x\x\|'.s:ns_word_char.'\|[#/;?:@&=+$,.!~*''()[\]]\)'
|
|
let s:ns_tag_char = '\%(%\x\x\|'.s:ns_word_char.'\|[#/;?:@&=+$.~*''()]\)'
|
|
let s:c_indicator = '[\-?:,[\]{}#&*!|>''"%@`]'
|
|
let s:c_flow_indicator = '[,[\]{}]'
|
|
|
|
let s:ns_anchor_char = substitute(s:ns_char, '\v\C[\zs', '\=s:c_flow_indicator[1:-2]', '')
|
|
let s:ns_char_without_c_indicator = substitute(s:ns_char, '\v\C[\zs', '\=s:c_indicator[1:-2]', '')
|
|
|
|
let s:_collection = '[^\@!\(\%(\\\.\|\[^\\\]]\)\+\)]'
|
|
let s:_neg_collection = '[^\(\%(\\\.\|\[^\\\]]\)\+\)]'
|
|
function s:SimplifyToAssumeAllPrintable(p)
|
|
return substitute(a:p, '\V\C\\%('.s:_collection.'\\@!\\p\\)', '[^\1]', '')
|
|
endfunction
|
|
let s:ns_char = s:SimplifyToAssumeAllPrintable(s:ns_char)
|
|
let s:ns_anchor_char = s:SimplifyToAssumeAllPrintable(s:ns_anchor_char)
|
|
let s:ns_char_without_c_indicator = s:SimplifyToAssumeAllPrintable(s:ns_char_without_c_indicator)
|
|
|
|
function s:SimplifyAdjacentCollections(p)
|
|
return substitute(a:p, '\V\C'.s:_collection.'\\|'.s:_collection, '[\1\2]', 'g')
|
|
endfunction
|
|
let s:ns_uri_char = s:SimplifyAdjacentCollections(s:ns_uri_char)
|
|
let s:ns_tag_char = s:SimplifyAdjacentCollections(s:ns_tag_char)
|
|
|
|
let s:c_verbatim_tag = '!<'.s:ns_uri_char.'\+>'
|
|
let s:c_named_tag_handle = '!'.s:ns_word_char.'\+!'
|
|
let s:c_secondary_tag_handle = '!!'
|
|
let s:c_primary_tag_handle = '!'
|
|
let s:c_tag_handle = '\%('.s:c_named_tag_handle.
|
|
\ '\|'.s:c_secondary_tag_handle.
|
|
\ '\|'.s:c_primary_tag_handle.'\)'
|
|
let s:c_ns_shorthand_tag = s:c_tag_handle . s:ns_tag_char.'\+'
|
|
let s:c_non_specific_tag = '!'
|
|
let s:c_ns_tag_property = s:c_verbatim_tag.
|
|
\ '\|'.s:c_ns_shorthand_tag.
|
|
\ '\|'.s:c_non_specific_tag
|
|
|
|
let s:c_ns_anchor_name = s:ns_anchor_char.'\+'
|
|
let s:c_ns_anchor_property = '&'.s:c_ns_anchor_name
|
|
let s:c_ns_alias_node = '\*'.s:c_ns_anchor_name
|
|
let s:c_ns_properties = '\%(\%('.s:c_ns_tag_property.'\|'.s:c_ns_anchor_property.'\)\s\+\)\+'
|
|
|
|
let s:ns_directive_name = s:ns_char.'\+'
|
|
|
|
let s:ns_local_tag_prefix = '!'.s:ns_uri_char.'*'
|
|
let s:ns_global_tag_prefix = s:ns_tag_char.s:ns_uri_char.'*'
|
|
let s:ns_tag_prefix = s:ns_local_tag_prefix.
|
|
\ '\|'.s:ns_global_tag_prefix
|
|
|
|
let s:ns_plain_safe_out = s:ns_char
|
|
let s:ns_plain_safe_in = '\%('.s:c_flow_indicator.'\@!'.s:ns_char.'\)'
|
|
|
|
let s:ns_plain_safe_in = substitute(s:ns_plain_safe_in, '\V\C\\%('.s:_collection.'\\@!'.s:_neg_collection.'\\)', '[^\1\2]', '')
|
|
let s:ns_plain_safe_in_without_colhash = substitute(s:ns_plain_safe_in, '\V\C'.s:_neg_collection, '[^\1:#]', '')
|
|
let s:ns_plain_safe_out_without_colhash = substitute(s:ns_plain_safe_out, '\V\C'.s:_neg_collection, '[^\1:#]', '')
|
|
|
|
let s:ns_plain_first_in = '\%('.s:ns_char_without_c_indicator.'\|[?:\-]\%('.s:ns_plain_safe_in.'\)\@=\)'
|
|
let s:ns_plain_first_out = '\%('.s:ns_char_without_c_indicator.'\|[?:\-]\%('.s:ns_plain_safe_out.'\)\@=\)'
|
|
|
|
let s:ns_plain_char_in = '\%('.s:ns_char.'#\|:'.s:ns_plain_safe_in.'\|'.s:ns_plain_safe_in_without_colhash.'\)'
|
|
let s:ns_plain_char_out = '\%('.s:ns_char.'#\|:'.s:ns_plain_safe_out.'\|'.s:ns_plain_safe_out_without_colhash.'\)'
|
|
|
|
let s:ns_plain_out = s:ns_plain_first_out . s:ns_plain_char_out.'*'
|
|
let s:ns_plain_in = s:ns_plain_first_in . s:ns_plain_char_in.'*'
|
|
|
|
|
|
syn keyword yamlTodo contained TODO FIXME XXX NOTE
|
|
|
|
syn region yamlComment display oneline start='\%\(^\|\s\)#' end='$'
|
|
\ contains=yamlTodo
|
|
|
|
execute 'syn region yamlDirective oneline start='.string('^\ze%'.s:ns_directive_name.'\s\+').' '.
|
|
\ 'end="$" '.
|
|
\ 'contains=yamlTAGDirective,'.
|
|
\ 'yamlYAMLDirective,'.
|
|
\ 'yamlReservedDirective '.
|
|
\ 'keepend'
|
|
|
|
syn match yamlTAGDirective /%TAG\ze\s/ contained nextgroup=yamlTagHandle skipwhite
|
|
execute 'syn match yamlTagHandle' string(s:c_tag_handle) 'contained nextgroup=yamlTagPrefix skipwhite'
|
|
execute 'syn match yamlTagPrefix' string(s:ns_tag_prefix) 'contained nextgroup=yamlComment skipwhite'
|
|
|
|
syn match yamlYAMLDirective /%YAML\ze\s/ contained nextgroup=yamlYAMLVersion skipwhite
|
|
syn match yamlYAMLVersion /\d\+\.\d\+/ contained nextgroup=yamlComment skipwhite
|
|
|
|
execute 'syn match yamlReservedDirective contained nextgroup=yamlComment '.
|
|
\string('%\%(\%(TAG\|YAML\)\s\)\@!'.s:ns_directive_name)
|
|
|
|
syn region yamlFlowString matchgroup=yamlFlowStringDelimiter start='"' skip='\\"' end='"'
|
|
\ contains=yamlEscape contained nextgroup=yamlFlowMappingDelimiter,yamlComment skipwhite
|
|
syn region yamlFlowString matchgroup=yamlFlowStringDelimiter start="'" skip="''" end="'"
|
|
\ contains=yamlSingleEscape contained nextgroup=yamlFlowMappingDelimiter,yamlComment skipwhite
|
|
syn match yamlEscape contained '\\\%([\\"abefnrtv\^0_ NLP\n]\|x\x\x\|u\x\{4}\|U\x\{8}\)'
|
|
syn match yamlSingleEscape contained "''"
|
|
|
|
syn cluster yamlConstant contains=yamlBool,yamlNull
|
|
|
|
syn cluster yamlFlowNode contains=yamlFlowString,yamlFlowMapping,yamlFlowCollection
|
|
syn cluster yamlFlowNode add=yamlFlowMappingKey,yamlFlowMappingKeyStart,yamlFlowMappingMerge
|
|
syn cluster yamlFlowNode add=@yamlConstant,yamlPlainScalar,yamlFloat,yamlComment
|
|
syn cluster yamlFlowNode add=yamlTimestamp,yamlInteger,yamlAlias,yamlFlowNodeProperties
|
|
syn region yamlFlowMapping matchgroup=yamlFlowIndicator start='{\@<!{{\@!' end='}' contains=@yamlFlowNode
|
|
syn region yamlFlowCollection matchgroup=yamlFlowIndicator start='\[' end='\]' contains=@yamlFlowNode
|
|
|
|
execute 'syn match yamlPlainScalar /'.s:ns_plain_out.'/'
|
|
execute 'syn match yamlPlainScalar contained /'.s:ns_plain_in.'/'
|
|
|
|
execute 'syn match yamlFlowMappingKey /'.s:ns_plain_in.'\%(\s\+'.s:ns_plain_in.'\)*\ze\s*:/ contained '.
|
|
\'nextgroup=yamlFlowMappingDelimiter skipwhite'
|
|
syn match yamlFlowMappingKeyStart /?/ contained nextgroup=@yamlFlowNode skipwhite
|
|
syn match yamlFlowMappingMerge /<<\ze\s*:/ contained nextgroup=yamlFlowMappingDelimiter skipwhite
|
|
syn match yamlFlowMappingDelimiter /:/ contained nextgroup=@yamlFlowNode skipwhite
|
|
execute 'syn match yamlFlowNodeProperties' string(s:c_ns_properties)
|
|
\ 'contained contains=yamlNodeTag,yamlAnchor nextgroup=@yamlFlowNode skipwhite'
|
|
|
|
execute 'syn match yamlBlockMappingKey /^\s*\zs'.s:ns_plain_out.'\%(\s\+'.s:ns_plain_out.'\)*\ze\s*:\%(\s\|$\)/ '.
|
|
\'nextgroup=yamlBlockMappingDelimiter skipwhite'
|
|
execute 'syn match yamlBlockMappingKey /'.s:ns_plain_out.'\%(\s\+'.s:ns_plain_out.'\)*\ze\s*:\%(\s\|$\)/ contained '.
|
|
\'nextgroup=yamlBlockMappingDelimiter skipwhite'
|
|
syn match yamlBlockMappingKeyString /^\s*\zs\%("\%([^"]\|\\"\)*"\|'\%([^']\|''\)*'\)\ze\s*:\%(\s\|$\)/
|
|
\ contains=yamlFlowString nextgroup=yamlBlockMappingDelimiter skipwhite
|
|
syn match yamlBlockMappingKeyString /\%("\%([^"]\|\\"\)*"\|'\%([^']\|''\)*'\)\ze\s*:\%(\s\|$\)/ contained
|
|
\ contains=yamlFlowString nextgroup=yamlBlockMappingDelimiter skipwhite
|
|
syn match yamlBlockMappingMerge /^\s*\zs<<\ze\s*:\%(\s\|$\)/ nextgroup=yamlBlockMappingDelimiter skipwhite
|
|
syn match yamlBlockMappingMerge /<<\ze\s*:\%(\s\|$\)/ contained nextgroup=yamlBlockMappingDelimiter skipwhite
|
|
|
|
syn match yamlBlockMappingDelimiter /^\s*\zs:\ze\%(\s\|$\)/ nextgroup=@yamlBlockNode skipwhite
|
|
syn match yamlBlockMappingDelimiter /:\ze\%(\s\|$\)/ contained nextgroup=@yamlBlockNode skipwhite
|
|
syn match yamlBlockMappingKeyStart /^\s*\zs?\ze\%(\s\|$\)/ nextgroup=@yamlBlockNode skipwhite
|
|
syn match yamlBlockMappingKeyStart /?\ze\%(\s\|$\)/ contained nextgroup=@yamlBlockNode skipwhite
|
|
|
|
syn match yamlBlockCollectionItemStart /^\s*\zs-\ze\%(\s\|$\)/ nextgroup=@yamlBlockNode skipwhite
|
|
syn match yamlBlockCollectionItemStart /-\ze\%(\s\|$\)/ contained nextgroup=@yamlBlockNode skipwhite
|
|
|
|
execute 'syn match yamlBlockNodeProperties' string(s:c_ns_properties)
|
|
\ 'contained contains=yamlNodeTag,yamlAnchor nextgroup=@yamlFlowNode,yamlBlockScalarHeader skipwhite'
|
|
syn match yamlBlockScalarHeader '[|>]\%([1-9][+-]\|[+-]\?[1-9]\?\)\%(\s\+#.*\)\?$' contained
|
|
\ contains=yamlComment nextgroup=yamlBlockString skipnl
|
|
syn region yamlBlockString start=/^\z(\s\+\)/ skip=/^$/ end=/^\%(\z1\)\@!/ contained
|
|
|
|
syn cluster yamlBlockNode contains=@yamlFlowNode,yamlBlockMappingKey,yamlBlockMappingKeyString,
|
|
\yamlBlockMappingMerge,yamlBlockMappingKeyStart,yamlBlockCollectionItemStart,
|
|
\yamlBlockNodeProperties,yamlBlockScalarHeader
|
|
|
|
syn cluster yamlScalarWithSpecials contains=yamlPlainScalar,yamlBlockMappingKey,yamlFlowMappingKey
|
|
|
|
let s:_bounder = s:SimplifyToAssumeAllPrintable('\%([[\]{}, \t]\@!\p\)')
|
|
if b:yaml_schema is# 'json'
|
|
syn keyword yamlNull null contained containedin=@yamlScalarWithSpecials
|
|
syn keyword yamlBool true false
|
|
exe 'syn match yamlInteger /'.s:_bounder.'\@1<!\%(0\|-\=[1-9][0-9]*\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
exe 'syn match yamlFloat /'.s:_bounder.'\@1<!\%(-\=[1-9][0-9]*\%(\.[0-9]*\)\=\(e[-+]\=[0-9]\+\)\=\|0\|-\=\.inf\|\.nan\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
elseif b:yaml_schema is# 'core'
|
|
syn keyword yamlNull null Null NULL contained containedin=@yamlScalarWithSpecials
|
|
syn keyword yamlBool true True TRUE false False FALSE contained containedin=@yamlScalarWithSpecials
|
|
exe 'syn match yamlNull /'.s:_bounder.'\@1<!\~'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
exe 'syn match yamlInteger /'.s:_bounder.'\@1<!\%([-+]\=\%(\%(0\%(b[0-1_]\+\|o\?[0-7_]\+\|x[0-9a-fA-F_]\+\)\=\|\%([1-9][0-9_]*\%(:[0-5]\=\d\)\+\)\)\|[1-9][0-9_]*\)\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
exe 'syn match yamlFloat /'.s:_bounder.'\@1<!\%([-+]\=\%(\%(\d[0-9_]*\)\.[0-9_]*\%([eE][-+]\=\d\+\)\=\|\.[0-9_]\+\%([eE][-+]\=[0-9]\+\)\=\|\d[0-9_]*\%(:[0-5]\=\d\)\+\.[0-9_]*\|\.\%(inf\|Inf\|INF\)\)\|\%(\.\%(nan\|NaN\|NAN\)\)\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
elseif b:yaml_schema is# 'pyyaml'
|
|
syn keyword yamlNull null Null NULL contained containedin=@yamlScalarWithSpecials
|
|
syn keyword yamlBool true True TRUE false False FALSE yes Yes YES no No NO on On ON off Off OFF contained containedin=@yamlScalarWithSpecials
|
|
exe 'syn match yamlNull /'.s:_bounder.'\@1<!\~'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
exe 'syn match yamlFloat /'.s:_bounder.'\@1<!\%(\v[-+]?%(\d[0-9_]*)\.[0-9_]*%([eE][-+]\d+)?|\.[0-9_]+%([eE][-+]\d+)?|[-+]?\d[0-9_]*%(\:[0-5]?\d)+\.[0-9_]*|[-+]?\.%(inf|Inf|INF)|\.%(nan|NaN|NAN)\m\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
exe 'syn match yamlInteger /'.s:_bounder.'\@1<!\%(\v[-+]?0b[0-1_]+|[-+]?0[0-7_]+|[-+]?%(0|[1-9][0-9_]*)|[-+]?0x[0-9a-fA-F_]+|[-+]?[1-9][0-9_]*%(:[0-5]?\d)+\m\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
exe 'syn match yamlTimestamp /'.s:_bounder.'\@1<!\%(\v\d\d\d\d\-\d\d\-\d\d|\d\d\d\d \-\d\d? \-\d\d?%([Tt]|[ \t]+)\d\d?\:\d\d \:\d\d %(\.\d*)?%([ \t]*%(Z|[-+]\d\d?%(\:\d\d)?))?\m\)'.s:_bounder.'\@!/ contained containedin=@yamlScalarWithSpecials'
|
|
elseif b:yaml_schema is# 'failsafe'
|
|
" Nothing
|
|
endif
|
|
unlet s:_bounder
|
|
|
|
|
|
execute 'syn match yamlNodeTag '.string(s:c_ns_tag_property)
|
|
execute 'syn match yamlAnchor '.string(s:c_ns_anchor_property)
|
|
execute 'syn match yamlAlias '.string(s:c_ns_alias_node)
|
|
|
|
syn match yamlDocumentStart '^---\ze\%(\s\|$\)'
|
|
syn match yamlDocumentEnd '^\.\.\.\ze\%(\s\|$\)'
|
|
|
|
hi def link yamlTodo Todo
|
|
hi def link yamlComment Comment
|
|
|
|
hi def link yamlDocumentStart PreProc
|
|
hi def link yamlDocumentEnd PreProc
|
|
|
|
hi def link yamlDirectiveName Keyword
|
|
|
|
hi def link yamlTAGDirective yamlDirectiveName
|
|
hi def link yamlTagHandle String
|
|
hi def link yamlTagPrefix String
|
|
|
|
hi def link yamlYAMLDirective yamlDirectiveName
|
|
hi def link yamlReservedDirective Error
|
|
hi def link yamlYAMLVersion Number
|
|
|
|
hi def link yamlString String
|
|
hi def link yamlFlowString yamlString
|
|
hi def link yamlFlowStringDelimiter yamlString
|
|
hi def link yamlEscape SpecialChar
|
|
hi def link yamlSingleEscape SpecialChar
|
|
|
|
hi def link yamlMappingKey Identifier
|
|
hi def link yamlMappingKeyStart Special
|
|
hi def link yamlMappingMerge Special
|
|
hi def link yamlKeyValueDelimiter Special
|
|
|
|
hi def link yamlFlowIndicator Special
|
|
hi def link yamlFlowMappingKey yamlMappingKey
|
|
hi def link yamlFlowMappingKeyStart yamlMappingKeyStart
|
|
hi def link yamlFlowMappingMerge yamlMappingMerge
|
|
hi def link yamlFlowMappingDelimiter yamlKeyValueDelimiter
|
|
|
|
hi def link yamlBlockMappingKey yamlMappingKey
|
|
hi def link yamlBlockMappingKeyStart yamlMappingKeyStart
|
|
hi def link yamlBlockMappingMerge yamlMappingMerge
|
|
hi def link yamlBlockMappingDelimiter yamlKeyValueDelimiter
|
|
hi def link yamlBlockCollectionItemStart Label
|
|
hi def link yamlBlockScalarHeader Special
|
|
" We do not link yamlBlockString to yamlString, because yamlPlainScalar is
|
|
" not highlighted as string neighter, and also due to historical reasons.
|
|
" hi def link yamlBlockString yamlString
|
|
|
|
hi def link yamlConstant Constant
|
|
|
|
hi def link yamlNull yamlConstant
|
|
hi def link yamlBool yamlConstant
|
|
|
|
hi def link yamlAnchor Type
|
|
hi def link yamlAlias Type
|
|
hi def link yamlNodeTag Type
|
|
|
|
hi def link yamlInteger Number
|
|
hi def link yamlFloat Float
|
|
hi def link yamlTimestamp Number
|
|
|
|
let b:current_syntax = "yaml"
|
|
|
|
unlet s:ns_char s:ns_word_char s:ns_uri_char s:ns_tag_char s:c_indicator s:c_flow_indicator
|
|
\ s:ns_anchor_char s:ns_char_without_c_indicator s:_collection s:_neg_collection
|
|
\ s:c_verbatim_tag s:c_named_tag_handle s:c_secondary_tag_handle s:c_primary_tag_handle
|
|
\ s:c_tag_handle s:c_ns_shorthand_tag s:c_non_specific_tag s:c_ns_tag_property
|
|
\ s:c_ns_anchor_name s:c_ns_anchor_property s:c_ns_alias_node s:c_ns_properties
|
|
\ s:ns_directive_name s:ns_local_tag_prefix s:ns_global_tag_prefix s:ns_tag_prefix
|
|
\ s:ns_plain_safe_out s:ns_plain_safe_in s:ns_plain_safe_in_without_colhash s:ns_plain_safe_out_without_colhash
|
|
\ s:ns_plain_first_in s:ns_plain_first_out s:ns_plain_char_in s:ns_plain_char_out s:ns_plain_out s:ns_plain_in
|
|
delfunction s:SimplifyAdjacentCollections
|
|
delfunction s:SimplifyToAssumeAllPrintable
|
|
|
|
let &cpo = s:cpo_save
|
|
unlet s:cpo_save
|
|
|
|
" vim: set et sw=4 sts=4 ts=8:
|