Added filewatch and cache functionality, notes can be searched by aliases

CHANGELOG.md

@@ -33,6 +33,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added file-watch: code that tracks changed notes in the vault.
+- Added cache: a JSON file, which stores aliases, last update date and path to the note. Updated using file-watch.
+- Added a new configuration option - `cache`, which is disabled by default.
 - Allow custom directory and ID logic for templates
 - When filling out a template with user-provided substitution functions, pass a "context" object to each invocation so that users can respond accordingly.
   - Added `obsidian.InsertTemplateContext` and `obsidian.CloneTemplateContext` as these new "context" objects.
@@ -104,6 +107,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Refactored workspace module for a better api.
 - Fixed types in `opts.workspaces[*].overrides` to all be optional.
 
+### Changed
+- In telescope an option was added to search notes by aliases.
+
 ## [v3.12.0](https://github.com/obsidian-nvim/obsidian.nvim/releases/tag/v3.12.0) - 2025-06-05
 
 ### Added

README.md

@@ -125,6 +125,8 @@ There's one entry point user command for this plugin: `Obsidian`
 
 - `:Obsidian yesterday` to open/create the daily note for the previous working day.
 
+- `:Obsidian rebuild_cache` to manually update the cache of the workspace.
+
 ### Demo
 
 [![2024-01-31 14 22 52](https://github.com/epwalsh/obsidian.nvim/assets/8812459/2986e1d2-13e8-40e2-9c9e-75691a3b662e)](https://github.com/epwalsh/obsidian.nvim/assets/8812459/2986e1d2-13e8-40e2-9c9e-75691a3b662e)
@@ -566,6 +568,13 @@ require("obsidian").setup {
     format = "{{properties}} properties {{backlinks}} backlinks {{words}} words {{chars}} chars",
   },
 
+  -- Experimental feature, disabled by default.
+  cache = {
+    enabled = false,
+    path = "./.cache.json",
+    show_tags = false -- will show tags after a note name and after aliases.
+  },
+
   ---@class obsidian.config.FooterOpts
   ---
   ---@field enabled? boolean

doc/obsidian_api.txt

@@ -331,10 +331,11 @@ Return ~
 Class ~
 {obsidian.note.LoadOpts}
 Fields ~
-{max_lines} `(integer|)`?
-{load_contents} `(boolean|)`?
-{collect_anchor_links} `(boolean|)`?
-{collect_blocks} `(boolean|)`?
+{max_lines} `(integer|? Stops)` reading file if reached max lines.
+{read_only_frontmatter} `(boolean|? Stops)` reading file if reached end of frontmatter.
+{load_contents} `(boolean|?  Save)` contents of the file if not frontmatter or block to obsidian.Note.contents. Still reads whole file if other options are true.
+{collect_anchor_links} `(boolean|? Save)` anchor_links of the file if not in frontmatter or block to obsidian.Note.anchor_links. Still reads whole file if other options are true.
+{collect_blocks} `(boolean|? Save)` code blocks to obsidian.Note.blocks. Still reads whole file if other options are true.
 
 ------------------------------------------------------------------------------
                                                      *obsidian.Note.from_file()*
@@ -892,4 +893,4 @@ Parameters ~
 Return ~
 `(string)` `(optional)`
 
- vim:tw=78:ts=8:noet:ft=help:norl:
+ vim:tw=78:ts=8:noet:ft=help:norl:

lua/obsidian/api.lua

@@ -590,6 +590,152 @@ M.get_icon = function(path)
   return nil
 end
 
+---Gets all notes from the vault.
+---@param path string The path to the vault.
+---@return string[]|? The path to the notes.
+M.get_all_notes_from_vault = function(path)
+  local files = {}
+
+  local cmd
+  local find_command
+
+  -- checking for executable which support .ignore or .gitignore
+  if 1 == vim.fn.executable "rg" then
+    find_command = { "rg", "--files", "--color", "never", "--glob", "'*.md'", path }
+    cmd = "rg"
+  elseif 1 == vim.fn.executable "fd" then
+    find_command = { "fd", "--type", "f", "--color", "never", "--extension", "md", "--base-directory", path }
+    cmd = "fd"
+  elseif 1 == vim.fn.executable "fdfind" then
+    find_command = { "fdfind", "--type", "f", "--color", "never", "--extension", "md", "--base-directory", path }
+    cmd = "fdfind"
+  end
+
+  if cmd then
+    local handle = io.popen(table.concat(find_command, " "))
+
+    if not handle then
+      log.error("couldn't execute cmd " .. cmd)
+      return {}
+    end
+
+    for file in handle:lines() do
+      files[#files + 1] = file
+    end
+  else
+    -- If we couldn't find one of the executable, fallback to default implemendation
+    -- which doesn't respect .ignore or .gitignore.
+    for name, t in vim.fs.dir(path, { depth = 10 }) do
+      if t == "file" and vim.endswith(name, ".md") then
+        local full_path = vim.fs.joinpath(path, name)
+        files[#files + 1] = full_path
+      end
+    end
+  end
+
+  return files
+end
+
+---Use greedy search to get the folder of the file.
+---@param file_path string
+---@param sep string
+---@return string
+local get_directory_path = function(file_path, sep)
+  return file_path:match("(.*" .. sep .. ")")
+end
+
+---Gets all subfolders from the vault.
+---@param path string The path to the vault.
+---@return string[]|? The path to the subfolders
+M.get_sub_dirs_from_vault = function(path)
+  local subdirs = {}
+
+  local cmd
+  local find_command
+
+  -- checking for executable which support .ignore or .gitignore
+  if 1 == vim.fn.executable "fd" then
+    find_command = { "fd", "--type", "d", "--color", "never", "--base-directory", path }
+    cmd = "fd"
+  elseif 1 == vim.fn.executable "fdfind" then
+    find_command = { "fdfind", "--type", "f", "--color", "never", "--base-directory", path }
+    cmd = "fdfind"
+  elseif 1 == vim.fn.executable "rg" then
+    -- rg doesn't support searching folders, so we will filter output manually.
+    -- Unfortunatly, this won't return folders which are empty.
+    find_command = { "rg", "--files", "--color", "never", "--glob", "'*.md'", path }
+    cmd = "rg"
+  end
+
+  if cmd then
+    local handle = io.popen(table.concat(find_command, " "))
+
+    if not handle then
+      log.error("couldn't execute cmd " .. cmd)
+      return {}
+    end
+
+    if cmd == "rg" then
+      local path_separator = "/"
+
+      local sysname = M.get_os()
+
+      if sysname == M.OSType.Windows then
+        path_separator = "\\"
+      end
+
+      for file in handle:lines() do
+        local subdir = get_directory_path(file, path_separator)
+
+        if not vim.tbl_contains(subdirs, subdir) then
+          subdirs[#subdirs + 1] = subdir
+        end
+      end
+    else
+      for subdir in handle:lines() do
+        subdirs[#subdirs + 1] = subdir
+      end
+    end
+  else
+    -- the user doesn't have tools which support .gitignore or .ignore,
+    -- fallback to getting all folders
+    for name, t in vim.fs.dir(path, { depth = 10 }) do
+      if t == "directory" then
+        local full_path = vim.fs.joinpath(path, name)
+        subdirs[#subdirs + 1] = full_path
+      end
+    end
+  end
+
+  return subdirs
+end
+
+---Cross-platform check if the pid exists.
+---@param pid string
+---@return boolean
+M.check_pid_exists = function(pid)
+  local system = M.get_os()
+
+  if system == M.OSType.Windows then
+    local cmd = string.format('tasklist /FI "PID eq %d" /NH', pid)
+    local pipe = io.popen(cmd)
+    assert(pipe)
+    local output = pipe:read()
+    pipe:close()
+
+    return output:match(pid) ~= nil
+  else
+    local cmd = "kill -0 " .. pid
+    local ok = os.execute(cmd)
+
+    if ok then
+      return true
+    else
+      return false
+    end
+  end
+end
+
 --- Resolve a basename to full path inside the vault.
 ---
 ---@param src string