kakoune: update ui options

[lobre]

Description

As ncurses was totally removed from kakoune, the 3 following options don’t exist anymore.

• terminal_change_colors (see: mawww/kakoune@3acf85f)
• terminal_wheel_down_button/terminal_wheel_up_button (see: mawww/kakoune@b841f3a)
• ncurses_builtin_key_parser (see: mawww/kakoune@4dd0b43)

However, 3 new options exist now (https://github.com/mawww/kakoune/blob/bfa3c568ccdc39910e5f9a0cbcc73ed05275087a/doc/pages/options.asciidoc)

• terminal_padding_char
• terminal_padding_fill
• terminal_synchronized

I added those in this PR.

Checklist

• Change is backwards compatible.

• Code formatted with ./format.

• Code tested through nix-shell --pure tests -A run.kakoune-{no-plugins,use-plugins,whitespace-highlighter,whitespace-highlighter-corner-cases}.

• Test cases updated/added. See example.

• Commit messages are formatted like

  {component}: {description}
  
  {long description}
  

  See CONTRIBUTING for more information and recent commit messages for examples.

[teto]

I would add mkRemovedOptionModule to help users transition

[lobre]

I have added mkRemovedOptionModule for the options that were removed.

Let me know if you have any comments, or feel free to merge @teto.

[lobre]

I can see the format failed in the CI. I tried to format it using ./format, but the output seems off. See:

in {
  imports = [
    (mkRemovedOptionModule [ "programs" "kakoune" "config" "ui" "changeColors" ]
      "Kakoune dropped the dependency to ncurses so this option has been removed.")
    (mkRemovedOptionModule [
      "programs"
      "kakoune"
      "config"
      "ui"
      "wheelDownButton"
    ]
      "Kakoune dropped the dependency to ncurses so this option has been removed.")
    (mkRemovedOptionModule [
      "programs"
      "kakoune"
      "config"
      "ui"
      "wheelUpButton"
    ]
      "Kakoune dropped the dependency to ncurses so this option has been removed.")
    (mkRemovedOptionModule [
      "programs"
      "kakoune"
      "config"
      "ui"
      "useBuiltinKeyParser"
    ]
      "Kakoune dropped the dependency to ncurses so this option has been removed.")
  ];

What am I supposed to do? Format anyway? Thanks.

[rycee]

@lobre Don't worry, just ./format 😉

[lobre]

I don’t really understand the error message reported by CI. Does anybody have a clue? That is the first time that I use mkRemovedOptionModule but something seems wrong with the parent "programs.kakoune.config".

error: The option `programs.kakoune.config' in module `/home/runner/work/home-manager/home-manager/modules/programs/kakoune.nix' would be a parent of the following options, but its type `null or (submodule)' does not support nested options.
        - option(s) with prefix `programs.kakoune.config.ui' in module `/home/runner/work/home-manager/home-manager/modules/programs/kakoune.nix'
        - option(s) with prefix `programs.kakoune.config.ui' in module `/home/runner/work/home-manager/home-manager/modules/programs/kakoune.nix'
        - option(s) with prefix `programs.kakoune.config.ui' in module `/home/runner/work/home-manager/home-manager/modules/programs/kakoune.nix'
        - option(s) with prefix `programs.kakoune.config.ui' in module `/home/runner/work/home-manager/home-manager/modules/programs/kakoune.nix'

Help you be appreciated.

[lobre]

Maybe @teto you have an idea about the problem?

Sorry to spam, but I feel that it is unfortunate that this PR is blocked because of this problem, and I struggle to find a solution. I also asked on IRC but haven’t received any help.

[ncfavier]

NixOS/nixpkgs#96006 strikes again.

I think kakoune is a clear example of a module with too many options, and this PR demonstrates why this is a problem.

There are ways to work around the mkRemovedOptionModule problem but they're all quite hacky. I think my preferred solution here would be to drop every option under programs.kakoune.config.ui, and instead make ui a generic attrsOf value for a suitable value type. Users of the deprecated options will get a warning from kakoune anyway, right?

Consider also adding freeformTypes to other submodules so that future new configuration settings can be added without having to change the module (see RFC 42 for more information).

[lobre]

Thank you for your comment and help @ncfavier.

Unfortunately, I don’t have time to work on this anymore. I created this PR while testing kakoune and I thought it would be easier to have those options updated.

I understand the problem and I see the path to the solution. But I don’t have a lot of free time at the moment so I think I will leave this for someone motivated to take over. I am using neovim full-time and I am not sure to come back to kakoune.

I am closing this, but feel free to reopen or take over if anyone is interested.