Vim syntaxfile: Difference between revisions
No edit summary |
|||
Line 83: | Line 83: | ||
</blockquote><!-- Example --> | </blockquote><!-- Example --> | ||
= Match Regions = | = Syntax = | ||
<blockquote> | |||
== Match Regions == | |||
<blockquote> | <blockquote> | ||
You define keywords/matches, optionally within a region.<br> | You define keywords/matches, optionally within a region.<br> | ||
Line 110: | Line 112: | ||
</blockquote><!-- Match Regions --> | </blockquote><!-- Match Regions --> | ||
= Syntax Arguments = | == Syntax Arguments == | ||
<blockquote> | <blockquote> | ||
== contains/contained == | === contains/contained === | ||
<blockquote> | <blockquote> | ||
<code>contains</code> indicates that a region/match contains another match-group.<br> | <code>contains</code> indicates that a region/match contains another match-group.<br> | ||
Line 134: | Line 136: | ||
</blockquote><!-- contains/contained --> | </blockquote><!-- contains/contained --> | ||
== matchgroup == | === matchgroup === | ||
<blockquote> | <blockquote> | ||
<code>matchgroup</code> allows you to highlight the start/end pattern <br> | <code>matchgroup</code> allows you to highlight the start/end pattern <br> | ||
Line 149: | Line 151: | ||
</blockquote><!-- Syntax Arguments --> | </blockquote><!-- Syntax Arguments --> | ||
= Highlight = | == Highlight == | ||
<blockquote> | <blockquote> | ||
You apply highlights to captured keywords, matches, or regions. | You apply highlights to captured keywords, matches, or regions. | ||
Line 160: | Line 162: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</blockquote><!-- Highlight --> | </blockquote><!-- Highlight --> | ||
</blockquote><!-- Syntax --> |
Revision as of 16:06, 30 July 2023
Syntax for writing vim syntax-files.
Documentation
:h syn-match
https://vimhelp.org/syntax.txt.html#%3Asyn-match :h syn-region
https://vimhelp.org/syntax.txt.html#%3Asyn-region :h syn-arguments
(ex. conceal, cchar, contained, ..)https://vimhelp.org/syntax.txt.html#%3Asyn-arguments
Tutorials
vimwiki: creating syntaxfiles https://vim.fandom.com/wiki/Creating_your_own_syntax_files
Locations
${vim-or-plug}/syntax/${vim_filetype}.vim
syntax files
Example
ftdetect/my_language.vim
Register a filetype based on a file-extension" ftdetect/my_language.vim au BufRead,BufNewFile *.todo set filetype=todolist_simple
syntax/my_language.vim
Define the syntax-highligting for the filetype" syntax/my_language.vim " don't reload if already loaded if exists('b:my_language_syntax') finish endif " Define marker colours (CLI/GUI) let s:todo_colour = 'magenta' let s:gui_todo_colour = '#F57900' " Define Regexes let s:todo_regex = '\(^\s*\)\@<=\*\([a-zA-Z]\)\@!' " Define syntax for Regexes execute "syntax match my_language_todo '". s:todo_regex ."'" " Apply highlighting execute ' highlight todolistsimple_todo ctermfg='. s:todo_colour .' guifg='. s:gui_todo_colour .' ctermbg=none cterm=bold gui=bold' " mark file as loaded let b:my_language_syntax = 1
Syntax
Match Regions
You define keywords/matches, optionally within a region.
these can be assigned styles with:highlight
" keyword matches are literal word-matches syntax keyword mySqlKeywords \ SELECT INSERT INNER LEFT JOIN " matches are regex matches syntax match myComments \ '\(--\|#\)' " regions let you define (potentially multiline) regions " you can have different rules within different types of regions " (contains defines matches/keywords that apply within the region) syntax region myBlock \ start='{' end='}' \ transparent \ contains=mySqlKeywords,myComments " you can assign multiple starts/ends to the same region " (ex. in ruby '{...}' and 'do; ...; end' are identical)Syntax Arguments
contains/contained
contains
indicates that a region/match contains another match-group.
Ex. if you wanted to syntax-highlight markdown within a doc-commentsyntax region docComment \ start='"""' end='"""' \ transparent \ contains=markdownHeader,markdownBold
contained
is the counterpart ofcontains
a contained match/keyword is only valid if it appears in a contains= statement (ex. it doesn't apply to the whole document)" don't apply to the whole document! only inside! syntax keyword myKwd1 \ contained \ SELECTmatchgroup
matchgroup
allows you to highlight the start/end pattern
differently than the body of the region.From the vim help page
" quotation-marks can be styled with `Quote` " inside-quotation-marks can be styled with `String` syntax region String matchgroup=Quote \ start=+"+ skip=+\\"+ end=+"+Highlight
You apply highlights to captured keywords, matches, or regions.
" apply style to `someKeywordOrMatch` highlight someKeywordOrMatch \ cterm=italic ctermfg=2 ctermbg=160 \ gui=italic guifg='#111111' guibg='#FFFFFF'