refactor: rename themes options to highlights

Author: cpea2506

lua/one_monokai/config.lua

@@ -3,27 +3,46 @@ local config = {}
 ---@class options
 ---@field transparent boolean #Whether to enable transparent background
 ---@field colors colors #Custom colors
----@field themes fun(colors:colors):groups #Custom highlight groups
----@field italics boolean #Whether to italicize some highlight groups
+---@field highlights? fun(colors:colors):groups #Custom highlight groups
+---@field italics boolean #Whether to apply italics to certain highlight groups
 local defaults = {
     transparent = false,
     colors = {},
-    themes = function(_)
-        return {}
-    end,
+    ---@deprecated
+    themes = nil,
+    highlights = nil,
     italics = true,
 }
 
-config.options = vim.deepcopy(defaults)
+---@type options
+local options = vim.deepcopy(defaults)
 
 ---Extend default with user's config
 ---@param opts options
-function config:extend(opts)
-    self.options = vim.tbl_deep_extend("force", self.options, opts or {})
+function config.extend(opts)
+    if not opts or vim.tbl_isempty(opts) then
+        return
+    end
+
+    local logs = require "one_monokai.logs"
+
+    if opts.themes then
+        logs.notify.warning(
+            "config: %q option has been deprecated and will be removed soon. Please update your config to use %q instead.",
+            "themes",
+            "highlights"
+        )
+
+        opts.highlights = opts.themes
+    end
+
+    options = vim.tbl_deep_extend("force", options, opts)
 end
 
-return setmetatable(config, {
-    __index = function(_, key)
-        return config.options[key]
+setmetatable(config, {
+    __index = function(_, k)
+        return options[k]
     end,
 })
+
+return config

lua/one_monokai/themes/groups.lua renamed to lua/one_monokai/highlights/groups.lua

@@ -1,4 +1,4 @@
-local themes = {}
+local highlights = {}
 
 ---Set highlight groups
 ---@param groups groups
@@ -10,18 +10,21 @@ local function set_highlight(groups)
         local status_ok, err = pcall(set_hl, 0, name, attrs)
 
         if not status_ok then
-            logs.error.notify("themes(%s): %s", name, err)
+            logs.notify.error("highlights(%s): %s", name, err)
         end
     end
 end
 
-function themes.load()
+function highlights.load()
     local config = require "one_monokai.config"
     local colors = require "one_monokai.colors"
-    local default = require "one_monokai.themes.groups"
+    local default = require "one_monokai.highlights.groups"
 
     set_highlight(default)
-    set_highlight(config.themes(colors))
+
+    if config.highlights then
+        set_highlight(config.highlights(colors))
+    end
 end
 
-return themes
+return highlights

lua/one_monokai/themes/init.lua renamed to lua/one_monokai/highlights/init.lua

@@ -3,7 +3,7 @@ local M = {}
 function M.setup(opts)
     local set = vim.cmd
     local config = require "one_monokai.config"
-    local themes = require "one_monokai.themes"
+    local highlights = require "one_monokai.highlights"
 
     if vim.g.colors_name then
         set.hi "clear"
@@ -17,8 +17,8 @@ function M.setup(opts)
     vim.o.termguicolors = true
     vim.g.colors_name = "one_monokai"
 
-    config:extend(opts)
-    themes.load()
+    config.extend(opts)
+    highlights.load()
 end
 
 return M