formats.lua: init; types.luaInline: init (#390120)

Author: Stunkymonkey

lib/default.nix

@@ -156,6 +156,7 @@ let
       makeScope makeScopeWithSplicing makeScopeWithSplicing'
       extendMkDerivation;
     inherit (self.derivations) lazyDerivation optionalDrvAttr warnOnInstantiate;
+    inherit (self.generators) mkLuaInline;
     inherit (self.meta) addMetaAttrs dontDistribute setName updateName
       appendToName mapDerivationAttrset setPrio lowPrio lowPrioSet hiPrio
       hiPrioSet licensesSpdx getLicenseFromSpdxId getLicenseFromSpdxIdOr

lib/generators.nix

@@ -743,6 +743,8 @@ in rec {
       "nil"
     else if isInt v || isFloat v || isString v || isBool v then
       toJSON v
+    else if isPath v || isDerivation v then
+      toJSON "${v}"
     else if isList v then
       (if v == [ ] then "{}" else
       "{${introSpace}${concatItems (map (value: "${toLua innerArgs value}") v)}${outroSpace}}")
@@ -752,8 +754,6 @@ in rec {
           "(${v.expr})"
         else if v == { } then
           "{}"
-        else if isDerivation v then
-          ''"${toString v}"''
         else
           "{${introSpace}${concatItems (
             mapAttrsToList (key: value: "[${toJSON key}] = ${toLua innerArgs value}") v

lib/types.nix

@@ -834,6 +834,15 @@ rec {
         };
       };
 
+    # A value produced by `lib.mkLuaInline`
+    luaInline = mkOptionType {
+      name = "luaInline";
+      description = "inline lua";
+      descriptionClass = "noun";
+      check = x: x._type or null == "lua-inline";
+      merge = mergeEqualOption;
+    };
+
     uniq = unique { message = ""; };
 
     unique = { message }: type: mkOptionType rec {

nixos/doc/manual/development/option-types.section.md

@@ -232,6 +232,13 @@ merging is handled.
     definitions cannot be merged. The regular expression is processed
     using `builtins.match`.
 
+### Specialised types {#sec-option-types-specialised}
+
+`types.luaInline`
+
+:   A string wrapped using `lib.mkLuaInline`. Allows embedding lua expressions
+    inline within generated lua. Multiple definitions cannot be merged.
+
 ## Submodule types {#sec-option-types-submodule}
 
 Submodules are detailed in [Submodule](#section-option-types-submodule).

nixos/doc/manual/development/settings-options.section.md

@@ -402,6 +402,31 @@ have a predefined type and string generator already declared under
     :   Outputs the given attribute set as an Elixir map, instead of the
         default Elixir keyword list
 
+`pkgs.formats.lua { asBindings ? false, multiline ? true, columnWidth ? 100, indentWidth ? 2, indentUsingTabs ? false }`
+
+:   A function taking an attribute set with values
+
+    `asBindings` (default `false`)
+
+    :   Whether to treat attributes as variable bindings
+
+    `multiline` (default `true`)
+
+    :   Whether to procude a multiline output. The output may still wrap across
+        multiple lines if it would otherwise exceed `columnWidth`.
+
+    `columnWidth` (default `100`)
+
+    :   The column width to use to attempt to wrap lines.
+
+    `indentWidth` (default `2`)
+
+    :   The width of a single indentation level.
+
+    `indentUsingTabs` (default `false`)
+
+    :   Whether the indentation should use tabs instead of spaces.
+
 `pkgs.formats.php { finalVariable }` []{#pkgs-formats-php}
 
 :   A function taking an attribute set with values

nixos/doc/manual/redirects.json

@@ -1592,6 +1592,9 @@
   "sec-option-types-string": [
     "index.html#sec-option-types-string"
   ],
+  "sec-option-types-specialised": [
+    "index.html#sec-option-types-specialised"
+  ],
   "sec-option-types-submodule": [
     "index.html#sec-option-types-submodule"
   ],

pkgs/pkgs-lib/formats.nix

@@ -47,7 +47,7 @@ rec {
 
   inherit (lib) mkOptionType;
   inherit (lib.types) nullOr oneOf coercedTo listOf nonEmptyListOf attrsOf either;
-  inherit (lib.types) bool int float str path;
+  inherit (lib.types) bool int float str path luaInline;
 
   json = {}: {
 
@@ -541,6 +541,66 @@ rec {
       '';
     };
 
+  lua =
+    {
+      asBindings ? false,
+      multiline ? true,
+      columnWidth ? 100,
+      indentWidth ? 2,
+      indentUsingTabs ? false,
+    }:
+    {
+      type =
+        let
+          valueType =
+            nullOr (oneOf [
+              bool
+              float
+              int
+              path
+              str
+              luaInline
+              (attrsOf valueType)
+              (listOf valueType)
+            ])
+            // {
+              description = "lua value";
+              descriptionClass = "noun";
+            };
+        in
+        if asBindings then attrsOf valueType else valueType;
+      generate =
+        name: value:
+        pkgs.callPackage (
+          { runCommand, stylua }:
+          runCommand name
+            {
+              nativeBuildInputs = [ stylua ];
+              inherit columnWidth;
+              inherit indentWidth;
+              indentType = if indentUsingTabs then "Tabs" else "Spaces";
+              value = lib.generators.toLua { inherit asBindings multiline; } value;
+              passAsFile = [ "value" ];
+              preferLocalBuild = true;
+            }
+            ''
+              ${lib.optionalString (!asBindings) ''
+                echo -n 'return ' >> $out
+              ''}
+              cat $valuePath >> $out
+              stylua \
+                --no-editorconfig \
+                --line-endings Unix \
+                --column-width $columnWidth \
+                --indent-width $indentWidth \
+                --indent-type $indentType \
+                $out
+            ''
+        ) { };
+      # Alias for mkLuaInline
+      lib.mkRaw = lib.mkLuaInline;
+    };
+
   # Outputs a succession of Python variable assignments
   # Useful for many Django-based services
   pythonVars = {}: {

pkgs/pkgs-lib/tests/formats.nix

@@ -601,6 +601,82 @@ in runBuildTests {
     '';
   };
 
+  luaTable = shouldPass {
+    format = formats.lua { };
+    input = {
+      null = null;
+      false = false;
+      true = true;
+      int = 10;
+      float = 3.141;
+      str = "foo";
+      attrs.foo = null;
+      list = [
+        null
+        null
+      ];
+      path = ./testfile;
+      inline = lib.mkLuaInline "hello('world')";
+    };
+    expected = ''
+      return {
+        ["attrs"] = {
+          ["foo"] = nil,
+        },
+        ["false"] = false,
+        ["float"] = 3.141,
+        ["inline"] = (hello("world")),
+        ["int"] = 10,
+        ["list"] = {
+          nil,
+          nil,
+        },
+        ["null"] = nil,
+        ["path"] = "${./testfile}",
+        ["str"] = "foo",
+        ["true"] = true,
+      }
+    '';
+  };
+
+  luaBindings = shouldPass {
+    format = formats.lua {
+      asBindings = true;
+    };
+    input = {
+      null = null;
+      _false = false;
+      _true = true;
+      int = 10;
+      float = 3.141;
+      str = "foo";
+      attrs.foo = null;
+      list = [
+        null
+        null
+      ];
+      path = ./testfile;
+      inline = lib.mkLuaInline "hello('world')";
+    };
+    expected = ''
+      _false = false
+      _true = true
+      attrs = {
+        ["foo"] = nil,
+      }
+      float = 3.141
+      inline = (hello("world"))
+      int = 10
+      list = {
+        nil,
+        nil,
+      }
+      null = nil
+      path = "${./testfile}"
+      str = "foo"
+    '';
+  };
+
   phpAtoms = shouldPass rec {
     format = formats.php { finalVariable = "config"; };
     input = {