Merge pull request #453 from CKolkey/add_settings

Initial implementation for persisting state

Author: ten3roberts

README.md

@@ -129,6 +129,13 @@ neogit.setup {
   console_timeout = 2000,
   -- Automatically show console if a command takes more than console_timeout milliseconds
   auto_show_console = true,
+  -- Persist the values of switches/options within and across sessions
+  remember_settings = true,
+  -- Scope persisted settings on a per-project basis
+  use_per_project_settings = true,
+  -- Array-like table of settings to never persist. Uses format "Filetype--cli-value"
+  --   ie: `{ "NeogitCommitPopup--author", "NeogitCommitPopup--no-verify" }`
+  ignored_settings = {},
   -- Change the default way of opening the commit popup
   commit_popup = {
     kind = "split",

lua/neogit.lua

@@ -4,6 +4,7 @@ local lib = require("neogit.lib")
 local signs = require("neogit.lib.signs")
 local hl = require("neogit.lib.hl")
 local status = require("neogit.status")
+local state = require("neogit.lib.state")
 
 local neogit = {
   lib = require("neogit.lib"),
@@ -57,6 +58,7 @@ local neogit = {
       config.values.mappings.status["p"] = ""
     end
     hl.setup()
+    state.setup()
 
     require("neogit.autocmds").setup()
   end,

lua/neogit/config.lua

@@ -7,6 +7,8 @@ M.values = {
   disable_commit_confirmation = false,
   disable_builtin_notifications = false,
   disable_insert_on_commit = true,
+  use_per_project_settings = true,
+  remember_settings = true,
   use_magit_keybindings = false,
   auto_refresh = true,
   sort_branches = "-committerdate",
@@ -61,6 +63,7 @@ M.values = {
       folded = true,
     },
   },
+  ignored_settings = {},
   mappings = {
     status = {
       ["q"] = "Close",

lua/neogit/lib/popup.lua

@@ -5,6 +5,7 @@ local Ui = require("neogit.lib.ui")
 local logger = require("neogit.logger")
 local util = require("neogit.lib.util")
 local config = require("neogit.config")
+local state = require("neogit.lib.state")
 
 local col = Ui.col
 local row = Ui.row
@@ -86,6 +87,7 @@ function M:toggle_switch(switch)
     return c.options.id == switch.id
   end)
   c.options.highlight = get_highlight_for_switch(switch)
+  state.set({ self.state.name, switch.cli }, switch.enabled)
   self.buffer.ui:update()
 end
 
@@ -100,6 +102,7 @@ function M:set_option(option)
   end)
   c.options.highlight = get_highlight_for_option(option)
   c.children[#c.children].value = option.value
+  state.set({ self.state.name, option.cli }, option.value)
   self.buffer.ui:update()
 end
 

lua/neogit/lib/popup/builder.lua

@@ -1,4 +1,5 @@
 local a = require("plenary.async")
+local state = require("neogit.lib.state")
 
 local M = {}
 
@@ -50,7 +51,7 @@ function M:switch(key, cli, description, enabled, parse)
     key = key,
     cli = cli,
     description = description,
-    enabled = enabled,
+    enabled = state.get({ self.state.name, cli }, enabled),
     parse = parse,
   })
 
@@ -62,7 +63,7 @@ function M:option(key, cli, value, description)
     id = "=" .. key,
     key = key,
     cli = cli,
-    value = value,
+    value = state.get({ self.state.name, cli }, value),
     description = description,
   })
 

lua/neogit/lib/state.lua

@@ -0,0 +1,109 @@
+local logger = require("neogit.logger")
+local config = require("neogit.config")
+local Path = require("plenary.path")
+
+local M = {}
+
+M.loaded = false
+
+local function log(message)
+  logger.debug("State: " .. message .. ": '" .. M.path:absolute() .. "'")
+end
+
+---@return Path
+function M.filepath()
+  local base_path = vim.fn.stdpath("state") .. "/neogit/"
+  local filename = "state"
+
+  if config.values.use_per_project_settings then
+    filename = vim.loop.cwd():gsub("/", "%%")
+  end
+
+  return Path:new(base_path .. filename)
+end
+
+---Initializes state
+function M.setup()
+  if M.loaded then
+    return
+  end
+
+  M.path = M.filepath()
+  M.loaded = true
+  M.state = M.read()
+  log("Loaded")
+end
+
+---@return boolean
+function M.enabled()
+  return M.loaded and config.values.remember_settings
+end
+
+---Reads state from disk
+---@return table
+function M.read()
+  if not M.enabled() then
+    return {}
+  end
+
+  if not M.path:exists() then
+    log("Creating file")
+    M.path:touch { parents = true }
+    M.path:write(vim.mpack.encode {}, "w")
+  end
+
+  log("Reading file")
+  return vim.mpack.decode(M.path:read())
+end
+
+---Writes state to disk
+function M.write()
+  if not M.enabled() then
+    return
+  end
+
+  log("Writing file")
+  M.path:write(vim.mpack.encode(M.state), "w")
+end
+
+---Construct a cache-key from a table
+---@param key_table table
+---@return string
+local function gen_key(key_table)
+  return table.concat(key_table, "--")
+end
+
+---Set option and write to disk
+---@param key table
+---@param value any
+function M.set(key, value)
+  if not M.enabled() then
+    return
+  end
+
+  if not vim.tbl_contains(config.values.ignored_settings, gen_key(key)) then
+    M.state[gen_key(key)] = value
+    M.write()
+  end
+end
+
+---Get option. If value isn't set, return provided default.
+---@param key table
+---@param default any
+---@return any
+function M.get(key, default)
+  if not M.enabled() then
+    return default
+  end
+
+  return M.state[gen_key(key)] or default
+end
+
+---Reset current state, removing whats written to disk
+function M._reset()
+  log("Reset file")
+  M.path:write(vim.mpack.encode {}, "w")
+  M.state = {}
+end
+
+return M