Breaking changes for V5 ⚠️

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

README.md

@@ -138,54 +138,57 @@ Below is an example of all the available configuration options with their defaul
 
 ```lua
 require("cyberdream").setup({
+    -- Set light or dark variant
+    variant = "default", -- use "light" for the light variant. Also accepts "auto" to set dark or light colors based on the current value of `vim.o.background`
+
     -- Enable transparent background
     transparent = false,
 
+    -- Reduce the overall saturation of colours for a more muted look
+    saturation = 1, -- accepts a value between 0 and 1. 0 will be fully desaturated (greyscale) and 1 will be the full color (default)
+
     -- Enable italics comments
     italic_comments = false,
 
     -- Replace all fillchars with ' ' for the ultimate clean look
     hide_fillchars = false,
 
-    -- Modern borderless telescope theme - also applies to fzf-lua
-    borderless_telescope = true,
+    -- Apply a modern borderless look to pickers like Telescope, Snacks Picker & Fzf-Lua
+    borderless_pickers = false,
 
     -- Set terminal colors used in `:terminal`
     terminal_colors = true,
 
     -- Improve start up time by caching highlights. Generate cache with :CyberdreamBuildCache and clear with :CyberdreamClearCache
     cache = false,
 
-    theme = {
-        variant = "default", -- use "light" for the light variant. Also accepts "auto" to set dark or light colors based on the current value of `vim.o.background`
-        saturation = 1, -- accepts a value between 0 and 1. 0 will be fully desaturated (greyscale) and 1 will be the full color (default)
-        highlights = {
-            -- Highlight groups to override, adding new groups is also possible
-            -- See `:h highlight-groups` for a list of highlight groups or run `:hi` to see all groups and their current values
+    -- Override highlight groups with your own colour values
+    highlights = {
+        -- Highlight groups to override, adding new groups is also possible
+        -- See `:h highlight-groups` for a list of highlight groups or run `:hi` to see all groups and their current values
 
-            -- Example:
-            Comment = { fg = "#696969", bg = "NONE", italic = true },
+        -- Example:
+        Comment = { fg = "#696969", bg = "NONE", italic = true },
 
-            -- Complete list can be found in `lua/cyberdream/theme.lua`
-        },
+        -- More examples can be found in `lua/cyberdream/extensions/*.lua`
+    },
 
-        -- Override a highlight group entirely using the color palette
-        overrides = function(colors) -- NOTE: This function nullifies the `highlights` option
-            -- Example:
-            return {
-                Comment = { fg = colors.green, bg = "NONE", italic = true },
-                ["@property"] = { fg = colors.magenta, bold = true },
-            }
-        end,
-
-        -- Override a color entirely
-        colors = {
-            -- For a list of colors see `lua/cyberdream/colours.lua`
-            -- Example:
-            bg = "#000000",
-            green = "#00ff00",
-            magenta = "#ff00ff",
-        },
+    -- Override a highlight group entirely using the built-in colour palette
+    overrides = function(colors) -- NOTE: This function nullifies the `highlights` option
+        -- Example:
+        return {
+            Comment = { fg = colors.green, bg = "NONE", italic = true },
+            ["@property"] = { fg = colors.magenta, bold = true },
+        }
+    end,
+
+    -- Override a color entirely
+    colors = {
+        -- For a list of colors see `lua/cyberdream/colours.lua`
+        -- Example:
+        bg = "#000000",
+        green = "#00ff00",
+        magenta = "#ff00ff",
     },
 
     -- Disable or enable colorscheme extensions
@@ -263,44 +266,44 @@ vim.api.nvim_create_autocmd("User", {
 <details>
 <summary><b>Dark</b></summary>
 
-| 🖌                                                        | 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 |
-| ![#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        |
-| ![#5eff6c](https://place-hold.it/15/5eff6c/5eff6c?text=+) | `#5eff6c` | green       |
-| ![#5ef1ff](https://place-hold.it/15/5ef1ff/5ef1ff?text=+) | `#5ef1ff` | cyan        |
-| ![#ff6e5e](https://place-hold.it/15/ff6e5e/ff6e5e?text=+) | `#ff6e5e` | red         |
-| ![#f1ff5e](https://place-hold.it/15/f1ff5e/f1ff5e?text=+) | `#f1ff5e` | yellow      |
-| ![#ff5ef1](https://place-hold.it/15/ff5ef1/ff5ef1?text=+) | `#ff5ef1` | magenta     |
-| ![#ff5ea0](https://place-hold.it/15/ff5ea0/ff5ea0?text=+) | `#ff5ea0` | pink        |
-| ![#ffbd5e](https://place-hold.it/15/ffbd5e/ffbd5e?text=+) | `#ffbd5e` | orange      |
-| ![#bd5eff](https://place-hold.it/15/bd5eff/bd5eff?text=+) | `#bd5eff` | purple      |
+| 🖌                                                        | Hex       | Color        |
+| --------------------------------------------------------- | --------- | ------------ |
+| ![#16181a](https://place-hold.it/15/16181a/16181a?text=+) | `#16181a` | bg           |
+| ![#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         |
+| ![#5eff6c](https://place-hold.it/15/5eff6c/5eff6c?text=+) | `#5eff6c` | green        |
+| ![#5ef1ff](https://place-hold.it/15/5ef1ff/5ef1ff?text=+) | `#5ef1ff` | cyan         |
+| ![#ff6e5e](https://place-hold.it/15/ff6e5e/ff6e5e?text=+) | `#ff6e5e` | red          |
+| ![#f1ff5e](https://place-hold.it/15/f1ff5e/f1ff5e?text=+) | `#f1ff5e` | yellow       |
+| ![#ff5ef1](https://place-hold.it/15/ff5ef1/ff5ef1?text=+) | `#ff5ef1` | magenta      |
+| ![#ff5ea0](https://place-hold.it/15/ff5ea0/ff5ea0?text=+) | `#ff5ea0` | pink         |
+| ![#ffbd5e](https://place-hold.it/15/ffbd5e/ffbd5e?text=+) | `#ffbd5e` | orange       |
+| ![#bd5eff](https://place-hold.it/15/bd5eff/bd5eff?text=+) | `#bd5eff` | purple       |
 
 </details>
 
 <details>
 <summary><b>Light</b></summary>
 
-| 🖌                                                        | 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 |
-| ![#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        |
-| ![#008b0c](https://place-hold.it/15/008b0c/008b0c?text=+) | `#008b0c` | green       |
-| ![#008c99](https://place-hold.it/15/008c99/008c99?text=+) | `#008c99` | cyan        |
-| ![#d11500](https://place-hold.it/15/d11500/d11500?text=+) | `#d11500` | red         |
-| ![#997b00](https://place-hold.it/15/997b00/997b00?text=+) | `#997b00` | yellow      |
-| ![#d100bf](https://place-hold.it/15/d100bf/d100bf?text=+) | `#d100bf` | magenta     |
-| ![#f40064](https://place-hold.it/15/f40064/f40064?text=+) | `#f40064` | pink        |
-| ![#d17c00](https://place-hold.it/15/d17c00/d17c00?text=+) | `#d17c00` | orange      |
-| ![#a018ff](https://place-hold.it/15/a018ff/a018ff?text=+) | `#a018ff` | purple      |
+| 🖌                                                        | Hex       | Color        |
+| --------------------------------------------------------- | --------- | ------------ |
+| ![#ffffff](https://place-hold.it/15/ffffff/ffffff?text=+) | `#ffffff` | bg           |
+| ![#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         |
+| ![#008b0c](https://place-hold.it/15/008b0c/008b0c?text=+) | `#008b0c` | green        |
+| ![#008c99](https://place-hold.it/15/008c99/008c99?text=+) | `#008c99` | cyan         |
+| ![#d11500](https://place-hold.it/15/d11500/d11500?text=+) | `#d11500` | red          |
+| ![#997b00](https://place-hold.it/15/997b00/997b00?text=+) | `#997b00` | yellow       |
+| ![#d100bf](https://place-hold.it/15/d100bf/d100bf?text=+) | `#d100bf` | magenta      |
+| ![#f40064](https://place-hold.it/15/f40064/f40064?text=+) | `#f40064` | pink         |
+| ![#d17c00](https://place-hold.it/15/d17c00/d17c00?text=+) | `#d17c00` | orange       |
+| ![#a018ff](https://place-hold.it/15/a018ff/a018ff?text=+) | `#a018ff` | purple       |
 
 </details>
 

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
 

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*

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"

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"

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",