Snippet for creating a sandboxed environment

[TheMeaningfulEngineer]

I wanted to have a sandboxed way to test Obsidian on its own without the experiments polluting my global nvim config.
Below is a snippet that will install obsidian and run nvim with a custom config all from a sandboxed environment (limited just to that folder).
The neovim still has to be in path.
Tested this on Ubuntu 24.04.

mkdir nvim-plugin-test
cd nvim-plugin-test
git clone https://github.com/folke/lazy.nvim

mkdir -p config/nvim/lua/plugins
cat << 'EOF' > config/nvim/init.lua
local lazypath = vim.fn.expand("$PWD/lazy.nvim")
vim.opt.rtp:prepend(lazypath)

-- Make Lua able to find the plugins module
package.path = vim.fn.expand("$PWD/config/nvim/lua/?.lua;") .. package.path

require("lazy").setup("plugins")
EOF


mkdir -p vaults/test-vault
cat << 'EOF' > config/nvim/lua/plugins/init.lua
return {
  {
    "obsidian-nvim/obsidian.nvim",
    version = "*",
    dependencies = { "nvim-lua/plenary.nvim" },
    opts = {
      workspaces = {
        {
          name = "test",
          path = vim.fn.getcwd() .. "/vaults/test-vault",
        },
      },
    },
  },
}
EOF

XDG_CONFIG_HOME=$PWD/config \
XDG_DATA_HOME=$PWD/data \
XDG_STATE_HOME=$PWD/state \
XDG_CACHE_HOME=$PWD/cache \
nvim -u config/nvim/init.lua

[neo451]

Nice one! I tested it on nixos and it works fine.
I made a few modifications

mkdir nvim-plugin-test
cd nvim-plugin-test
git clone https://github.com/folke/lazy.nvim --depth 1

mkdir -p config/nvim/lua/plugins
cat << 'EOF' > config/nvim/init.lua
local lazypath = vim.fn.expand("$PWD/lazy.nvim")
vim.opt.rtp:prepend(lazypath)

-- Make Lua able to find the plugins module
package.path = vim.fn.expand("$PWD/config/nvim/lua/?.lua;") .. package.path

require("lazy").setup("plugins")
EOF


mkdir -p vaults/test-vault
cat << 'EOF' > config/nvim/lua/plugins/init.lua
return {
  {
    "obsidian-nvim/obsidian.nvim",
    version = "*",
    dependencies = { "nvim-lua/plenary.nvim" },
    opts = {
      workspaces = {
        {
          name = "test",
          path = vim.fs.joinpath(vim.uv.cwd(), "vaults", "test-vault")
        },
      },
    },
  },
}
EOF

XDG_CONFIG_HOME=$PWD/config \
XDG_DATA_HOME=$PWD/data \
XDG_STATE_HOME=$PWD/state \
XDG_CACHE_HOME=$PWD/cache \
nvim -u config/nvim/init.lua

Also do you think we to add a picker?

[neo451]

I created a pure lua version based on folke's repro approach (in the hope that it will work on windows) #50

[neo451]

I have merged the new changes, feel free to try them!

[TheMeaningfulEngineer]

@neo451

mkdir nvim-plugin-test
cd nvim-plugin-test

git clone [email protected]:obsidian-nvim/obsidian.nvim.git
CONF_PATH=$(pwd)/obsidian.nvim/minimal.lua

XDG_CONFIG_HOME=$PWD/config
XDG_DATA_HOME=$PWD/data
XDG_STATE_HOME=$PWD/state
XDG_CACHE_HOME=$PWD/cache

nvim -u $CONF_PATH

Gave it a run, definitely much simpler now, thanks.
Perhaps ask for a review for the PR next time will gladly test and comment there.

A lot of external dependencies for the minimal (blink, nvim-cmp, telescope, render-markdown + mini.icons).
I envisioned minimal as something that gives you obsidian.nvim plus whatever features you would get wit vanilla neovim.
After that the choice of picker, autocomplete plugin etc... are extra integrations.

You have a vision behind going that way?
That way being implying a stronger coupling with the plugins. :)

[neo451]

I will surely ask for a review next time, I happened to have more time this weekend and want to make that release as soon as possible.
I think you make a good point in like implying coupling, maybe I will just comment out all the dependencies in a new PR.
But on the other hand the example dependencies should live there because many issues we see is regarding integrations, and you don't get many things like search and completion out of box with vanilla obsidian.nvim.
I think implying coupling is not much a issue if we are moving towards decoupling :)
To me the sanbox thing is not about minimal but to to avoid some werid global option that the user or some other plugin has set, so that users don't show up with non-issues.

[TheMeaningfulEngineer]

Solved with "tip" in https://github.com/obsidian-nvim/obsidian.nvim?tab=readme-ov-file#-installation
Closing