test: for ab and shortest link

types: less tables

Author: neo451

lua/obsidian/builtin.lua

@@ -3,12 +3,12 @@ local M = {}
 local util = require "obsidian.util"
 
 ---@class obsidian.link.LinkCreationOpts
----@field path obsidian.Path
 ---@field label string
----@field id string|integer|?
----@field anchor obsidian.note.HeaderAnchor|?
----@field block obsidian.note.Block|?
----@field style "wiki" | "markdown"
+---@field path? obsidian.Path|string|?
+---@field id? string|integer|?
+---@field anchor? obsidian.note.HeaderAnchor|?
+---@field block? obsidian.note.Block|?
+---@field style? "wiki" | "markdown"
 
 ---Create a new unique Zettel ID.
 ---
@@ -34,6 +34,7 @@ M.wiki_link_alias_only = function(opts)
   return string.format("[[%s%s]]", opts.label, header_or_block)
 end
 
+---NOTE: more close to what should be default
 ---@param opts obsidian.link.LinkCreationOpts
 ---@return string
 M.wiki_link_path_only = function(opts)
@@ -89,19 +90,6 @@ M.wiki_link_id_prefix = function(opts)
   end
 end
 
----@param path obsidian.Path vault-relative-path
----@param style "shortest" | "relative" | "absolute"
----@return string foramted_path
-local function format_path(path, style)
-  if style == "absolute" then
-    return assert(path:vault_relative_path {})
-  elseif style == "relative" then
-    return assert(tostring(path:relative_to(Obsidian.buf_dir)), "failed to resolve link path against current note")
-  else
-    return vim.fs.basename(tostring(path))
-  end
-end
-
 ---@param opts obsidian.link.LinkCreationOpts
 ---@return string
 M.markdown_link = function(opts)
@@ -115,10 +103,7 @@ M.markdown_link = function(opts)
     header = "#" .. opts.block.id
   end
 
-  local path = format_path(opts.path, Obsidian.opts.link.format)
-  path = util.urlencode(path, { keep_path_sep = true })
-
-  return string.format("[%s%s](%s%s)", opts.label, header, path, anchor)
+  return string.format("[%s%s](%s%s)", opts.label, header, opts.path, anchor)
 end
 
 ---@param path string

lua/obsidian/completion/sources/base/new.lua

@@ -1,6 +1,5 @@
 local completion = require "obsidian.completion.refs"
 local util = require "obsidian.util"
-local LinkStyle = require("obsidian.config").LinkStyle
 local Note = require "obsidian.note"
 local Path = require "obsidian.path"
 

lua/obsidian/completion/sources/base/refs.lua

@@ -1,5 +1,4 @@
 local completion = require "obsidian.completion.refs"
-local LinkStyle = require("obsidian.config").LinkStyle
 local util = require "obsidian.util"
 local api = require "obsidian.api"
 local search = require "obsidian.search"

lua/obsidian/config/default.lua

@@ -29,8 +29,8 @@ return {
   link = {
     style = "wiki",
     markdown = require("obsidian.builtin").markdown_link,
-    wiki = require("obsidian.builtin").wiki_link_id_prefix,
-    fromat = "shortest",
+    wiki = require("obsidian.builtin").wiki_link_path_only,
+    format = "shortest",
   },
 
   workspaces = {},

lua/obsidian/config/init.lua

@@ -20,18 +20,6 @@ config.SortBy = {
   created = "created",
 }
 
----@enum obsidian.config.NewNotesLocation
-config.NewNotesLocation = {
-  current_dir = "current_dir",
-  notes_subdir = "notes_subdir",
-}
-
----@enum obsidian.config.LinkStyle
-config.LinkStyle = {
-  wiki = "wiki",
-  markdown = "markdown",
-}
-
 ---@enum obsidian.config.Picker
 config.Picker = {
   telescope = "telescope.nvim",

lua/obsidian/note.lua

@@ -16,7 +16,6 @@ local search = require "obsidian.search"
 local iter = vim.iter
 local compat = require "obsidian.compat"
 local api = require "obsidian.api"
-local config = require "obsidian.config"
 local Frontmatter = require "obsidian.frontmatter"
 
 local SKIP_UPDATING_FRONTMATTER = { "README.md", "CONTRIBUTING.md", "CHANGELOG.md" }
@@ -117,7 +116,7 @@ end
 ---@private
 Note._get_creation_opts = function(opts)
   --- @type obsidian.note.NoteCreationOpts
-  local default = {
+  local ret = {
     notes_subdir = Obsidian.opts.notes_subdir,
     note_id_func = Obsidian.opts.note_id_func,
     new_notes_location = Obsidian.opts.new_notes_location,
@@ -127,22 +126,23 @@ Note._get_creation_opts = function(opts)
   local success, template_path = pcall(resolve_template, opts.template, api.templates_dir())
 
   if not success then
-    return default
+    return ret
   end
 
   local stem = template_path.stem:lower()
 
   -- Check if the configuration has a custom key for this template
   for key, cfg in pairs(Obsidian.opts.templates.customizations) do
     if key:lower() == stem then
-      return {
+      ret = {
         notes_subdir = cfg.notes_subdir,
         note_id_func = cfg.note_id_func,
-        new_notes_location = config.NewNotesLocation.notes_subdir,
+        new_notes_location = "notes_subdir",
       }
+      break
     end
   end
-  return default
+  return ret
 end
 
 --- Resolves the title, ID, and path for a new note.
@@ -224,7 +224,7 @@ Note._resolve_title_id_path = function(title, id, dir, strategy)
   else
     local bufpath = Path.buffer(0):resolve()
     if
-      strategy.new_notes_location == config.NewNotesLocation.current_dir
+      strategy.new_notes_location == "current_dir"
       -- note is actually in the workspace.
       and Obsidian.dir:is_parent_of(bufpath)
       -- note is not in dailies folder
@@ -1129,27 +1129,46 @@ Note.load_contents = function(self)
   end
 end
 
+---@param path obsidian.Path vault-relative-path
+---@param style obsidian.link.LinkFormat
+---@return string foramted_path
+local function format_path(path, style)
+  if style == "absolute" then
+    return assert(path:vault_relative_path {})
+  elseif style == "relative" then
+    return assert(tostring(path:relative_to(Obsidian.buf_dir)), "failed to resolve link path against current note")
+  else
+    return vim.fs.basename(tostring(path))
+  end
+end
+
 --- Create a formatted markdown / wiki link for a note.
 ---
----@param opts obsidian.link.LinkCreationOpts
+---@param opts obsidian.link.LinkCreationOpts?
 ---@return string
 Note.format_link = function(self, opts)
   opts = opts or {}
   local label = opts.label or self:display_name()
   local note_id = opts.id or self.id
   local link_style = opts.style or Obsidian.opts.link.style
 
+  local formatted_path = format_path(self.path, Obsidian.opts.link.format)
+  formatted_path = util.urlencode(formatted_path, { keep_path_sep = true })
+  if link_style == "wiki" then
+    formatted_path = formatted_path:gsub(".md", "")
+  end
+
   local new_opts = {
-    path = self.path,
+    path = formatted_path,
     label = label,
     id = note_id,
     anchor = opts.anchor,
     block = opts.block,
   }
 
-  if link_style == config.LinkStyle.markdown then
+  if link_style == "markdown" then
     return Obsidian.opts.link.markdown(new_opts)
-  elseif link_style == config.LinkStyle.wiki or link_style == nil then
+  elseif link_style == "wiki" or link_style == nil then
     return Obsidian.opts.link.wiki(new_opts)
   else
     error(string.format("Invalid link style '%s'", link_style))
@@ -1178,7 +1197,7 @@ end
 ---@class obsidian.note.NoteCreationOpts
 ---@field notes_subdir string
 ---@field note_id_func fun()
----@field new_notes_location string
+---@field new_notes_location "current_dir" | "notes_subdir"
 
 ---@class obsidian.note.NoteOpts
 ---@field title string|? The note's title

lua/obsidian/types.lua

@@ -37,7 +37,7 @@
 ---@field log_level? integer
 ---@field notes_subdir? string
 ---@field templates? obsidian.config.TemplateOpts
----@field new_notes_location? obsidian.config.NewNotesLocation
+---@field new_notes_location? obsidian.note.NewNotesLocation
 ---@field note_id_func? (fun(title: string|?, path: obsidian.Path|?): string)|?
 ---@field note_path_func? fun(spec: { id: string, dir: obsidian.Path, title: string|? }): string|obsidian.Path
 ----@field wiki_link_func? fun(opts: {path: string, label: string, id: string|?}): string
@@ -71,7 +71,7 @@
 ---@field log_level integer
 ---@field notes_subdir string|?
 ---@field templates obsidian.config.TemplateOpts
----@field new_notes_location obsidian.config.NewNotesLocation
+---@field new_notes_location obsidian.note.NewNotesLocation
 ---@field note_id_func (fun(title: string|?, path: obsidian.Path|?): string)|?
 ---@field note_path_func (fun(spec: { id: string, dir: obsidian.Path, title: string|? }): string|obsidian.Path)|?
 ----@field wiki_link_func (fun(opts: {path: string, label: string, id: string|?}): string)
@@ -96,3 +96,6 @@
 ---@field comment obsidian.config.CommentOpts
 ---@field search obsidian.config.SearchOpts
 ---@field link obsidian.config.LinkOpts
+
+---@alias obsidian.link.LinkFormat "shortest" | "relative" | "absolute"
+---@alias obsidian.note.NewNotesLocation "current_dir" | "notes_subdir"

tests/test_builtin.lua

@@ -76,8 +76,4 @@ T["markdown_link"]["should work with an anchor link"] = function()
   )
 end
 
-T["markdown_link"]["should URL-encode paths"] = function()
-  eq("[Foo](notes/123%20foo.md)", builtin.markdown_link { path = "notes/123 foo.md", id = "123-foo", label = "Foo" })
-end
-
 return T

tests/test_note.lua

@@ -395,6 +395,33 @@ T["resolve_title_id_path"]["should ensure result of 'note_path_func' is always a
   eq(Path.new(Obsidian.dir) / "notes" / "foo-bar-123.md", path)
 end
 
+T["format_link"] = new_set()
+
+T["format_link"]["should respect link.style"] = function() end
+
+T["format_link"]["wiki should respect link.format"] = function()
+  -- default to link.style = "shortest"
+  (Obsidian.dir / "notes"):mkdir { exist_ok = true }
+  local note = from_str(foo, Obsidian.dir / "notes/foo.md")
+  eq("[[foo]]", note:format_link())
+  Obsidian.opts.link.format = "absolute"
+  eq("[[notes/foo]]", note:format_link())
+  -- Obsidian.opts.link.format = "relative"
+  -- eq("[[foo]]", note:format_link())
+end
+
+T["format_link"]["markdown should respect link.format"] = function()
+  -- default to link.style = "shortest"
+  Obsidian.opts.link.style = "markdown"
+  (Obsidian.dir / "notes"):mkdir { exist_ok = true }
+  local note = from_str(foo, Obsidian.dir / "notes/foo.md")
+  eq("[foo](foo.md)", note:format_link())
+  Obsidian.opts.link.format = "absolute"
+  eq("[foo](notes/foo.md)", note:format_link())
+  -- Obsidian.opts.link.format = "relative"
+  -- eq("[[foo]]", note:format_link())
+end
+
 -- T["reference_paths"] = new_set()
 --
 -- T["reference_paths"]["do four basic paths"] = function()