feat: add enable() and disable()

Author: mawkler

lua/modicator/backup.lua

@@ -0,0 +1,17 @@
+local M = {}
+
+--- @type table
+local cursor_line_nr_hl_backup = nil
+
+function M.backup_default_cursorline_hl()
+  local hl = require('modicator.utils').get_highlight('CursorLineNr')
+  cursor_line_nr_hl_backup = hl
+end
+
+function M.restore_default_cursorline_hl()
+  if cursor_line_nr_hl_backup then
+    vim.api.nvim_set_hl(0, 'CursorLineNr', cursor_line_nr_hl_backup)
+  end
+end
+
+return M

lua/modicator/init.lua

@@ -33,8 +33,11 @@ local options = {
   },
 }
 
+---@type integer?
+local augroup_id = nil
+
 --- @return ModicatorOptions
-M.get_options = function()
+function M.get_options()
   return options
 end
 
@@ -115,7 +118,7 @@ local function mode_name_from_mode(mode)
 end
 
 --- @param mode string
-M.hl_name_from_mode = function(mode)
+function M.hl_name_from_mode(mode)
   local mode_name = mode_name_from_mode(mode)
   return mode_name .. 'Mode'
 end
@@ -183,10 +186,9 @@ local function set_highlight_groups()
   update_mode()
 end
 
---- Set the foreground and background color of 'CursorLineNr'. Accepts any
---- highlight definition map that `vim.api.nvim_set_hl()` does.
---- @param hl_name string
-M.set_cursor_line_highlight = function(hl_name)
+--- Set the foreground and background color of 'CursorLineNr'
+--- @param hl_name string Name of mode highlight group
+function M.set_cursor_line_highlight(hl_name)
   local hl_group = require('modicator.utils').get_highlight(hl_name)
   local hl = vim.tbl_extend('force', options.highlights.defaults, hl_group)
   if options.highlights.use_cursorline_background == true then
@@ -195,14 +197,15 @@ M.set_cursor_line_highlight = function(hl_name)
   end
   api.nvim_set_hl(0, 'CursorLineNr', hl)
 
-  local is_register_executing = vim.fn.reg_executing() ~= ""
+  local register_is_executing = vim.fn.reg_executing() ~= ""
 
   -- Workaround for https://github.com/neovim/neovim/issues/25851
-  if not vim.o.lazyredraw and not is_register_executing then
+  if not vim.o.lazyredraw and not register_is_executing then
     vim.cmd.redraw()
   end
 end
 
+---@return integer augroup Augroup ID
 local function create_autocmds()
   local augroup = api.nvim_create_augroup('Modicator', {})
   -- NOTE: VimEnter loads after user's configuration is loaded
@@ -221,17 +224,36 @@ local function create_autocmds()
     callback = set_highlight_groups,
     group = augroup,
   })
+
+  return augroup
+end
+
+--- Enable Modicator
+function M.enable()
+  set_highlight_groups()
+
+  api.nvim_set_hl(0, 'CursorLineNr', { link = 'NormalMode' })
+
+  augroup_id = create_autocmds()
+end
+
+--- Disable Modicator
+function M.disable()
+  if augroup_id then
+    api.nvim_del_augroup_by_id(augroup_id)
+    augroup_id = nil
+  end
+
+  require('modicator.backup').restore_default_cursorline_hl()
 end
 
 --- @param opts ModicatorOptions?
 function M.setup(opts)
   options = vim.tbl_deep_extend('force', options, opts or {})
 
-  set_highlight_groups()
-
-  vim.api.nvim_set_hl(0, 'CursorLineNr', { link = 'NormalMode' })
+  require('modicator.backup').backup_default_cursorline_hl()
 
-  create_autocmds()
+  M.enable()
 end
 
 return M

lua/modicator/integration/lualine/init.lua

@@ -100,7 +100,7 @@ end
 
 --- Set mode highlights based on lualine's mode highlights
 --- @param mode_section LualineSectionLetter?
-M.use_lualine_mode_highlights = function(mode_section)
+function M.use_lualine_mode_highlights(mode_section)
   mode_section = mode_section or get_mode_section_letter()
   -- If lualine doesn't have a `mode` section and none was passed in
   if mode_section == nil then

lua/modicator/utils.lua

@@ -3,15 +3,15 @@ local modicator = require('modicator')
 local M = {}
 
 --- @param message string
-M.warn = function(message)
+function M.warn(message)
   if modicator.get_options().show_warnings then
     local warning = string.format('modicator.nvim: %s', message)
     vim.notify(warning, vim.log.levels.WARN)
   end
 end
 
 --- @param message string
-M.inform = function(message)
+function M.inform(message)
   if modicator.get_options().show_warnings then
     local warning = string.format('modicator.nvim: %s', message)
     vim.notify(warning, vim.log.levels.INFO)
@@ -20,13 +20,13 @@ end
 
 --- @param hl_group string
 --- @return boolean
-M.highlight_exists = function(hl_group)
+function M.highlight_exists(hl_group)
   local hl = vim.api.nvim_get_hl(0, { name = hl_group })
   return not vim.tbl_isempty(hl)
 end
 
 --- @return table<string>
-M.get_highlights = function()
+function M.get_highlights()
   local modes = require('modicator').modes
   return vim.tbl_map(function(mode)
     return mode .. 'Mode'
@@ -36,7 +36,7 @@ end
 --- Gets the highlight `group`.
 --- @param hl_name string
 --- @return table<string, any>
-M.get_highlight = function(hl_name)
+function M.get_highlight(hl_name)
   return vim.api.nvim_get_hl(0, { name = hl_name, link = false })
 end