https://github.com/saecki/live-rename.nvim

A neovim plugin to live preview lsp renames
https://github.com/saecki/live-rename.nvim

lsp neovim nvim nvim-plugin

Last synced: about 1 month ago
JSON representation

A neovim plugin to live preview lsp renames

• Host: GitHub
• URL: https://github.com/saecki/live-rename.nvim
• Owner: saecki
• Created: 2024-08-11T10:23:22.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-25T21:30:15.000Z (about 2 months ago)
• Last Synced: 2024-09-29T06:02:53.881Z (about 2 months ago)
• Topics: lsp, neovim, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 44.9 KB
• Stars: 46
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# live-rename.nvim

A neovim plugin to live preview lsp renames.

https://github.com/user-attachments/assets/7cc03f60-3c59-45f5-b8e7-e53e324ce56b

## Installation

[__lazy.nvim__](https://github.com/folke/lazy.nvim)

```lua

{ "saecki/live-rename.nvim" }

```

[__vim-plug__](https://github.com/junegunn/vim-plug)

```

Plug 'saecki/live-rename.nvim'

```

## Setup (optional)

```lua

-- default config

require("live-rename").setup({

    -- Send a `textDocument/prepareRename` request to the server to

    -- determine the word to be renamed, can be slow on some servers.

    -- Otherwise fallback to using ``.

    prepare_rename = true,

    --- The timeout for the `textDocument/prepareRename` request and final

    --- `textDocument/rename` request when submitting.

    request_timeout = 1500,

    -- Make an initial `textDocument/rename` request to gather other

    -- occurences which are edited and use these ranges to preview.

    -- If disabled only the word under the cursor will have a preview.

    show_other_ocurrences = true,

    -- Try to infer patterns from the initial `textDocument/rename` request

    -- and use these to show hopefully better edit previews.

    use_patterns = true,

    keys = {

        submit = {

            { "n", "" },

            { "v", "" },

            { "i", "" },

        },

        cancel = {

            { "n", "" },

            { "n", "q" },

        },

    },

    hl = {

        current = "CurSearch",

        others = "Search",

    },

})

```

## Usage

```lua

-- start in normal mode and jump to the start of the word

require("live-rename").rename()

-- start in insert mode and jump to the end of the word

require("live-rename").rename({ insert = true })

-- start in insert mode with an empty word

require("live-rename").rename({ text = "", insert = true })

```

live-rename includes a `map` function to make creating key mappings more ergonomic.  

The options accepted are the same as for `rename`.

```lua

local live_rename = require("live-rename")

-- the following are equivalent

vim.keymap.set("n", "r", live_rename.rename, { desc = "LSP rename" })

vim.keymap.set("n", "r", live_rename.map(), { desc = "LSP rename" })

vim.keymap.set("n", "r", live_rename.map({}), { desc = "LSP rename" })

-- the following are equivalent

vim.keymap.set("n", "R", live_rename.map({ text = "", insert = true }), { desc = "LSP rename" })

vim.keymap.set("n", "R", function() live_rename.rename({ text = "", insert = true }) end, { desc = "LSP rename" })

```