danth
gtksourceview: init module
Adds the gtksourceview target. This is used to configure GNOME Text Editor^1, among others. The gnome-text-editor target is made mostly obsolete by this. It only works on Home Manager though.
Moves the theme template from the gedit module, because GTKSourceView is the more generic target.
I haven't tested this yet!
This documentation page suggests to me that a package containing share/gnome/gtksourceview-{2.0,3.0}/styles/stylix.xml might appear on the search path, which would get this working at the NixOS level too. If not, it contains a Python script to find out exactly what the search path is.
This works in my config!
There are some differences between the highlighting in GNOME Text Editor compared to VSCode, which could be caused by differences in our templates or differences in the editors themselves, however that's not relevant to this PR. The good thing is that it's now using the correct user level theme.
Once NixOS is supported, we should remove the gnome-text-editor module completely and just use lib.mkRenamedOptionModule to handle its enable option.
Do you want to work on NixOS now, or merge this and leave it for later?
There are some differences between the highlighting in GNOME Text Editor compared to VSCode, which could be caused by differences in our templates or differences in the editors themselves, however that's not relevant to this PR.
We could adapt both themes to the base16 style guide in a future PR!
Once NixOS is supported, we should remove the
gnome-text-editormodule completely and just uselib.mkRenamedOptionModuleto handle its enable option.Do you want to work on NixOS now, or merge this and leave it for later?
Now that you mention it's possible, I'd rather work on the NixOS implementation first to enable a seamless transition from the gnome-text-editor module.
Not sure if we should actually remove the old module though, because some might have disabled it when its overlay caused issues. If we just remove the module, targets.gnome-text-editor.enable = false would result in an error, which might be confusing to some.
One of lib.mkRenamedOptionModule, lib.mkRemovedOptionModule or lib.mkChangedOptionModule would handle the removed option gracefully. I think lib.mkChangedOptionModule offers customisation so we could set a more helpful message.
@danth I added a NixOS implementation by overriding various gtksourceview packages. But now all other packages depending on gtksourceview will be rebuilt. I think this is quite a high cost for something that's already available as a Home Manager module.
The Stylix manual also says:
Many applications cannot be configured system wide, so Stylix will also need Home Manager to be able to change their settings within your home directory.
Realistically, most Stylix users also use Home Manager anyways. For this reason I'll disable the NixOS module by default.
OK, apparently this is the updated documentation for gtksourceview-5:
${PREFIX}/share/gtksourceview-5/(where ${PREFIX} can be/usr/or/usr/local/if you have installed from source)
I copied the theme to gtksourceview-5 and gtksourceview-2.0. I also added it to gtksourceview-4, all though I couldn't find any documentation for this version.
The theme works again!
@danth I added a NixOS implementation by overriding various
gtksourceviewpackages. But now all other packages depending ongtksourceviewwill be rebuilt. I think this is quite a high cost for something that's already available as a Home Manager module.The Stylix manual also says:
Many applications cannot be configured system wide, so Stylix will also need Home Manager to be able to change their settings within your home directory.
Realistically, most Stylix users also use Home Manager anyways. For this reason I'll disable the NixOS module by default.
Is it not possible to enable the module when the Stylix Home Manager module is not used? For reference, commit 2c20aed3b39a ("qt: autoenable hm module only on NixOS (#942)") uses osConfig as a workaround for detecting this.
Sure, that would be possible! However this wouldn't be able to detect standalone Home Manager.
What is the status of this PR? At this point, I assume there are quiet many merge conflicts.
I honestly can't remember because it's been so long. I'll try to tackle my backlog next week, but I can't promise anything. After that I will be working on a personal project for a year and I'm not sure how available I'll be during that time.
I rebased this onto master and removed some checks to simplify things for now. I enabled the overlay by default because there aren't many apps that depend on gtksourceview, so the rebuild wouldn't be too expensive.
I removed the warning for gnome-text-editor that it depends on gtksourceview, because gtksourceview is enabled by default anyways. There should probably be a more streamlined way to declare dependencies.
As per https://github.com/nix-community/stylix/pull/958#issuecomment-3037193959 I can only provide maintenance on a best-efford basis. These modules should be fine though, since they aren't too complex.
The maintainers file should comment that it's merged with nixpkgs maintainers.
GTKSourceView isn't an app, but multiple apps depend on it. There is already a testbed for the GNOME Text Editor.