openinf / openinf-autoenvstack

Autoenvstack

Make your fish feel better in the environment of trees.

(or an improved version of autoenvfish)

Fish plugin. Once installed, it will do essentially the following

• if you enter some directory and there's .env.fish inside, it will be sourced
• if you leave that directory, the file will be "unsourced"

"Unsourcing" means restoring back global shell variables (exported or not). There could be multiple .env.fish on different levels of folder structure. Diving into such a tree with a single cd command would cause them to be sourced in order. Global variables are retained at each level, so returning would unsource files in reversed order. It works similarly to the concept of local scope variables in some programming languages, including fish.

Install

With fisherman

fisher OpenINF/openinf-autoenvstack

Example

In ~/play/.env.fish settitle sets a global variable that is displayed both in the title and command prompt.

In both ~/play/scrapy/.env.fish and ~/play/flask/.env.fish Python virtual environment is activated.

By moving around, files are sourced and unsourced, eventually restoring the initial state of the global variables.

Bugs

If, under some circumstances, autoenvstack removes all your globally declared variables (no colors, git complains), clean up the cache of universal variables:

rm -f ~/.config/fish/fishd.*

openinf-autoenvstack's Issues

potential areas for optimization and improvement

RE OpenINF/openinf.github.io#1179

From Claude:

Overall, the script is functional, but there are a few potential areas for optimization and improvement.

The script appears to be a fish shell implementation of the autoenv/direnv concept, where it automatically loads and unloads environment variables based on the current working directory.

Here are some potential issues or points to consider:

1. The _autoenvstack_activate_env function seems like what you provided earlier. It looks correct, assuming that the _autoenvstack_hash function is working as expected.

2. In the _autoenvstack_deactivate_env function, there's a line set $var_name $$old_var_name that attempts to restore a variable's original value. However, if the original value was an empty string or a value that could be interpreted as a command, this line might cause issues. Using the set -g flag to explicitly set a global variable might be safer.

3. The _autoenvstack_deactivate_env function uses several external commands (grep, sed, comm, psub) to filter and process variable names. This could be a performance bottleneck, especially if there are many variables. Consider optimizing these operations or using native fish shell constructs if possible.

4. The _autoenvstack_switch_to_new_stack function is quite complex and could benefit from some refactoring and comments explaining the logic. It seems to determine which environments need to be activated or deactivated based on the current and new stacks.

5. The _autoenvstack function is triggered on the PWD (current working directory) variable change. It constructs the new stack of environments to be activated and calls _autoenvstack_switch_to_new_stack. This function seems to work as intended, assuming the _autoenvstack_switch_to_new_stack function is correct.

6. The _autoenvstack_hash function is used to generate a hash from the environment directory path. Depending on the requirements, using a simple string substitution (as implemented) might not be suitable for handling all possible directory paths. Consider using a more robust hashing algorithm if necessary.

7. The script assumes that the .env.fish file exists in the environment directories and contains the environment variable definitions. Make sure that these files are present and correctly formatted.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

None detected

---

• Check this box to trigger a request for Renovate to run again on this repository