Allow viz selection or cursor location with :ObsidianTags command

Author: epwalsh

CHANGELOG.md

@@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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.
 
+### Changed
+
+- `:ObsidianTags` command can take a visual selection or look for a tag under the cursor instead of explicitly provided arguments.
+
 ## [v2.8.0](https://github.com/epwalsh/obsidian.nvim/releases/tag/v2.8.0) - 2024-01-26
 
 ### Added

lua/obsidian/commands/init.lua

@@ -159,7 +159,7 @@ M.register("ObsidianOpen", { opts = { nargs = "?" }, complete = M.complete_args_
 M.register("ObsidianBacklinks", { opts = { nargs = 0 } })
 
 ---Find all instances of any number of tags.
-M.register("ObsidianTags", { opts = { nargs = "+" } })
+M.register("ObsidianTags", { opts = { nargs = "*", range = true } })
 
 ---Search notes.
 M.register("ObsidianSearch", { opts = { nargs = "?" } })

lua/obsidian/commands/tags.lua

@@ -1,12 +1,13 @@
 local log = require "obsidian.log"
 local util = require "obsidian.util"
+local search = require "obsidian.search"
 local LocationList = require "obsidian.location_list"
 
 ---@param client obsidian.Client
-return function(client, data)
+---@param tags string[]
+local function gather_tag_location_list(client, tags)
   -- Gather tag locations.
   local tag_locations = {}
-  local tags = util.tbl_unique(data.fargs)
   local tag_locs = client:find_tags(tags, { sort = true })
   for _, tag_loc in ipairs(tag_locs) do
     for _, tag in ipairs(tags) do
@@ -92,9 +93,57 @@ return function(client, data)
   loclist:render(view_lines, folds, highlights)
 
   log.info(
-    "Showing tag locations.\n\n"
+    "Showing tag locations for '%s'.\n\n"
       .. "TIPS:\n\n"
       .. "- Hit ENTER on a match to go to the tag location\n"
-      .. "- Hit ENTER on a group header to toggle the fold, or use normal fold mappings"
+      .. "- Hit ENTER on a group header to toggle the fold, or use normal fold mappings",
+    table.concat(tags, "', '")
   )
 end
+
+---@param client obsidian.Client
+return function(client, data)
+  local tags = data.fargs
+
+  if vim.tbl_isempty(tags) then
+    -- Check for visual selection.
+    local _, csrow, cscol, _ = unpack(assert(vim.fn.getpos "'<"))
+    local _, cerow, cecol, _ = unpack(assert(vim.fn.getpos "'>"))
+    if data.line1 == csrow and data.line2 == cerow then
+      local lines = vim.fn.getline(csrow, cerow)
+      if #lines ~= 1 then
+        log.err "Only in-line visual selections allowed"
+        return
+      end
+
+      local line = assert(lines[1])
+      local tag = string.sub(line, cscol, cecol)
+
+      if not string.match(tag, "^#?" .. search.Patterns.TagCharsRequired .. "$") then
+        log.err("Visual selection '%s' is not a valid tag", tag)
+        return
+      end
+
+      if vim.startswith(tag, "#") then
+        tag = string.sub(tag, 2)
+      end
+
+      tags = { tag }
+    else
+      -- Otherwise check for a tag under the cursor.
+      local tag = util.cursor_tag()
+      if tag then
+        tags = { tag }
+      end
+    end
+  end
+
+  if vim.tbl_isempty(tags) then
+    log.warn "Please provide a tag argument"
+    return
+  end
+
+  tags = util.tbl_unique(tags)
+
+  return gather_tag_location_list(client, tags)
+end

lua/obsidian/search.lua

@@ -26,6 +26,7 @@ M.Patterns = {
   -- Tags
   TagCharsOptional = "[A-Za-z0-9_/-]*",
   TagCharsRequired = "[A-Za-z]+[A-Za-z0-9_/-]*[A-Za-z0-9]+", -- assumes tag is at least 2 chars
+  Tag = "#[A-Za-z]+[A-Za-z0-9_/-]*[A-Za-z0-9]+",
 
   -- Miscellaneous
   Highlight = "==[^=]+==", -- ==text==
@@ -35,7 +36,6 @@ M.Patterns = {
   Wiki = "%[%[[^][%|]+%]%]", -- [[xxx]]
   Markdown = "%[[^][]+%]%([^%)]+%)", -- [yyy](xxx)
   NakedUrl = "https?://[a-zA-Z0-9._-]+[a-zA-Z0-9._#/=&?:%%-]+[a-zA-Z0-9]", -- https://xyz.com
-  Tag = "#[a-zA-Z0-9_/-]+", -- #tag
 }
 
 --- Find all matches of a pattern

lua/obsidian/util.lua

@@ -605,6 +605,29 @@ util.cursor_link = function(line, col, include_naked_urls)
   return link_location, link_name, link_type
 end
 
+--- Get the tag under the cursor, if there is one.
+---
+---@param line string|?
+---@param col integer|?
+---
+---@return string|?
+util.cursor_tag = function(line, col)
+  local search = require "obsidian.search"
+
+  local current_line = line and line or vim.api.nvim_get_current_line()
+  local _, cur_col = unpack(vim.api.nvim_win_get_cursor(0))
+  cur_col = col or cur_col + 1 -- nvim_win_get_cursor returns 0-indexed column
+
+  for match in iter(search.find_tags(current_line)) do
+    local open, close, _ = unpack(match)
+    if open <= cur_col and cur_col <= close then
+      return string.sub(current_line, open + 1, close)
+    end
+  end
+
+  return nil
+end
+
 util.gf_passthrough = function()
   if util.cursor_on_markdown_link(nil, nil, true) then
     return "<cmd>ObsidianFollowLink<CR>"