GitHub

您所在的位置：网站首页 › codeqf1 › GitHub

GitHub

#GitHub| 来源: 网络整理| 查看: 265

muren.nvim

Neovim plugin for doing multiple search and replace with ease.

⚠️ This plugins is in its early days so feel free to open issues if you stumble on issues, have ideas or are missing some things to configure.

What does this plugin do

Sometimes you may want to do some number of search-and-replacements that follow a certain structure. Lets say you have some variables named a_0, a_1 and a_2 but you instead want to rename them to x, y and z. Using builtin methods there are a few ways to do that (and maybe more which I don't know):

Do the replacements one by one manually. Do the first replacement and then edit the command in the command-line window (q:). Come up with some complex regex.

All of which I find somewhat cumbersome.

With muren ui, you get two buffers where you can enter a sequence of patterns in the left one (one per line) in the right buffer enter the replacements in the corresponding row. For example it would look something like:

a_0 | x a_1 | y a_2 | z

where you can use all your vim-skills to populate the buffers (eg , etc etc).

See examples below for some screencasts of how this looks like with muren.

Features Define and apply multiple replacements. Toggle between simple and 2-step replacements (eg to swap names), see showcases. Interactively changes options, including which buffer to apply to. Preview changes. Keep patterns and options when toggling ui. Installation

Use your favorite plugin manager, eg with lazy.nvim:

{ 'AckslD/muren.nvim', config = true, }

❗ requires nvim 0.9.

Usage

By default the following commands are created:

MurenToggle: Toggle the UI. MurenOpen: Open the UI. MurenClose: Open the UI. MurenFresh: Open the UI fresh, ie reset all settings and buffers. MurenUnique: Open the UI populating the patterns with all unique matches of the last search. See examples below for why this can be very powerful.

The UI uses the following normal mode keymaps (buffer local):

q: Quit UI. : Swap between patterns and replacements pane. : Swap between patterns/replacements and options pane. : Apply replacements (only in patterns or replacements pane). : Toggle/pick options (only in options pane).

See below for how to configure there.

Pass create_commands = false to require('muren').setup to not create them.

You can also access this using lua as the following functions:

require('muren.api').toggle_ui require('muren.api').open_ui require('muren.api').close_ui require('muren.api').open_fresh_ui require('muren.api').open_unique_ui Configuration

Pass settings to require('muren').setup. The current defaults are:

{ -- general create_commands = true, -- default togglable options two_step = false, all_on_line = true, preview = true, -- keymaps keys = { close = 'q', toggle_side = '', toggle_options_focus = '', toggle_option_under_cursor = '', do_replace = '', }, -- ui sizes patterns_width = 30, patterns_height = 10, options_width = 15, preview_height = 12, -- options order in ui order = { 'buffer', 'two_step', 'all_on_line', 'preview', }, -- highlights used for options ui hl = { options = { on = '@string', off = '@variable.builtin', }, }, } Showcase Basic usage

Basic usage replacing variables a_0, a_1 and a_2 to x, y and z:

muren_basic.mp4 Swapping things

Using non-recursive (2-step) replacements one can swap variables with ease since they are first replaced to temporary placeholders. Toggle the option (see below) to see the difference.

muren_swap.mp4 Pick options interactively

You can change some options interactively while previewing your changes in the UI.

muren_options.mp4

Note in particular how things change in the preview.

Populate with unique previuous search matches

:MurenUnique might initially seem like a random command but something I find very useful. What it does is it finds all the matches of your last search and populates the unique set of these in the patterns pane of the UI. You can them replace all of them in some way but importantly you can do this differently for each unique match.

muren_unique.mp4 Regexes

There is full support for builtin regex patterns. However this won't work then the two_step option is enabled:

muren_regex.mp4 TODO Store history of batches replacements and have a telescope picker to chose between them, previewing the list of patterns and replacements. Possibly calculate the preview asynchronously in case it makes the UI sluggish? Support replacements in CWD instead of single buffer. Apply filetype highlights in preview buffer? Etymology

Here are two explanations for the name of the plugin, choose the one you like the most:

muren stands for "MUltiple REplacements in Neovim". muren is the swedish word for "the wall" and refers to the border between the patterns-buffer and the replacements-buffer.

【本文地址】

GitHub

GitHub

今日新闻

推荐新闻