feat(templates): provide note to custom variable substitution functions

[cristobalgvera]

Descrition

Provide the Note related with the template to the custom variable substitution function. This helps to define custom variables that require Note data.

Examples

Uppercase the note ID

-- ...
templates = {
  substitutions = {
    ---@param note obsidian.Note
    uppercase_id = function(note)
      return note.id:upper()
    end,
  }
}
-- ...

Set a custom title based on the note ID

-- ...
templates = {
  substitutions = {
    ---Format `id` field of `Note` to a more human-readable string.
    ---For an `id` "17823674-My-note-title", it will returns "My note title"
    ---@param note obsidian.Note
    normalized_title = function(note)
        return note.id:gsub("%d+-?", ""):gsub("-", " ")
    end,
  }
}
-- ...

This will make the template variables more flexible, e.g.:

<!-- This template -->
# {{normalized_title}}

<!-- ...will be replaced by -->
# My note title

<!-- Instead of this template -->
# {{id}}

<!-- ...that will be replaced to -->
# 17823674-My-note-title

Changes

• Provide Note when executing substitution functions.
• Update test related with the substitution functions.
• Add change to CHANGELOG.md.

[ajmasia]

Any news here?