Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/echasnovski/mini.splitjoin

Neovim Lua plugin to split and join arguments. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.splitjoin

lua mini-nvim neovim neovim-plugin

Last synced: 2 months ago
JSON representation

Neovim Lua plugin to split and join arguments. Part of 'mini.nvim' library.

Host: GitHub
URL: https://github.com/echasnovski/mini.splitjoin
Owner: echasnovski
License: mit
Created: 2023-03-09T08:56:27.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-06-23T13:38:52.000Z (7 months ago)
Last Synced: 2024-06-24T01:42:19.158Z (7 months ago)
Topics: lua, mini-nvim, neovim, neovim-plugin
Language: Lua
Homepage:
Size: 38.1 KB
Stars: 35
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)

### Split and join arguments

See more details in [Features](#features) and [help file](doc/mini-splitjoin.txt).

---

⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-splitjoin.md) if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See the repository page to learn about common design principles and configuration recipes.

---

If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

## Demo

https://user-images.githubusercontent.com/24854248/223969793-e0e461ff-5a98-444f-9bc3-7b490ebfe59e.mp4

## Features

- Mappings and Lua functions that modify arguments (regions inside brackets between allowed separators) under cursor.

Supported actions:
- Toggle - split if arguments are on single line, join otherwise. Main supported function of the module. See `MiniSplitjoin.toggle()` in help file.
- Split - make every argument separator be on end of separate line. See `MiniSplitjoin.split()` in help file.
- Join - make all arguments be on single line. See `MiniSplitjoin.join()` in help file.

- Mappings are dot-repeatable in Normal mode and work in Visual mode.

- Customizable argument detection (see `MiniSplitjoin.config.detect` in help file):
- Which brackets can contain arguments.
- Which strings can separate arguments.
- Which regions exclude when looking for separators (like inside nested brackets or quotes).

- Customizable pre and post hooks for both split and join. See `split` and `join` of `MiniSplitjoin.config` in help file.

- Works inside comments by using modified notion of indent. See `MiniSplitjoin.get_indent_part()` in help file.

- Provides low-level Lua functions for split and join at positions. See `MiniSplitjoin.split_at()` and `MiniSplitjoin.join_at()` in help file.

Notes:
- Search for arguments is done using Lua patterns (regex-like approach). Certain amount of false positives is to be expected.

- This module is mostly designed around `MiniSplitjoin.toggle()`. If initial split positions are on different lines, join first and then split.

- Actions can be done on Visual mode selection, which mostly present as a safety route in case of incorrect detection of initial region. It uses `MiniSplitjoin.get_visual_region()` which treats selection as full brackets (use `va)` and not `vi)`).

## Installation

This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.

There are two branches to install from:

- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.

Here are code snippets for some common installation methods (use only one):

With mini.deps

Github repo
Branch Code snippet

'mini.nvim' library Main Follow recommended 'mini.deps' installation

Stable

Standalone plugin Main add('echasnovski/mini.splitjoin')

Stable add({ source = 'echasnovski/mini.splitjoin', checkout = 'stable' })

With folke/lazy.nvim

Github repo
Branch Code snippet

'mini.nvim' library
Main { 'echasnovski/mini.nvim', version = false },

Stable { 'echasnovski/mini.nvim', version = '*' },

Standalone plugin
Main { 'echasnovski/mini.splitjoin', version = false },

Stable { 'echasnovski/mini.splitjoin', version = '*' },

With junegunn/vim-plug

Github repo
Branch Code snippet

'mini.nvim' library
Main Plug 'echasnovski/mini.nvim'

Stable Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }

Standalone plugin Main Plug 'echasnovski/mini.splitjoin'

Stable Plug 'echasnovski/mini.splitjoin', { 'branch': 'stable' }

**Important**: don't forget to call `require('mini.splitjoin').setup()` to enable its functionality.

**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following:
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
- Install plugin in other place with shorter path.

## Default config

```lua
-- No need to copy this inside `setup()`. Will be used automatically.
{
-- Module mappings. Use `''` (empty string) to disable one.
-- Created for both Normal and Visual modes.
mappings = {
toggle = 'gS',
split = '',
join = '',
},

-- Detection options: where split/join should be done
detect = {
-- Array of Lua patterns to detect region with arguments.
-- Default: { '%b()', '%b[]', '%b{}' }
brackets = nil,

-- String Lua pattern defining argument separator
separator = ',',

-- Array of Lua patterns for sub-regions to exclude separators from.
-- Enables correct detection in presence of nested brackets and quotes.
-- Default: { '%b()', '%b[]', '%b{}', '%b""', "%b''" }
exclude_regions = nil,
},

-- Split options
split = {
hooks_pre = {},
hooks_post = {},
},

-- Join options
join = {
hooks_pre = {},
hooks_post = {},
},
}
```

## Similar plugins

- [FooSoft/vim-argwrap](https://github.com/FooSoft/vim-argwrap)
- [AndrewRadev/splitjoin.vim](https://github.com/AndrewRadev/splitjoin.vim)
- [Wansmer/treesj](https://github.com/Wansmer/treesj)