Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niuiic/track.nvim
Neovim plugin to track the thought process of reading source code.
https://github.com/niuiic/track.nvim
mark neovim plugin
Last synced: 1 day ago
JSON representation
Neovim plugin to track the thought process of reading source code.
- Host: GitHub
- URL: https://github.com/niuiic/track.nvim
- Owner: niuiic
- License: mit
- Created: 2024-05-10T06:41:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T13:18:53.000Z (9 days ago)
- Last Synced: 2024-10-26T17:02:28.366Z (8 days ago)
- Topics: mark, neovim, plugin
- Language: Lua
- Homepage:
- Size: 57.6 KB
- Stars: 23
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - niuiic/track.nvim - Enhanced mark with description. Track the thought process of reading source code. (Marks / PHP)
README
# track.nvim
- Enhanced mark with description.
- Track the thought process of analyzing code.
[More neovim plugins](https://github.com/niuiic/awesome-neovim-plugins)
## Features
- flow
- multiple flows
- multiple marks in different flows on same line
- outline
- list flows and marks
- filter with flow
- move mark/flow up/down
- navigate to mark
- preview mark
- edit mark/flow
- delete mark/flow
- highlight current marks
- mark
- decorate
- edit text
- delete
- batch delete
- store/restore
## Usage
- showcase
- available functions
```mermaid
classDiagram
class App {
%% config
+setup(config: Config)
%% enable
+is_enabled(bufnr: number, winnr: number) boolean
%% outline
+open_outline(show_all?: boolean)
+close_outline()
+is_outline_open() boolean
%% flow
+add_flow()
+delete_flow()
+update_flow()
%% mark
+add_mark()
+delete_mark()
+delete_marks(delete_all?: string)
+update_mark(set_default?: boolean)
+store_marks(file_path: string)
+restore_marks(file_path: string)
+notify_file_path_change(old: string, new: string | nil)
+notify_dir_path_change(old: string, new: string | nil)
+notify_file_change(file_path: string)
+decorate_marks_on_file(file_path: string)
+navigate_to_outline()
+highlight_cursor_marks_on_outline(file_path: string, lnum: number)
}
```
- update marks when file change
Line number of mark would be updated when buffer saved by default.
```lua
vim.api.nvim_create_autocmd("BufWritePost", {
callback = function(args)
if require("track").is_enabled(args.buf, vim.api.nvim_get_current_win()) then
local file_path = vim.api.nvim_buf_get_name(args.buf)
require("track").notify_file_change(file_path)
end
end,
})
```
It's recommended to update marks when file/dir renamed/moved/deleted. Take `nvim-tree.lua` for example.
```lua
local api = require("nvim-tree.api")
local opts = function(desc)
return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
end
local cut_files = {}
local cut_dirs = {}
vim.keymap.set("n", "p", function()
local node = api.tree.get_node_under_cursor()
api.fs.paste()
for _, path in ipairs(cut_files) do
require("track").notify_file_path_change(
path[1],
node.type == "file" and node.parent.absolute_path or node.absolute_path .. "/" .. path[2]
)
end
for _, path in ipairs(cut_dirs) do
require("track").notify_dir_path_change(
path[1],
node.type == "file" and node.parent.absolute_path or node.absolute_path .. "/" .. path[2]
)
end
cut_files = {}
cut_dirs = {}
end, opts("paste"))
vim.keymap.set("n", "r", function()
local node = api.tree.get_node_under_cursor()
local old = node.absolute_path
api.fs.rename()
local new = api.tree.get_node_under_cursor().absolute_path
if node.type == "file" then
require("track").notify_file_path_change(old, new)
else
require("track").notify_dir_path_change(old, new)
end
end, opts("rename"))
vim.keymap.set("n", "d", function()
local node = api.tree.get_node_under_cursor()
local target_buf = vim.iter(vim.api.nvim_list_bufs()):find(function(x)
return string.find(vim.api.nvim_buf_get_name(x), node.absolute_path, 1, true) ~= nil
end)
if target_buf then
require("mini.bufremove").delete(target_buf)
end
api.fs.remove()
if node.type == "file" then
require("track").notify_file_path_change(node.absolute_path)
else
require("track").notify_dir_path_change(node.absolute_path)
end
end, opts("remove"))
vim.keymap.set("n", "x", function()
local node = api.tree.get_node_under_cursor()
api.fs.cut()
if node.type == "file" then
table.insert(
cut_files,
{ node.absolute_path, string.match(node.absolute_path, node.parent.absolute_path .. "/(.*)") }
)
else
table.insert(
cut_dirs,
{ node.absolute_path, string.match(node.absolute_path, node.parent.absolute_path .. "/(.*)") }
)
end
end, opts("cut"))
```
- store/restore marks
You may need a session plugin for storing/restoring marks. Check [niuiic/multiple-session.nvim](https://github.com/niuiic/multiple-session.nvim).
- preview mark
If there is no highlight on your preview window, try to set filetype.
```lua
vim.filetype.add({
extension = {
ts = "typescript",
},
})
```
## Config
- default config
```lua
local screen_w = vim.opt.columns:get()
local screen_h = vim.opt.lines:get() - vim.opt.cmdheight:get()
local preview_win_width = math.floor(screen_w * 0.6)
local preview_win_height = math.floor(screen_h * 0.6)
local default_config = {
is_enabled = function()
return true
end,
mark = {
mark_hl_group = "WarningMsg",
mark_icon = "",
sign_priority = 10,
get_root_dir = function()
return vim.fs.root(0, ".git") or vim.fn.getcwd()
end,
},
outline = {
flow_hl_group = "FloatBorder",
mark_hl_group = "WarningMsg",
win_pos = "left",
win_size = 30,
preview_win_width = preview_win_width,
preview_win_height = preview_win_height,
preview_on_hover = true,
cursor_line_hl_group = "CursorLine",
set_default_when_update = false,
keymap_navigate_to_mark = "",
keymap_move_up = "",
keymap_move_down = "",
keymap_delete = "d",
keymap_update = "e",
keymap_preview_mark = "p",
keymap_close_preview_win = "q",
get_mark_line_text = function(_, _, text)
local space, content = string.match(text, "([%s]*)(.*)")
return space .. "- " .. content
end,
select_window = function() end,
},
}
```
- config type
```mermaid
classDiagram
Config --* OutlineConfig
Config --* MarkConfig
class Config {
+outline: OutlineConfig
+mark: MarkConfig
+is_enabled(bufnr: number, winnr: number) boolean
}
class OutlineConfig {
+flow_hl_group: string
+mark_hl_group: string
+win_pos: 'left' | 'right' | 'top' | 'bottom'
+win_size: number
+preview_win_width: number
+preview_win_height: number
+cursor_line_hl_group: string
+preview_on_hover: boolean
+set_default_when_update: boolean
+keymap_move_up: string
+keymap_move_down: string
+keymap_delete: string
+keymap_update: string
+keymap_navigate_to_mark: string
+keymap_preview_mark: string
+keymap_close_preview_win: string
+get_mark_line_text(file_path: string, lnum: string, text: string) string
+select_window(fn: (winnr: number) => void)
}
class MarkConfig {
+mark_hl_group: string
+mark_icon: string
+get_root_dir: () => string | nil
+sign_priority: number
}
```