Add new client and note methods (#351)

Author: epwalsh

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Added client method `Client:current_note()` to get the note corresponding to the current buffer.
+- Added note method `Note.add_field(key: string, value: any)` to add/update an additional field in the frontmatter.
+- Added note method ` Note.save_to_buffer(bufnr: integer|?, frontmatter: table|?)` for saving the frontmatter to a buffer.
+
 ## [v2.8.0](https://github.com/epwalsh/obsidian.nvim/releases/tag/v2.8.0) - 2024-01-26
 
 ### Added

lua/obsidian/client.lua

@@ -550,6 +550,17 @@ Client.resolve_note_async = function(self, query, callback)
   end)
 end
 
+--- Get the current note.
+---
+---@return obsidian.Note|?
+Client.current_note = function(self)
+  if vim.bo.filetype ~= "markdown" then
+    return nil
+  end
+
+  return Note.from_buffer(0, self.dir)
+end
+
 ---@class obsidian.TagLocation
 ---
 ---@field tag string The tag found.

lua/obsidian/init.lua

@@ -225,20 +225,9 @@ obsidian.setup = function(opts)
         if client.opts.note_frontmatter_func ~= nil then
           frontmatter = client.opts.note_frontmatter_func(note)
         end
-        local new_lines = note:frontmatter_lines(nil, frontmatter)
-        local cur_lines
-        if note.frontmatter_end_line ~= nil then
-          cur_lines = vim.api.nvim_buf_get_lines(0, 0, note.frontmatter_end_line, false)
-        end
 
-        vim.api.nvim_buf_set_lines(
-          bufnr,
-          0,
-          note.frontmatter_end_line and note.frontmatter_end_line or 0,
-          false,
-          new_lines
-        )
-        if not client._quiet and not vim.deep_equal(cur_lines, new_lines) then
+        local updated = note:save_to_buffer(bufnr, frontmatter)
+        if not client._quiet and updated then
           log.info "Updated frontmatter"
         end
       end,

lua/obsidian/note.lua

@@ -132,6 +132,22 @@ Note.add_tag = function(self, tag)
   end
 end
 
+--- Add or update a field in the frontmatter.
+---
+---@param key string
+---@param value any
+Note.add_field = function(self, key, value)
+  if key == "id" or key == "aliases" or key == "tags" then
+    error "Updating field '%s' this way is not allowed. Please update the corresponding attribute directly instead"
+  end
+
+  if not self.metadata then
+    self.metadata = {}
+  end
+
+  self.metadata[key] = value
+end
+
 --- Initialize a note from a file.
 ---
 ---@param path string|Path
@@ -447,7 +463,7 @@ Note.frontmatter_lines = function(self, eol, frontmatter)
   end
 end
 
---- Save note to file.
+--- Save note to file. This only updates the frontmatter and header, leaving the rest of the contents unchanged.
 ---
 ---@param path string|Path|?
 ---@param insert_frontmatter boolean|?
@@ -467,7 +483,8 @@ Note.save = function(self, path, insert_frontmatter, frontmatter)
   if self_f ~= nil then
     local contents = self_f:read "*a"
     for idx, line in ipairs(vim.split(contents, "\n")) do
-      table.insert(lines, line .. "\n")
+      lines[#lines + 1] = line .. "\n"
+
       if idx == 1 then
         if Note._is_frontmatter_boundary(line) then
           has_frontmatter = true
@@ -480,6 +497,7 @@ Note.save = function(self, path, insert_frontmatter, frontmatter)
         end
       end
     end
+
     self_f:close()
   elseif #self.aliases > 0 then
     -- Add a header.
@@ -512,4 +530,31 @@ Note.save = function(self, path, insert_frontmatter, frontmatter)
   return lines
 end
 
+--- Save frontmatter to the given buffer.
+---
+---@param bufnr integer|?
+---@param frontmatter table|?
+---
+---@return boolean updated True if the buffer lines were updated, false otherwise.
+Note.save_to_buffer = function(self, bufnr, frontmatter)
+  bufnr = bufnr and bufnr or 0
+
+  local cur_buf_note = Note.from_buffer(bufnr)
+  local new_lines = self:frontmatter_lines(nil, frontmatter)
+  local cur_lines
+  if cur_buf_note.frontmatter_end_line ~= nil then
+    cur_lines = vim.api.nvim_buf_get_lines(bufnr, 0, cur_buf_note.frontmatter_end_line, false)
+  end
+
+  vim.api.nvim_buf_set_lines(
+    bufnr,
+    0,
+    cur_buf_note.frontmatter_end_line and cur_buf_note.frontmatter_end_line or 0,
+    false,
+    new_lines
+  )
+
+  return not vim.deep_equal(cur_lines, new_lines)
+end
+
 return Note

test/obsidian/note_spec.lua

@@ -9,6 +9,7 @@ describe("Note", function()
     assert.equals(note.id, "FOO")
     assert.equals(note.aliases[1], "foo")
   end)
+
   it("should be able to be initialized from a file", function()
     local note = Note.from_file "test_fixtures/notes/foo.md"
     assert.equals(note.id, "foo")
@@ -18,13 +19,15 @@ describe("Note", function()
     assert.is_true(note.has_frontmatter)
     assert(#note.tags == 0)
   end)
+
   it("should be able to be initialized from a README", function()
     local note = Note.from_file "README.md"
     assert.equals(note.id, "README")
     assert.equals(#note.tags, 0)
     assert.equals(note:fname(), "README.md")
     assert.is_false(note:should_save_frontmatter())
   end)
+
   it("should be able to be initialized from a note w/o frontmatter", function()
     local note = Note.from_file "test_fixtures/notes/note_without_frontmatter.md"
     assert.equals(note.id, "note_without_frontmatter")
@@ -35,32 +38,39 @@ describe("Note", function()
     assert.is_false(note.has_frontmatter)
     assert.is_true(note:should_save_frontmatter())
   end)
+
   it("should be able to add an alias", function()
     local note = Note.from_file "test_fixtures/notes/foo.md"
     assert.equals(#note.aliases, 2)
     note:add_alias "Foo Bar"
     assert.equals(#note.aliases, 3)
   end)
+
   it("should be able to save to file", function()
     local note = Note.from_file "test_fixtures/notes/foo.md"
     note:add_alias "Foo Bar"
     note:save "./test_fixtures/notes/foo_bar.md"
   end)
+
   it("should be able to save note w/o frontmatter to file", function()
     local note = Note.from_file "test_fixtures/notes/note_without_frontmatter.md"
     note:save "./test_fixtures/notes/note_without_frontmatter_saved.md"
   end)
+
   it("should be able to save a new note", function()
     local note = Note.new("FOO", {}, {}, "/tmp/" .. util.zettel_id() .. ".md")
     note:save()
   end)
+
   it("should be able to parse a markdown header", function()
     assert.equals(Note._parse_header "## Hey there", "Hey there")
   end)
+
   it("should be able to find a frontmatter boundary", function()
     assert.is_true(Note._is_frontmatter_boundary "---")
     assert.is_true(Note._is_frontmatter_boundary "----")
   end)
+
   it("should be able to be initialize and save a note with additional frontmatter metadata", function()
     local note = Note.from_file "test_fixtures/notes/note_with_additional_metadata.md"
     assert.equals(note.id, "note_with_additional_metadata")
@@ -80,6 +90,7 @@ describe("Note", function()
     )
     note:save "./test_fixtures/notes/note_with_additional_metadata_saved.md"
   end)
+
   it("should be able to be read frontmatter that's formatted differently", function()
     local note = Note.from_file "test_fixtures/notes/note_with_different_frontmatter_format.md"
     assert.equals(note.id, "note_with_different_frontmatter_format")