Option to override environment variables in child processes #5063
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Today I have to restart Kakoune in order to set environment variables in shell expansions globally. For example KAK_LSP_FORCE_PROJECT_ROOT. When running ":git" commands, there is an ambiguity on whether to use the $PWD or the buffer's worktree. We use $PWD but it should be possible to override this behavior. An obvious way to do this is to override Git environment variables: set-option -add global env GIT_WORK_TREE=/path/to/my/repo GIT_DIR=/path/to/my/repo.git (another in-flight patch adds the obvious default to GIT_DIR so we don't need to set that). --- There are some minor issues left - If a user sets PATH, this will stomp the one we setenv()'d. - Today both key and value require escaping for = and \. This is not intuitive. Since neither environment variables nor ui_options ever need a = in the key name, we can get rid of the escaping. Alternative approach: The str-to-str-map can be somewhat clunky. We could instead export any option named like env_FOO. Not yet sure which approach is better. Closes mawww#4482 That issues asks for a separate client-specific env as well but we don't have a client scope so I'm not sure.
krobelus
added a commit
to kakoune-lsp/kakoune-lsp
that referenced
this pull request
Feb 10, 2024
To use, either patch Kakoune using mawww/kakoune#5063 and set preferred servers for each buffer like set-option -add buffer env KAK_LSP_LANGUAGE_SERVER=pylsp_main # or pylsp_test Alternatively, use (untested) unset-option buffer lsp_cmd set-option buffer lsp_cmd "KAK_LSP_LANGUAGE_SERVER=pylsp_main %opt{lsp_cmd}"
krobelus
commented
Feb 12, 2024
| @@ -146,6 +146,8 @@ Vector<String> generate_env(StringView cmdline, const Context& context, GetValue | |||
| static const Regex re(R"(\bkak_(quoted_)?(\w+)\b)"); | |||
|
|
|||
| Vector<String> env; | |||
| for (const auto& [key, value] : context.options()["env"].get<HashMap<String, String, MemoryDomain::Options>>()) | |||
| env.push_back(format("{}={}", key, value)); | |||
There was a problem hiding this comment.
This is an ergonomic abstraction; notably it's incomplete in that it does not allow to unset environment variables, and neither does it allow erase the entire environment (though I don't think there is a use case for that).
A more flexible (but probably not better) approach would be to allow overriding KAKOUNE_POSIX_SHELL dynamically, then we can set it to env ... "$@"..
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today I have to restart Kakoune in order to set environment variables
in shell expansions globally. For example KAK_LSP_FORCE_PROJECT_ROOT or RUST_BACKTRACE.
Another use case is when using
rust-analyzer's test framework.When a test fails, it tells me to run
env UPDATE_EXPECT=1 cargo testto update test with the actual behavior.The
kakoune-cargoplugin does not provide a way to set environment variables.The reason I want to run this from the editor is that this allows me to run only the test at cursor (using
rust-analyzercode lenses).When running ":git" commands, there is an ambiguity on whether to
use the $PWD or the buffer's worktree. We use $PWD but it should be
possible to override this behavior. An obvious way to do this is to
override Git environment variables:
(another in-flight patch adds the obvious default to GIT_DIR so we don't need to set that).
There are some minor issues left
intuitive. Since neither environment variables nor ui_options ever
need a = in the key name, we can get rid of the escaping.
Alternative approach: The str-to-str-map can be somewhat clunky. We
could instead export any option named like env_FOO. Not yet sure
which approach is better.
Alternative: maybe a
setenvorexportcommand?Closes #4482
That issues asks for a separate client-specific env as well but we
don't have a client scope so I'm not sure.