Port over bezhermoso/base16-live-reload functionality (#6)

bezhermoso · JamyGolden · web-flow · commit 924cc650dfc5 · 2025-04-20T11:41:11.000-07:00
* doc: update README
* chore: rebuild themes &amp; docs

Co-authored-by: Jamy &lt;code@jamygolden.com&gt;

* Apply suggestions from code review

Co-authored-by: Jamy &lt;code@jamygolden.com&gt;

* Update lua/tinted-live-reload.lua

Co-authored-by: Jamy &lt;code@jamygolden.com&gt;

* doc: fix typo

* fix: read output of `tinty config` better &amp; avoid newlines

---------

Co-authored-by: Jamy &lt;code@jamygolden.com&gt;
diff --git a/README.md b/README.md
@@ -97,10 +97,11 @@ optional arguments: a theme or a config table.
 
 ##### `supports` Options
 
-| Key            | Default | Description                                                                 |
-| -------------- | ------- | --------------------------------------------------------------------------- |
-| `tinty`        | `true`  | If `true`, attempts to use current [Tinty] theme if available               |
-| `tinted_shell` | `false` | If `true`, allows detection from `BASE16_THEME` env var (only outside tmux) |
+| Key            | Default | Description                                                                                |
+| -------------- | ------- | -------------------------------------------------------------------------------------------|
+| `tinty`        | `true`  | If `true`, attempts to use current [Tinty] theme if available                              |
+| `tinted_shell` | `false` | If `true`, allows detection from `BASE16_THEME` env var (only outside tmux)                |
+| `live_reload`  | `true`  | If `true`, open Neovim instances live reloads whenever [Tinty] applies a theme system-wide |
 
 ##### `highlights` Options
 
@@ -154,25 +155,35 @@ local red = require('tinted-colorscheme').colors.base08
 value, "tinted-nvim-default" (`base16-ayu-dark`) will be used as a fallback
 theme.
 
-To have tinted-nvim update the theme when `tinty apply ayu-dark` is run, you
-need to tell Neovim to update and the easiest way to do this is to update the
-theme when Neovim is given focus. The following will update the theme, on window
-focus, if the theme has changed:
+To have tinted-nvim automatically update the theme when `tinty apply ayu-dark` is run, you can enable
+the live-reload feature.
 
 ```lua
 local tinted = require('tinted-colorscheme')
-tinted.setup()
-
-vim.api.nvim_create_autocmd("FocusGained", {
-  callback = function() tinted.setup() end
+tinted.setup(nil, {
+  supports = {
+    live_reload = true
+  }
 })
 ```
 
-**Note**: If you don't see colours, try adding `vim.opt.termguicolors = true` to
-your init.lua
+The live-reload feature depends on [fwatch.nvim]. Add this dependency in whatever manner your plugin manager allows you.
+For example, with **lazy.nvim**:
 
-Have a look at [Tinted Gallery] for a preview of our themes.
+```diff
+ return {
+   "tinted-theming/tinted-nvim",
++  dependencies = {
++    { "rktjmp/fwatch.nvim" },
++  }
+ }
+```
+
+> ![NOTE]
+> If you don't see colours, try adding `vim.opt.termguicolors = true` to
+> your init.lua
 
+Have a look at [Tinted Gallery] for a preview of our themes.
 ## Advanced Usage
 
 ### Config
@@ -184,6 +195,7 @@ require('tinted-colorscheme').with_config({
     supports = {
       tinty = true,
       tinted_shell = false,
+      live_reload = false -- If set to true, requires rktjump/fwatch.nvim as a dependency
     },
     highlights = {
       telescope = true,
@@ -197,6 +209,19 @@ require('tinted-colorscheme').with_config({
 })
 ```
 
+### Autocmd
+
+```lua
+
+vim.api.nvim_create_autocmd("User", {
+  pattern = "TintedColorsPost",
+  callback = function()
+    -- Do things whenever the theme changes.
+    local colors = require("tinted-colorscheme").colors
+  end,
+})
+```
+
 ## 🗂️ Builtin Colorschemes
 
 You can use any of the following schemes with `:colorscheme` (for example
@@ -660,3 +685,4 @@ contributors for work they've done.
 [Tinty]: https://github.com/tinted-theming/tinty
 [Tinted Gallery]: https://tinted-theming.github.io/tinted-gallery/
 [base16-nvim]: https://github.com/RRethy/base16-nvim
+[fwatch.nvim]: https://github.com/rktjump/fwatch.nvim
diff --git a/lua/tinted-colorscheme.lua b/lua/tinted-colorscheme.lua
@@ -132,6 +132,7 @@ function M.with_config(config)
 
     local supports = vim.tbl_extend("force", {
         tinty = true,
+        live_reload = false,
         tinted_shell = false,
     }, config.supports or M.config.supports or {})
     local highlights = vim.tbl_extend("force", {
@@ -152,100 +153,11 @@ function M.with_config(config)
     }
 end
 
---- Creates a tinted colorscheme using the colors specified.
---
--- Builtin colorschemes can be found in the M.colorschemes table.
---
--- The default Vim highlight groups (including User[1-9]), highlight groups
--- pertaining to Neovim's builtin LSP, and highlight groups pertaining to
--- Treesitter will be defined.
---
--- It's worth noting that many colorschemes will specify language specific
--- highlight groups like rubyConstant or pythonInclude. However, I don't do
--- that here since these should instead be linked to an existing highlight
--- group.
---
--- @param colors (table) table with keys 'base00', 'base01', 'base02',
---   'base03', 'base04', 'base05', 'base06', 'base07', 'base08', 'base09',
---   'base0A', 'base0B', 'base0C', 'base0D', 'base0E', 'base0F'. Each key should
---   map to a valid 6 digit hex color. If a string is provided, the
---   corresponding table specifying the colorscheme will be used.
-function M.setup(colors, config)
-    M.with_config(config or {})
-
-    local current_colorscheme_name = vim.g.tinted_current_colorscheme;
-
-    if type('colors') == 'table' or colors == '' or colors == nil then
-        colors = M.colorschemes["tinted-nvim-default"]
-    elseif type('colors') == 'string' then
-        -- Return if the theme is being set to the same theme
-        if colors == current_colorscheme_name then
-          return
-        end
-
-        local ok, colorscheme = pcall(function()
-            vim.g.tinted_current_colorscheme = colors
-            return M.colorschemes[colors]
-        end)
-
-        if ok then
-            colors = colorscheme
-        else
-            vim.g.tinted_current_colorscheme = "tinted-nvim-default"
-            colors = M.colorschemes["tinted-nvim-default"]
-        end
-    end
-
-    if M.config.supports.tinty == true then
-        local current_tinty_theme = vim.trim(get_tinty_theme())
-
-        -- If the Tinty theme is not null
-        if current_tinty_theme ~= nil and current_tinty_theme ~= '' then
-            -- Set to Tinty theme if new theme name is different to already set
-            if current_tinty_theme ~= current_colorscheme_name then
-                -- Safely get colorscheme object from Tinty theme name
-                local ok, colorscheme = pcall(function()
-                    return M.colorschemes[current_tinty_theme]
-                end)
-
-                if ok then
-                    vim.g.tinted_current_colorscheme = current_tinty_theme
-                    vim.o.termguicolors = true
-                    vim.g.tinted_colorspace = 256
-                    colors = colorscheme
-                else
-                    vim.notify(
-                        string.format("Failed to load Tinty colorscheme '%s', falling back to default", current_tinty_theme),
-                        vim.log.levels.WARN
-                    )
-                end
-            -- Return if the theme is being set to the same theme
-            else
-                return
-            end
-        else
-            vim.notify(
-                string.format("Failed to load Tinty colorscheme '%s', falling back to default", current_tinty_theme),
-                vim.log.levels.WARN
-            )
-        end
-    -- Only trust BASE16_THEME if not inside a TMUX pane due to how TMUX handles env vars
-    elseif M.config.tinted_shell == true and vim.env.TMUX == nil and vim.env.BASE16_THEME ~= nil then
-        -- Safely get colorscheme object from BASE16_THEME env var
-        local ok, colorscheme = pcall(function()
-            return M.colorschemes[vim.env.BASE16_THEME]
-        end)
-
-        if ok then
-            vim.g.tinted_current_colorscheme = vim.env.BASE16_THEME
-            colors = colorscheme
-        end
-    end
-
-    if vim.fn.exists('syntax_on') then
-        vim.cmd('syntax reset')
-    end
+local function trigger_autocmd()
+  vim.cmd([[doautocmd User TintedColorsPost]])
+end
 
+local function set_colors(colors)
     M.colors                              = colors
 
     local hi                              = M.highlight
@@ -808,6 +720,123 @@ function M.setup(colors, config)
     vim.g.tinted_gui15      = M.colors.base15
     vim.g.tinted_gui16      = M.colors.base16
     vim.g.tinted_gui17      = M.colors.base17
+
+    trigger_autocmd()
+end
+
+local function detect_colors_from_tinty()
+        local current_tinty_theme = vim.trim(get_tinty_theme())
+
+        -- If the Tinty theme is not null
+        if current_tinty_theme ~= nil and current_tinty_theme ~= '' then
+            -- Set to Tinty theme if new theme name is different to already set
+            if current_tinty_theme ~= current_colorscheme_name then
+                -- Safely get colorscheme object from Tinty theme name
+                local ok, colorscheme = pcall(function()
+                    return M.colorschemes[current_tinty_theme]
+                end)
+
+                if ok then
+                    vim.g.tinted_current_colorscheme = current_tinty_theme
+                    vim.o.termguicolors = true
+                    vim.g.tinted_colorspace = 256
+                    return colorscheme
+                else
+                    vim.notify(
+                        string.format("Failed to load Tinty colorscheme '%s', falling back to default", current_tinty_theme),
+                        vim.log.levels.WARN
+                    )
+                end
+            -- Return if the theme is being set to the same theme
+            else
+                return
+            end
+        else
+            vim.notify(
+                string.format("Failed to load Tinty colorscheme '%s', falling back to default", current_tinty_theme),
+                vim.log.levels.WARN
+            )
+        end
+end
+
+--- Creates a tinted colorscheme using the colors specified.
+--
+-- Builtin colorschemes can be found in the M.colorschemes table.
+--
+-- The default Vim highlight groups (including User[1-9]), highlight groups
+-- pertaining to Neovim's builtin LSP, and highlight groups pertaining to
+-- Treesitter will be defined.
+--
+-- It's worth noting that many colorschemes will specify language specific
+-- highlight groups like rubyConstant or pythonInclude. However, I don't do
+-- that here since these should instead be linked to an existing highlight
+-- group.
+--
+-- @param colors (table) table with keys 'base00', 'base01', 'base02',
+--   'base03', 'base04', 'base05', 'base06', 'base07', 'base08', 'base09',
+--   'base0A', 'base0B', 'base0C', 'base0D', 'base0E', 'base0F'. Each key should
+--   map to a valid 6 digit hex color. If a string is provided, the
+--   corresponding table specifying the colorscheme will be used.
+function M.setup(colors, config)
+    M.with_config(config or {})
+
+    local current_colorscheme_name = vim.g.tinted_current_colorscheme;
+
+    if type('colors') == 'table' or colors == '' or colors == nil then
+        colors = M.colorschemes["tinted-nvim-default"]
+    elseif type('colors') == 'string' then
+        -- Return if the theme is being set to the same theme
+        if colors == current_colorscheme_name then
+          return
+        end
+
+        local ok, colorscheme = pcall(function()
+            vim.g.tinted_current_colorscheme = colors
+            return M.colorschemes[colors]
+        end)
+
+        if ok then
+            colors = colorscheme
+        else
+            vim.g.tinted_current_colorscheme = "tinted-nvim-default"
+            colors = M.colorschemes["tinted-nvim-default"]
+        end
+    end
+
+    -- Live-reload only supports reading current theme from Tinty.
+    if M.config.supports.live_reload == true and M.config.supports.tinty == false then
+        vim.notify(
+            "Live-reload feature only works with Tinty integration.",
+            vim.log.levels.WARN
+        )
+    end
+
+    if M.config.supports.tinty == true then
+        colors = detect_colors_from_tinty()
+        if M.config.supports.live_reload then
+            require("tinted-live-reload").setup_live_reload(function()
+                set_colors(detect_colors_from_tinty())
+            end)
+        end
+
+    -- Only trust BASE16_THEME if not inside a TMUX pane due to how TMUX handles env vars
+    elseif M.config.tinted_shell == true and vim.env.TMUX == nil and vim.env.BASE16_THEME ~= nil then
+        -- Safely get colorscheme object from BASE16_THEME env var
+        local ok, colorscheme = pcall(function()
+            return M.colorschemes[vim.env.BASE16_THEME]
+        end)
+
+        if ok then
+            vim.g.tinted_current_colorscheme = vim.env.BASE16_THEME
+            colors = colorscheme
+        end
+    end
+
+    if vim.fn.exists('syntax_on') then
+        vim.cmd('syntax reset')
+    end
+
+    set_colors(colors)
 end
 
 function M.available_colorschemes()
diff --git a/lua/tinted-live-reload.lua b/lua/tinted-live-reload.lua
@@ -0,0 +1,64 @@
+local M = {}
+
+local function check_prerequisites()
+  local ok = pcall(require, "fwatch")
+  if not ok then
+    vim.notify("Required plugin rktjmp/fwatch.nvim is missing.", vim.log.levels.ERROR)
+    return false
+  end
+  return true
+end
+
+local function schedule_trigger(callback)
+  vim.schedule(callback)
+end
+
+local function start_watcher(callback)
+  if vim.g.tinted_live_reload_registered then
+    return
+  end
+  vim.g.tinted_live_reload_registered = true
+
+  local fwatch = require("fwatch")
+
+  -- The first line of the output is the path to the data directory.
+  -- We need to watch the "current_scheme" file in that directory.
+  -- The output is a list of lines, so we take the first line.
+  -- The path is trimmed to remove any leading or trailing whitespace.
+  -- We check if the path is not empty.
+  local job = vim.fn.jobstart(
+    { "tinty", "config", "--data-dir-path" },
+    {
+      on_stdout = function(_, data)
+        if data == nil or #data == 0 then
+          return
+        end
+        local path = vim.fn.trim(data[1])
+        if #path == 0 then
+          return
+        end
+        local file_path = path .. "current_scheme"
+        if not vim.fn.filereadable(file_path) then
+          vim.notify(string.format("File %s is not readable.", file_path), vim.log.levels.ERROR)
+          return
+        end
+        fwatch.watch(file_path, {
+          on_event = function()
+            schedule_trigger(callback)
+          end,
+        })
+      end,
+    }
+  )
+end
+
+M.setup_live_reload = function(callback)
+  local ok = check_prerequisites()
+  if not ok then
+    -- Required plugins aren't present. Stop.
+    return
+  end
+  start_watcher(callback)
+end
+
+return M
diff --git a/templates/README.md.mustache b/templates/README.md.mustache
