Add colortheme configuration to kate

[Asqiir]

This is the second contribution to #87.

This contribution adds support for kate's colorthemes. A user can either pick one of the system themes by name, or a file for a custom theme.

The custom file will never override any existing file, nor will it introduce name collisions.

Known limitations

When picking a theme by name there is no check whether such a theme exists. The existing themes live in the ksyntaxhighlighting framework in data/themes.
But these existing themes do not live in any of ${XDG_DATA_DIRS}. They are included as a linked library. I don't know if there is any non-ugly way to access these (option 1: via an overlay. option 2: going through multiple layers of built-inputs).

As an artefact of that process (when I tried to find the themes) there is an option home.kate.package that allows the user to pick a package to be installed. By default, this is pkgs.kate. That changes the default behaviour of programs.kate.enable: When enabling this option, a package will be installed. I believe this is a more natural behaviour for the enable option.

[magnouvean]

See my comments for some initial possible tweaks

[magnouvean]

Is there something missing here?

[Asqiir]

tldr: No, this is a note that there should be a check – if I just knew how to. (See "known limitations" above.) I improved the comment.

long form: I would like to check that a user can only select valid themes – that are those already packaged in the installed kate package. I could not figure out a viable way, which makes this an error-prone string entry.

[magnouvean]

Here I would suggest creating a nix-derivation here which runs the script. That way you don't have to send in the jquery path as a command-line argument, and in general is a better practice. See here for how we did with the config-writing script

[Asqiir]

I changed to to a derivation in the same style. Imo it looks a bit bloated:

    checkThemeNameScript = pkgs.writeShellApplication {
      name = "checkThemeName";
      runtimeInputs = with pkgs; [ jq ];
      text = builtins.readFile ./check-theme-name-free.sh;
    };

    checkThemeName = name:
    ''
      ${checkThemeNameScript}/bin/checkThemeName ${name}
    '';

    script = pkgs.writeScript "kate-check" (checkThemeName cfg.editor.theme.name);

Maybe it would be nicer to do this with just 1-2 definitions? My attempt would be:

    checkThemeNameScript = pkgs.writeShellApplication {
      name = "checkThemeName";
      runtimeInputs = with pkgs; [ jq ];
      text = builtins.readFile ./check-theme-name-free.sh;
    };

    script = pkgs.writeScript "kate-check" "${checkThemeNameScript}/bin/checkThemeName ${name}";

What do you think?

[Asqiir]

@magnouvean do my changes look alright to you?

[magnouvean]

I will check this out later today (when I get home). There has been a change in the configuration syntax lately after #94, so will probably need some tweaks, but they should be fairly straight forward :). Your solutions to the comments look good though :)

[Asqiir]

@magnouvean You are right it needs some tweaks. I would have preferred to rebase this branch myself & do a new commit at the same time, so there wouldn't have been this broken state now ;)

[magnouvean]

Ah sorry about that. Some prefer different things. I can revert it :)

[magnouvean]

Would be good if you could make sure to have ran nixpkgs-fmt on these files. Other than that if you can get these functional with the latest syntax I think this looks great!

[Asqiir]

I did the changes you proposed.
The kate config now sets all values but makes none immutable. (Should it? What do we want the default behaviour to be?)

[magnouvean]

No, immutability isn't needed granted the module works just fine without them. I see there were some problems with the merging leading to changes in files and hotkeys which shouldn't be there (but this is very easy to fix, I'll do it soon). Are you happy enough with this that we can merge then?

[Asqiir]

@magnouvean yes I'm happy with the current state :)
thx for the fast workflow!

[magnouvean]

Great, I'll merge right away then! Thanks for the contribution, prs like this helps plasma-manager grow and makes the plasma experience in nix better!