Recipe: WeeklyRecap

[ellisra]

I have a collection of user commands in my config for creating specific notes in defined directories, such as this example:

vim.api.nvim_create_user_command("WeeklyRecap", function()
    local client = require("obsidian").get_client()
    client:open_note(client:create_note({
        title = string.format(
            "Week %d, %d",
            os.date("%V"),
            os.date("%Y")
        ),
        id = string.format("%d-W%02d", os.date("%Y"), os.date("%V")),
        dir = client.dir / "journal/weekly-review",
        tags = { "journal", "weekly-recap" },
    }))
end, { desc = "Create weekly recap note" })

After updating the plugin I see that many Client features are being deprecated in favour of Note but I've been unable to migrate these commands correctly. Additionally the new Obsidian.dir which is meant to replace Client.dir seems to be returning nil when called in a command. I apologise if any of my explanation is unclear as I'm not super familiar with the inner workings of this plugin, I'm happy to provide additional context if it would be helpful.

[neo451]

vim.api.nvim_create_user_command("WeeklyRecap", function()
   local Note = require("obsidian.note")

   Note.create({
      title = string.format("Week %d, %d", os.date("%V"), os.date("%Y")),
      id = string.format("%d-W%02d", os.date("%Y"), os.date("%V")),
      dir = Obsidian.dir / "journal/weekly-review",
      tags = { "journal", "weekly-recap" },
   }):open()
end, { desc = "Create weekly recap note" })

Hi, this is my try at your command, it partially works, because the api was refactored to fit the need of other stuff at the time and is not completely thought out, now it only places the correct dir, and use title as filename and id, id and tags seems to be not working, which I will fix soon.

Also, Obsidian.dir returning nil might be because you are lazy loading the plugin, and then you are creating this command before obsidian loads, you can either not lazy load, or just create after obsidian loads.

Better yet, you can follow: https://github.com/obsidian-nvim/obsidian.nvim/wiki/Extensions

just move the logic as a function in ~/.config/nvim/lua/obsidian/commands/weekly_recap.lua, then in ~/.config/nvim/plugin/weekly_recap.lua or anywhere in your obsidian.nvim's setup, do require("obsidian").register_command("weekly_recap", { nargs = 0 })

and then you can use :Obsidian weekly_recap

[neo451]

@ellisra my version should work as intended now, try it

[ellisra]

Nice, this seems to be working now, thanks!

[ellisra]

One thing to note with this new approach; should_write seemingly needs to be set to true in order for the note creation to work as expected. If it isn't set then tags or aliases won't be passed correctly. Here is a corrected version:

vim.api.nvim_create_user_command("WeeklyRecap", function()
    local Note = require("obsidian.note")

    Note.create({
        title = string.format("Week %d, %d", os.date("%V"), os.date("%Y")),
        id = string.format("%d-W%02d", os.date("%Y"), os.date("%V")),
        dir = Obsidian.dir / "journal/weekly-review",
        tags = { "journal", "weekly-recap" },
        should_write = true,
    }):open()
end, { desc = "Create weekly recap note" })