breaking: colorbuddy 2.0 (tjdevries#38)

Update to better version :) Sorry if this broke anything for you, just use tag 1.0.0 :)

Author: tjdevries

BREAKING.md

@@ -0,0 +1,19 @@
+# Breaking Changes
+
+### v2
+
+These are the following breaking changes moving from previous version
+into the new v2 branch. If I have to make bad breaking changes again in
+the future, then we'll move to `v3` i guess
+
+- now requires latest neovim 0.8 (as of august 17)
+- now uses "@<group>" names primarily
+
+- Color.new
+  - Now only accepts string `#RRGGBB` OR `ColorbuddyHSL` OR `ColorbuddyRGB`
+  - Old usages of `Color.new("name", "#ffffff")` will still work (which was as many as I could find)
+- Color:new_child
+  - If you were using this (not thinking anyone actually was though, it wasn't really required)
+    then you need to now pass modifiers as a table.
+
+

README.md

@@ -1,11 +1,22 @@
 # colorbuddy.nvim
 
+NOTE: now requires neovim 0.9 or nightly
+
 A colorscheme helper for Neovim.
 
 Written in Lua! Quick & Easy Color Schemes :smile:
 
 Sincerely, your color buddy.
 
+
+# Basic Usage
+
+```lua
+vim.cmd.colorscheme("colorbuddy")
+-- or
+vim.cmd.colorscheme("gruvbuddy")
+```
+
 ## Example
 
 Your color buddy for making cool neovim color schemes. Write your colorscheme in lua!
@@ -15,7 +26,19 @@ You can see one example for gruvbox-esque styles [here](https://github.com/tjdev
 Example:
 
 ```lua
-local Color, colors, Group, groups, styles = require('colorbuddy').setup()
+-- file: colors/my-colorscheme-name.lua
+
+local colorbuddy = require('colorbuddy')
+
+-- Set up your custom colorscheme if you want
+colorbuddy.colorscheme("my-colorscheme-name")
+
+-- And then modify as you like
+local Color = colorbuddy.Color
+local colors = colorbuddy.colors
+local Group = colorbuddy.Group
+local groups = colorbuddy.groups
+local styles = colorbuddy.styles
 
 -- Use Color.new(<name>, <#rrggbb>) to create new colors
 -- They can be accessed through colors.<name>
@@ -30,15 +53,6 @@ Group.new('luaFunctionCall' , groups.Function    , groups.Function   , groups.Fu
 
 -- Define highlights in relative terms of other colors
 Group.new('Error'           , colors.red:light() , nil               , s.bold)
-```
-
-
-### Advanced Examples
-
-```lua
--- Optionally, you can just use the globals created when calling `setup()`
--- No need to declare new locals
-require('colorbuddy').setup()
 
 -- If you want multiple styles, just add them!
 Group.new('italicBoldFunction', colors.green, groups.Function, styles.bold + styles.italic)

colors/colorbuddy.lua

@@ -0,0 +1 @@
+require("colorbuddy").colorscheme("colorbuddy")

colors/gruvbuddy.lua

@@ -0,0 +1,42 @@
+require("colorbuddy").colorscheme("gruvbuddy")
+
+local colorbuddy = require("colorbuddy")
+local Color = colorbuddy.Color
+local Group = colorbuddy.Group
+local c = colorbuddy.colors
+local g = colorbuddy.groups
+local s = colorbuddy.styles
+
+Color.new("white", "#f2e5bc")
+Color.new("red", "#cc6666")
+Color.new("pink", "#fef601")
+Color.new("green", "#99cc99")
+Color.new("yellow", "#f8fe7a")
+Color.new("blue", "#81a2be")
+Color.new("aqua", "#8ec07c")
+Color.new("cyan", "#8abeb7")
+Color.new("purple", "#8e6fbd")
+Color.new("violet", "#b294bb")
+Color.new("orange", "#de935f")
+Color.new("brown", "#a3685a")
+
+Color.new("seagreen", "#698b69")
+Color.new("turquoise", "#698b69")
+
+local background_string = "#111111"
+Color.new("background", background_string)
+Color.new("gray0", background_string)
+
+Group.new("Normal", c.superwhite, c.gray0)
+
+Group.new("@constant", c.orange, nil, s.none)
+Group.new("@function", c.yellow, nil, s.none)
+Group.new("@function.bracket", g.Normal, g.Normal)
+Group.new("@keyword", c.violet, nil, s.none)
+Group.new("@keyword.faded", g.nontext.fg:light(), nil, s.none)
+Group.new("@property", c.blue)
+Group.new("@variable", c.superwhite, nil)
+Group.new("@variable.builtin", c.purple:light():light(), g.Normal)
+
+-- I've always liked lua function calls to be blue. I don't know why.
+Group.new("@function.call.lua", c.blue:dark(), nil, nil)

example/colorscheme.lua

@@ -1,23 +1,26 @@
+if true then
+  return
+end
 
-local Color = require('colorbuddy.init').Color
-local colors = require('colorbuddy.init').colors
+local Color = require("colorbuddy.init").Color
+local colors = require("colorbuddy.init").colors
 
-local Group = require('colorbuddy.init').Group
-local groups = require('colorbuddy.init').groups
+local Group = require("colorbuddy.init").Group
+local groups = require("colorbuddy.init").groups
 
-local styles = require('colorbuddy.init').styles
+local styles = require("colorbuddy.init").styles
 
-Color.new('red', '#cc6666')
-Color.new('green', '#99cc99')
-Color.new('yellow', '#f0c674')
-Color.new('background', '#1d1f21')
+Color.new("red", "#cc6666")
+Color.new("green", "#99cc99")
+Color.new("yellow", "#f0c674")
+Color.new("background", "#1d1f21")
 
-Group.new('Function', colors.yellow, colors.background, styles.bold)
-Group.new('mFunction', groups.Function, groups.Function, groups.Function)
+Group.new("Function", colors.yellow, colors.background, styles.bold)
+Group.new("mFunction", groups.Function, groups.Function, groups.Function)
 
 -- If you want multiple styles, just add them!
-Group.new('italicBoldFunction', groups.Function, colors.background, styles.bold + styles.italic)
+Group.new("italicBoldFunction", groups.Function, colors.background, styles.bold + styles.italic)
 
 -- If you want the same style as a different group, but without a style
 -- just subtract it!
-Group.new('boldFunction', colors.yellow, colors.yellow, groups.italicBoldFunction - styles.italic)
+Group.new("boldFunction", colors.yellow, colors.yellow, groups.italicBoldFunction - styles.italic)

lua/colorbuddy/actions.lua

@@ -1,31 +1,33 @@
-local _c = require("colorbuddy.color")
-local Color = require("colorbuddy.color").Color
 local colors = require("colorbuddy.color").colors
 
-local log = require("colorbuddy.log")
-
 local actions = {}
 
-actions.lighter = function()
+local global_apply = function(modifier)
   local updated = {}
 
   for _, c in pairs(colors) do
     if not updated[c] then
-      updated = Color.modifier_apply(c, "light")
+      -- Get to the root of all the nodes
+      local val = c
+      while val.parent do
+        val = val.parent
+      end
+
+      if not updated[val] then
+        vim.tbl_extend("force", updated, val:modifier_apply({ modifier }, updated))
+      end
+
+      assert(updated[c], "must have encountered color at some point")
     end
   end
 end
 
-actions.darker = function()
-  local updated = {}
+actions.lighter = function()
+  global_apply("light")
+end
 
-  for _, c in pairs(colors) do
-    if not updated[c] then
-      updated = Color.modifier_apply(c, "dark")
-    end
-  end
+actions.darker = function()
+  global_apply("dark")
 end
 
-return {
-  actions = actions,
-}
+return actions