Merge pull request #468 from jarviliam/feat-validate-config

feat: Rework configuration setup to add validation

lua/octo/commands.lua

@@ -341,7 +341,7 @@ function M.octo(object, action, ...)
   end
 
   if not object then
-    if config.get_config().enable_builtin then
+    if config.values.enable_builtin then
       M.commands.actions()
     else
       utils.error "Missing arguments"
@@ -759,7 +759,7 @@ end
 
 function M.create_pr(is_draft)
   is_draft = "draft" == is_draft and true or false
-  local conf = config.get_config()
+  local conf = config.values
   local select = conf.pull_requests.always_select_remote_on_create or false
 
   local repo

lua/octo/gh/init.lua

@@ -28,7 +28,7 @@ local env_vars = {
 
 local function get_env()
   local env = env_vars
-  local gh_env = config.get_config().gh_env
+  local gh_env = config.values.gh_env
   if type(gh_env) == "function" then
     local computed_env = gh_env()
     if type(computed_env) == "table" then
@@ -83,7 +83,7 @@ function M.run(opts)
   end
 
   opts = opts or {}
-  local conf = config.get_config()
+  local conf = config.values
   local mode = opts.mode or "async"
   local hostname = ""
   if opts.args[1] == "api" then

lua/octo/model/octo-buffer.lua

@@ -237,7 +237,7 @@ end
 function OctoBuffer:configure()
   -- configure buffer
   vim.api.nvim_buf_call(self.bufnr, function()
-    local use_signcolumn = config.get_config().ui.use_signcolumn
+    local use_signcolumn = config.values.ui.use_signcolumn
     vim.cmd [[setlocal filetype=octo]]
     vim.cmd [[setlocal buftype=acwrite]]
     vim.cmd [[setlocal omnifunc=v:lua.octo_omnifunc]]
@@ -799,7 +799,7 @@ end
 
 ---Renders the signcolumn
 function OctoBuffer:render_signcolumn()
-  local use_signcolumn = config.get_config().ui.use_signcolumn
+  local use_signcolumn = config.values.ui.use_signcolumn
   if not use_signcolumn or not self.ready then
     return
   end

lua/octo/picker.lua

@@ -4,7 +4,7 @@ local utils = require "octo.utils"
 local M = {}
 
 function M.setup()
-  local provider_name = config.get_config().picker
+  local provider_name = config.values.picker
   if utils.is_blank(provider_name) then
     provider_name = "telescope"
   end

lua/octo/pickers/fzf-lua/pickers/fzf_actions.lua

@@ -21,7 +21,7 @@ M.common_buffer_actions = function(formatted_items)
 end
 
 M.common_open_actions = function(formatted_items)
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   return vim.tbl_extend("force", M.common_buffer_actions(formatted_items), {
     [utils.convert_vim_mapping_to_fzf(cfg.picker_config.mappings.open_in_browser.lhs)] = function(selected)
       picker_utils.open_in_browser(formatted_items[selected[1]])

lua/octo/pickers/fzf-lua/pickers/issues.lua

@@ -23,7 +23,7 @@ return function(opts)
   end
 
   local owner, name = utils.split_repo(opts.repo)
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   local order_by = cfg.issues.order_by
 
   local query = graphql("issues_query", owner, name, filter, order_by.field, order_by.direction, { escape = false })

lua/octo/pickers/fzf-lua/pickers/prs.lua

@@ -27,7 +27,7 @@ return function(opts)
   end
 
   local owner, name = utils.split_repo(opts.repo)
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   local order_by = cfg.pull_requests.order_by
 
   local query =

lua/octo/pickers/fzf-lua/previewers.lua

@@ -324,7 +324,7 @@ M.repo = function(formatted_repos)
     self:set_preview_buf(tmpbuf)
 
     local stargazer, fork
-    if config.get_config().picker_config.use_emojis then
+    if config.values.picker_config.use_emojis then
       stargazer = string.format("💫: %s", entry.repo.stargazerCount)
       fork = string.format("🔱: %s", entry.repo.forkCount)
     else

lua/octo/pickers/telescope/provider.lua

@@ -132,7 +132,7 @@ function M.issues(opts)
   end
 
   local owner, name = utils.split_repo(opts.repo)
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   local order_by = cfg.issues.order_by
   local query = graphql("issues_query", owner, name, filter, order_by.field, order_by.direction, { escape = false })
   utils.info "Fetching issues (this may take a while) ..."
@@ -277,7 +277,7 @@ function M.pull_requests(opts)
   end
 
   local owner, name = utils.split_repo(opts.repo)
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   local order_by = cfg.pull_requests.order_by
   local query =
     graphql("pull_requests_query", owner, name, filter, order_by.field, order_by.direction, { escape = false })
@@ -479,7 +479,7 @@ end
 ---
 function M.search(opts)
   opts = opts or {}
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   local requester = function()
     return function(prompt)
       if not opts.prompt and utils.is_blank(prompt) then
@@ -924,7 +924,7 @@ end
 --
 function M.repos(opts)
   opts = opts or {}
-  local cfg = octo_config.get_config()
+  local cfg = octo_config.values
   if not opts.login then
     if vim.g.octo_viewer then
       opts.login = vim.g.octo_viewer

lua/octo/reviews/file-entry.lua

@@ -176,7 +176,7 @@ function FileEntry:fetch()
   local left_sha = current_review.layout.left.commit
   local right_abbrev = current_review.layout.right:abbrev()
   local left_abbrev = current_review.layout.left:abbrev()
-  local conf = config.get_config()
+  local conf = config.values
 
   -- handle renamed files
   if self.status == "R" and self.previous_path then
@@ -236,7 +236,7 @@ function FileEntry:load_buffers(left_winid, right_winid)
   -- configure diff buffers
   for _, split in ipairs(splits) do
     if not split.bufid or not vim.api.nvim_buf_is_loaded(split.bufid) then
-      local conf = config.get_config()
+      local conf = config.values
       local use_local = conf.use_local_fs and split.pos == "right" and utils.in_pr_branch(self.pull_request.bufnr)
 
       -- create buffer
@@ -469,15 +469,15 @@ end
 
 function M._configure_buffer(bufid)
   utils.apply_mappings("review_diff", bufid)
-  -- local conf = config.get_config()
+  -- local conf = config.values
   -- vim.cmd(string.format("nnoremap %s :OctoAddReviewComment<CR>", conf.mappings.review_thread.add_comment))
   -- vim.cmd(string.format("vnoremap %s :OctoAddReviewComment<CR>", conf.mappings.review_thread.add_comment))
   -- vim.cmd(string.format("nnoremap %s :OctoAddReviewSuggestion<CR>", conf.mappings.review_thread.add_suggestion))
   -- vim.cmd(string.format("vnoremap %s :OctoAddReviewSuggestion<CR>", conf.mappings.review_thread.add_suggestion))
 end
 
 function M._detach_buffer(bufid)
-  local conf = config.get_config()
+  local conf = config.values
   for _, lhs in pairs(conf.mappings.review_diff) do
     pcall(vim.keymap.del, "n", lhs, { buffer = bufid })
   end

lua/octo/reviews/file-panel.lua

@@ -58,7 +58,7 @@ FilePanel.bufopts = {
 ---@param files FileEntry[]
 ---@return FilePanel
 function FilePanel:new(files)
-  local conf = config.get_config()
+  local conf = config.values
   local this = {
     files = files,
     size = conf.file_panel.size,
@@ -96,7 +96,7 @@ function FilePanel:open()
     return
   end
 
-  local conf = config.get_config()
+  local conf = config.values
   self.size = conf.file_panel.size
   --vim.cmd("wincmd H")
   --vim.cmd("vsp")
@@ -233,7 +233,7 @@ function FilePanel:render()
   end
 
   local current_review = require("octo.reviews").get_current_review()
-  local conf = config.get_config()
+  local conf = config.values
   local strlen = vim.fn.strlen
   local s = "Files changed"
   add_hl("OctoFilePanelTitle", line_idx, 0, #s)

lua/octo/reviews/init.lua

@@ -130,7 +130,7 @@ end
 function Review:initiate(opts)
   opts = opts or {}
   local pr = self.pull_request
-  local conf = config.get_config()
+  local conf = config.values
   if conf.use_local_fs and not utils.in_pr_branch(pr.bufnr) then
     local choice = vim.fn.confirm("Currently not in PR branch, would you like to checkout?", "&Yes\n&No", 2)
     if choice == 1 then
@@ -224,7 +224,7 @@ function Review:collect_submit_info()
     return
   end
 
-  local conf = config.get_config()
+  local conf = config.values
   local winid, bufnr = window.create_centered_float {
     header = string.format(
       "Press %s to approve, %s to comment or %s to request changes",

lua/octo/reviews/renderer.lua

@@ -84,7 +84,7 @@ function M.get_git_hl(status)
 end
 
 function M.get_file_icon(name, ext, render_data, line_idx, offset)
-  local use_icons = config.get_config().file_panel.use_icons
+  local use_icons = config.values.file_panel.use_icons
   if not use_icons then
     return " "
   end

lua/octo/ui/bubbles.lua

@@ -9,7 +9,7 @@ local colors = require "octo.ui.colors"
 
 local function make_bubble(content, highlight_group, opts)
   opts = opts or {}
-  local conf = config.get_config()
+  local conf = config.values
   local margin = string.rep(" ", opts.margin_width or 0)
   local right_margin = string.rep(" ", opts.right_margin_width or 0)
   local left_margin = string.rep(" ", opts.left_margin_width or 0)
@@ -38,7 +38,7 @@ end
 
 local function make_user_bubble(name, is_viewer, opts)
   opts = opts or {}
-  local conf = config.get_config()
+  local conf = config.values
   local highlight = is_viewer and "OctoUserViewer" or "OctoUser"
   local icon_position = opts.icon_position or "left"
   local icon = conf.user_icon
@@ -53,7 +53,7 @@ local function make_user_bubble(name, is_viewer, opts)
 end
 
 local function make_reaction_bubble(icon, includes_viewer, opts)
-  local conf = config.get_config()
+  local conf = config.values
   local highlight = includes_viewer and "OctoReactionViewer" or "OctoReaction"
   local hint_for_viewer = includes_viewer and conf.reaction_viewer_hint_icon or ""
   local content = icon .. hint_for_viewer

lua/octo/ui/colors.lua

@@ -22,7 +22,7 @@ local function get_fg(hl_group_name)
 end
 
 local function get_colors()
-  local conf = config.get_config()
+  local conf = config.values
   return conf.colors
 end
 

lua/octo/ui/signs.lua

@@ -3,7 +3,7 @@ local config = require "octo.config"
 local M = {}
 
 function M.setup()
-  local conf = config.get_config()
+  local conf = config.values
 
   vim.cmd(string.format("sign define octo_thread text=%s texthl=OctoBlue", conf.comment_icon))
   vim.cmd(string.format("sign define octo_thread_resolved text=%s  texthl=OctoGreen", conf.comment_icon))

lua/octo/ui/writers.lua

@@ -466,7 +466,7 @@ function M.write_comment(bufnr, comment, kind, line)
   ---- PullRequestComment (regular comment (not associated to any review) to a PR review comment)
 
   local buffer = octo_buffers[bufnr]
-  local conf = config.get_config()
+  local conf = config.values
 
   -- heading
   line = line or vim.api.nvim_buf_line_count(bufnr) + 1
@@ -598,7 +598,7 @@ function M.write_comment(bufnr, comment, kind, line)
 end
 
 local function find_snippet_range(diffhunk_lines)
-  local conf = config.get_config()
+  local conf = config.values
   local context_lines = conf.snippet_context_lines or 4
   local snippet_start
   local count = 0
@@ -818,7 +818,7 @@ end
 function M.write_review_thread_header(bufnr, opts, line)
   line = line or vim.api.nvim_buf_line_count(bufnr) - 1
 
-  local conf = config.get_config()
+  local conf = config.values
 
   -- clear virtual texts
   vim.api.nvim_buf_clear_namespace(bufnr, constants.OCTO_THREAD_HEADER_VT_NS, line, line + 2)
@@ -1024,7 +1024,7 @@ end
 
 function M.write_issue_summary(bufnr, issue, opts)
   opts = opts or {}
-  local conf = config.get_config()
+  local conf = config.values
   local max_length = opts.max_length or 80
   local chunks = {}
 
@@ -1107,7 +1107,7 @@ function M.write_assigned_event(bufnr, item)
   --   item.actor.login == vim.g.octo_viewer
   -- )
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)
@@ -1120,7 +1120,7 @@ end
 
 function M.write_commit_event(bufnr, item)
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   if item.commit.committer.user ~= vim.NIL then
@@ -1148,7 +1148,7 @@ function M.write_merged_event(bufnr, item)
   --   item.actor.login == vim.g.octo_viewer
   -- )
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)
@@ -1167,7 +1167,7 @@ function M.write_closed_event(bufnr, item)
   --   item.actor.login == vim.g.octo_viewer
   -- )
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)
@@ -1192,7 +1192,7 @@ function M.write_labeled_events(bufnr, items, action)
 
   for _, actor in ipairs(vim.tbl_keys(labels_by_actor)) do
     local vt = {}
-    local conf = config.get_config()
+    local conf = config.values
     table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
     table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
     --vim.list_extend(vt, actor_bubble)
@@ -1218,7 +1218,7 @@ function M.write_reopened_event(bufnr, item)
   --   item.actor.login == vim.g.octo_viewer
   -- )
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)
@@ -1235,7 +1235,7 @@ function M.write_review_requested_event(bufnr, item)
   -- )
 
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)
@@ -1256,7 +1256,7 @@ function M.write_review_request_removed_event(bufnr, item)
   --   item.actor.login == vim.g.octo_viewer
   -- )
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)
@@ -1277,7 +1277,7 @@ function M.write_review_dismissed_event(bufnr, item)
   --   item.actor.login == vim.g.octo_viewer
   -- )
   local vt = {}
-  local conf = config.get_config()
+  local conf = config.values
   table.insert(vt, { conf.timeline_marker .. " ", "OctoTimelineMarker" })
   table.insert(vt, { "EVENT: ", "OctoTimelineItemHeading" })
   --vim.list_extend(vt, actor_bubble)