From 0ff53f6d336edb3ad81647dc931ad1c9c7f890ca Mon Sep 17 00:00:00 2001
From: Aneesh Bhave <aneesh1701@gmail.com>
Date: Tue, 25 Mar 2025 23:55:51 +0000
Subject: [PATCH] helix: add extraConfig option (#6575)

The extraConfig option can be used to append
ordered lines to helix configuration. Helix
depends on order for rendering minor mode menus.
---
 modules/programs/helix.nix                    | 24 +++++++++++++++----
 .../programs/helix/example-settings.nix       | 10 +++++---
 .../programs/helix/settings-expected.toml     |  4 ++++
 3 files changed, 30 insertions(+), 8 deletions(-)

diff --git a/modules/programs/helix.nix b/modules/programs/helix.nix
index 840f5d82f..6529e6c22 100644
--- a/modules/programs/helix.nix
+++ b/modules/programs/helix.nix
@@ -1,7 +1,5 @@
 { config, lib, pkgs, ... }:
-
 with lib;
-
 let
   cfg = config.programs.helix;
   tomlFormat = pkgs.formats.toml { };
@@ -26,6 +24,20 @@ in {
       description = "Extra packages available to hx.";
     };
 
+    extraConfig = mkOption {
+      type = types.lines;
+      default = "";
+      description = ''
+        Extra lines to be appended to the config file.
+        Use this if you would like to maintain order for helix settings (eg. for minor modes)
+      '';
+      example = literalExpression ''
+        [keys.normal.g] # Reverse Alphabetical Order
+        G = "goto_file_end"
+        g = "goto_file_start"
+      '';
+    };
+
     defaultEditor = mkOption {
       type = types.bool;
       default = false;
@@ -200,7 +212,9 @@ in {
     xdg.configFile = let
       settings = {
         "helix/config.toml" = mkIf (cfg.settings != { }) {
-          source = tomlFormat.generate "helix-config" cfg.settings;
+          text =
+            builtins.readFile (tomlFormat.generate "helix-config" cfg.settings)
+            + "\n" + cfg.extraConfig;
         };
         "helix/languages.toml" = mkIf (cfg.languages != { }) {
           source = tomlFormat.generate "helix-languages-config" cfg.languages;
@@ -210,10 +224,10 @@ in {
         };
       };
 
-      themes = (mapAttrs' (n: v:
+      themes = mapAttrs' (n: v:
         nameValuePair "helix/themes/${n}.toml" {
           source = tomlFormat.generate "helix-theme-${n}" v;
-        }) cfg.themes);
+        }) cfg.themes;
     in settings // themes;
   };
 }
diff --git a/tests/modules/programs/helix/example-settings.nix b/tests/modules/programs/helix/example-settings.nix
index 69a5ef557..e345725e4 100644
--- a/tests/modules/programs/helix/example-settings.nix
+++ b/tests/modules/programs/helix/example-settings.nix
@@ -1,6 +1,4 @@
-{ config, ... }:
-
-{
+{ config, ... }: {
   programs.helix = {
     enable = true;
 
@@ -18,6 +16,12 @@
       };
     };
 
+    extraConfig = ''
+      [keys.normal.G]
+      G = "goto_file_end"
+      g = "goto_file_start"
+    '';
+
     languages = {
       language-server.typescript-language-server = let
         typescript-language-server = config.lib.test.mkStubPackage {
diff --git a/tests/modules/programs/helix/settings-expected.toml b/tests/modules/programs/helix/settings-expected.toml
index 91682f0ae..5e218ed77 100644
--- a/tests/modules/programs/helix/settings-expected.toml
+++ b/tests/modules/programs/helix/settings-expected.toml
@@ -12,3 +12,7 @@ esc = ["collapse_selection", "keep_primary_selection"]
 q = ":q"
 space = "file_picker"
 w = ":w"
+
+[keys.normal.G]
+G = "goto_file_end"
+g = "goto_file_start"