snailed
/
taolf
Archived
2
0
Fork 0
This repository has been archived on 2024-05-03. You can view files and clone it, but cannot push or open issues or pull requests.
taolf/README.md

56 lines
1.8 KiB
Markdown

## taolf
This is a neovim plugin for the [`lf`](https://github.com/gokcehan/lf) file manager.
It's stripped down fork of [`lf.nvim`](https://github.com/lmburns/lf.nvim)
I stripped out the parts of code that overwrite the default toggleterm configurations,
as I find they get in the way more often than not. I also streamlined the installation
process with lazy.nvim a tiny bit.
**NOTE**: This plugin uses [`toggleterm.nvim`](https://github.com/akinsho/toggleterm.nvim).
### Installation
Setup:
```lua
require("taolf").setup({
-- The Command to start lf with.
default_cmd = "lf",
-- The dir to start lf in.
-- "gwd" expands to the git working directory.
-- "fd" expands to the open file's directory.
dir = "",
}
vim.keymap.set("n", "<Leader>el", function() require("lf").start() end,
{ desc = "Open Lf" })
vim.keymap.set("n", "<Leader>ec", function() require("lf").start({ dir = "fd"}) end,
{ desc = "Open Lf in directory of open file" })
vim.keymap.set("n", "<Leader>eg", function() require("lf").start({ dir = "gwd" }) end,
{ desc = "Open Lf in git working directory" })
```
lazy.nvim setup:
```lua
{
"ssnailed/taolf",
event = "VeryLazy",
opts = {
-- The Command to start lf with
default_cmd = "lf",
-- The path to start lf in.
-- "gwd" expands to the git working directory
-- "fd" expands to the open file's directory
dir = "",
},
dependencies = { "akinsho/toggleterm.nvim" },
keys = {
{ "<Leader>el", function() require("taolf").start() end, desc = "Open Lf" },
{ "<Leader>ec", function() require("taolf").start({ dir = "fd" }) end, desc = "Open Lf in directory of open file" },
{ "<Leader>eg", function() require("taolf").start({ dir = "gwd" }) end, desc = "Open Lf in git working directory" },
}
}
```