refactor: restructure the whole plugin following a better separation of concers

This commit is contained in:
NicolasGB
2025-11-23 16:34:42 +01:00
committed by Nicolas GB
parent f6982a7716
commit e545d02ceb
11 changed files with 1237 additions and 1175 deletions
+10 -333
View File
@@ -1,55 +1,13 @@
local runner = require("jj.core.runner")
--- @class jj.utils
--- @field highlights jj.utils.highlights Highlight configuration
---@class jj.utils.highlights
---@field added table Highlight settings for added lines
---@field modified table Highlight settings for modified lines
---@field deleted table Highlight settings for deleted lines
---@field renamed table Highlight settings for renamed lines
local M = {
executable_cache = {},
dependency_cache = {},
highlights_initialized = false,
highlights = {
added = { fg = "#3fb950", ctermfg = "Green" },
modified = { fg = "#56d4dd", ctermfg = "Cyan" },
deleted = { fg = "#f85149", ctermfg = "Red" },
renamed = { fg = "#d29922", ctermfg = "Yellow" },
},
}
-- Initialize highlight groups once
local function init_highlights()
if M.highlights_initialized then
return
end
vim.api.nvim_set_hl(0, "JJComment", { link = "Comment" })
vim.api.nvim_set_hl(0, "JJAdded", M.highlights.added)
vim.api.nvim_set_hl(0, "JJModified", M.highlights.modified)
vim.api.nvim_set_hl(0, "JJDeleted", M.highlights.deleted)
vim.api.nvim_set_hl(0, "JJRenamed", M.highlights.renamed)
M.highlights_initialized = true
end
--- Setup function to configure highlights and other options
---@param opts? jj.utils Configuration options
function M.setup(opts)
opts = opts or {}
-- Merge user highlights with defaults
if opts.highlights then
M.highlights = vim.tbl_deep_extend("force", M.highlights, opts.highlights)
end
-- Reset highlights flag to force re-initialization with new highlights
if M.highlights_initialized then
M.highlights_initialized = false
init_highlights()
end
end
-- No-op setup, but keep it for API consistency in case we need it later.
function M.setup(_) end
--- Cache for executable checks to avoid repeated system calls
@@ -98,39 +56,6 @@ function M.ensure_jj()
return true
end
--- Execute a system command and return output with error handling
--- @param cmd string The command to execute
--- @param error_prefix string|nil Optional error message prefix
--- @param input string|nil Optional input to pass to stdin
--- @param silent boolean|nil Optional to silent the notification
--- @return string|nil output The command output, or nil if failed
--- @return boolean success Whether the command succeeded
function M.execute_command(cmd, error_prefix, input, silent)
local output
if input then
output = vim.fn.system(cmd, input)
else
output = vim.fn.system(cmd)
end
local success = vim.v.shell_error == 0
if not success then
local error_message
if error_prefix then
error_message = string.format("%s: %s", error_prefix, output)
else
error_message = output
end
if not silent then
M.notify(error_message, vim.log.levels.ERROR)
end
return nil, false
end
return output, success
end
--- Check if we're in a jj repository
--- @return boolean True if in jj repo, false otherwise
function M.is_jj_repo()
@@ -138,7 +63,8 @@ function M.is_jj_repo()
return false
end
local _, success = M.execute_command("jj status")
-- We require the runner here to avoid a circular dependency loop at startup
local _, success = runner.execute_command("jj status")
return success
end
@@ -149,42 +75,14 @@ function M.get_jj_root()
return nil
end
local output, success = M.execute_command("jj root")
-- We require the runner here to avoid a circular dependency loop at startup
local output, success = runner.execute_command("jj root")
if success and output then
return vim.trim(output)
end
return nil
end
--- Get a list of files with their status in the current jj repository.
--- @return table[] A list of tables with {status = string, file = string}
function M.get_status_files(revset)
if not M.ensure_jj() then
return {}
end
if revset == nil then
revset = "@"
end
cmd = "jj log -r " .. revset .. " --no-graph -T 'self.diff().summary()'"
local result, success = M.execute_command(cmd, "Error getting status")
if not success or not result then
return {}
end
local files = {}
-- Parse jj status output: "M filename", "A filename", "D filename", "R old => new"
for line in result:gmatch("[^\r\n]+") do
local status, file = line:match("^([MADRC])%s+(.+)$")
if status and file then
table.insert(files, { status = status, file = file })
end
end
return files
end
--- Get a list of files modified in the current jj repository.
--- @return string[] A list of modified file paths
function M.get_modified_files()
@@ -192,7 +90,8 @@ function M.get_modified_files()
return {}
end
local result, success = M.execute_command("jj diff --name-only", "Error getting diff")
-- We require the runner here to avoid a circular dependency loop at startup
local result, success = runner.execute_command("jj diff --name-only", "Error getting diff")
if not success or not result then
return {}
end
@@ -214,226 +113,4 @@ function M.notify(message, level)
vim.notify(message, level, { title = "JJ", timeout = 3000 })
end
---@param initial_text string[] Lines to initialize the buffer with
---@param on_done fun(buf: string[])? Optional callback called with user text on buffer write
function M.open_ephemeral_buffer(initial_text, on_done)
-- Initialize highlight groups once
init_highlights()
-- Create a horizontal split at the bottom, half the screen height
local height = math.floor(vim.o.lines / 2)
vim.cmd(string.format("%dsplit", height))
-- Create a new unlisted, scratch buffer
local buf = vim.api.nvim_create_buf(false, true)
vim.api.nvim_buf_set_name(buf, "jujutsu:///DESCRIBE_EDITMSG")
vim.api.nvim_buf_set_lines(buf, 0, -1, false, initial_text)
vim.api.nvim_win_set_buf(0, buf)
-- Configure buffer options
vim.bo[buf].buftype = "acwrite" -- Allow custom write handling
vim.bo[buf].bufhidden = "wipe" -- Automatically wipe buffer when hidden
vim.bo[buf].swapfile = false -- Disable swapfile
vim.bo[buf].modifiable = true -- Allow editing
-- Create a namespace for our highlights
local ns_id = vim.api.nvim_create_namespace("jj_describe_highlights")
-- Function to apply highlights to the buffer
local function apply_highlights()
-- Clear existing highlights
vim.api.nvim_buf_clear_namespace(buf, ns_id, 0, -1)
-- Get all lines
local lines = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
for i, line in ipairs(lines) do
local line_idx = i - 1 -- 0-indexed
-- First, check if line starts with JJ: and highlight it as comment
if line:match("^JJ:") then
-- Highlight the "JJ:" prefix as comment (first 3 characters)
vim.api.nvim_buf_set_extmark(buf, ns_id, line_idx, 0, {
end_col = 3,
hl_group = "JJComment",
})
-- Then check for status indicators and highlight the rest of the line
local status_pos = line:find("[MADRC] ", 4) -- Find status after "JJ:"
if status_pos then
local status = line:sub(status_pos, status_pos) -- Get the status character
local hl_group = nil
if status == "A" or status == "C" then
hl_group = "JJAdded"
elseif status == "M" then
hl_group = "JJModified"
elseif status == "D" then
hl_group = "JJDeleted"
elseif status == "R" then
hl_group = "JJRenamed"
end
if hl_group then
-- Highlight from the status character to the end of the line
vim.api.nvim_buf_set_extmark(buf, ns_id, line_idx, status_pos - 1, {
end_col = #line,
hl_group = hl_group,
})
else
-- No status, keep rest as comment
vim.api.nvim_buf_set_extmark(buf, ns_id, line_idx, 3, {
end_col = #line,
hl_group = "JJComment",
})
end
else
-- No status indicator, highlight rest of line as comment
vim.api.nvim_buf_set_extmark(buf, ns_id, line_idx, 3, {
end_col = #line,
hl_group = "JJComment",
})
end
end
end
end
-- Apply highlights initially
apply_highlights()
-- Reapply highlights when text changes
vim.api.nvim_create_autocmd({ "TextChanged", "TextChangedI" }, {
buffer = buf,
callback = apply_highlights,
})
-- Position cursor at the end (after the last JJ: line) and enter insert mode
vim.schedule(function()
local line_count = vim.api.nvim_buf_line_count(buf)
local target_line_idx = line_count - 1 -- 0-indexed line number for API calls
local last_line_content = vim.api.nvim_buf_get_lines(buf, target_line_idx, line_count, false)[1]
local col_index = #last_line_content
vim.api.nvim_win_set_cursor(0, { 1, 0 })
end)
-- Handle :w and :wq commands
vim.api.nvim_create_autocmd("BufWriteCmd", {
buffer = buf,
callback = function()
local buf_lines = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
if on_done then
on_done(buf_lines)
end
vim.bo[buf].modified = false
end,
})
-- Add keymap to close the buffer with 'q' in normal mode
vim.keymap.set(
"n",
"q",
"<cmd>close!<CR>",
{ buffer = buf, noremap = true, silent = true, desc = "Close describe buffer" }
)
-- Add keymap to close the buffer with '<Esc>' in normal mode
vim.keymap.set(
"n",
"<Esc>",
"<cmd>close!<CR>",
{ buffer = buf, noremap = true, silent = true, desc = "Close describe buffer" }
)
end
--- Parse the current line in the jj status buffer to extract file information.
--- Handles renamed files and regular status lines.
--- @return table|nil A table with {old_path = string, new_path = string, is_rename = boolean}, or nil if parsing fails
function M.parse_file_info_from_status_line()
local line = vim.api.nvim_get_current_line()
-- Handle renamed files: "R path/{old_name => new_name}" or "R old_path => new_path"
local rename_pattern_curly = "^R (.*)/{(.*) => ([^}]+)}"
local dir_path, old_name, new_name = line:match(rename_pattern_curly)
if dir_path and old_name and new_name then
return {
old_path = dir_path .. "/" .. old_name,
new_path = dir_path .. "/" .. new_name,
is_rename = true,
}
else
-- Try simple rename pattern: "R old_path => new_path"
local rename_pattern_simple = "^R (.*) => (.+)$"
local old_path, new_path = line:match(rename_pattern_simple)
if old_path and new_path then
return {
old_path = old_path,
new_path = new_path,
is_rename = true,
}
end
end
-- Not a rename, try regular status patterns
local filepath
-- Handle renamed files: "R path/{old_name => new_name}" or "R old_path => new_path"
local rename_pattern_curly_new = "^R (.*)/{.* => ([^}]+)}"
local dir_path_new, renamed_file = line:match(rename_pattern_curly_new)
if dir_path_new and renamed_file then
filepath = dir_path_new .. "/" .. renamed_file
else
-- Try simple rename pattern: "R old_path => new_path"
local rename_pattern_simple_new = "^R .* => (.+)$"
filepath = line:match(rename_pattern_simple_new)
end
if not filepath then
-- jj status format: "M filename" or "A filename"
-- Match lines that start with status letter followed by space and filename
local pattern = "^[MAD?!] (.+)$"
filepath = line:match(pattern)
end
if filepath then
return {
old_path = filepath,
new_path = filepath,
is_rename = false,
}
end
return nil
end
--- Parse the default command from jj config
--- @return table|nil args Array of command arguments, or nil if parsing fails
function M.parse_default_cmd()
local default_cmd, success =
M.execute_command("jj config get ui.default-command", "Error getting user's default command", nil, true)
if not success or not default_cmd or default_cmd == "" then
return nil
end
-- Remove whitespace and parse TOML output
default_cmd = vim.trim(default_cmd)
-- Try to parse as TOML array: ["item1", "item2", ...]
-- Pattern "%[(.*)%]" captures everything between square brackets
local array_items = default_cmd:match("%[(.*)%]")
if array_items then
local args = {}
-- Pattern '"([^"]+)"' captures content between double quotes (non-greedy)
for item in array_items:gmatch('"([^"]+)"') do
table.insert(args, item)
end
return #args > 0 and args or nil
else
-- Single string value, remove surrounding quotes if present
-- Pattern '^"?(.-)"?$' optionally matches quotes at start/end, captures content
local single_value = default_cmd:match('^"?(.-)"?$')
return single_value and { single_value } or nil
end
end
return M