lib/generators: add toLua/mkLuaInline

Suitable to simplify Lua-based configurations like neovim-lspconfig that
might need to interpolate Nix package paths.

2 files changed, 116 insertions, 0 deletions

diff --git a/lib/generators.nix b/lib/generators.nix
index 4357a0353398..41c2862973f1 100644
--- a/lib/generators.nix
+++ b/lib/generators.nix
@@ -426,4 +426,59 @@ ${expr "" v}
       abort "generators.toDhall: cannot convert a null to Dhall"
     else
       builtins.toJSON v;
+
+  /*
+   * Translate a simple Nix expression to Lua representation with occasional
+   * Lua-inlines that can be construted by mkLuaInline function.
+   *
+   * generators.toLua {} {
+   *   cmd = [ "typescript-language-server" "--stdio" ];
+   *   settings.workspace.library = mkLuaInline ''vim.api.nvim_get_runtime_file("", true)'';
+   * }
+   *
+   *> {
+   *>   ["cmd"] = {
+   *>     "typescript-language-server",
+   *>     "--stdio"
+   *>   },
+   *>   ["settings"] = {
+   *>     ["workspace"] = {
+   *>       ["library"] = (vim.api.nvim_get_runtime_file("", true))
+   *>     }
+   *>   }
+   *> }
+   */
+  toLua = { indent ? "" }@args: v:
+    with builtins;
+    let
+      indent' = "${indent}  ";
+      args' = args // { indent = indent'; };
+      concatItems = concatStringsSep ",\n";
+      isLuaInline = { _type ? null, ... }: _type == "lua-inline";
+    in
+    if v == null then
+      "nil"
+    else if isInt v || isFloat v || isString v || isBool v then
+      builtins.toJSON v
+    else if isList v then
+      (if v == [ ] then "{}" else
+      "{\n${concatItems (map (value: "${indent'}${toLua args' value}") v)}\n${indent}}")
+    else if isAttrs v then
+      (
+        if isLuaInline v then
+          "(${v.expr})"
+        else if v == { } then
+          "{}"
+        else
+          "{\n${concatItems (
+            lib.attrsets.mapAttrsToList (key: value: "${indent'}[${builtins.toJSON key}] = ${toLua args' value}") v
+            )}\n${indent}}"
+      )
+    else
+      abort "generators.toLua: type ${typeOf v} is unsupported";
+
+  /*
+   * Mark string as Lua expression to be inlined when processed by toLua.
+   */
+  mkLuaInline = expr: { _type = "lua-inline"; inherit expr; };
 }
diff --git a/lib/tests/misc.nix b/lib/tests/misc.nix
index baa382f3e589..682b1a379fc3 100644
--- a/lib/tests/misc.nix
+++ b/lib/tests/misc.nix
@@ -915,6 +915,67 @@ runTests {
   };
 
 
+  testToLuaEmptyAttrSet = {
+    expr = generators.toLua {} {};
+    expected = ''{}'';
+  };
+
+  testToLuaEmptyList = {
+    expr = generators.toLua {} [];
+    expected = ''{}'';
+  };
+
+  testToLuaListOfVariousTypes = {
+    expr = generators.toLua {} [ null 43 3.14159 true ];
+    expected = ''
+      {
+        nil,
+        43,
+        3.14159,
+        true
+      }'';
+  };
+
+  testToLuaString = {
+    expr = generators.toLua {} ''double-quote (") and single quotes (')'';
+    expected = ''"double-quote (\") and single quotes (')"'';
+  };
+
+  testToLuaAttrsetWithLuaInline = {
+    expr = generators.toLua {} { x = generators.mkLuaInline ''"abc" .. "def"''; };
+    expected = ''
+      {
+        ["x"] = ("abc" .. "def")
+      }'';
+  };
+
+  testToLuaAttrsetWithSpaceInKey = {
+    expr = generators.toLua {} { "some space and double-quote (\")" = generators.mkLuaInline ''"abc" .. "def"''; };
+    expected = ''
+      {
+        ["some space and double-quote (\")"] = ("abc" .. "def")
+      }'';
+  };
+
+  testToLuaBasicExample = {
+    expr = generators.toLua {} {
+      cmd = [ "typescript-language-server" "--stdio" ];
+      settings.workspace.library = generators.mkLuaInline ''vim.api.nvim_get_runtime_file("", true)'';
+    };
+    expected = ''
+      {
+        ["cmd"] = {
+          "typescript-language-server",
+          "--stdio"
+        },
+        ["settings"] = {
+          ["workspace"] = {
+            ["library"] = (vim.api.nvim_get_runtime_file("", true))
+          }
+        }
+      }'';
+  };
+
 # CLI
 
   testToGNUCommandLine = {