feat: global install #1791

jameswalmsley · 2021-10-16T18:43:05Z

Resurrected my global-install PR again to work with the latest rolling release.

This ensures that bin/lvim defines all of the LUNARVIM_x_DIR variables correctly.

Also when running as lvim (instead of nvim) we should guarantee that stdpath('data') etc do not give paths to the user standard neovim installation.

kylo252

One thing I'm not set on yet, should we call it LUNARVIM_ROOT_DIR instead?

kylo252 · 2021-10-17T07:12:37Z

utils/bin/lvim

-#!/bin/sh
+#!/bin/bash


Please be aware that macOS is stuck with an ancient bash v3.xx.

Cool, I'll convert it to pure POSIX shell at the end of the PR.. just wanted to scratch up the idea quickly.

That's probably because the default shell is ZSH

kylo252 · 2021-10-17T07:14:29Z

utils/bin/lvim

+#
+# When runnins as lvim the neovim process MUST never refer to the standard user config:
+# Anything that uses stdpath('data'), stdpath('cache') etc will get:
+#
+# LUNARVIM_x_DIR/nvim
+#
+export XDG_CONFIG_HOME=${LUNARVIM_CONFIG_DIR}
+export XDG_DATA_HOME="${LUNARVIM_RUNTIME_DIR}"
+export XDG_CACHE_HOME="${LUNARVIM_CACHE_DIR}"


Interesting, are you sure this actually works tho?

Yes, I used this technique before LunarVim had the bootstrap in the configuration to remove and add folders from the runtimepath. Using just this, I was able to completely decouple a global install from the user's neovim config.

I think when I first did this, because its e.g. XDG_x_HOME/nvim for each folder the paths didn't make sense. (E.g. ~/.local/share/lunarvim/nvim ...).

However combined with the technique you've used already it works nicely.

I looked into the Neovim sources to work out how to do it, and it uses this variables, otherwise the defaults.

This might be risky now that I think about it. A lot of external tools are relying on these variables to read their configuration. If this environment variable is inherited by these tools then this will break a lot of stuff.

Could you test this with git or lazygit, and maybe something like fd or ripgrep?

Thats a good point, anything that forks from neovim will have those variables also..
I'll double check what happens..

I wonder if theres a way to unset those env variables for the nvim process once its running.

I can see in a terminal session thats the case.. I'll see if I can find anything.

Ok, so its simple in VIM... once running:
Simply execute the command e.g:

unlet $XDG_CONFIG_HOME

We could do this conditionally on init.
I suppose it kind of means we should also "push" these variables if they have already been set by the user, and pop them in the lvim init too.

I've tested this, and unsetting XDG_x_HOME variables just causes vim.fn.stdpath() to return the standard values.
The environment variable must be evaluated everytime.

I've tested this, and unsetting XDG_x_HOME variables just causes vim.fn.stdpath() to return the standard values. The environment variable must be evaluated everytime.

So that's a problem, because we also don't want to be missing with these variables as you never know the workflows that people are using. I think it's fine to leave them alone tbh. We have very little dependence on them outside of the cache folder.

This is also the approach I thought for solving #2944
Sadly, neovim does not provide any way to configure what those folders are and make that globally available for everyone, it's very frustrating to be honest.
It really matters because it not only relies on the cache, also the plugins installation place and the extensions state/storage is shared across neovim instances, which is a mess.

kylo252 · 2021-10-17T07:15:33Z

utils/bin/lvim

+export LUNARVIM_RUNTIME_DIR="$HOME/.local/share/lunarvim/data"
+export LUNARVIM_CACHE_DIR="$HOME/.local/share/lunarvim/cache"
+export LUNARVIM_CONFIG_DIR="$HOME/.config/lvim"


Why remove the default values check? It's useful in case the binary and installer get out of sync.

I'll put that back in. (I actually didn't know what the syntax was doing)..

kylo252 · 2021-10-17T07:17:35Z

utils/bin/lvim

+#
+# Ensure a new install has an empty lvim/config.lua file
+#
+if [ ! -f ${LUNARVIM_CONFIG_DIR}/config.lua ]; then
+  mkdir -p ${LUNARVIM_CONFIG_DIR}
+  touch ${LUNARVIM_CONFIG_DIR}/config.lua
+fi
+
+#
+# If the global installation was updated, ensure to run a packer_sync
+# on the users installation.
+#
+if [ -v GLOBAL ]; then
+  if [ ${LUNARVIM_INSTALL_DIR}/.packer_sync -nt ${LUNARVIM_RUNTIME_DIR}/.packer_sync ] || [ ! -f ${LUNARVIM_RUNTIME_DIR}/.packer_sync ]; then
+
+    LUNARVIM_ARGS="+PackerSync"
+    touch ${LUNARVIM_RUNTIME_DIR}/.packer_sync
+  fi
+fi


This part should be decoupled from the binary and handled by either the installer or the update handler.

kylo252 · 2021-10-17T07:18:06Z

lua/lvim/bootstrap.lua

@@ -124,7 +124,7 @@ end
 ---pulls the latest changes from github and, resets the startup cache
 function M:update()
  hooks.run_pre_update()
-  M:update_repo()
+  --M:update_repo()


Why isn't this working?

I have it commented on my branch because I'm using a global installation.
This means that the repo is at:

/usr/share/lunarvim or /opt/lunarvim.

Basically any user process doesn't have permission to git pull at that path.. and I want the other parts of LvimUpdate to succeed.

In a global install the admin would have to update Lvim's repo through...
sudo lvim +LvimUpdate

Or

pacman -Sy lvim

I'll look at update_repo() and make work gracefully on a system where the current user doesn't have permission.

lua/lvim/bootstrap.lua

init.lua

jameswalmsley · 2021-10-17T17:00:55Z

One thing I'm not set on yet, should we call it LUNARVIM_ROOT_DIR instead?

I think we should make the following changes to the names:

LUNARVIM_INSTALL_DIR -> LUNARVIM_ROOT_DIR or LUNARVIM_BASE_DIR
LUNARVIM_RUNTIME_DIR -> LUNARVIM_DATA_DIR (I find runtime a bit too ambiguous).
LUNARVIM_CONFIG_DIR -- same.
LUNARVIM_CACHE_DIR -- same.

@kylo252 Let me know what you think?

kylo252 · 2021-10-17T17:55:21Z

LUNARVIM_INSTALL_DIR -> LUNARVIM_ROOT_DIR or LUNARVIM_BASE_DIR

Let's see if what I added in https://github.com/LunarVim/LunarVim/pull/1777/files/5c3ef594c65ce2396c2f114390c3061295fccfdf fixes the issue, then we won't have to introduce a new variable.

LUNARVIM_RUNTIME_DIR -> LUNARVIM_DATA_DIR (I find runtime a bit too ambiguous).

I'm slightly worried this might cause a regression since we haven't set a reliable way to update the binary. We would need to finish #1444 first, but that should fairly straight-forward anyway.

jameswalmsley · 2021-10-18T11:12:21Z

LUNARVIM_INSTALL_DIR -> LUNARVIM_ROOT_DIR or LUNARVIM_BASE_DIR

Let's see if what I added in https://github.com/LunarVim/LunarVim/pull/1777/files/5c3ef594c65ce2396c2f114390c3061295fccfdf fixes the issue, then we won't have to introduce a new variable.

LUNARVIM_RUNTIME_DIR -> LUNARVIM_DATA_DIR (I find runtime a bit too ambiguous).

I'm slightly worried this might cause a regression since we haven't set a reliable way to update the binary. We would need to finish #1444 first, but that should fairly straight-forward anyway.

I like what you are doing there.
I've mocked out how that can work with the LVIM shim and the global install here:

5cb4762

This is simpler, because the SHIM doesn't need to be updated unless you allow the user to choose an arbitrary base_dir.

It defaults to using a global installation, unless the user has their own local installation, in-which case we use the users config...
And then as you demonstrated we can get the lvim_base dir() automatically.

meijieru · 2021-12-10T01:47:50Z

For someone else waiting for it, here is a tricky way to do it. Put the following in your ~/.config/nvim/init.lua

local home_dir = os.getenv("HOME")
local envs = {
  LUNARVIM_CONFIG_DIR = home_dir .. "/.config/lvim",
  LUNARVIM_RUNTIME_DIR = home_dir .. "/.local/share/lunarvim",
}
for key, val in pairs(envs) do
  vim.fn.setenv(key, val)
end

local lvim_init = envs.LUNARVIM_RUNTIME_DIR .. "/lvim/init.lua"
vim.cmd("source " .. lvim_init)

kylo252 · 2022-04-17T10:32:24Z

@meijieru, @jameswalmsley
Please take a look at 8ccca67 and let me know what you think

meijieru · 2022-08-29T19:20:22Z

@meijieru, @jameswalmsley Please take a look at 8ccca67 and let me know what you think

Thanks for the feature.
Is it safe to directly override the internal function?

kylo252 · 2022-10-06T10:46:52Z

Replaced by #3161

jameswalmsley mentioned this pull request Oct 16, 2021

fix(bootstrap): support for using default neovim config and data directories #1777

Merged

jameswalmsley force-pushed the lunarvim.global.install branch 4 times, most recently from 9e59335 to 153c7a2 Compare October 16, 2021 19:15

kylo252 requested changes Oct 17, 2021

View reviewed changes

jameswalmsley force-pushed the lunarvim.global.install branch 2 times, most recently from bf869aa to f597c4f Compare October 17, 2021 15:16

feat: global install

5bed5aa

jameswalmsley force-pushed the lunarvim.global.install branch from 5cb4762 to 5bed5aa Compare October 20, 2021 17:02

chase force-pushed the rolling branch from 0e24471 to 605c14e Compare November 10, 2021 19:25

danielo515 mentioned this pull request Aug 31, 2022

Make Lunarvim more isolated and hence more portable #2944

Closed

kylo252 mentioned this pull request Oct 6, 2022

feat: enable global installation #3161

Merged

kylo252 closed this Oct 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: global install #1791

feat: global install #1791

jameswalmsley commented Oct 16, 2021

kylo252 left a comment

kylo252 Oct 17, 2021

jameswalmsley Oct 17, 2021

danielo515 Aug 31, 2022

kylo252 Oct 17, 2021

jameswalmsley Oct 17, 2021

kylo252 Oct 17, 2021 •

edited

Loading

jameswalmsley Oct 17, 2021

jameswalmsley Oct 17, 2021

jameswalmsley Oct 17, 2021

kylo252 Oct 20, 2021

danielo515 Aug 31, 2022

kylo252 Oct 17, 2021

jameswalmsley Oct 17, 2021

kylo252 Oct 17, 2021

jameswalmsley Oct 17, 2021

kylo252 Oct 17, 2021

jameswalmsley Oct 17, 2021

jameswalmsley commented Oct 17, 2021 •

edited

Loading

kylo252 commented Oct 17, 2021

jameswalmsley commented Oct 18, 2021 •

edited

Loading

meijieru commented Dec 10, 2021

kylo252 commented Apr 17, 2022

meijieru commented Aug 29, 2022

kylo252 commented Oct 6, 2022

		#!/bin/sh
		#!/bin/bash

feat: global install #1791

feat: global install #1791

Conversation

jameswalmsley commented Oct 16, 2021

kylo252 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kylo252 Oct 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jameswalmsley commented Oct 17, 2021 • edited Loading

kylo252 commented Oct 17, 2021

jameswalmsley commented Oct 18, 2021 • edited Loading

meijieru commented Dec 10, 2021

kylo252 commented Apr 17, 2022

meijieru commented Aug 29, 2022

kylo252 commented Oct 6, 2022

kylo252 Oct 17, 2021 •

edited

Loading

jameswalmsley commented Oct 17, 2021 •

edited

Loading

jameswalmsley commented Oct 18, 2021 •

edited

Loading