Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomiis4/BufEx.nvim
A plugin for effortless buffer sharing between nvim sessions.
https://github.com/tomiis4/BufEx.nvim
Last synced: about 2 months ago
JSON representation
A plugin for effortless buffer sharing between nvim sessions.
- Host: GitHub
- URL: https://github.com/tomiis4/BufEx.nvim
- Owner: tomiis4
- License: apache-2.0
- Created: 2023-07-11T17:16:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-25T19:10:33.000Z (2 months ago)
- Last Synced: 2024-07-25T22:09:42.537Z (2 months ago)
- Language: Lua
- Size: 91.8 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Buffer Exchange
A plugin for effortless buffer sharing between nvim sessions.
Colorscheme: dogrun; Font: Hurmit NerdFont Mono
## Usage Local
1. send buffer
- open BufEx menu
- select "Send Buffer" window (press `n` to switch between windows)
- select buffer which you want to send and toggle options
-
preview
2. select buffer
- open BufEx menu
- press enter on buffer which you want open
-
preview
## Usage Global
1. host server
- create or select TCP [server](https://github.com/tomiis4/BufEx.nvim/tree/main/servers) and host it
- in configuration change `port`, `host` and `local_server`
- follow instructions from [Usage Local](#usage-local)
## Available transfer servers
- Lua (build-in)
- TypeScript
- GoLang
## Installation
Using vim-plug
```vim
Plug 'tomiis4/BufEx.nvim'
```
Using packer
```lua
use 'tomiis4/BufEx.nvim'
```
Using lazy
```lua
{
'tomiis4/BufEx.nvim',
dependencies = {
'nvim-tree/nvim-web-devicons', -- optional
},
lazy = true,
config = function()
require('bufex').setup({
-- config
})
end
},
```
## Setup
```lua
require('bufex').setup()
```
Default configuration
```lua
require('hypersonic').setup({
transfer = {
---@type string|nil nil = name will be random selected
name = nil,
---@type string|nil password will need to be entered each time
password = nil,
opts = {
allow_edit = true,
allow_save = false, -- NOTE: WIP
---@type 'always'|'never'
need_password = 'always',
server = {
local_server = true,
port = 4200,
host = '127.0.0.1',
}
}
},
float = {
---@type 'none'|'single'|'double'|'rounded'|'solid'|'shadow'|table
border = 'rounded',
---@type number background blur: 0-100
winblend = 0,
---@type boolean allow nvim-web-devicons
icons = true,
keymap = {
next_window = 'n',
quit = 'q',
opts = {
toggle_save = 'S',
toggle_edit = 'E',
toggle_password = 'P',
continue = 'C',
}
}
}
})
```
## Create own transfer server
- create
- TCP server
- variable
- `array[array[got_data, client_id]]`
- got message `GET`
- send all `got_data` from variable joined by `,` and all wrapped in `{}`
- TS example: `'{' + variable.map((buf) => buf[0]).join(',') + '}'`
- other message
- to variable push `[got_data, client_id]`, client\_id can be anything unique
- user disconected (optional)
- delte from variable array with client\_id
## File order
```
| 📄 LICENSE
| 📄 README.md
|
+-- 📁 lua
| \-- 📁 bufex
| | 📄 config.lua
| | 📄 data.lua
| | 📄 init.lua
| | 📄 utils.lua
| |
| +-- 📁 local
| | 📄 client.lua
| | 📄 local.lua
| | 📄 server.lua
| |
| \-- 📁 ui
| 📄 float.lua
| 📄 input.lua
| 📄 select.lua
|
\-- 📁 plugin
| 📄 bufex.lua
|
\-- 📁 servers
| 📄 ts/main.ts
| 📄 go/main.go
```
## Contributors
