feat: support workspaces config option

CHANGELOG.md

@@ -10,10 +10,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - The `overwrite_mappings` option, which sets the mappings in the config even if they already exist
+- Added support for multiple vaults (#128)
+- Added command to switch between vaults (#60)
 
 ### Fixed
 
-- Eliminated silent runtime errors on validation errors in note.from_lines 
+- Eliminated silent runtime errors on validation errors in note.from_lines
 
 ## [v1.14.2](https://github.com/epwalsh/obsidian.nvim/releases/tag/v1.14.2) - 2023-09-25
 

README.md

@@ -46,6 +46,7 @@ Built for people who love the concept of Obsidian -- a simple, markdown-based no
   This command has one optional argument: the ID, path, or alias of the note to link to. If not given, the selected text will be used to find the note with a matching ID, path, or alias.
 - `:ObsidianLinkNew` to create a new note and link it to an in-line visual selection of text.
   This command has one optional argument: the title of the new note. If not given, the selected text will be used as the title.
+- `:ObsidianWorkspace` to switch to another workspace.
 
 ### Demo
 
@@ -86,7 +87,16 @@ return {
     -- see below for full list of optional dependencies 👇
   },
   opts = {
-    dir = "~/my-vault",  -- no need to call 'vim.fn.expand' here
+    workspaces = {
+      {
+        name = "personal",
+        path = "~/vaults/personal",
+      },
+      {
+        name = "work",
+        path = "~/vaults/work",
+      },
+    },
 
     -- see below for full list of options 👇
   },
@@ -106,7 +116,16 @@ use({
   },
   config = function()
     require("obsidian").setup({
-      dir = "~/my-vault",
+      workspaces = {
+        {
+          name = "personal",
+          path = "~/vaults/personal",
+        },
+        {
+          name = "work",
+          path = "~/vaults/work",
+        },
+      },
 
       -- see below for full list of options 👇
     })
@@ -132,8 +151,23 @@ This is a complete list of all of the options that can be passed to `require("ob
 
 ```lua
 {
-  -- Required, the path to your vault directory.
-  dir = "~/my-vault",
+  -- Optional, and for backward compatibility. Setting this will use it as the default workspace
+  -- dir = "~/vaults/other",
+  -- Optional, list of vault names and paths.
+  workspaces = {
+    {
+      name = "personal",
+      path = "~/vaults/personal",
+    },
+    {
+      name = "work",
+      path = "~/vaults/work",
+    },
+  },
+
+  -- Optional, set to true to use the current directory as a vault; otherwise,
+  -- the first workspace is opened by default
+  detect_cwd = false,
 
   -- Optional, if you keep notes in a specific subdirectory of your vault.
   notes_subdir = "notes",

lua/obsidian/command.lua

@@ -651,6 +651,34 @@ command.check_health = function(client, _)
   end
 end
 
+command.switch_workspace = function(client, data)
+  if not data.args or #data.args == 0 then
+    echo.info(
+      "Current workspace: " .. client.current_workspace.name .. " @ " .. tostring(client.dir),
+      client.opts.log_level
+    )
+    return
+  end
+
+  local workspace = nil
+  for _, value in pairs(client.opts.workspaces) do
+    if data.args == value.name then
+      workspace = value
+    end
+  end
+
+  if not workspace then
+    echo.err("Workspace '" .. data.args .. "' does not exist", client.opts.log_level)
+    return
+  end
+
+  client.current_workspace = workspace
+
+  echo.info("Switching to workspace '" .. workspace.name .. "' (" .. workspace.path .. ")", client.opts.log_level)
+  -- NOTE: workspace.path has already been normalized
+  client.dir = Path:new(workspace.path)
+end
+
 local commands = {
   ObsidianCheck = { func = command.check, opts = { nargs = 0 } },
   ObsidianTemplate = { func = command.template, opts = { nargs = "?" } },
@@ -665,6 +693,7 @@ local commands = {
   ObsidianLinkNew = { func = command.link_new, opts = { nargs = "?", range = true } },
   ObsidianFollowLink = { func = command.follow, opts = { nargs = 0 } },
   ObsidianCheckHealth = { func = command.check_health, opts = { nargs = 0 } },
+  ObsidianWorkspace = { func = command.switch_workspace, opts = { nargs = "?" } },
 }
 
 ---Register all commands.

lua/obsidian/config.lua

@@ -1,11 +1,14 @@
 local echo = require "obsidian.echo"
+local workspace = require "obsidian.workspace"
 
 local config = {}
 
 ---[[ Options specs ]]---
 
 ---@class obsidian.config.ClientOpts
----@field dir string
+---@field dir string|?
+---@field workspaces obsidian.Workspace[]|?
+---@field detect_cwd boolean
 ---@field log_level integer|?
 ---@field notes_subdir string|?
 ---@field templates obsidian.config.TemplateOpts
@@ -30,7 +33,9 @@ config.ClientOpts = {}
 ---@return obsidian.config.ClientOpts
 config.ClientOpts.default = function()
   return {
-    dir = vim.fs.normalize "./",
+    dir = nil,
+    workspaces = {},
+    detect_cwd = false,
     log_level = nil,
     notes_subdir = nil,
     templates = config.TemplateOpts.default(),
@@ -64,13 +69,21 @@ config.ClientOpts.normalize = function(opts)
   opts.mappings = opts.mappings and opts.mappings or config.MappingOpts.default()
   opts.daily_notes = vim.tbl_extend("force", config.DailyNotesOpts.default(), opts.daily_notes)
   opts.templates = vim.tbl_extend("force", config.TemplateOpts.default(), opts.templates)
-  opts.dir = vim.fs.normalize(tostring(opts.dir))
 
   -- Validate.
   if opts.sort_by ~= nil and not vim.tbl_contains({ "path", "modified", "accessed", "created" }, opts.sort_by) then
     echo.err("invalid 'sort_by' option '" .. opts.sort_by .. "'")
   end
 
+  for key, value in pairs(opts.workspaces) do
+    opts.workspaces[key].path = vim.fs.normalize(tostring(value.path))
+  end
+
+  if opts.dir ~= nil then
+    -- NOTE: path will be normalized in workspace.new() fn
+    table.insert(opts.workspaces, 1, workspace.new("dir", opts.dir))
+  end
+
   return opts
 end
 

lua/obsidian/init.lua

@@ -10,8 +10,10 @@ obsidian.completion = require "obsidian.completion"
 obsidian.note = require "obsidian.note"
 obsidian.util = require "obsidian.util"
 obsidian.mapping = require "obsidian.mapping"
+obsidian.workspace = require "obsidian.workspace"
 
 ---@class obsidian.Client
+---@field current_workspace obsidian.Workspace
 ---@field dir Path
 ---@field templates_dir Path|?
 ---@field opts obsidian.config.ClientOpts
@@ -24,7 +26,10 @@ local client = {}
 ---@return obsidian.Client
 obsidian.new = function(opts)
   local self = setmetatable({}, { __index = client })
-  self.dir = Path:new(vim.fs.normalize(tostring(opts.dir and opts.dir or "./")))
+
+  self.current_workspace = obsidian.workspace.get_from_opts(opts)
+  -- NOTE: workspace.path has already been normalized
+  self.dir = Path:new(self.current_workspace.path)
   self.opts = opts
   self.backlinks_namespace = vim.api.nvim_create_namespace "ObsidianBacklinks"
 
@@ -37,7 +42,7 @@ end
 ---@return obsidian.Client
 obsidian.new_from_dir = function(dir)
   local opts = config.ClientOpts.default()
-  opts.dir = vim.fs.normalize(dir)
+  opts.workspaces = vim.tbl_extend("force", { obsidian.workspace.new_from_dir(dir) }, opts.workspaces)
   return obsidian.new(opts)
 end
 

lua/obsidian/util.lua

@@ -32,6 +32,20 @@ util.contains = function(table, val)
   return false
 end
 
+---Check if a table (list) contains a key.
+---
+---@param table table
+---@param needle any
+---@return boolean
+util.contains_key = function(table, needle)
+  for key, _ in pairs(table) do
+    if key == needle then
+      return true
+    end
+  end
+  return false
+end
+
 ---Return a new table (list) with only the unique values of the original.
 ---
 ---@param table table

lua/obsidian/workspace.lua

@@ -0,0 +1,74 @@
+---@class obsidian.Workspace
+---@field name string
+---@field path string
+local workspace = {}
+
+---Create a new workspace
+---
+---@param name string Workspace name
+---@param path string Workspace path (will be normalized)
+---
+---@return obsidian.Workspace
+workspace.new = function(name, path)
+  local self = setmetatable({}, { __index = workspace })
+
+  self.name = name
+  self.path = vim.fs.normalize(path)
+
+  return self
+end
+
+workspace.new_from_cwd = function()
+  return workspace.new_from_dir(vim.fn.getcwd())
+end
+
+workspace.new_from_dir = function(dir)
+  return workspace.new(vim.fn.fnamemodify(dir, ":t"), dir)
+end
+
+---Determines if cwd is a workspace
+---
+---@param workspaces table<obsidian.Workspace>
+---@return obsidian.Workspace|nil
+workspace.get_workspace_from_cwd = function(workspaces)
+  local cwd = vim.fn.getcwd()
+  local _, value = next(vim.tbl_filter(function(w)
+    if w.path == cwd then
+      return true
+    end
+    return false
+  end, workspaces))
+
+  return value
+end
+
+---Returns the default workspace
+---
+---@param workspaces table<obsidian.Workspace>
+---@return obsidian.Workspace|nil
+workspace.get_default_workspace = function(workspaces)
+  local _, value = next(workspaces)
+  return value
+end
+
+---Resolves current workspace from client config
+---
+---@param opts obsidian.config.ClientOpts
+---@return obsidian.Workspace
+workspace.get_from_opts = function(opts)
+  local current_workspace
+
+  if opts.detect_cwd then
+    current_workspace = workspace.get_workspace_from_cwd(opts.workspaces)
+  else
+    current_workspace = workspace.get_default_workspace(opts.workspaces)
+  end
+
+  if not current_workspace then
+    current_workspace = workspace.new_from_cwd()
+  end
+
+  return current_workspace
+end
+
+return workspace

test/obsidian/workspace_spec.lua

@@ -0,0 +1,64 @@
+local workspace = require "obsidian.workspace"
+
+local opts = {
+  workspaces = {
+    {
+      name = "work",
+      path = "~/notes/work",
+    },
+    {
+      name = "personal",
+      path = "~/notes/personal",
+    },
+    {
+      name = "cwd_workspace",
+      path = os.getenv "PWD",
+    },
+  },
+  detect_cwd = false,
+}
+
+describe("Workspace", function()
+  it("should be able to initialize a workspace", function()
+    local ws = workspace.new("test_workspace", "/tmp/obsidian_test_workspace")
+    assert.equals("test_workspace", ws.name)
+    assert.equals("/tmp/obsidian_test_workspace", ws.path)
+  end)
+
+  it("should be able to initialize from cwd", function()
+    local ws = workspace.new_from_cwd()
+    local cwd = os.getenv "PWD"
+    assert.equals(vim.fn.fnamemodify(vim.fn.getcwd(), ":t"), ws.name)
+    assert.equals(cwd, ws.path)
+  end)
+
+  it("should be able to retrieve the default workspace", function()
+    local ws = workspace.get_default_workspace(opts.workspaces)
+    assert.is_not(ws, nil)
+    assert.equals(opts.workspaces[1].name, ws.name)
+    assert.equals(opts.workspaces[1].path, ws.path)
+  end)
+
+  it("should initialize workspace from cwd", function()
+    local ws = workspace.get_workspace_from_cwd(opts.workspaces)
+    assert.equals(opts.workspaces[3].name, ws.name)
+    assert.equals(opts.workspaces[3].path, ws.path)
+  end)
+
+  it("should return cwd workspace when detect_cwd is true", function()
+    local old_cwd = opts.detect_cwd
+    opts.detect_cwd = true
+    local ws = workspace.get_from_opts(opts)
+    assert.equals(opts.workspaces[3].name, ws.name)
+    assert.equals(opts.workspaces[3].path, ws.path)
+    opts.detect_cwd = old_cwd
+  end)
+  it("should return default workspace when detect_cwd is false", function()
+    local old_cwd = opts.detect_cwd
+    opts.detect_cwd = false
+    local ws = workspace.get_from_opts(opts)
+    assert.equals(opts.workspaces[1].name, ws.name)
+    assert.equals(opts.workspaces[1].path, ws.path)
+    opts.detect_cwd = old_cwd
+  end)
+end)