63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
|
## Lf.nvim
|
||
|
|
|
||
|
|
This is a neovim plugin for the [`lf`](https://github.com/gokcehan/lf) file manager.
|
||
|
|
It is very similar to [`lf.vim`](https://github.com/ptzz/lf.vim), except for that this is written in Lua.
|
||
|
|
|
||
|
|
**NOTE**: This plugin uses [`toggleterm.nvim`](https://github.com/akinsho/toggleterm.nvim) and [`plenary.nvim`](https://github.com/nvim-lua/plenary.nvim)
|
||
|
|
|
||
|
|
### Setup/Configuration
|
||
|
|
|
||
|
|
```lua
|
||
|
|
local M = {}
|
||
|
|
|
||
|
|
-- Defaults
|
||
|
|
local lf = require("lf").setup({
|
||
|
|
default_cmd = "lf", -- default `lf` command
|
||
|
|
default_action = "edit", -- default action when `Lf` opens a file
|
||
|
|
default_actions = { -- default action keybindings
|
||
|
|
["<C-t>"] = "tabedit",
|
||
|
|
["<C-x>"] = "split",
|
||
|
|
["<C-v>"] = "vsplit",
|
||
|
|
["<C-o>"] = "tab drop",
|
||
|
|
},
|
||
|
|
|
||
|
|
winblend = 10, -- psuedotransparency level
|
||
|
|
dir = "", -- directory where `lf` starts ('gwd' is git-working-directory)
|
||
|
|
direction = "float", -- window type: float horizontal vertical
|
||
|
|
border = "double", -- border kind: single double shadow curved
|
||
|
|
height = 0.80, -- height of the *floating* window
|
||
|
|
width = 0.85, -- width of the *floating* window
|
||
|
|
})
|
||
|
|
|
||
|
|
function M.start_lf()
|
||
|
|
lf:start()
|
||
|
|
end
|
||
|
|
|
||
|
|
vim.api.nvim_set_keymap("n", "<mapping>", "<cmd>lua require('file').start_lf()", { noremap = true })
|
||
|
|
-- or
|
||
|
|
vim.api.nvim_set_keymap("n", "<mapping>", "<cmd>lua require('lf').setup():start()", { noremap = true })
|
||
|
|
|
||
|
|
return M
|
||
|
|
```
|
||
|
|
|
||
|
|
There is a command that does basically the exact same thing `:Lf`. This command takes one optional argument,
|
||
|
|
which is a directory for `lf` to start in.
|
||
|
|
|
||
|
|
### Default Actions
|
||
|
|
The goal is to allow for these keybindings to be hijacked by `Lf` and make them execute the command
|
||
|
|
as soon as the keybinding is pressed; however, I am unsure of a way to do this at the moment. If `lf` had a more
|
||
|
|
programmable API that was similar to `ranger`'s, then something like [`rnvimr`](https://github.com/kevinhwang91/rnvimr)
|
||
|
|
would be possible, which allows this.
|
||
|
|
|
||
|
|
For the moment, these bindings are hijacked on the startup of `Lf`, and when they are pressed, a notification is sent
|
||
|
|
that your default action has changed. When you go to open a file as you normally would, this command is ran instead
|
||
|
|
of your `default_action`.
|
||
|
|
|
||
|
|
### Replacing Netrw
|
||
|
|
The only configurable environment variable is `g:lf_replace_netrw`, which can be set to `1` to replace `netrw`
|
||
|
|
|
||
|
|
### TODO
|
||
|
|
- `:LfToggle` command
|
||
|
|
- Find a way for `lf` to hijack keybindings
|
||
|
|
- Allow keybindings to cycle through various sizes of the terminal (similar to `rnvimr`)
|