epwalsh / epwalsh/obsidian.nvim
Frontmatter of template is not merged with existing frontmatter
- Dominant language
- Lua
- Stars
- 6.2k
- Forks
- 250
- PR merge metrics
- No merged PRs in 30d
Description
### 🐛 Describe the bug
Create a note with frontmatter and then use `:ObsidianTemplate` to insert a template with frontmatter
For reference:
A note with frontmatter

**What Happens**: Template is inserted at the location of cursor along with its frontmatter as a simple text

**What should happen**: frontmatter from template should be merged with frontmatter of the buffer

### Config
```
return {
-- Git URL
"epwalsh/obsidian.nvim",
version = "*",
lazy = false,
ft = "markdown",
dependencies = {
"nvim-lua/plenary.nvim",
},
config = function()
vim.o.conceallevel = 2 -- set conceal level for obsidian plugin
require("obsidian").setup({
workspaces = {
{
name = "Ibrahim's Vault",
path = os.getenv("OBSIDIAN_VAULT_DIR"),
},
},
notes_subdir = "00_inbox",
new_notes_location = "notes_subdir",
disable_frontmatter = false,
templates = {
subdir = "templates",
date_format = "%Y-%m-%d",
time_format = "%H:%M:%S",
},
-- name new notes starting the ISO datetime and ending with note name
-- put them in the inbox subdir
-- note_id_func = function(title)
-- local suffix = ""
-- -- get current ISO datetime with -5 hour offset from UTC for EST
-- local current_datetime = os.date("!%Y-%m-%d-%H%M%S", os.time() - 5*3600)
-- if title ~= nil then
-- suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
-- else
-- for _ = 1, 4 do
-- suffix = suffix .. string.char(math.random(65, 90))
-- end
-- end
-- return current_datetime .. "_" .. suffix
-- end,
-- key mappings, below are the defaults
mappings = {
-- overrides the 'gf' mapping to work on markdown/wiki links within your vault
["gf"] = {
action = function()
return require("obsidian").util.gf_passthrough()
end,
opts = { noremap = false, expr = true, buffer = true },
},
-- Smart action depending on context, either follow link or toggle checkbox.
[""] = {
action = function()
return require("obsidian").util.smart_action()
end,
opts = { buffer = true, expr = true },
},
},
completion = {
nvim_cmp = true,
min_chars = 2,
},
picker = {
-- Set your preferred picker. Can be one of 'telescope.nvim', 'fzf-lua', or 'mini.pick'.
name = "telescope.nvim",
-- Optional, configure key mappings for the picker. These are the defaults.
-- Not all pickers support all mappings.
note_mappings = {
-- Create a new note from your query.
new = "",
-- Insert a link to the selected note.
insert_link = "",
},
tag_mappings = {
-- Add tag(s) to current note.
tag_note = "",
-- Insert a tag at the current location.
insert_tag = "",
},
},
-- Optional, configure additional syntax highlighting / extmarks.
-- This requires you have `conceallevel` set to 1 or 2. See `:help conceallevel` for more details.
ui = {
enable = true, -- set to false to disable all additional syntax features
update_debounce = 200, -- update delay after a text change (in milliseconds)
max_file_length = 5000, -- disable UI features for files with more than this many lines
-- Define how various check-boxes are displayed
checkboxes = {
-- NOTE: the 'char' value has to be a single character, and the highlight groups are defined below.
[" "] = { char = "", hl_group = "ObsidianTodo" },
["x"] = { char = "", hl_group = "ObsidianDone" },
[">"] = { char = "", hl_group = "ObsidianRightArrow" },
["~"] = { char = "", hl_group = "ObsidianTilde" },
["!"] = { char = "", hl_group = "ObsidianImportant" },
-- Replace the above with this if you don't have a patched font:
-- [" "] = { char = "☐", hl_group = "ObsidianTodo" },
-- ["x"] = { char = "✔", hl_group = "ObsidianDone" },
-- You can also add more custom ones...
},
-- Use bullet marks for non-checkbox lists.
bullets = { char = "•", hl_group = "ObsidianBullet" },
external_link_icon = { char = "", hl_group = "ObsidianExtLinkIcon" },
-- Replace the above with this if you don't have a patched font:
-- external_link_icon = { char = "", hl_group = "ObsidianExtLinkIcon" },
reference_text = { hl_group = "ObsidianRefText" },
highlight_text = { hl_group = "ObsidianHighlightText" },
tags = { hl_group = "ObsidianTag" },
block_ids = { hl_group = "ObsidianBlockID" },
hl_groups = {
-- The options are passed directly to `vim.api.nvim_set_hl()`. See `:help nvim_set_hl`.
ObsidianTodo = { bold = true, fg = "#f78c6c" },
ObsidianDone = { bold = true, fg = "#89ddff" },
ObsidianRightArrow = { bold = true, fg = "#f78c6c" },
ObsidianTilde = { bold = true, fg = "#ff5370" },
ObsidianImportant = { bold = true, fg = "#d73128" },
ObsidianBullet = { bold = true, fg = "#89ddff" },
ObsidianRefText = { underline = true, fg = "#c792ea" },
ObsidianExtLinkIcon = { fg = "#c792ea" },
ObsidianTag = { italic = true, fg = "#89ddff" },
ObsidianBlockID = { italic = true, fg = "#89ddff" },
ObsidianHighlightText = { bg = "#75662e" },
},
},
daily_notes = {
-- Optional, if you keep daily notes in a separate directory.
folder = "dailies",
-- Optional, if you want to change the date format for the ID of daily notes.
date_format = "%Y-%m-%d",
-- Optional, if you want to change the date format of the default alias of daily notes.
alias_format = "%B %-d, %Y",
-- Optional, default tags to add to each new daily note created.
default_tags = { "daily-notes" },
-- Optional, if you want to automatically insert a template from your template directory like 'daily.md'
template = "daily.md",
},
-- Specify how to handle attachments.
attachments = {
-- The default folder to place images in via `:ObsidianPasteImg`.
-- If this is a relative path it will be interpreted as relative to the vault root.
-- You can always override this per image by passing a full path to the command instead of just a filename.
img_folder = "assets/imgs", -- This is the default
-- Optional, customize the default name or prefix when pasting images via `:ObsidianPasteImg`.
---@return string
img_name_func = function()
-- Prefix image names with timestamp.
return string.format("%s-", os.time())
end,
-- A function that determines the text to insert in the note when pasting an image.
-- It takes two arguments, the `obsidian.Client` and an `obsidian.Path` to the image file.
-- This is the default implementation.
---@param client obsidian.Client
---@param path obsidian.Path the absolute path to the image file
---@return string
img_text_func = function(client, path)
path = client:vault_relative_path(path) or path
return string.format("", path.name, path)
end,
},
-- Optional, customize how note IDs are generated given an optional title.
---@param title string|?
---@return string
note_id_func = function(title)
-- Create note IDs in a Zettelkasten format with a timestamp and a suffix.
-- In this case a note with the title 'My new note' will be given an ID that looks
-- like '1657296016-my-new-note', and therefore the file name '1657296016-my-new-note.md'
local suffix = ""
if title ~= nil then
-- If title is given, transform it into valid file name.
suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
else
-- If title is nil, just add 4 random uppercase letters to the suffix.
for _ = 1, 4 do
suffix = suffix .. string.char(math.random(65, 90))
end
end
return tostring(os.time()) .. "-" .. suffix
end,
})
end,
}
```
### Environment
```
$ nvim --version
NVIM v0.10.1
Build type: Release
LuaJIT 2.1.1713484068
Run "nvim -V1 -v" for more info
$ nvim --headless -c 'lua require("obsidian").info()' -c q
Obsidian.nvim v3.9.0 (unknown commit)
Status:
• buffer directory: nil
• working directory: /mnt/c/Users/ibrah/Obsidian/vault/00_inbox
Workspaces:
✓ active workspace: Workspace(name='Ibrahim's Vault', path='/mnt/c/Users/ibrah/Obsidian/vault', root='/mnt/c/Users/ibrah/Obsidian/vault')
Dependencies:
✓ plenary.nvim: ec289423a1693aeae6cd0d503bac2856af74edaa
✓ nvim-cmp: ae644feb7b67bf1ce4260c231d1d4300b19c6f30
✓ telescope.nvim: a0bbec21143c7bc5f8bb02e0005fa0b982edc026
Integrations:
✓ picker: TelescopePicker()
✓ completion: enabled (nvim-cmp) ✗ refs, ✗ tags, ✗ new
all sources:
• nvim_lsp
• luasnip
• buffer
• path
• neorg
Tools:
✓ rg: ripgrep 14.1.1
Environment:
• operating system: Wsl
Config:
• notes_subdir: 00_inbox
```
Contributor guide
Research direction
Start by reproducing the issue with an existing note containing frontmatter and a template containing frontmatter, then trace the :ObsidianTemplate command and its frontmatter handling. Done means template fields are merged into the buffer's existing frontmatter rather than inserted as plain text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100