lib/helpers: internal refactoring

lib/options.nix

@@ -0,0 +1,252 @@
+{
+  lib,
+  mkIf,
+  mkIfNonNull,
+  mkRaw,
+  nixvimTypes,
+}:
+with lib; rec {
+  # Creates an option with a nullable type that defaults to null.
+  mkNullOrOption = type: desc:
+    lib.mkOption {
+      type = lib.types.nullOr type;
+      default = null;
+      description = desc;
+    };
+
+  mkCompositeOption = desc: options:
+    mkNullOrOption (types.submodule {inherit options;}) desc;
+
+  mkNullOrStr = mkNullOrOption (with nixvimTypes; maybeRaw str);
+
+  mkNullOrLua = desc:
+    lib.mkOption {
+      type = lib.types.nullOr nixvimTypes.strLua;
+      default = null;
+      description = desc;
+      apply = mkRaw;
+    };
+
+  mkNullOrLuaFn = desc:
+    lib.mkOption {
+      type = lib.types.nullOr nixvimTypes.strLuaFn;
+      default = null;
+      description = desc;
+      apply = mkRaw;
+    };
+
+  mkNullOrStrLuaOr = ty: desc:
+    lib.mkOption {
+      type = lib.types.nullOr (types.either nixvimTypes.strLua ty);
+      default = null;
+      description = desc;
+      apply = v:
+        if builtins.isString v
+        then mkRaw v
+        else v;
+    };
+
+  mkNullOrStrLuaFnOr = ty: desc:
+    lib.mkOption {
+      type = lib.types.nullOr (types.either nixvimTypes.strLuaFn ty);
+      default = null;
+      description = desc;
+      apply = v:
+        if builtins.isString v
+        then mkRaw v
+        else v;
+    };
+
+  defaultNullOpts = rec {
+    mkNullable = type: default: desc:
+      mkNullOrOption type (
+        let
+          defaultDesc = "default: `${default}`";
+        in
+          if desc == ""
+          then defaultDesc
+          else ''
+            ${desc}
+
+            ${defaultDesc}
+          ''
+      );
+
+    mkNullableWithRaw = type: mkNullable (maybeRaw type);
+
+    mkStrLuaOr = type: default: desc:
+      mkNullOrStrLuaOr type (let
+        defaultDesc = "default: `${default}`";
+      in
+        if desc == ""
+        then defaultDesc
+        else ''
+          ${desc}
+
+          ${defaultDesc}
+        '');
+
+    mkStrLuaFnOr = type: default: desc:
+      mkNullOrStrLuaFnOr type (let
+        defaultDesc = "default: `${default}`";
+      in
+        if desc == ""
+        then defaultDesc
+        else ''
+          ${desc}
+
+          ${defaultDesc}
+        '');
+
+    mkLua = default: desc:
+      mkNullOrLua
+      (
+        (optionalString (desc != "") ''
+          ${desc}
+
+        '')
+        + ''
+          default: `${default}`
+        ''
+      );
+
+    mkLuaFn = default: desc: let
+      defaultDesc = "default: `${default}`";
+    in
+      mkNullOrLuaFn
+      (
+        if desc == ""
+        then defaultDesc
+        else ''
+          ${desc}
+
+          ${defaultDesc}
+        ''
+      );
+
+    mkNum = default: mkNullable (with nixvimTypes; maybeRaw number) (toString default);
+    mkInt = default: mkNullable (with nixvimTypes; maybeRaw int) (toString default);
+    # Positive: >0
+    mkPositiveInt = default: mkNullable (with nixvimTypes; maybeRaw ints.positive) (toString default);
+    # Unsigned: >=0
+    mkUnsignedInt = default: mkNullable (with nixvimTypes; maybeRaw ints.unsigned) (toString default);
+    mkBool = default:
+      mkNullable (with nixvimTypes; maybeRaw bool) (
+        if default
+        then "true"
+        else "false"
+      );
+    mkStr = default: mkNullable (with nixvimTypes; maybeRaw str) ''${builtins.toString default}'';
+    mkAttributeSet = default: mkNullable nixvimTypes.attrs ''${default}'';
+    mkListOf = ty: default: mkNullable (with nixvimTypes; listOf (maybeRaw ty)) default;
+    mkAttrsOf = ty: default: mkNullable (with nixvimTypes; attrsOf (maybeRaw ty)) default;
+    mkEnum = enumValues: default: mkNullable (with nixvimTypes; maybeRaw (enum enumValues)) ''"${default}"'';
+    mkEnumFirstDefault = enumValues: mkEnum enumValues (head enumValues);
+    mkBorder = default: name: desc:
+      mkNullable
+      nixvimTypes.border
+      default
+      (let
+        defaultDesc = ''
+          Defines the border to use for ${name}.
+          Accepts same border values as `nvim_open_win()`. See `:help nvim_open_win()` for more info.
+        '';
+      in
+        if desc == ""
+        then defaultDesc
+        else ''
+          ${desc}
+          ${defaultDesc}
+        '');
+    mkSeverity = default: desc:
+      mkOption {
+        type = with types;
+          nullOr
+          (
+            either ints.unsigned
+            (
+              enum
+              ["error" "warn" "info" "hint"]
+            )
+          );
+        default = null;
+        apply =
+          mapNullable
+          (
+            value:
+              if isInt value
+              then value
+              else mkRaw "vim.diagnostic.severity.${strings.toUpper value}"
+          );
+        description = let
+          defaultDesc = "default: `${toString default}`";
+        in
+          if desc == ""
+          then defaultDesc
+          else ''
+            ${desc}
+
+            ${defaultDesc}
+          '';
+      };
+    mkLogLevel = default: desc:
+      mkOption {
+        type = with types;
+          nullOr
+          (
+            either ints.unsigned
+            (
+              enum
+              ["off" "error" "warn" "info" "debug" "trace"]
+            )
+          );
+        default = null;
+        apply =
+          mapNullable
+          (
+            value:
+              if isInt value
+              then value
+              else mkRaw "vim.log.levels.${strings.toUpper value}"
+          );
+        description = let
+          defaultDesc = "default: `${toString default}`";
+        in
+          if desc == ""
+          then defaultDesc
+          else ''
+            ${desc}
+
+            ${defaultDesc}
+          '';
+      };
+
+    mkHighlight = default: name: desc:
+      mkNullable
+      nixvimTypes.highlight
+      default
+      (
+        if desc == ""
+        then "Highlight settings."
+        else desc
+      );
+  };
+
+  mkPackageOption = name: default:
+    mkOption {
+      type = types.package;
+      inherit default;
+      description = "Plugin to use for ${name}";
+    };
+
+  extraOptionsOptions = {
+    extraOptions = mkOption {
+      default = {};
+      type = types.attrs;
+      description = ''
+        These attributes will be added to the table parameter for the setup function.
+        (Can override other attributes set by nixvim)
+      '';
+    };
+  };
+}