`repl-overlays` / `PathSetting`: Support `~/` in paths #482

New issue

Closed

opened 2024-08-21 22:50:28 +00:00 by rbt · 6 comments

rbt commented

2024-08-21 22:50:28 +00:00

Owner

Currently, if I want to set a repl-overlays file in my nix.conf, I have to use the absolute path. This makes it impossible to keep the file in my dotfiles repo, because I don't have the same username/homedir on all my machines.

Describe the solution you'd like

I'd like to be able to set a repl-overlays value of ~/.config/nix/repl.nix in my ~/.config/nix/nix.conf and have it expand out my home directory. This probably shouldn't be allowed in /etc/nix/nix.conf. (It would be nice to have this for the other settings that take paths, like the credential files setting.)

Describe alternatives you've considered

Suffering, using home-manager to set the Nix configuration or my home directory declaratively (suffering), putting a symlink to my repl overlay in a consistent absolute path like /opt/nix/repl.nix or something (suffering when it inevitably breaks and every Nix command fails).

## Is your feature request related to a problem? Please describe. Currently, if I want to set a `repl-overlays` file in my `nix.conf`, I have to use the absolute path. This makes it impossible to keep the file in my dotfiles repo, because I don't have the same username/homedir on all my machines. ## Describe the solution you'd like I'd like to be able to set a `repl-overlays` value of `~/.config/nix/repl.nix` in my `~/.config/nix/nix.conf` and have it expand out my home directory. This probably shouldn't be allowed in `/etc/nix/nix.conf`. (It would be nice to have this for the other settings that take paths, like the credential files setting.) ## Describe alternatives you've considered Suffering, using `home-manager` to set the Nix configuration or my home directory declaratively (suffering), putting a symlink to my repl overlay in a consistent absolute path like `/opt/nix/repl.nix` or something (suffering when it inevitably breaks and every Nix command fails).

rbt commented

2024-08-21 22:50:48 +00:00

Author

Owner

(Hi also!! Sorry I haven't been doing much for Lix lately!)

rbt commented

2024-08-22 03:10:12 +00:00

Author

Owner

Discussed out-of-band with @jade: "yes do it, that's a ux improvement that has no negative consequences to the future".

rbt added the

E/easy

E/help wanted

labels

2024-08-22 03:10:54 +00:00

rbt commented

2024-08-23 19:34:09 +00:00

Author

Owner

Implementation strategy:

Add a SetSettingSettings struct with options like "relative paths allowed" and "tilde paths allowed"
loadConfFile allows tilde paths only in nixUserConfFiles
- Split getConfigDirs() into getUserConfigDir() and getOtherConfigDirs(), so we know which one should be able to access tilde paths
- Check that the user config directory starts with the detected $HOME path
- TODO: What if there's a config file in someone else's home dir, that kinda thing? Have to write tests and such for this.
Config::set and AbstractConfig::applyConfig gain a SetSettingSettings parameter
PathSetting::parse uses SetSettingSettings to determine if relative or tilde paths should be resolved (and if so, from where)

Implementation strategy: - Add a `SetSettingSettings` struct with options like "relative paths allowed" and "tilde paths allowed" - [`loadConfFile`](https://git.lix.systems/lix-project/lix/src/commit/87fd6e00952f3597618a82a121052a9ad37b8f4a/src/libstore/globals.cc#L117) allows tilde paths only in `nixUserConfFiles` - Split `getConfigDirs()` into `getUserConfigDir()` and `getOtherConfigDirs()`, so we know which one should be able to access tilde paths - Check that the user config directory starts with the detected `$HOME` path - TODO: What if there's a config file in someone else's home dir, that kinda thing? Have to write tests and such for this. - `Config::set` and `AbstractConfig::applyConfig` gain a `SetSettingSettings` parameter - `PathSetting::parse` uses `SetSettingSettings` to determine if relative or tilde paths should be resolved (and if so, from where)