FlintyLemming/bookmarks.yazi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1 from sxyazi/pr-fedfab59

Browse Source 
refactor: use `ya.sync` to simplify the code
This commit is contained in:
Diogo Duarte
2024-02-10 07:30:23 +00:00
committed by GitHub
parent 5f60cdad32 f60922ed1d
commit 6de87454d7
2 changed files with 53 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -1,35 +1,44 @@
# Bookmarks.yazi # bookmarks.yazi
A [Yazi](https://github.com/sxyazi/yazi) plugin that adds the basic functionality of [vi-like marks](https://neovim.io/doc/user/motion.html#mark-motions). A [Yazi](https://github.com/sxyazi/yazi) plugin that adds the basic functionality of [vi-like marks](https://neovim.io/doc/user/motion.html#mark-motions).
> [!NOTE]
> The latest main branch of Yazi is required at the moment.
https://github.com/dedukun/bookmarks.yazi/assets/25795432/9a9fe345-dd06-442e-99f1-8475ab22fad5 https://github.com/dedukun/bookmarks.yazi/assets/25795432/9a9fe345-dd06-442e-99f1-8475ab22fad5
## Installation
```sh
# Linux/macOS
git clone https://github.com/dedukun/bookmarks.yazi.git ~/.config/yazi/plugins/bookmarks.yazi
# Windows
git clone https://github.com/dedukun/bookmarks.yazi.git %AppData%\yazi\config\plugins\bookmarks.yazi
```
## Usage ## Usage
Add this to your `keymap.toml`:
```toml ```toml
[[manager.prepend_keymap]] [[manager.prepend_keymap]]
on = [ "m" ] on = [ "m" ]
exec = "plugin bookmarks --sync --args='set'" exec = "plugin bookmarks --args=save"
desc = "Set a bookmark" desc = "Save current position as a bookmark"
```
```toml
[[manager.prepend_keymap]] [[manager.prepend_keymap]]
on = [ "'" ] on = [ "'" ]
exec = "plugin bookmarks --sync --args='jump'" exec = "plugin bookmarks --args=jump"
desc = "Jump to a bookmark" desc = "Jump to a bookmark"
```
```toml
[[manager.prepend_keymap]] [[manager.prepend_keymap]]
on = [ "b", "d" ] on = [ "b", "d" ]
exec = "plugin bookmarks --sync --args='delete'" exec = "plugin bookmarks --args=delete"
desc = "Jump to a bookmark" desc = "Delete a bookmark"
```
```toml
[[manager.prepend_keymap]] [[manager.prepend_keymap]]
on = [ "b", "D" ] on = [ "b", "D" ]
exec = "plugin bookmarks --sync --args='deleteall'" exec = "plugin bookmarks --args=delete_all"
desc = "Jump to a bookmark" desc = "Delete all bookmarks"
``` ```

118
init.lua
View File

@@ -14,41 +14,20 @@ local SUPPORTED_KEYS = {
{ on = "u"}, { on = "v"}, { on = "w"}, { on = "x"}, { on = "y"}, { on = "z"}, { on = "u"}, { on = "v"}, { on = "w"}, { on = "x"}, { on = "y"}, { on = "z"},
} }
local function save_bookmark(idx) local save_bookmark = ya.sync(function(idx)
if idx == -1 then
return
end
local folder = Folder:by_kind(Folder.CURRENT)
local key = SUPPORTED_KEYS[idx].on
state.bookmarks = state.bookmarks or {} state.bookmarks = state.bookmarks or {}
state.bookmarks[key] = { cursor = folder.cursor, path = tostring(folder.cwd) } state.bookmarks[#state.bookmarks + 1] = {
end on = SUPPORTED_KEYS[idx].on,
desc = tostring(folder.cwd),
cursor = Folder:by_kind(Folder.CURRENT).cursor,
}
end)
local function jump_to_bookmark(bookmark) local all_bookmarks = ya.sync(function() return state.bookmarks or {} end)
state.bookmarks = state.bookmarks or {}
local selected_bookmark = state.bookmarks[bookmark] local delete_bookmark = ya.sync(function(idx) table.remove(state.bookmarks, idx) end)
ya.manager_emit("cd", { selected_bookmark.path }) local delete_all_bookmarks = ya.sync(function() state.bookmarks = nil end)
ya.manager_emit("arrow", { -99999999 })
ya.manager_emit("arrow", { selected_bookmark.cursor })
end
local function delete_bookmark(bookmark)
state.bookmarks = state.bookmarks or {}
state.bookmarks[bookmark] = nil
end
local function delete_all_bookmarks()
state.bookmarks = nil
end
local function next(sync, args)
ya.manager_emit("plugin", { "bookmarks", sync = sync, args = table.concat(args, " ") })
end
return { return {
entry = function(_, args) entry = function(_, args)
@@ -57,67 +36,30 @@ return {
return return
end end
if action == "set" then if action == "save" then
local key = args[2] local key = ya.which { cands = SUPPORTED_KEYS, silent = true }
if not key then if key then
next(false, { "_set" }) save_bookmark(key)
else
save_bookmark(tonumber(key))
end end
elseif action == "_set" then return
local key = ya.which({ end
cands = SUPPORTED_KEYS,
silent = true,
})
if not key then if action == "delete_all" then
-- selection was cancelled return delete_all_bookmarks()
return end
end
next(true, { "set", key }) local bookmarks = all_bookmarks()
elseif action == "jump" or action == "delete" then local selected = #bookmarks > 0 and ya.which { cands = bookmarks }
local bookmark = args[2] if not selected then
if not bookmark then return
-- tried to use ya.sync but was unsuccessful, doing this way for the moment end
if state.bookmarks then
local arguments = { "_" .. action }
for k, _ in pairs(state.bookmarks) do
table.insert(arguments, k)
table.insert(arguments, state.bookmarks[k].path)
end
next(false, arguments)
end
else
if action == "jump" then
jump_to_bookmark(bookmark)
elseif action == "delete" then
delete_bookmark(bookmark)
end
end
elseif action == "_jump" or action == "_delete" then
if #args == 1 then
-- Should never enter here, but just to be safe
return
end
local marked_keys = {} if action == "jump" then
for i = 2, #args, 2 do ya.manager_emit("cd", { bookmarks[selected].desc })
table.insert(marked_keys, { on = args[i], desc = args[i + 1] }) ya.manager_emit("arrow", { -99999999 })
end ya.manager_emit("arrow", { bookmarks[selected].cursor })
elseif action == "delete" then
local selected_bookmark = ya.which({ delete_bookmark(selected)
cands = marked_keys,
})
if not selected_bookmark then
-- selection was cancelled
return
end
next(true, { string.sub(action, 2), marked_keys[selected_bookmark].on })
elseif action == "deleteall" then
delete_all_bookmarks()
end end
end, end,
} }