vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

mbsync.vim (14284B)


      1 " Vim syntax file
      2 " Language:	mbsyncrc
      3 " Maintainer:	Pierrick Guillaume  <pguillaume@fymyte.com>
      4 " Last Change:	2025 Apr 13
      5 " 2025 Jun 04 by Vim project: match TLSType configuration variable
      6 " 2026 Jan 15 by Vim project: support TLSVersions keyword
      7 " 2026 May 20 by Vim project: handle sync keyword #20243
      8 "
      9 " Syntax support for mbsync config file
     10 
     11 " This file is based on the mbsync manual (isync v1.4.4)
     12 " https://isync.sourceforge.io/mbsync.html
     13 
     14 if exists('b:current_syntax')
     15   finish
     16 endif
     17 
     18 let b:current_syntax = 'mbsync'
     19 
     20 let s:cpo_save = &cpo
     21 set cpo&vim
     22 
     23 syn match mbsError    '.*'
     24 
     25 syn match mbsCommentL '^#.*$'
     26 
     27 " Properties {{{
     28 
     29 syn match   mbsNumber   '[0-9]\+' display contained
     30 syn match   mbsPath     '\%([A-Za-z0-9/._+#$%~=\\{}\[\]:@!-]\|\\.\)\+' display contained
     31 syn match   mbsPath     '"\%([A-Za-z0-9/._+#$%~=\\{}\[\]:@! -]\|\\.\)\+"' display contained
     32 syn match   mbsName     '\%([A-Za-z0-9/._+#$%~=\\{}\[\]:@!-]\|\\.\)\+' display contained
     33 syn match   mbsName     '"\%([A-Za-z0-9/._+#$%~=\\{}\[\]:@! -]\|\\.\)\+"' display contained
     34 syn match   mbsCommand  '+\?.*$' display contained contains=mbsCommandPrompt
     35 syn match   mbsCommandPrompt '+' display contained
     36 syn region  mbsString   start=+"+ skip=+\\"+ end=+"+ display contained
     37 syn match   mbsSizeUnit '[kKmMbB]' display contained
     38 syn match   mbsSize     '[0-9]\+' display contained contains=mbsNumber nextgroup=mbsSizeUnit
     39 syn keyword mbsBool     yes no contained
     40 
     41 " }}}
     42 
     43 
     44 " Stores {{{
     45 " Global Store Config Items
     46 syn match mbsGlobConfPath     '^Path\s\+\ze.*$'      contains=mbsGlobConfItemK contained nextgroup=mbsPath transparent
     47 syn match mbsGlobConfMaxSize  '^MaxSize\s\+\ze.*$'   contains=mbsGlobConfItemK contained nextgroup=mbsSize transparent
     48 syn match mbsGlobConfMapInbox '^MapInbox\s\+\ze.*$'  contains=mbsGlobConfItemK contained nextgroup=mbsPath transparent
     49 syn match mbsGlobConfFlatten  '^Flatten\s\+\ze.*$'   contains=mbsGlobConfItemK contained nextgroup=mbsPath transparent
     50 syn match mbsGlobConfTrash    '^Trash\s\+\ze.*$'     contains=mbsGlobConfItemK contained nextgroup=mbsPath transparent
     51 syn match mbsGlobConfTrashNO  '^TrashNewOnly\s\+\ze.*$'   contains=mbsGlobConfItemK contained nextgroup=mbsBool transparent
     52 syn match mbsGlobConfTrashRN  '^TrashRemoteNew\s\+\ze.*$' contains=mbsGlobConfItemK contained nextgroup=mbsBool transparent
     53 syn keyword mbsGlobConfItemK  Path MaxSize MapInbox Flatten Trash TrashNewOnly TrashRemoteNew contained
     54 
     55 syn cluster mbsGlobConfItem contains=mbsGlobConfPath,mbsGlobConfMaxSize,mbsGlobConfMapInbox,mbsGlobConfFlatten,mbsCommentL,mbsGlobConfTrash.*
     56 
     57 
     58 "   MaildirStore
     59 syn match mbsMdSConfStMaildirStore  '^MaildirStore\s\+\ze.*$'   contains=mbsMdSConfItemK contained nextgroup=mbsName transparent
     60 syn match mbsMdSConfStAltMap        '^AltMap\s\+\ze.*$'         contains=mbsMdSConfItemK contained nextgroup=mbsBool transparent
     61 syn match mbsMdsConfStInbox         '^Inbox\s\+\ze.*$'          contains=mbsMdSConfItemK contained nextgroup=mbsPath transparent
     62 syn match mbsMdsConfStInfoDelimiter '^InfoDelimiter\s\+\ze.*$'  contains=mbsMdSConfItemK contained nextgroup=mbsPath transparent
     63 syn keyword mbsMdSConfSubFoldersOpt  Verbatim Legacy contained
     64 syn match mbsMdSConfSubFoldersOpt   'Maildir++' display contained
     65 syn match mbsMdsConfStSubFolders    '^SubFolders\s\+\ze.*$'     contains=mbsMdSConfItemK contained nextgroup=mbsMdSConfSubFoldersOpt transparent
     66 
     67 syn cluster mbsMdSConfItem contains=mbsMdSConfSt.*
     68 
     69 syn keyword mbsMdSConfItemK   MaildirStore AltMap Inbox InfoDelimiter SubFolders contained
     70 
     71 syn region mbsMaildirStore start="^MaildirStore" end="^$" end='\%$' contains=@mbsGlobConfItem,mbsCommentL,@mbsMdSConfItem,mbsError transparent
     72 
     73 
     74 "   IMAP4Accounts
     75 syn match mbsIAConfStIMAPAccount  '^IMAPAccount\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsName transparent
     76 syn match mbsIAConfStHost         '^Host\s\+\ze.*$'           contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     77 syn match mbsIAConfStPort         '^Port\s\+\ze.*$'           contains=mbsIAConfItemK contained nextgroup=mbsNumber transparent
     78 syn match mbsIAConfStTimeout      '^Timeout\s\+\ze.*$'        contains=mbsIAConfItemK contained nextgroup=mbsNumber transparent
     79 syn match mbsIAConfStUser         '^User\s\+\ze.*$'           contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     80 syn match mbsIAConfStUserCmd      '^UserCmd\s\+\ze.*$'        contains=mbsIAConfItemK contained nextgroup=mbsCommand transparent
     81 syn match mbsIAConfStPass         '^Pass\s\+\ze.*$'           contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     82 syn match mbsIAConfStPassCmd      '^PassCmd\s\+\ze.*$'        contains=mbsIAConfItemK contained nextgroup=mbsCommand transparent
     83 syn match mbsIAConfStUseKeychain  '^UseKeychain\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsBool transparent
     84 syn match mbsIAConfStTunnel       '^Tunnel\s\+\ze.*$'         contains=mbsIAConfItemK contained nextgroup=mbsCommand transparent
     85 syn match mbsIAConfStAuthMechs    '^AuthMechs\s\+\ze.*$'      contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     86 syn keyword mbsIAConfTLSTypeOpt None STARTTLS IMAPS contained
     87 syn match mbsIAConfStSSLType      '^SSLType\s\+\ze.*$'        contains=mbsIAConfItemK contained nextgroup=mbsIAConfTLSTypeOpt transparent
     88 syn match mbsIAConfStTLSType      '^TLSType\s\+\ze.*$'        contains=mbsIAConfItemK contained nextgroup=mbsIAConfTLSTypeOpt transparent
     89 syn match mbsIAConfSSLVersionsOpt '\%(SSLv3\|TLSv1\%(.[123]\)\?\)\%(\s\+\%(SSLv3\|TLSv1\%(.[123]\)\?\)\)*' contained
     90 syn match mbsIAConfTLSVersionsOpt '[+-]\d\.\d\(\s\+[+-]\d\.\d\)*' contained
     91 syn match mbsIAConfStSSLVersions  '^SSLVersions\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsIAConfSSLVersionsOpt transparent
     92 syn match mbsIAConfStTLSVersions  '^TLSVersions\s\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsIAConfTLSVersionsOpt transparent
     93 syn match mbsIAConfStSystemCertificates  '^SystemCertificates\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsBool transparent
     94 syn match mbsIAConfStCertificateFile  '^CertificateFile\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     95 syn match mbsIAConfStClientCertificate  '^ClientCertificate\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     96 syn match mbsIAConfStClientKey    '^ClientKey\s\+\ze.*$'       contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
     97 syn match mbsIAConfStCipherString '^CipherString\s\+\ze.*$'    contains=mbsIAConfItemK contained nextgroup=mbsString transparent
     98 syn match mbsIAConfStPipelineDepth '^PipelineDepth\s\+\ze.*$'  contains=mbsIAConfItemK contained nextgroup=mbsNumber transparent
     99 syn match mbsIAConfStDisableExtensions '^DisableExtensions\?\s\+\ze.*$'  contains=mbsIAConfItemK contained nextgroup=mbsPath transparent
    100 
    101 syn cluster mbsIAConfItem contains=mbsIAConfSt.*
    102 syn keyword mbsIAConfItemK
    103   \ IMAPAccount Host Port Timeout User UserCmd Pass PassCmd UseKeychain Tunnel TLSVersions
    104   \ AuthMechs SSLType TLSType SSLVersions SystemCertificates CertificateFile ClientCertificate
    105   \ ClientKey CipherString PipelineDepth DisableExtension[s] contained
    106 
    107 syn region mbsIMAP4AccontsStore start="^IMAPAccount" end="^$" end="\%$" contains=@mbsGlobConfItem,mbsCommentL,@mbsIAConfItem,mbsError transparent
    108 
    109 
    110 "   IMAPStores
    111 syn match mbsISConfStIMAPStore    '^IMAPStore\s\+\ze.*$'      contains=mbsISConfItemK contained nextgroup=mbsName transparent
    112 syn match mbsISConfStAccount      '^Account\s\+\ze.*$'        contains=mbsISConfItemK contained nextgroup=mbsName transparent
    113 syn match mbsISConfStUseNamespace '^UseNamespace\s\+\ze.*$'   contains=mbsISConfItemK contained nextgroup=mbsBool transparent
    114 syn match mbsISConfStPathDelimiter '^PathDelimiter\s\+\ze.*$'   contains=mbsISConfItemK contained nextgroup=mbsPath transparent
    115 syn match mbsISConfStSubscribedOnly '^SubscribedOnly\s\+\ze.*$'   contains=mbsISConfItemK contained nextgroup=mbsBool transparent
    116 
    117 syn cluster mbsISConfItem contains=mbsISConfSt.*
    118 syn keyword mbsISConfItemK  IMAPStore Account UseNamespace PathDelimiter SubscribedOnly contained
    119 
    120 syn region mbsIMAPStore start="^IMAPStore" end="^$" end="\%$" contains=@mbsGlobConfItem,mbsCommentL,@mbsISConfItem,mbsError transparent
    121 
    122 " }}}
    123 
    124 " Channels {{{
    125 
    126 syn match mbsCConfStChannel       '^Channel\s\+\ze.*$'        contains=mbsCConfItemK contained nextgroup=mbsName transparent
    127 syn region mbsCConfProxOpt matchgroup=mbsCConfProxOptOp start=':' matchgroup=mbsCConfProxOptOp end=':' contained contains=mbsName nextgroup=mbsPath keepend
    128 syn match mbsCConfStFar           '^Far\s\+\ze.*$'            contains=mbsCConfItemK contained nextgroup=mbsCConfProxOpt transparent
    129 syn match mbsCConfStNear          '^Near\s\+\ze.*$'           contains=mbsCConfItemK contained nextgroup=mbsCConfProxOpt transparent
    130 syn match mbsCConfPatternOptOp '[*%!]' display contained
    131 syn match mbsCConfPatternOpt  '.*$' display contained contains=mbsCConfPatternOptOp
    132 syn match mbsCConfStPattern       '^Patterns\?\s\+\ze.*$'     contains=mbsCConfItemK contained nextgroup=mbsCConfPatternOpt transparent
    133 syn match mbsCConfStMaxSize       '^MaxSize\s\+\ze.*$'        contains=mbsCConfItemK contained nextgroup=mbsSize transparent
    134 syn match mbsCConfStMaxMessages   '^MaxMessages\s\+\ze.*$'    contains=mbsCConfItemK contained nextgroup=mbsNumber transparent
    135 syn match mbsCConfStExpireUnread  '^ExpireUnread\s\+\ze.*$'   contains=mbsCConfItemK contained nextgroup=mbsBool transparent
    136 " Properly matching mbsCConfSyncOpt:
    137 "
    138 " None is a special case. From mbsync's man page:
    139 "   "None may not be combined with any other operation."
    140 " Once "None" is out of the way, first try to match operations, including:
    141 "   - New, Old, Upgrade, Gone, Flags
    142 "   - ReNew (deprecated synonym for Upgrade)
    143 "   - Delete (deprecated synonym for Gone)
    144 "   - All and Full, since they can be combined with other flags
    145 " Then try to match the "second style" (as defined by mbsync's man page),
    146 " which is a concatenation of direction Flags (Pull/Push) and of the
    147 " operations seen above (New, Old, Upgrade/Renew, Gone/Delete, Flags, Full).
    148 " Note that while "PullFull" exists, "PullAll" is not handled by mbsync's
    149 " parser.
    150 " Last but not least, match "\s+%(All of the above, except None) as multiple
    151 " operations may be given to Sync.
    152 syn match mbsCConfSyncOpt /\v(
    153   \None
    154   \|%(Pull|Push|New|Old|Upgrade|ReNew|Gone|Delete|Flags|Full|All
    155     \|%(Pull|Push)%(New|Old|Upgrade|ReNew|Gone|Delete|Flags|Full))
    156   \%(\s+%(Pull|Push|New|Old|Upgrade|ReNew|Gone|Delete|Flags|Full|All
    157         \|%(Pull|Push)%(New|Old|Upgrade|ReNew|Gone|Delete|Flags|Full)))*)$/ display contained
    158 syn match mbsCConfStSync          '^Sync\s\+\ze.*$'           contains=mbsCConfItemK contained nextgroup=mbsCConfSyncOpt transparent
    159 syn keyword mbsCConfManipOpt  None Far Near Both contained
    160 syn match mbsCConfStCreate        '^Create\s\+\ze.*$'         contains=mbsCConfItemK contained nextgroup=mbsCConfManipOpt transparent
    161 syn match mbsCConfStRemove        '^Remove\s\+\ze.*$'         contains=mbsCConfItemK contained nextgroup=mbsCConfManipOpt transparent
    162 syn match mbsCConfStExpunge       '^Expunge\s\+\ze.*$'        contains=mbsCConfItemK contained nextgroup=mbsCConfManipOpt transparent
    163 syn match mbsCConfStCopyArrivalDate '^CopyArrivalDate\s\+\ze.*$' contains=mbsCConfItemK contained nextgroup=mbsBool transparent
    164 syn match mbsCConfSyncStateOpt  '\*\|.*$' display contained contains=mbsCConfSyncStateOptOp,mbsPath transparent
    165 syn match mbsCConfSyncStateOptOp  '\*' display contained
    166 syn match mbsCConfStSyncState     '^SyncState\s\+\ze.*$'      contains=mbsCConfItemK contained nextgroup=mbsCConfSyncStateOpt transparent
    167 
    168 syn cluster mbsCConfItem contains=mbsCConfSt.*
    169 
    170 syn keyword mbsCConfItemK
    171   \ Channel Far Near Pattern[s] MaxSize MaxMessages ExpireUnread Sync Create
    172   \ Remove Expunge CopyArrivalDate SyncState contained
    173 
    174 syn region mbsChannel start="^Channel" end="^$" end="\%$" contains=@mbsCConfItem,mbsCommentL,mbsError transparent
    175 
    176 " }}}
    177 
    178 " Groups {{{
    179 
    180 syn match mbsGConfGroupOpt  '\%([A-Za-z0-9/._+#$%~=\\{}\[\]:@!-]\|\\.\)\+' display contained contains=mbsName nextgroup=mbsGConfChannelOpt
    181 syn match mbsGConfStGroup         '^Group\s\+\ze.*$'          contains=mbsGConfItemK contained nextgroup=mbsGConfGroupOpt transparent
    182 syn match mbsGConfChannelOpt '.*$' display contained
    183 syn match mbsGConfStChannel       '^Channels\?\s\+\ze.*$'     contains=mbsGConfItemK contained nextgroup=mbsGConfChannelOpt transparent
    184 
    185 syn cluster mbsGConfItem contains=mbsGConfSt.*
    186 
    187 syn keyword mbsGConfItemK  Group Channel[s] contained
    188 
    189 syn region mbsGroup start="^Group" end="^$" end="\%$" contains=@mbsGConfItem,mbsError transparent
    190 
    191 " }}}
    192 
    193 " Global Options {{{
    194 
    195 syn match mbsFSync                '^FSync\s\+\ze.*$'          contains=mbsGlobOptItemK nextgroup=mbsBool transparent
    196 syn match mbsFieldDelimiter       '^FieldDelimiter\s\+\ze.*$' contains=mbsGlobOptItemK nextgroup=mbsPath transparent
    197 syn match mbsBufferLimit          '^BufferLimit\s\+\ze.*$'    contains=mbsGlobOptItemK nextgroup=mbsSize transparent
    198 
    199 syn keyword mbsGlobOptItemK FSync FieldDelimiter BufferLimit contained
    200 " }}}
    201 
    202 " Highlights {{{
    203 
    204 hi def link mbsError      Error
    205 
    206 hi def link mbsCommentL   Comment
    207 
    208 hi def link mbsNumber     Number
    209 hi def link mbsSizeUnit   Type
    210 hi def link mbsPath       String
    211 hi def link mbsString     String
    212 hi def link mbsCommand    String
    213 hi def link mbsCommandPrompt Operator
    214 hi def link mbsName       Constant
    215 hi def link mbsBool       Boolean
    216 
    217 hi def link mbsGlobConfItemK  Statement
    218 
    219 hi def link mbsMdSConfItemK   Statement
    220 hi def link mbsMdSConfSubFoldersOpt Keyword
    221 
    222 hi def link mbsIAConfItemK    Statement
    223 hi def link mbsIAConfTLSTypeOpt Keyword
    224 hi def link mbsIAConfSSLVersionsOpt Keyword
    225 hi def link mbsIAConfTLSVersionsOpt Keyword
    226 
    227 hi def link mbsISConfItemK    Statement
    228 
    229 hi def link mbsCConfItemK     Statement
    230 hi def link mbsCConfProxOptOp Operator
    231 hi def link mbsCConfPatternOpt String
    232 hi def link mbsCConfPatternOptOp Operator
    233 hi def link mbsCConfSyncOpt   Keyword
    234 hi def link mbsCConfManipOpt  Keyword
    235 hi def link mbsCConfSyncStateOptOp Operator
    236 
    237 hi def link mbsGConfItemK     Statement
    238 hi def link mbsGConfChannelOpt  String
    239 
    240 hi def link mbsGlobOptItemK   Statement
    241 " }}}
    242 
    243 let &cpo = s:cpo_save
    244 unlet s:cpo_save