refactor: use libuv directly, drop dependency on fwatch.nvim (#13)

Use `vim.uv` wrapper of `libuv`

Author: bezhermoso

README.md

@@ -167,18 +167,6 @@ tinted.setup(nil, {
 })
 ```
 
-The live-reload feature depends on [fwatch.nvim]. Add this dependency in whatever manner your plugin manager allows you.
-For example, with **lazy.nvim**:
-
-```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
@@ -195,7 +183,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
+      live_reload = true,
     },
     highlights = {
       telescope = true,
@@ -209,15 +197,22 @@ require('tinted-colorscheme').with_config({
 })
 ```
 
-### Autocmd
+### Live Reload
 
-```lua
+If you have both `tinty` and `live_reload` enabled, the colorscheme will automatically update whenever you change
+your theme system-wide with `tinty apply <SCHEME>`. 
 
+The user event `TintedColorsPost` is triggered whenever the colorscheme changes. This is useful for when you want to
+do something whenever the colorscheme live-reloads for example, such as applying some highlights yourself. You're able
+to access the color-table from the `tinted-colorscheme` module:
+
+```lua
 vim.api.nvim_create_autocmd("User", {
   pattern = "TintedColorsPost",
   callback = function()
     -- Do things whenever the theme changes.
     local colors = require("tinted-colorscheme").colors
+    -- e.g. colors.base00, colors.base01, ... colors.base0F
   end,
 })
 ```
@@ -685,4 +680,3 @@ 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

lua/tinted-colorscheme.lua

@@ -32,7 +32,7 @@
 local default_config = {
     supports = {
         tinty = true,
-        live_reload = false,
+        live_reload = true,
         tinted_shell = false,
     },
     highlights = {

lua/tinted-live-reload.lua

@@ -1,34 +1,17 @@
-local uv = require("luv")
-
 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(
+  return vim.fn.jobstart(
     { "tinty", "config", "--data-dir-path" },
     {
       on_stdout = function(_, data)
@@ -44,36 +27,45 @@ local function start_watcher(callback)
           vim.notify(string.format("File %s is not readable.", file_path), vim.log.levels.ERROR)
           return
         end
-        fwatch.watch(file_path, {
-          on_event = function(_, events, unwatch)
-            schedule_trigger(callback)
-            -- Tinty 0.28+ will no longer update the current_scheme file in place. It will replace it
-            -- with a new file which breaks this file watcher. We'll check whether the file moves,
-            -- at which point we'll start a new watcher.
-            if events.rename == true then
-              -- Trigger the change
-              vim.schedule(function()
-                -- Stop the existing watcher.
-                unwatch()
-                -- Reset the idempotency tracker
-                vim.g.tinted_live_reload_registered = false
-                -- Start a new watcher
-                start_watcher(callback)
-              end)
-            end
-          end,
-        })
+
+
+        local handle = vim.uv.new_fs_event()
+
+        if handle == nil then
+          vim.notify("Unable to start watcher.", vim.log.levels.ERROR)
+          return
+        end
+
+        --- @link https://docs.libuv.org/en/v1.x/fs_event.html
+        local flags = {
+          watch_entry = false,
+          stat = false,
+          recursive = false,
+        }
+
+        -- attach handler
+        vim.uv.fs_event_start(handle, file_path, flags, function(_, _, events)
+          vim.schedule(callback)
+          -- Tinty 0.28+ will no longer update the current_scheme file in place. It will replace it
+          -- with a new file which breaks this file watcher. We'll check whether the file moves,
+          -- at which point we'll start a new watcher.
+          if events.rename == true then
+            -- Stop the existing watcher.
+            vim.uv.fs_event_stop(handle)
+            vim.schedule(function()
+              -- Reset the idempotency tracker
+              vim.g.tinted_live_reload_registered = false
+              -- Start a new watcher
+              start_watcher(callback)
+            end)
+          end
+        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
 

templates/README.md.mustache

@@ -167,18 +167,6 @@ tinted.setup(nil, {
 })
 ```
 
-The live-reload feature depends on [fwatch.nvim]. Add this dependency in whatever manner your plugin manager allows you.
-For example, with **lazy.nvim**:
-
-```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
@@ -195,7 +183,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
+      live_reload = true,
     },
     highlights = {
       telescope = true,
@@ -209,15 +197,22 @@ require('tinted-colorscheme').with_config({
 })
 ```
 
-### Autocmd
+### Live Reload
 
-```lua
+If you have both `tinty` and `live_reload` enabled, the colorscheme will automatically update whenever you change
+your theme system-wide with `tinty apply <SCHEME>`. 
 
+The user event `TintedColorsPost` is triggered whenever the colorscheme changes. This is useful for when you want to
+do something whenever the colorscheme live-reloads for example, such as applying some highlights yourself. You're able
+to access the color-table from the `tinted-colorscheme` module:
+
+```lua
 vim.api.nvim_create_autocmd("User", {
   pattern = "TintedColorsPost",
   callback = function()
     -- Do things whenever the theme changes.
     local colors = require("tinted-colorscheme").colors
+    -- e.g. colors.base00, colors.base01, ... colors.base0F
   end,
 })
 ```
@@ -241,4 +236,3 @@ 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