luarc.json: Environment variables inside of workspace.library paths?

[b0o]

It it possible to use environment variables inside workspace.library paths in .luarc.json? I don't want to hard-code paths for my local machine. I couldn't find any documentation about this.

[sumneko]

All paths support using $ENV_VAR.

(Translated by ChatGPT)

[chaneyzorn]

lua-language-server/script/files.lua

Line 945 in cb964c6

elseif key:sub(1, 4) == "env:" then

According to the lua_ls codes, I think it can be:

example:

"workspace.library": [ "${env:HOME}/path/to/lib", "${env:VIMRUNTIME}" ]

(I couldn't find any documentation about this either)

[tomlau10]

This syntax seems borrowed the idea from vscode variable substitution: https://code.visualstudio.com/docs/editor/variables-reference#_environment-variables

(And you're right that there should be better documentation on luals side 🙈 )

[tomlau10]

I just found that luals actually do support the $ENV_VAR syntax, in the logic of util.expandPath

from a comment in another repo EmmyLuaLs/emmylua-analyzer-rust#28 (comment)

• lua-language-server/script/files.lua

  Lines 967 to 970 in 115a518

  	function m.normalize(path)
  	path = m.resolvePathPlaceholders(path)
  	path = util.expandPath(path)
  	path = path:gsub('^%.[/\\]+', '')

• lua-language-server/script/utility.lua

  Lines 712 to 721 in 115a518

  	function m.expandPath(path, env)
  	if path:sub(1, 1) == '~' then
  	local home = getenv('HOME')
  	if not home then -- has to be Windows
  	home = getenv 'USERPROFILE' or (getenv 'HOMEDRIVE' .. getenv 'HOMEPATH')
  	end
  	return home .. path:sub(2)
  	elseif path:sub(1, 1) == '$' then
  	path = path:gsub('%$([%w_]+)', function (name)
  	return env and env[name] or getenv(name) or ''

---

so you can actually write it as

"workspace.library": [ "~/path/to/lib", "$VIMRUNTIME" ]

[hinell]

I've reported an issue in documentation repo so these features are documented:

• Document ENV variables refs in workspace.library config LuaLS.github.io#49