refactor: replace camel case palette properties

scottmckendry · Feb 6, 2025 · cb717f8 · cb717f8
1 parent 05d44f6
commit cb717f8
Show file tree

Hide file tree

Showing 48 changed files with 177 additions and 181 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -51,7 +51,7 @@ function M.get(opts, t)
         -- Add your highlights here
         -- See lua/cyberdream/colors.lua for a complete list of available colors in the palette
         HighlightGroupName = { fg = t.blue },
-        AnotherHighlightGroupName = { fg = t.purple, bg = t.bgHighlight },
+        AnotherHighlightGroupName = { fg = t.purple, bg = t.bg_highlight },
     }
 
     return highlights

diff --git a/README.md b/README.md
@@ -266,8 +266,8 @@ vim.api.nvim_create_autocmd("User", {
 | 🖌                                                        | Hex       | Color       |
 | --------------------------------------------------------- | --------- | ----------- |
 | ![#16181a](https://place-hold.it/15/16181a/16181a?text=+) | `#16181a` | bg          |
-| ![#1e2124](https://place-hold.it/15/1e2124/1e2124?text=+) | `#1e2124` | bgAlt       |
-| ![#3c4048](https://place-hold.it/15/3c4048/3c4048?text=+) | `#3c4048` | bgHighlight |
+| ![#1e2124](https://place-hold.it/15/1e2124/1e2124?text=+) | `#1e2124` | bg_alt       |
+| ![#3c4048](https://place-hold.it/15/3c4048/3c4048?text=+) | `#3c4048` | bg_highlight |
 | ![#ffffff](https://place-hold.it/15/ffffff/ffffff?text=+) | `#ffffff` | fg          |
 | ![#7b8496](https://place-hold.it/15/7b8496/7b8496?text=+) | `#7b8496` | grey        |
 | ![#5ea1ff](https://place-hold.it/15/5ea1ff/5ea1ff?text=+) | `#5ea1ff` | blue        |
@@ -288,8 +288,8 @@ vim.api.nvim_create_autocmd("User", {
 | 🖌                                                        | Hex       | Color       |
 | --------------------------------------------------------- | --------- | ----------- |
 | ![#ffffff](https://place-hold.it/15/ffffff/ffffff?text=+) | `#ffffff` | bg          |
-| ![#eaeaea](https://place-hold.it/15/eaeaea/eaeaea?text=+) | `#eaeaea` | bgAlt       |
-| ![#acacac](https://place-hold.it/15/acacac/acacac?text=+) | `#acacac` | bgHighlight |
+| ![#eaeaea](https://place-hold.it/15/eaeaea/eaeaea?text=+) | `#eaeaea` | bg_alt       |
+| ![#acacac](https://place-hold.it/15/acacac/acacac?text=+) | `#acacac` | bg_highlight |
 | ![#16181a](https://place-hold.it/15/16181a/16181a?text=+) | `#16181a` | fg          |
 | ![#7b8496](https://place-hold.it/15/7b8496/7b8496?text=+) | `#7b8496` | grey        |
 | ![#0057d1](https://place-hold.it/15/0057d1/0057d1?text=+) | `#0057d1` | blue        |

diff --git a/doc/cyberdream.txt b/doc/cyberdream.txt
@@ -279,9 +279,9 @@ Dark ~
   ---------------------------------------------------- --------- -------------
   [#16181a]                                            #16181a   bg
 
-  [#1e2124]                                            #1e2124   bgAlt
+  [#1e2124]                                            #1e2124   bg_alt
 
-  [#3c4048]                                            #3c4048   bgHighlight
+  [#3c4048]                                            #3c4048   bg_highlight
 
   [#ffffff]                                            #ffffff   fg
 
@@ -312,9 +312,9 @@ Light ~
   ---------------------------------------------------- --------- -------------
   [#ffffff]                                            #ffffff   bg
 
-  [#eaeaea]                                            #eaeaea   bgAlt
+  [#eaeaea]                                            #eaeaea   bg_alt
 
-  [#acacac]                                            #acacac   bgHighlight
+  [#acacac]                                            #acacac   bg_highlight
 
   [#16181a]                                            #16181a   fg
 

diff --git a/doc/tags b/doc/tags
@@ -0,0 +1,11 @@
+cyberdream-configuring	cyberdream.txt	/*cyberdream-configuring*
+cyberdream-contributing	cyberdream.txt	/*cyberdream-contributing*
+cyberdream-extras	cyberdream.txt	/*cyberdream-extras*
+cyberdream-features	cyberdream.txt	/*cyberdream-features*
+cyberdream-installation	cyberdream.txt	/*cyberdream-installation*
+cyberdream-links	cyberdream.txt	/*cyberdream-links*
+cyberdream-palette	cyberdream.txt	/*cyberdream-palette*
+cyberdream-table-of-contents	cyberdream.txt	/*cyberdream-table-of-contents*
+cyberdream-usage	cyberdream.txt	/*cyberdream-usage*
+cyberdream-‍-recipes	cyberdream.txt	/*cyberdream-‍-recipes*
+cyberdream.txt	cyberdream.txt	/*cyberdream.txt*
diff --git a/extras/helix/cyberdream-light.toml b/extras/helix/cyberdream-light.toml
@@ -6,7 +6,7 @@
 "ui.statusline" = { fg = "cyan" }
 "ui.selection" = "green"
 "ui.selection.primary" = "magenta"
-"ui.virtual.ruler" = { bg = "bgHighlight" }
+"ui.virtual.ruler" = { bg = "bg_highlight" }
 
 # Syntax Highlighting for Code
 "comment" = { fg = "grey", modifiers = ["italic"] }
@@ -41,10 +41,10 @@
 "label" = "red"
 
 # Interface specific
-"ui.cursorline.primary" = { bg = "bgHighlight" }
-"ui.cursorline.secondary" = { bg = "bgAlt" }
-"ui.cursorcolumn.primary" = { bg = "bgHighlight" }
-"ui.cursorcolumn.secondary" = { bg = "bgAlt" }
+"ui.cursorline.primary" = { bg = "bg_highlight" }
+"ui.cursorline.secondary" = { bg = "bg_alt" }
+"ui.cursorcolumn.primary" = { bg = "bg_highlight" }
+"ui.cursorcolumn.secondary" = { bg = "bg_alt" }
 "ui.statusline.normal" = { fg = "fg", bg = "bg" }
 "ui.statusline.insert" = { fg = "green", bg = "bg" }
 "ui.statusline.select" = { fg = "blue", bg = "bg" }
@@ -63,7 +63,7 @@
 
 # Popups and Menus
 "ui.popup" = { fg = "fg", bg = "bg" }
-"ui.popup.info" = { fg = "cyan", bg = "bgAlt" }
+"ui.popup.info" = { fg = "cyan", bg = "bg_alt" }
 "ui.menu" = { fg = "fg", bg = "bg" }
 "ui.menu.selected" = { fg = "bg", bg = "fg" }
 
@@ -84,5 +84,5 @@ magenta = "#d100bf"
 pink = "#f40064"
 orange = "#d17c00"
 purple = "#a018ff"
-bgAlt = "#eaeaea"
-bgHighlight = "#acacac"
+bg_alt = "#eaeaea"
+bg_highlight = "#acacac"
diff --git a/extras/helix/cyberdream.toml b/extras/helix/cyberdream.toml
@@ -6,7 +6,7 @@
 "ui.statusline" = { fg = "cyan" }
 "ui.selection" = "green"
 "ui.selection.primary" = "magenta"
-"ui.virtual.ruler" = { bg = "bgHighlight" }
+"ui.virtual.ruler" = { bg = "bg_highlight" }
 
 # Syntax Highlighting for Code
 "comment" = { fg = "grey", modifiers = ["italic"] }
@@ -41,10 +41,10 @@
 "label" = "red"
 
 # Interface specific
-"ui.cursorline.primary" = { bg = "bgHighlight" }
-"ui.cursorline.secondary" = { bg = "bgAlt" }
-"ui.cursorcolumn.primary" = { bg = "bgHighlight" }
-"ui.cursorcolumn.secondary" = { bg = "bgAlt" }
+"ui.cursorline.primary" = { bg = "bg_highlight" }
+"ui.cursorline.secondary" = { bg = "bg_alt" }
+"ui.cursorcolumn.primary" = { bg = "bg_highlight" }
+"ui.cursorcolumn.secondary" = { bg = "bg_alt" }
 "ui.statusline.normal" = { fg = "fg", bg = "bg" }
 "ui.statusline.insert" = { fg = "green", bg = "bg" }
 "ui.statusline.select" = { fg = "blue", bg = "bg" }
@@ -63,7 +63,7 @@
 
 # Popups and Menus
 "ui.popup" = { fg = "fg", bg = "bg" }
-"ui.popup.info" = { fg = "cyan", bg = "bgAlt" }
+"ui.popup.info" = { fg = "cyan", bg = "bg_alt" }
 "ui.menu" = { fg = "fg", bg = "bg" }
 "ui.menu.selected" = { fg = "bg", bg = "fg" }
 
@@ -84,5 +84,5 @@ magenta = "#ff5ef1"
 pink = "#ff5ea0"
 orange = "#ffbd5e"
 purple = "#bd5eff"
-bgAlt = "#1e2124"
-bgHighlight = "#3c4048"
+bg_alt = "#1e2124"
+bg_highlight = "#3c4048"
diff --git a/lua/cyberdream/colors.lua b/lua/cyberdream/colors.lua
@@ -1,7 +1,7 @@
 ---@class CyberdreamPalette
 ---@field bg string
----@field bgAlt string
----@field bgHighlight string
+---@field bg_alt string
+---@field bg_highlight string
 ---@field bg_solid? string
 ---@field fg string
 ---@field grey string
@@ -22,8 +22,8 @@ local M = {}
 
 M.default = {
     bg = "#16181a",
-    bgAlt = "#1e2124",
-    bgHighlight = "#3c4048",
+    bg_alt = "#1e2124",
+    bg_highlight = "#3c4048",
     fg = "#ffffff",
     grey = "#7b8496",
     blue = "#5ea1ff",
@@ -39,8 +39,8 @@ M.default = {
 
 M.light = {
     bg = "#ffffff",
-    bgAlt = "#eaeaea",
-    bgHighlight = "#acacac",
+    bg_alt = "#eaeaea",
+    bg_highlight = "#acacac",
     fg = "#16181a",
     grey = "#7b8496",
     blue = "#0057d1",

diff --git a/lua/cyberdream/extensions/base.lua b/lua/cyberdream/extensions/base.lua
@@ -8,13 +8,13 @@ function M.get(opts, t)
     opts = opts or {}
     local highlights = {
         Comment = { fg = t.grey, italic = opts.italic_comments },
-        ColorColumn = { bg = t.bgHighlight },
+        ColorColumn = { bg = t.bg_highlight },
         Conceal = { fg = t.grey },
         Cursor = { fg = t.bg, bg = t.fg },
         ICursor = { fg = t.bg, bg = t.fg },
         CursorIM = { fg = t.bg, bg = t.fg },
-        CursorColumn = { bg = t.bgHighlight },
-        CursorLine = { bg = t.bgHighlight },
+        CursorColumn = { bg = t.bg_highlight },
+        CursorLine = { bg = t.bg_highlight },
         Directory = { fg = t.blue },
         DiffAdd = { bg = util.blend(t.bg_solid, t.green, 0.8) },
         DiffChange = { bg = util.blend(t.bg_solid, t.blue, 0.8) },
@@ -24,16 +24,16 @@ function M.get(opts, t)
         Removed = { fg = t.red },
         EndOfBuffer = { fg = t.bg },
         ErrorMsg = { fg = t.red },
-        VertSplit = { fg = t.bgHighlight, bg = t.bg },
-        WinSeparator = { fg = t.bgHighlight, bg = t.bg },
+        VertSplit = { fg = t.bg_highlight, bg = t.bg },
+        WinSeparator = { fg = t.bg_highlight, bg = t.bg },
         Folded = { fg = t.grey, bg = t.bg },
         FoldColumn = { fg = t.grey, bg = t.bg },
         SignColumn = { fg = t.grey, bg = t.bg },
         SignColumnSB = { fg = t.grey, bg = t.bg },
-        Substitute = { fg = t.red, bg = t.bgHighlight },
-        LineNr = { fg = util.blend(t.bgHighlight, t.fg, 0.9) },
+        Substitute = { fg = t.red, bg = t.bg_highlight },
+        LineNr = { fg = util.blend(t.bg_highlight, t.fg, 0.9) },
         CursorLineNr = { fg = t.grey },
-        MatchParen = { fg = t.pink, bg = t.bgHighlight },
+        MatchParen = { fg = t.pink, bg = t.bg_highlight },
         ModeMsg = { fg = t.fg },
         MsgArea = { fg = t.fg },
         MoreMsg = { fg = t.blue },
@@ -42,16 +42,16 @@ function M.get(opts, t)
         NormalNC = { fg = t.fg, bg = t.bg },
         NormalFloat = { fg = t.fg, bg = t.bg },
         FloatTitle = { fg = t.cyan, bg = t.bg },
-        FloatBorder = { fg = t.bgHighlight, bg = t.bg },
+        FloatBorder = { fg = t.bg_highlight, bg = t.bg },
         Pmenu = { fg = t.fg, bg = t.bg },
-        PmenuSel = { fg = t.fg, bg = t.bgHighlight },
-        PmenuSbar = { fg = t.bg, bg = t.bgHighlight },
-        PmenuThumb = { fg = t.bg, bg = t.bgHighlight },
+        PmenuSel = { fg = t.fg, bg = t.bg_highlight },
+        PmenuSbar = { fg = t.bg, bg = t.bg_highlight },
+        PmenuThumb = { fg = t.bg, bg = t.bg_highlight },
         Question = { fg = t.yellow },
-        QuickFixLine = { bg = t.bgHighlight },
-        Search = { fg = t.bgAlt, bg = t.fg },
-        IncSearch = { fg = t.bgAlt, bg = t.cyan },
-        CurSearch = { fg = t.bgAlt, bg = t.cyan },
+        QuickFixLine = { bg = t.bg_highlight },
+        Search = { fg = t.bg_alt, bg = t.fg },
+        IncSearch = { fg = t.bg_alt, bg = t.cyan },
+        CurSearch = { fg = t.bg_alt, bg = t.cyan },
         SpecialKey = { fg = t.grey },
         SpellBad = { sp = t.red, undercurl = true },
         SpellCap = { sp = t.yellow, undercurl = true },
@@ -61,14 +61,14 @@ function M.get(opts, t)
         StatusLineNC = { fg = t.grey, bg = t.bg },
         TabLine = { fg = t.grey, bg = t.bg },
         TabLineFill = { fg = t.grey, bg = t.bg },
-        TabLineSel = { fg = t.fg, bg = t.bgHighlight },
+        TabLineSel = { fg = t.fg, bg = t.bg_highlight },
         WinBar = { fg = t.fg, bg = t.bg },
         WinBarNC = { fg = t.grey, bg = t.bg },
         Title = { fg = t.fg },
-        Visual = { bg = t.bgHighlight },
-        VisualNOS = { bg = t.bgHighlight },
+        Visual = { bg = t.bg_highlight },
+        VisualNOS = { bg = t.bg_highlight },
         WarningMsg = { fg = t.orange },
-        Whitespace = { fg = t.bgHighlight },
+        Whitespace = { fg = t.bg_highlight },
         WildMenu = { fg = t.bg, bg = t.blue },
 
         Constant = { fg = t.pink },
@@ -120,9 +120,9 @@ function M.get(opts, t)
         markdownH6 = { fg = t.green, bold = true },
         markdownLinkText = { fg = t.blue, underline = true },
 
-        LspReferenceText = { bg = t.bgHighlight },
-        LspReferenceRead = { bg = t.bgHighlight },
-        LspReferenceWrite = { bg = t.bgHighlight },
+        LspReferenceText = { bg = t.bg_highlight },
+        LspReferenceRead = { bg = t.bg_highlight },
+        LspReferenceWrite = { bg = t.bg_highlight },
 
         DiagnosticError = { fg = t.red },
         DiagnosticWarn = { fg = t.yellow },

diff --git a/lua/cyberdream/extensions/blinkcmp.lua b/lua/cyberdream/extensions/blinkcmp.lua
@@ -8,8 +8,8 @@ function M.get(opts, t)
     opts = opts or {}
     local highlights = {
         BlinkCmpMenu = { link = "Pmenu" },
-        BlinkCmpMenuBorder = { fg = util.blend(t.bgHighlight, t.grey, 0.7) },
-        BlinkCmpMenuSelection = { bg = t.bgHighlight },
+        BlinkCmpMenuBorder = { fg = util.blend(t.bg_highlight, t.grey, 0.7) },
+        BlinkCmpMenuSelection = { bg = t.bg_highlight },
         BlinkCmpLabel = { fg = t.fg },
         BlinkCmpLabelDeprecated = { fg = t.grey, strikethrough = true },
         BlinkCmpLabelMatch = { fg = t.cyan },

diff --git a/lua/cyberdream/extensions/fzflua.lua b/lua/cyberdream/extensions/fzflua.lua
@@ -7,15 +7,15 @@ function M.get(opts, t)
     opts = opts or {}
 
     local highlights = {
-        FzfLuaNormal = { bg = t.bgAlt },
-        FzfLuaPreviewNormal = { bg = t.bgAlt },
-        FzfLuaBorder = { fg = t.bgAlt, bg = t.bgAlt },
-        FzfLuaTitle = { bg = t.blue, fg = t.bgAlt },
+        FzfLuaNormal = { bg = t.bg_alt },
+        FzfLuaPreviewNormal = { bg = t.bg_alt },
+        FzfLuaBorder = { fg = t.bg_alt, bg = t.bg_alt },
+        FzfLuaTitle = { bg = t.blue, fg = t.bg_alt },
 
         FzfLuaFzfMatch = { fg = t.cyan },
         FzfLuaFzfQuery = { fg = t.blue },
         FzfLuaFzfPrompt = { fg = t.fg },
-        FzfLuaFzfGutter = { bg = t.bgAlt },
+        FzfLuaFzfGutter = { bg = t.bg_alt },
         FzfLuaFzfPointer = { fg = t.pink },
         FzfLuaFzfHeader = { fg = t.purple },
         FzfLuaFzfInfo = { fg = t.cyan },

diff --git a/lua/cyberdream/extensions/grapple.lua b/lua/cyberdream/extensions/grapple.lua
@@ -13,9 +13,9 @@ function M.get(opts, t)
 
     -- Inherit borderless theme from telescope (if enabled)
     if opts.borderless_telescope then
-        highlights.GrappleNormal = { bg = t.bgAlt }
-        highlights.GrappleBorder = { fg = t.bgAlt, bg = t.bgAlt }
-        highlights.GrappleTitle = { fg = t.bgAlt, bg = t.cyan }
+        highlights.GrappleNormal = { bg = t.bg_alt }
+        highlights.GrappleBorder = { fg = t.bg_alt, bg = t.bg_alt }
+        highlights.GrappleTitle = { fg = t.bg_alt, bg = t.cyan }
     end
 
     return highlights

diff --git a/lua/cyberdream/extensions/grugfar.lua b/lua/cyberdream/extensions/grugfar.lua
@@ -15,7 +15,7 @@ function M.get(opts, t)
         GrugFarHelpWinActionDescription = { link = "Comment" },
 
         GrugFarInputLabel = { fg = t.orange, bold = true },
-        GrugFarInputPlaceholder = { fg = util.blend(t.bgHighlight, t.fg, 0.9), italic = true },
+        GrugFarInputPlaceholder = { fg = util.blend(t.bg_highlight, t.fg, 0.9), italic = true },
 
         GrugFarResultsHeader = { link = "Comment" },
         GrugFarResultsStats = { fg = t.yellow },

diff --git a/lua/cyberdream/extensions/helpview.lua b/lua/cyberdream/extensions/helpview.lua
@@ -13,9 +13,9 @@ function M.get(opts, t)
         HelpviewHeading3 = { fg = t.purple, bg = util.blend(t.bg_solid, t.purple, 0.8), bold = true },
         HelpviewHeading4 = { fg = t.magenta, bg = util.blend(t.bg_solid, t.magenta, 0.8), bold = true },
 
-        HelpviewCode = { bg = t.bgAlt },
+        HelpviewCode = { bg = t.bg_alt },
         HelpviewInlineCode = { link = "HelpviewCode" },
-        HelpviewCodeLanguage = { fg = t.grey, bg = t.bgAlt, italic = true },
+        HelpviewCodeLanguage = { fg = t.grey, bg = t.bg_alt, italic = true },
 
         HelpviewTaglink = { fg = t.blue },
         HelpviewOptionlink = { fg = util.blend(t.cyan, t.magenta, 0.4) },

diff --git a/lua/cyberdream/extensions/hop.lua b/lua/cyberdream/extensions/hop.lua
@@ -14,8 +14,8 @@ function M.get(opts, t)
             bg = util.blend(t.bg_solid, t.cyan, 0.9),
             bold = true,
         },
-        HopUnmatched = { fg = t.bgHighlight },
-        HopPreview = { fg = t.fg, bg = t.bgHighlight },
+        HopUnmatched = { fg = t.bg_highlight },
+        HopPreview = { fg = t.fg, bg = t.bg_highlight },
     }
     return highlights
 end

diff --git a/lua/cyberdream/extensions/indentblankline.lua b/lua/cyberdream/extensions/indentblankline.lua
@@ -7,8 +7,8 @@ local M = {}
 function M.get(opts, t)
     opts = opts or {}
     local highlights = {
-        IblIndent = { fg = util.blend(t.bgHighlight, t.bgAlt, 0.3) },
-        IblScope = { fg = t.bgHighlight },
+        IblIndent = { fg = util.blend(t.bg_highlight, t.bg_alt, 0.3) },
+        IblScope = { fg = t.bg_highlight },
     }
 
     return highlights

diff --git a/lua/cyberdream/extensions/lazy.lua b/lua/cyberdream/extensions/lazy.lua
@@ -8,8 +8,8 @@ function M.get(opts, t)
     local highlights = {
         LazyH1 = { fg = t.blue, bold = true },
         LazyH2 = { fg = t.fg, bold = true },
-        LazyButton = { fg = t.fg, bg = t.bgHighlight },
-        LazyButtonActive = { fg = t.fg, bg = t.bgHighlight, bold = true },
+        LazyButton = { fg = t.fg, bg = t.bg_highlight },
+        LazyButtonActive = { fg = t.fg, bg = t.bg_highlight, bold = true },
 
         LazyProgressDone = { bold = true, fg = t.magenta },
         LazyProgressTodo = { bold = true, fg = t.grey },

diff --git a/lua/cyberdream/extensions/leap.lua b/lua/cyberdream/extensions/leap.lua
@@ -9,7 +9,7 @@ function M.get(opts, t)
         LeapMatch = { fg = t.fg, bg = t.magenta },
         LeapLabelPrimary = { fg = t.blue, bg = t.bg, bold = true },
         LeapLabelSecondary = { fg = t.green, bg = t.bg },
-        LeapBackdrop = { fg = t.bgHighlight },
+        LeapBackdrop = { fg = t.bg_highlight },
     }
 
     return highlights

diff --git a/lua/cyberdream/extensions/markdown.lua b/lua/cyberdream/extensions/markdown.lua
@@ -21,7 +21,7 @@ function M.get(opts, t)
         RenderMarkdownH5Bg = { bg = util.blend(t.bg_solid, t.magenta, 0.85) },
         RenderMarkdownH6Bg = { bg = util.blend(t.bg_solid, t.green, 0.85) },
 
-        RenderMarkdownCode = { bg = t.bgAlt },
+        RenderMarkdownCode = { bg = t.bg_alt },
         RenderMarkdownBullet = { fg = t.grey },
         RenderMarkdownQuote = { link = "Comment" },
         RenderMarkdownDash = { fg = t.grey },