Merge pull request #362 from epwalsh/epwalsh/list-tags

Add `Client:list_tags()` method

Author: epwalsh

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added configuration option `image_name_func: (fun(): string)|?` for customizing the default image name/prefix when pasting images via `:ObsidianPasteImg`.
 - Added client method `Client:current_note()` to get the note corresponding to the current buffer.
+- Added client method `Client:list_tags()` for listing all tags in the vault, along with async version `Client:list_tags_async(callback: fun(tags: string[]))`.
 - Added note method `Note.add_field(key: string, value: any)` to add/update an additional field in the frontmatter.
 - Added note method `Note.get_field(key: string)`.
 - Added note method ` Note.save_to_buffer(bufnr: integer|?, frontmatter: table|?)` for saving the frontmatter to a buffer.

lua/obsidian/client.lua

@@ -575,7 +575,7 @@ end
 ---
 ---@param term string|string[]
 ---@param opts obsidian.SearchOpts|boolean|? search options or a boolean indicating if sorting should be used
----@param timeout integer|?
+---@param timeout integer|? Timeout in milliseconds.
 ---
 ---@return obsidian.TagLocation[]
 Client.find_tags = function(self, term, opts, timeout)
@@ -599,10 +599,7 @@ Client.find_tags_async = function(self, term, opts, callback)
   end
 
   for i, t in ipairs(terms) do
-    if string.len(t) == 0 then
-      log.err "Empty search terms are not allowed when searching for tags"
-      return
-    elseif vim.startswith(t, "#") then
+    if vim.startswith(t, "#") then
       terms[i] = string.sub(t, 2)
     end
   end
@@ -680,6 +677,7 @@ Client.find_tags_async = function(self, term, opts, callback)
         local m_start, m_end, _ = unpack(match)
         local tag = string.sub(line, m_start + 1, m_end)
         for t in iter(terms) do
+          -- NOTE: this works when 't' is an empty string too.
           if vim.startswith(string.lower(tag), t) then
             add_match(tag, path, note, match_data.line_number, line, m_start, m_end)
             n_matches = n_matches + 1
@@ -707,9 +705,15 @@ Client.find_tags_async = function(self, term, opts, callback)
 
   local search_terms = {}
   for t in iter(terms) do
-    search_terms[#search_terms + 1] = "#" .. t .. search.Patterns.TagChars -- tag in the wild
-    search_terms[#search_terms + 1] = "\\s*- " .. t .. search.Patterns.TagChars -- frontmatter tag in multiline list
-    search_terms[#search_terms + 1] = "tags: .*" .. t .. search.Patterns.TagChars -- frontmatter tag in inline list
+    if string.len(t) > 0 then
+      search_terms[#search_terms + 1] = "#" .. t .. search.Patterns.TagCharsOptional -- tag in the wild
+      search_terms[#search_terms + 1] = "\\s*- " .. t .. search.Patterns.TagCharsOptional -- frontmatter tag in multiline list
+      search_terms[#search_terms + 1] = "tags: .*" .. t .. search.Patterns.TagCharsOptional -- frontmatter tag in inline list
+    else
+      search_terms[#search_terms + 1] = "#" .. search.Patterns.TagCharsRequired -- tag in the wild
+      search_terms[#search_terms + 1] = "\\s*- " .. search.Patterns.TagCharsRequired -- frontmatter tag in multiline list
+      search_terms[#search_terms + 1] = "tags: .*" .. search.Patterns.TagCharsRequired -- frontmatter tag in inline list
+    end
   end
 
   search.search_async(
@@ -762,6 +766,32 @@ Client.find_tags_async = function(self, term, opts, callback)
   end, callback)
 end
 
+--- Gather a list of all tags in the vault.
+---
+---@param timeout integer|? Timeout in milliseconds.
+---
+---@return string[]
+Client.list_tags = function(self, timeout)
+  local tags = {}
+  for _, tag_loc in ipairs(self:find_tags("", nil, timeout)) do
+    tags[tag_loc.tag] = true
+  end
+  return vim.tbl_keys(tags)
+end
+
+--- An async version of 'list_tags()'.
+---
+---@param callback fun(tags: string[])
+Client.list_tags_async = function(self, callback)
+  self:find_tags_async("", nil, function(tag_locations)
+    local tags = {}
+    for _, tag_loc in ipairs(tag_locations) do
+      tags[tag_loc.tag] = true
+    end
+    callback(vim.tbl_keys(tags))
+  end)
+end
+
 --- Apply a function over all notes in the current vault.
 ---
 ---@param on_note fun(note: obsidian.Note)

lua/obsidian/search.lua

@@ -24,7 +24,8 @@ M.RefTypes = {
 ---@enum obsidian.search.Patterns
 M.Patterns = {
   -- Miscellaneous
-  TagChars = "[A-Za-z0-9_/-]*",
+  TagCharsOptional = "[A-Za-z0-9_/-]*",
+  TagCharsRequired = "[A-Za-z]+[A-Za-z0-9_/-]*[A-Za-z0-9]+", -- assumes tag is at least 2 chars
   Highlight = "==[^=]+==", -- ==text==
 
   -- References