gitlab.nvim/lua/gitlab/actions/summary.lua at develop · harrisoncramer/gitlab.nvim · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

-- This module is responsible for the MR description

-- This lets the user open the description in a popup and

-- send edits to the description back to Gitlab

local Layout = require("nui.layout")

local Popup = require("nui.popup")

local git = require("gitlab.git")

local client = require("gitlab.client")

local common = require("gitlab.actions.common")

local u = require("gitlab.utils")

local popup = require("gitlab.popup")

local state = require("gitlab.state")

local miscellaneous = require("gitlab.actions.miscellaneous")

-- No-break space used in summary details to make matching different parts of the line more robust.

local nbsp = " "

local M = {

layout_visible = false,

layout = nil,

layout_buf = nil,

title_bufnr = nil,

description_bufnr = nil,

}

---Render a popup with the MR title and description, and, optionally, additional

---metadata configured in `settings.info.fields`.

---The title and description are editable, and changes can be confirmed via the local

---action keybinding, which also closes the popup.

M.summary = function()

if M.layout_visible then

M.layout:unmount()

M.layout_visible = false

return

end

require("gitlab.git_async").check_current_branch_up_to_date_on_remote()

local title = state.INFO.title

local description_lines = common.build_content(state.INFO.description)

local info_lines = state.settings.info.enabled and M.build_info_lines() or { "" }

local layout, title_popup, description_popup, info_popup = M.create_layout(info_lines)

layout:mount()

local popups = {

title_popup,

description_popup,

info_popup,

}

M.layout = layout

M.info_popup = info_popup

M.title_popup = title_popup

M.description_popup = description_popup

M.layout_buf = layout.bufnr

M.layout_visible = true

local function exit()

layout:unmount()

M.layout_visible = false

end

vim.schedule(function()

vim.api.nvim_buf_set_lines(description_popup.bufnr, 0, -1, false, description_lines)

vim.api.nvim_buf_set_lines(title_popup.bufnr, 0, -1, false, { title })

if info_popup then

M.update_details_popup(info_popup.bufnr, info_lines)

end

popup.set_popup_keymaps(

description_popup,

M.edit_summary,

miscellaneous.attach_file,

{ cb = exit, action_before_close = true, action_before_exit = true, save_to_temp_register = true }

)

popup.set_popup_keymaps(

title_popup,

M.edit_summary,

nil,

{ cb = exit, action_before_close = true, action_before_exit = true }

)

popup.set_popup_keymaps(

info_popup,

M.edit_summary,

nil,

{ cb = exit, action_before_close = true, action_before_exit = true }

)

popup.set_cycle_popups_keymaps(popups)

vim.api.nvim_set_current_buf(description_popup.bufnr)

end)

git.check_mr_in_good_condition()

end

---Update the contents and layout of the summary popup.

M.update_summary_details = function()

if not M.info_popup or not M.info_popup.bufnr then

return

end

local details_lines = state.settings.info.enabled and M.build_info_lines() or { "" }

local internal_layout = M.create_internal_layout(details_lines, M.title_popup, M.description_popup, M.info_popup)

M.layout:update(M.get_outer_layout_config(), internal_layout)

M.update_details_popup(M.info_popup.bufnr, details_lines)

end

---Update the contents of the Details buffer.

---@param bufnr integer Buffer number of the details window

---@param info_lines string[] The new Detail contents to set in the buffer

M.update_details_popup = function(bufnr, info_lines)

u.switch_can_edit_buf(bufnr, true)

vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, info_lines)

u.switch_can_edit_buf(bufnr, false)

M.color_details(bufnr) -- Color values in details popup

end

---Return the mergeability checks statuses and descriptions.

---@return string[]

local make_mergeability_checks = function()

local lines = {}

for _, check in ipairs(state.MERGEABILITY) do

local status = state.settings.mergeability_checks.statuses[check.status]

if status == nil then

u.notify(string.format("Unknown mergeability check status: %s", check.status), vim.log.levels.ERROR)

end

if status then

local description = state.settings.mergeability_checks.checks[check.identifier]

if description == nil then

u.notify(string.format("Unknown mergeability check identifier: %s", check.identifier), vim.log.levels.ERROR)

end

if description then

table.insert(lines, status .. " " .. description)

end

return lines

end

---Build a list of metadata about the current MR.

---Only builds the lines that users include in their state.settings.info.fields list.

---TODO: Consider splitting this into simpler functions and calculating `options` lazily

---only when necessary.

---@return string[]

M.build_info_lines = function()

local info = state.INFO

local options = {

author = { title = "Author", content = "@" .. info.author.username .. " (" .. info.author.name .. ")" },

created_at = { title = "Created", content = u.format_to_local(info.created_at, vim.fn.strftime("%z")) },

updated_at = { title = "Updated", content = u.time_since(info.updated_at) },

detailed_merge_status = { title = "Status", content = info.detailed_merge_status },

draft = { title = "Draft", content = (info.draft and "Yes" or "No") },

conflicts = { title = "Merge Conflicts", content = (info.has_conflicts and "Yes" or "No") },

assignees = { title = "Assignees", content = u.make_readable_list(info.assignees, "name") },

reviewers = { title = "Reviewers", content = u.make_readable_list(info.reviewers, "name") },

branch = { title = "Branch", content = info.source_branch },

labels = { title = "Labels", content = table.concat(info.labels, ", ") },

target_branch = { title = "Target Branch", content = info.target_branch },

auto_merge = { title = "Auto-merge", content = (info.merge_when_pipeline_succeeds and "Yes" or "No") },

delete_branch = {

title = "Delete Source Branch",

content = (info.force_remove_source_branch and "Yes" or "No"),

squash = { title = "Squash Commits", content = (info.squash and "Yes" or "No") },

pipeline = {

title = "Pipeline Status",

content = function()

local pipeline = info.head_pipeline ~= vim.NIL and info.head_pipeline or info.pipeline

if type(pipeline) ~= "table" or (type(pipeline) == "table" and u.table_size(pipeline) == 0) then

return ""

end

return pipeline.status

end,

web_url = { title = "MR URL", content = info.web_url },

mergeability_checks = { title = "Mergeability checks", content = make_mergeability_checks },

}

local longest_used = ""

for _, v in ipairs(state.settings.info.fields) do

if v == "merge_status" then

v = "detailed_merge_status"

end -- merge_status was deprecated, see https://gitlab.com/gitlab-org/gitlab/-/issues/3169#note_1162532204

if options[v] == nil then

u.notify(string.format("Invalid field in settings.info.fields: '%s'", v), vim.log.levels.ERROR)

else

local title = options[v].title

if vim.fn.strcharlen(title) > vim.fn.strcharlen(longest_used) then

longest_used = title

end

---Return the padding (no-break spaces) between the row title and content to make the contents on

---individual rows aligned.

---@param title string The title of the current row or multi-line section

---@return string

local function get_padding(title)

local offset = vim.fn.strcharlen(longest_used) - vim.fn.strcharlen(title)

return string.rep(nbsp, offset + 3)

end

local result = {}

for _, v in ipairs(state.settings.info.fields) do

if v == "merge_status" then

v = "detailed_merge_status"

end

local row = options[v]

local title_prefix = "* " .. row.title .. get_padding(row.title)

local content = type(row.content) == "function" and row.content() or row.content

if type(content) == "table" then

-- Multi-line content

local padding = string.rep(nbsp, vim.fn.strcharlen(title_prefix))

for i, line in ipairs(#content > 0 and content or { "" }) do

table.insert(result, (i == 1 and title_prefix or padding) .. line)

end

else

-- Single-line content

table.insert(result, title_prefix .. (content or ""))

end

return result

end

---Send the new MR description to the Go server.

M.edit_summary = function()

local description = u.get_buffer_text(M.description_bufnr)

local title = u.get_buffer_text(M.title_bufnr):gsub("\n", " ")

local body = { title = title, description = description }

client.send_request("/mr/summary", "PUT", body, function(data)

u.notify(data.message, vim.log.levels.INFO)

state.INFO.description = data.mr.description

state.INFO.title = data.mr.title

end)

end

---Create the Summary layout and individual popups that make up the Layout.

---@param info_lines string[] Table of strings that make up the details content

---@return NuiLayout, NuiPopup, NuiPopup, NuiPopup

M.create_layout = function(info_lines)

local settings = u.merge(state.settings.popup, state.settings.popup.summary or {})

local title_popup = Popup(popup.create_box_popup_state(nil, false, settings))

M.title_bufnr = title_popup.bufnr

local description_popup = Popup(popup.create_popup_state({ title = "Description", user_settings = settings }))

M.description_bufnr = description_popup.bufnr

local details_popup

if state.settings.info.enabled then

details_popup = Popup(popup.create_box_popup_state("Details", false, settings))

end

local internal_layout = M.create_internal_layout(info_lines, title_popup, description_popup, details_popup)

local layout = Layout(M.get_outer_layout_config(), internal_layout)

popup.set_up_autocommands(description_popup, layout, vim.api.nvim_get_current_win())

return layout, title_popup, description_popup, details_popup

end

---Create the internal layout of the Summary and individual popups that make up the Layout.

---@param info_lines string[] Table of strings that make up the details content

---@param title_popup NuiPopup

---@param description_popup NuiPopup

---@param details_popup NuiPopup

---@return NuiLayout.Box

M.create_internal_layout = function(info_lines, title_popup, description_popup, details_popup)

local internal_layout

if state.settings.info.enabled then

if state.settings.info.horizontal then

local max_line_length = u.get_max_length(info_lines)

internal_layout = Layout.Box({

Layout.Box(title_popup, { size = 3 }),

Layout.Box({

Layout.Box(details_popup, { size = max_line_length + 3 }),

Layout.Box(description_popup, { grow = 1 }),

}, { dir = "row", size = "95%" }),

}, { dir = "col" })

else

internal_layout = Layout.Box({

Layout.Box(title_popup, { size = 3 }),

Layout.Box(description_popup, { grow = 1 }),

Layout.Box(details_popup, { size = #info_lines + 3 }),

}, { dir = "col" })

end

else

internal_layout = Layout.Box({

Layout.Box(title_popup, { size = 3 }),

Layout.Box(description_popup, { grow = 1 }),

}, { dir = "col" })

end

return internal_layout

end

---Create the config for the outer Layout of the Summary.

---@return nui_layout_options

M.get_outer_layout_config = function()

local settings = u.merge(state.settings.popup, state.settings.popup.summary or {})

return {

position = settings.position,

relative = "editor",

size = {

width = settings.width,

height = settings.height,

}

end

---Return the highlight definition map.

---Use a light background color (the foreground color of Normal highlight) when

---vim.o.background and the `color` are dark.

---@param color string Color definition, e.g., "#dc143c"

---@return vim.api.keyset.highlight

local function label_hl(color)

local r, g, b = color:match("%#(%x%x)(%x%x)(%x%x)")

local luminance = (0.299 * tonumber(r, 16) + 0.587 * tonumber(g, 16) + 0.114 * tonumber(b, 16)) / 255

local normal = vim.api.nvim_get_hl(0, { name = "Normal", link = false })

local normal_fg = normal.fg and string.format("#%06x", normal.fg) or "#ffffff"

local bg = (vim.o.background == "dark" and luminance < 0.5) and normal_fg or nil

return { fg = color, bg = bg }

end

---Colorize the details buffer

---@param bufnr integer The buffer number of the Details popup

M.color_details = function(bufnr)

local details_namespace = vim.api.nvim_create_namespace("Details")

for i, line in ipairs(vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)) do

if line:match("^* Labels") then

for j, label in ipairs(state.LABELS) do

local start_idx, end_idx = line:find(label.Name, 1, true)

if start_idx ~= nil and end_idx ~= nil then

vim.api.nvim_set_hl(0, ("label" .. j), label_hl(label.Color))

vim.hl.range(bufnr, details_namespace, ("label" .. j), { i - 1, start_idx - 1 }, { i - 1, end_idx })

end

elseif line:match("^* Status") then

local status = line:match("[^" .. nbsp .. "]-$")

local hl = ({

blocked_status = "DiagnosticError",

broken_status = "DiagnosticError",

checking = "DiagnosticInfo",

ci_must_pass = "DiagnosticWarn",

ci_still_running = "DiagnosticInfo",

discussions_not_resolved = "DiagnosticWarn",

draft_status = "Comment",

external_status_checks = "DiagnosticHint",

mergeable = "DiagnosticOK",

not_approved = "DiagnosticWarn",

not_open = "NonText",

policies_denied = "DiagnosticError",

unchecked = "NonText",

})[status] or "Normal"

local start_idx, end_idx = line:find("[^" .. nbsp .. "]-$")

vim.hl.range(bufnr, details_namespace, hl, { i - 1, start_idx - 1 }, { i - 1, end_idx })

elseif line:match("^* Branch") or line:match("^* Target Branch") then

local start_idx, end_idx = line:find("[^" .. nbsp .. "]-$")

vim.hl.range(bufnr, details_namespace, "Title", { i - 1, start_idx - 1 }, { i - 1, end_idx })

elseif line:match("^* Pipeline") then

local status = line:match("[^" .. nbsp .. "]-$")

local hl = ({

canceled = "DiagnosticWarn",

created = "DiagnosticInfo",

failed = "DiagnosticError",

manual = "DiagnosticHint",

pending = "DiagnosticWarn",

running = "DiagnosticInfo",

skipped = "Comment",

success = "DiagnosticOK",

unknown = "NonText",

})[status] or "Normal"

local start_idx, end_idx = line:find("[^" .. nbsp .. "]-$")

vim.hl.range(bufnr, details_namespace, hl, { i - 1, start_idx - 1 }, { i - 1, end_idx })

elseif line:match(nbsp .. "No$") or line:match(nbsp .. "Yes$") then

local start_idx, end_idx = line:find("[^" .. nbsp .. "]-$")

vim.api.nvim_set_hl(0, "boolean", { link = "Constant" })

vim.hl.range(bufnr, details_namespace, "boolean", { i - 1, start_idx - 1 }, { i - 1, end_idx })

end

return M

gitlab.nvim/lua/gitlab/actions/summary.lua at develop · harrisoncramer/gitlab.nvim · GitHub

Repository navigation

Expand file tree

Breadcrumbs

summary.lua

Latest commit

History

Breadcrumbs

summary.lua

File metadata and controls