andrewradev / dsf.vim Goto Github PK

Note: Special thanks to @faceleg, who seems to have extracted this plugin from my vimfiles before I did. If you'd like a simpler version of this plugin for whatever reason, feel free to use this one.

The plugin defines a mapping to delete a surrounding function call (or something similar to one), even if it happens to be namespaced. Some examples:

nested(function_call(cursor_here)) #=> nested(cursor_here)
nested(cursor_here(chewy_center))  #=> cursor_here(chewy_center)
One::Two.new([cursor_here])        #=> [cursor_here]
One::Two.new(Hash[cursor_here])    #=> One::Two.new(cursor_here)

SomeStruct{cursor_here: "Something"} //=> cursor_here: "Something"

By pressing dsf (which stands for "delete surrounding function call") with the cursor on cursor_here, you get the result on the right.

The plugin defines csf to "change surrounding function call", which deletes only the function itself and leaves the cursor waiting to enter a new name.

For convenience, the dsnf (the "n" standing for "next") mapping will look for a function call after the cursor to delete:

var result = function_call(foo, bar(baz));
// With the cursor on "foo", pressing dsnf results in:
var result = function_call(foo, baz);

The text objects for if and af manipulate function calls with their contents. Given this example:

var result = function_call(one, two);

Typing daf ("delete a function call") with the cursor anywhere on function_call(one, two) would result in:

var result = ;

Typing dif ("delete inner function call") with the cursor anywhere on function_call(one, two) would result in:

var result = function_call();

To learn more about how text objects work, try :help text-objects.

The plugin also works on multiline function calls, for example:

foo = one(
  two
)

foo = two

The insides of the function will be automatically indented using the = operator to compensate for any potential changes in indentation level.

If you'd like to set your own mappings, instead of using the built-ins, simply set the variable g:dsf_no_mappings to 1 and use the mappings provided by the plugin:

let g:dsf_no_mappings = 1

nmap dsf <Plug>DsfDelete
nmap csf <Plug>DsfChange

nmap dsnf <Plug>DsfNextDelete
nmap csnf <Plug>DsfNextChange

omap af <Plug>DsfTextObjectA
xmap af <Plug>DsfTextObjectA
omap if <Plug>DsfTextObjectI
xmap if <Plug>DsfTextObjectI

Change any of the left-hand sides of the map calls to whatever you'd like, or remove lines to leave them unset.

For additional settings, check the full documentation with :help dsf-settings.

Pull requests are welcome, but take a look at CONTRIBUTING.md first for some guidelines.