search

nix-community / nix-direnv

A fast, persistent use_nix/use_flake implementation for direnv [maintainer=@Mic92 / @bbenne10]
MIT License
1.78k stars 101 forks source link

[README] Show the `hide_env_diff` configuration in `home-manager` section #485

Closed MathisWellmann closed 5 months ago

MathisWellmann commented 5 months ago

Background:

After spending too much time trying to figure out how to silence the large block of text showing the exported variables upon entering the directory I came across an elegant solution described in this thread comment: https://github.com/direnv/direnv/issues/68#issuecomment-2054033048

Quote:

Since direnv 2.34.0, to remove the "export" message completely, add hide_env_diff = true to ~/.config/direnv/direnv.toml in the global section:

[global]
# https://direnv.net/man/direnv.toml.1.html
hide_env_diff = true

Changes:

Adds the required configuration to home-manager section in the README.

Impact:

Will help out everyone (who views the home-manager section) to quickly find the required configuration setting. This will greatly increase user retention as without this, the block of logs produced is a major turnoff IMO.

Thanks for this nice project.

bbenne10 commented 5 months ago

This is a direnv configuration option that we don't need to interact with. I would prefer to remain somewhat neutral on how users interact with direnv outside of setting up nix-direnv properly.

This stance is because I'm not entirely sure that I agree with the line that their community has drawn around what is "configuration" - and therefore needs to be in direnv.toml and what is "code" - and thus needs to be in .enrvc or .direnvrc. This PR blurs the lines just a bit further, I think.

I am a soft "no" on merging this. While not technically wrong, this documentation does not belong in our README. Furthermore, this is a relatively bleeding-edge feature (released in direnv 2.34, which is not even in a stable NixOS channel yet) and I don't feel like debugging that with users opening issues against nix-direnv with a too-old direnv version. I spend enough time debugging problems that are direnv or nixos configuration related without this one (probably) making it worse.

I'll let @Mic92 make the final call here though.

bbenne10 commented 5 months ago

I have pushed a change to the README in #487 that notes this change in a way I feel is more appropriate for this project. Let me know if that works for you.

MathisWellmann commented 5 months ago

I'm happy with your README changes in #487. That should be enough for user to be aware of this option.

Thanks