make recursive scans optional

Author: navicore

doc/nvim-reminders.txt

@@ -39,15 +39,28 @@ Use 't' to toggle the sort order from oldest to newest and vice versa.
 ==============================================================================
 CONFIGURATION                                           *nvim-reminders-config*
 
-The nvim-reminders plugin can be configured by passing a configuration table
+The nvim-reminders plugin can be enabled by the `setup` function called your
+init.lua file:
+>
+  require('reminders').setup()
+
+The nvim-reminders plugin can be customized by passing a configuration table
 to the `setup` function in your init.lua file:
 
+`paths`: A list of paths to scan for and edit reminders
+>
+  require('reminders').setup({
+    paths = { "~/path/to/your/markdown/files" }
+  })
+
+`recursive_scan`: A boolean flag to indicate scan all sub directories when
+processing the `ReminderScan` and `ReminderScanUpcoming` commands.  Note,
+`ReminderScanAll` always scans recursively.
 >
   require('reminders').setup({
-    paths = { "~/path/to/your/reminders" }
+    recursive_scan = true
   })
 
-`paths`: A list of paths to scan for reminders
 
 ==============================================================================
 vim:tw=78:ts=8:ft=help:norl:

lua/reminders/autocmds.lua

@@ -65,7 +65,7 @@ function M.update_virtual_text()
 end
 
 -- Set up autocmds for markdown files in the configured paths
-function M.setup_autocmds(paths)
+function M.setup_autocmds()
     vim.cmd([[
         augroup Reminders
             autocmd!

lua/reminders/init.lua

@@ -313,13 +313,17 @@ end, {})
 -- Plugin setup function
 function M.setup(user_config)
     M.config = {
-        paths = { fn.expand("~/git/" .. io.popen("whoami"):read("*a"):gsub("\n", "") .. "/zet") }
+        paths = { fn.expand("~/git/" .. io.popen("whoami"):read("*a"):gsub("\n", "") .. "/zet") },
+        recursive_scan = false
     }
     if user_config and user_config.paths then
         M.config.paths = user_config.paths
     end
+    if user_config and user_config.recursive_scan then
+        M.config.recursive_scan = user_config.recursive_scan
+    end
     -- Set up autocmds for markdown files in the configured paths
-    require('reminders.autocmds').setup_autocmds(M.config.paths)
+    require('reminders.autocmds').setup_autocmds()
 end
 
 function M.is_reminder(line)

lua/reminders/reminder_list.lua

@@ -62,7 +62,6 @@ local function scan_file(file_path, upcoming, all_reminders)
     local lines = vim.fn.readfile(file_path)
     for i, line in ipairs(lines) do
         local reminder, datetime, is_checked = parse_reminder_line(line)
-
         if datetime and (all_reminders or not is_checked) then
             add_reminder(file_path, i, reminder, datetime, upcoming, all_reminders)
         end
@@ -71,9 +70,17 @@ end
 
 -- Function to scan all configured paths for due reminders
 function M.scan_paths(paths)
+
+    local recursive_scan = require('reminders').config.recursive_scan
+
     M.reminders = {}  -- Clear the list before scanning
     for _, path in ipairs(paths) do
-        local files = vim.fn.globpath(path, "**/*.md", false, true)
+        local files
+        if recursive_scan == true then
+            files = vim.fn.globpath(path, "**/*.md", false, true)
+        else
+            files = vim.fn.globpath(path, "*.md", false, true)
+        end
         for _, file in ipairs(files) do
             scan_file(file, false, false)  -- Pass false for upcoming and all_reminders
         end
@@ -82,9 +89,15 @@ end
 
 -- Function to scan all configured paths for upcoming reminders
 function M.scan_paths_upcoming(paths)
+    local recursive_scan = require('reminders').config.recursive_scan
     M.reminders = {}  -- Clear the list before scanning
     for _, path in ipairs(paths) do
-        local files = vim.fn.globpath(path, "**/*.md", false, true)
+        local files
+        if recursive_scan == true then
+            files = vim.fn.globpath(path, "**/*.md", false, true)
+        else
+            files = vim.fn.globpath(path, "*.md", false, true)
+        end
         for _, file in ipairs(files) do
             scan_file(file, true, false)  -- Pass true for upcoming and false for all_reminders
         end
@@ -95,6 +108,7 @@ end
 function M.scan_paths_all(paths)
     M.reminders = {}  -- Clear the list before scanning
     for _, path in ipairs(paths) do
+        -- always scan recursively for all reminders
         local files = vim.fn.globpath(path, "**/*.md", false, true)
         for _, file in ipairs(files) do
             scan_file(file, false, true)  -- Pass false for upcoming and true for all_reminders