Commentary gc + matchup a% about vim-matchup HOT 8 CLOSED

I see that the word return is also a target for a%. Using gc1a% works.

from vim-matchup.

However, given your example:

if condition
 █call one()
  call two()
endif

pressing di% will produce

if condition
endif

Should this work similar to vimscript functions for gc1i%?

from vim-matchup.

Glad the first issue was resolved :) I've debated whether this should be configurable with an option.

[Edit] Ah I see what you mean now, gci% comments too much?

" if condition
"  █call one()
"   call two()
endif

from vim-matchup.

I think the solution is

let g:matchup_text_obj_linewise_operators += [ 'g@' ]

can you confirm?

from vim-matchup.

No, I cannot confirm. Sorry for not adding an example for what I meant. But you already figured it out. Yes, I would expect that the if condition would not be commented. Consider the vimscript function from above as a second example

function! s:test()

    let l:str = "hello"

    return l:str

endfunction

Place the cursor on the line with let ... and press gc1i%, I get

" function! s:test()

"     let l:str = "hello"

"     return l:str

endfunction

I would expect

function! s:test()

"     let l:str = "hello"

"     return l:str

endfunction

Using 1i% for a visual selection shows that match-up works characterwise and just omits the matchword function:

Well, this looks intended. I am not sure how to resolve this. Maybe enforcing linewise mode could be used and the i% object does NOT include lines with match words when in linewise mode.

from vim-matchup.

Strange.. I cannot reproduce it with the following vimrc:

set nocompatible

" load match-up (and commentary)
for s:loc in ['bundle', 'plugged']
    let &rtp  = '~/.vim/'.s:loc.'/vim-matchup,' . &rtp
    let &rtp .= ',~/.vim/'.s:loc.'/vim-matchup/after'
    let &rtp  = '~/.vim/'.s:loc.'/vim-commentary,' . &rtp
    let &rtp .= ',~/.vim/'.s:loc.'/vim-commentary/after'
endfor

filetype plugin indent on
syntax enable

" match-up options go here
let g:matchup_text_obj_linewise_operators = ['d', 'y', 'g@', ':']

However, I think using : for visual mode is unintuitive, so I added the following enhancement:

function! IsCommentaryOpFunc()
    return &operatorfunc ==? matchstr(maparg('<Plug>Commentary', 'n'),
            \ '\cset op\%(erator\)\?func=\zs.\{-\}\ze<cr>')
endfunction

let g:matchup_text_obj_linewise_operators = ['d', 'y',
    \ 'g@,IsCommentaryOpFunc()', 'V']

Now you can specify exactly which visual modes and which operatorfuncs (a bit complicated to determine) you want to act line-wise.

from vim-matchup.

Now, it works with

let g:matchup_text_obj_linewise_operators = ['d', 'y', 'g@', ':']

or your enhancement.

Can adding g@ and : to linewise operators have side effects?

from vim-matchup.

Can adding g@ and : to linewise operators have side effects?

1. If you add g@, then any plugin which uses operatorfunc will be line-wise, which might be undesirable. That's why I added the syntax g@,execute-string, so you can check what opfunc is. If you don't care or don't use any other plugins, it won't matter.

2. I don't think adding : (or v, V, and <c-v>) will have any side-effects but I'm not completely sure. Note, this option only applies to the i% text-object, so the effect should be limited.

from vim-matchup.