Updating config file with new features

[nebulosa2007]

There should also be an update mechanism for adding new lines and features to the user's configuration file. Otherwise, Niri use default config newer than the user has and user not warned about it.

Since this commit

[YaLTeR]

When I add new config options I make sure the previous configs without them will have them at the default values, so it shouldn't be a big issue. I try to document all of them in release notes.

[nebulosa2007]

I'm not talking about default values and how Niri's work with them, but about how edit default values.

For example, this commit, which will allow to change screen rotation. All new options need to be moved manually, right?

[YaLTeR]

Wdym? If you don't need rotation, you just do nothing and it keeps working. If you need rotation, you write transform "90" or similar.

[nebulosa2007]

I mean something like:

git diff ~/.config/niri/config.kdl /usr/share/doc/niri/default-config.kdl --word-diff | grep -P '{\+|\[\-' --color=never

Then show those lines or write in ~/.config/niri/config.kdl in proper order.

[YaLTeR]

Well, that's kinda complicated to do right. Plus, I'm sure there are people who'd rather their config not touched every update

[nebulosa2007]

Almost all day think how it could be, yes it's complicated.

Maybe write some instruction in the wiki - on a new release: move config.klm to config.klm.backup, reload Niri and manually edit config file. Something like that.
I understand that if the option is not activated in the config file, Niri use the default settings, but still somehow the config file needs to be updated periodically.

Not a big deal, of course, just thoughts.

[kchibisov]

It's usually solved with putting the actual docs into separate place, like man page.

[0xDEAD-C0DE]

I agree with @kchibisov about new features documented in a man page. User configuration should not be touch at all.

[nebulosa2007]

Meanwhile, I made simple script for updating main config:

Mod+Shift+Ctrl+Slash { spawn "bash" "-c" "$HOME/.config/niri/update_niri_config"; }

and

#!/bin/bash

url="https://raw.githubusercontent.com/YaLTeR/niri/main/resources/default-config.kdl"
config_user="$HOME/.config/niri/config.kdl"
config_default_niri="/tmp/default-config.kdl"

curl -sLR -o $config_default_niri $url
meld $config_default_niri $config_user
rm $config_default_niri