feat(syntax): specify verbose level for bracket cite conceal

refer: lervag#2008
Mu-L · Mar 27, 2021 · abe9f36 · abe9f36
1 parent 41667e5
commit abe9f36
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 12 deletions.
diff --git a/autoload/vimtex/options.vim b/autoload/vimtex/options.vim
@@ -283,6 +283,7 @@ function! vimtex#options#init() abort " {{{1
   call s:init_option('vimtex_syntax_conceal_cites', {
         \ 'type': 'brackets',
         \ 'icon': '📖',
+        \ 'verbose': v:true,
         \})
   call s:init_option('vimtex_syntax_nested', {
         \ 'aliases' : {

diff --git a/autoload/vimtex/syntax/core.vim b/autoload/vimtex/syntax/core.vim
@@ -596,7 +596,8 @@ function! vimtex#syntax#core#init_highlights() abort " {{{1
   highlight def link texNewenvParm         texParm
   highlight def link texOptEqual           texSymbol
   highlight def link texRefOpt             texOpt
-  highlight def link texRefConcealedOpt    texRefOpt
+  highlight def link texRefConcealedOpt1   texRefOpt
+  highlight def link texRefConcealedOpt2   texRefOpt
   highlight def link texRefConcealedArg    texRefArg
   highlight def link texRefConcealedDelim  texDelim
   highlight def link texTabularArg         texOpt
@@ -1518,10 +1519,14 @@ endfunction
 function! s:match_conceal_cites_brackets() abort " {{{1
   syntax match texCmdRefConcealed
         \ "\\cite[tp]\?\>\*\?"
-        \ conceal skipwhite nextgroup=texRefConcealedOpt,texRefConcealedArg
-  call vimtex#syntax#core#new_opt('texRefConcealedOpt', {
+        \ conceal skipwhite nextgroup=texRefConcealedOpt1,texRefConcealedArg
+  call vimtex#syntax#core#new_opt('texRefConcealedOpt1', {
+        \ 'opts': g:vimtex_syntax_conceal_cites.verbose ? '' : 'conceal',
+        \ 'next': 'texRefConcealedOpt2,texRefConcealedArg',
+        \})
+  call vimtex#syntax#core#new_opt('texRefConcealedOpt2', {
         \ 'opts': 'conceal',
-        \ 'next': 'texRefConcealedOpt,texRefConcealedArg',
+        \ 'next': 'texRefConcealedArg',
         \})
   call vimtex#syntax#core#new_arg('texRefConcealedArg', {
         \ 'contains': 'texComment,@NoSpell,texRefConcealedDelim',

diff --git a/autoload/vimtex/syntax/p/biblatex.vim b/autoload/vimtex/syntax/p/biblatex.vim
@@ -44,7 +44,7 @@ endfunction
 function! s:match_conceal_cites_brackets() abort " {{{1
   syntax match texCmdRefConcealed
         \ "\v\\%(cite[tp]?>\*?|%([Tt]ext|[Ss]mart|[Aa]uto)cite>)"
-        \ conceal skipwhite nextgroup=texRefConcealedOpt,texRefConcealedArg
+        \ conceal skipwhite nextgroup=texRefConcealedOpt1,texRefConcealedArg
 endfunction
 
 " }}}1

diff --git a/doc/vimtex.txt b/doc/vimtex.txt
@@ -2086,27 +2086,38 @@ OPTIONS                                                        *vimtex-options*
   Default value: All keys set to |g:vimtex_syntax_conceal_default|.
 
 *g:vimtex_syntax_conceal_cites*
-  A simple dictionary to control how citation conceal should work. It has two
-  keys:
+  A simple dictionary to control how citation conceal should work. It has
+  three keys:
 
     type~
       Specify the type of concealment. There are two options, and the
       difference is best explained by example:
 
         Value       LaTeX             Concealed
         -----       -----             ---------
-        'icon'      `\cite{Knuth1981}`  `📖`
-        'brackets'  `\cite{Knuth1981}`  `[Knuth1981]`
+        `'icon'`      `\cite{Knuth1981}`  `📖`
+        `'brackets'`  `\cite{Knuth1981}`  `[Knuth1981]`
 
     icon~
       Specify an icon for `icon` conceal. This must be a single (possibly
       multibyte) character.
 
+    verbose~
+      Specify how much to conceal in bracket mode (`type` set to `'bracket'`).
+      The following table shows how the concealed result depending on the
+      `'verbose'` value for `\cite[Figure 1]{Knuth1981}`:
+
+        Value    Concealed
+        -----    ---------
+        |v:true|   `[Figure 1][Knuth1981]`
+        |v:false|  `[Knuth1981]`
+
   Default value: >
 
     let g:vimtex_syntax_conceal_cites = {
           \ 'type': 'brackets',
           \ 'icon': '📖',
+          \ 'verbose': v:true,
           \}
 
 *g:vimtex_syntax_nested*

diff --git a/test/test-syntax/test-biblatex.vim b/test/test-syntax/test-biblatex.vim
@@ -2,9 +2,9 @@ source common.vim
 
 highlight Conceal ctermfg=4 ctermbg=7 guibg=NONE guifg=blue
 
-let g:vimtex_syntax_conceal_cites = {
-      \ 'type': 'brackets',
-      \}
+" let g:vimtex_syntax_conceal_cites = {
+"       \ 'type': 'icon',
+"       \}
 
 silent edit test-biblatex.tex