helpers: move rawType to helpers.nixvimTypes (nix-community#871)

This is done in preparation of adding new (lua) types to help the documentation.
mirkolenz · Jan 1, 2024 · af41ea2 · af41ea2
1 parent 2f13e3a
commit af41ea2
Show file tree

Hide file tree

Showing 38 changed files with 80 additions and 75 deletions.
diff --git a/lib/autocmd-helpers.nix b/lib/autocmd-helpers.nix
@@ -40,7 +40,7 @@ in rec {
       A textual description of this autocommand.
     '';
 
-    callback = helpers.mkNullOrOption (with types; either str helpers.rawType) ''
+    callback = helpers.mkNullOrOption (with types; either str helpers.nixvimTypes.rawLua) ''
       A function or a string.
       - if a string, the name of a Vimscript function to call when this autocommand is triggered.
       - Otherwise, a Lua function which is called when this autocommand is triggered.

diff --git a/lib/helpers.nix b/lib/helpers.nix
@@ -141,7 +141,7 @@ with lib; rec {
     );
 
   defaultNullOpts = let
-    maybeRaw = t: lib.types.either t rawType;
+    maybeRaw = t: lib.types.either t nixvimTypes.rawLua;
   in rec {
     mkNullable = type: default: desc:
       mkNullOrOption type (
@@ -404,13 +404,18 @@ with lib; rec {
     end
   '';
 
-  rawType = mkOptionType {
-    name = "rawType";
-    description = "raw lua code";
-    descriptionClass = "noun";
-    merge = mergeEqualOption;
-    check = isRawType;
-  };
+  nixvimTypes =
+    {
+      rawLua = mkOptionType {
+        name = "rawType";
+        description = "raw lua code";
+        descriptionClass = "noun";
+        merge = mergeEqualOption;
+        check = isRawType;
+      };
+    }
+    # Allow to do `with nixvimTypes;` instead of `with types;`
+    // types;
 
   isRawType = v: lib.isAttrs v && lib.hasAttr "__raw" v && lib.isString v.__raw;
 }
diff --git a/modules/commands.nix b/modules/commands.nix
@@ -15,7 +15,7 @@ with lib; let
       nargs = helpers.mkNullOrOption (types.enum ["0" "1" "*" "?" "+"]) ''
         The number of arguments to expect, see :h command-nargs.
       '';
-      complete = helpers.mkNullOrOption (with types; either str helpers.rawType) ''
+      complete = helpers.mkNullOrOption (with types; either str helpers.nixvimTypes.rawLua) ''
         Tab-completion behaviour, see :h command-complete.
       '';
       range = helpers.mkNullOrOption (with types; oneOf [bool int (enum ["%"])]) ''

diff --git a/modules/filetype.nix b/modules/filetype.nix
@@ -13,7 +13,7 @@ with lib; let
           # Raw filetype
           str
           # Function to set the filetype
-          helpers.rawType
+          helpers.nixvimTypes.rawLua
           # ["filetype" {priority = xx;}]
           (listOf (either str (submodule {
             options = {

diff --git a/plugins/bufferlines/bufferline.nix b/plugins/bufferlines/bufferline.nix
@@ -121,7 +121,7 @@ in {
             with types;
               either
               (enum ["none" "ordinal" "buffer_id" "both"])
-              helpers.rawType
+              helpers.nixvimTypes.rawLua
           )
           "none"
           ''

diff --git a/plugins/completion/copilot-lua.nix b/plugins/completion/copilot-lua.nix
@@ -70,7 +70,7 @@ in {
 
         filetypes =
           helpers.defaultNullOpts.mkNullable
-          (with types; attrsOf (either bool helpers.rawType))
+          (with types; attrsOf (either bool helpers.nixvimTypes.rawLua))
           ''
             {
               yaml = false;

diff --git a/plugins/completion/nvim-cmp/default.nix b/plugins/completion/nvim-cmp/default.nix
@@ -123,7 +123,7 @@ in {
           (
             with types;
               either
-              helpers.rawType
+              helpers.nixvimTypes.rawLua
               (enum (attrNames snippetEngines))
           )
           ''

diff --git a/plugins/dap/dap-python.nix b/plugins/dap/dap-python.nix
@@ -31,7 +31,7 @@ in {
       By default the `VIRTUAL_ENV` and `CONDA_PREFIX` environment variables are used if present.
     '';
 
-    testRunner = helpers.mkNullOrOption (types.either types.str helpers.rawType) ''
+    testRunner = helpers.mkNullOrOption (types.either types.str helpers.nixvimTypes.rawLua) ''
       The name of test runner to use by default.
       The default value is dynamic and depends on `pytest.ini` or `manage.py` markers.
       If neither is found "unittest" is used.

diff --git a/plugins/filetrees/nvim-tree.nix b/plugins/filetrees/nvim-tree.nix
@@ -99,7 +99,7 @@ in {
         (
           types.either
           (types.enum ["name" "case_sensitive" "modification_time" "extension"])
-          helpers.rawType
+          helpers.nixvimTypes.rawLua
         )
         "name"
         ''
@@ -317,7 +317,7 @@ in {
 
       onAttach =
         helpers.defaultNullOpts.mkNullable
-        (with types; either (enum ["default"]) helpers.rawType)
+        (with types; either (enum ["default"]) helpers.nixvimTypes.rawLua)
         "default"
         ''
           Function ran when creating the nvim-tree buffer.
@@ -378,7 +378,7 @@ in {
 
                   padding =
                     helpers.defaultNullOpts.mkNullable
-                    (either ints.unsigned helpers.rawType)
+                    (either ints.unsigned helpers.nixvimTypes.rawLua)
                     "1"
                     "Extra padding to the right.";
                 };
@@ -466,7 +466,7 @@ in {
         rootFolderLabel =
           helpers.defaultNullOpts.mkNullable
           # Type
-          (with types; oneOf [str bool helpers.rawType])
+          (with types; oneOf [str bool helpers.nixvimTypes.rawLua])
           # Default
           ":~:s?$?/..?"
           # Description
@@ -740,7 +740,7 @@ in {
 
           picker =
             helpers.defaultNullOpts.mkNullable
-            (types.either types.str helpers.rawType)
+            (types.either types.str helpers.nixvimTypes.rawLua)
             "default"
             ''
               Change the default window picker, can be a string `"default"` or a function.

diff --git a/plugins/git/gitlinker.nix b/plugins/git/gitlinker.nix
@@ -20,7 +20,7 @@ with lib; {
       '';
 
       actionCallback =
-        helpers.defaultNullOpts.mkNullable (with types; either str helpers.rawType)
+        helpers.defaultNullOpts.mkNullable (with types; either str helpers.nixvimTypes.rawLua)
         "copy_to_clipboard"
         ''
           Callback for what to do with the url.
@@ -47,7 +47,7 @@ with lib; {
             (
               either
               str
-              helpers.rawType
+              helpers.nixvimTypes.rawLua
             )
         )
         ''

diff --git a/plugins/languages/lint.nix b/plugins/languages/lint.nix
@@ -40,7 +40,7 @@ with lib; let
     };
 
     args = {
-      type = listOf (either str helpers.rawType);
+      type = listOf (either str helpers.nixvimTypes.rawLua);
       description = ''
         List of arguments.
         Can contain functions with zero arguments that will be evaluated once the linter is used.
@@ -229,7 +229,7 @@ in {
 
                   callback = mkOption {
                     type = with types;
-                      nullOr (either str helpers.rawType);
+                      nullOr (either str helpers.nixvimTypes.rawLua);
                     default = defaultCallback;
                     description = "What action to perform for linting";
                   };

diff --git a/plugins/languages/nvim-jdtls.nix b/plugins/languages/nvim-jdtls.nix
@@ -63,7 +63,7 @@ in {
 
       rootDir =
         helpers.defaultNullOpts.mkNullable
-        (types.either types.str helpers.rawType)
+        (types.either types.str helpers.nixvimTypes.rawLua)
         ''{ __raw = "require('jdtls.setup').find_root({'.git', 'mvnw', 'gradlew'})"; }''
         ''
           This is the default if not provided, you can remove it. Or adjust as needed.

diff --git a/plugins/languages/treesitter/rainbow-delimiters.nix b/plugins/languages/treesitter/rainbow-delimiters.nix
@@ -22,7 +22,7 @@ with lib; {
           with types;
             attrsOf (
               either
-              helpers.rawType
+              helpers.nixvimTypes.rawLua
               (enum ["global" "local" "noop"])
             )
         )
@@ -106,7 +106,7 @@ with lib; {
       log = {
         file =
           helpers.defaultNullOpts.mkNullable
-          (with types; either str helpers.rawType)
+          (with types; either str helpers.nixvimTypes.rawLua)
           ''
             {
               __raw = "vim.fn.stdpath('log') .. '/rainbow-delimiters.log'";

diff --git a/plugins/languages/vim-slime.nix b/plugins/languages/vim-slime.nix
@@ -46,7 +46,7 @@ in
 
       defaultConfig =
         helpers.defaultNullOpts.mkNullable
-        (with types; attrsOf (either str helpers.rawType))
+        (with types; attrsOf (either str helpers.nixvimTypes.rawLua))
         "null"
         ''
           Pre-filled prompt answer.

diff --git a/plugins/lsp/fidget.nix b/plugins/lsp/fidget.nix
@@ -14,7 +14,7 @@ with lib; let
       with types;
         oneOf [
           str
-          helpers.rawType
+          helpers.nixvimTypes.rawLua
           (listOf str)
           (attrsOf (either str ints.unsigned))
         ]
@@ -593,7 +593,7 @@ in {
 
           path =
             helpers.defaultNullOpts.mkNullable
-            (with types; either str helpers.rawType)
+            (with types; either str helpers.nixvimTypes.rawLua)
             ''{__raw = "string.format('%s/fidget.nvim.log', vim.fn.stdpath('cache'))";}''
             ''
               Where Fidget writes its logs to.

diff --git a/plugins/lsp/language-servers/default.nix b/plugins/lsp/language-servers/default.nix
@@ -323,7 +323,7 @@ with lib; let
               nullOr
               (
                 listOf
-                (either str helpers.rawType)
+                (either str helpers.nixvimTypes.rawLua)
               );
             description = ''
               An array of abosolute or workspace-relative paths that will be added to the workspace

diff --git a/plugins/lsp/language-servers/efmls-configs.nix b/plugins/lsp/language-servers/efmls-configs.nix
@@ -190,7 +190,7 @@ in {
       miscFormatters = languageTools "misc" "formatters";
 
       mkChooseOption = lang: kind: possible: let
-        toolType = with types; either (enum possible) helpers.rawType;
+        toolType = with types; either (enum possible) helpers.nixvimTypes.rawLua;
       in
         mkOption {
           type = with types; either toolType (listOf toolType);

diff --git a/plugins/lsp/language-servers/pylsp.nix b/plugins/lsp/language-servers/pylsp.nix
@@ -357,7 +357,7 @@ in {
         overrides =
           helpers.defaultNullOpts.mkNullable
           (types.listOf
-            (types.oneOf [types.bool types.str helpers.rawType]))
+            (types.oneOf [types.bool types.str helpers.nixvimTypes.rawLua]))
           "[true]"
           ''
             Specifies a list of alternate or supplemental command-line options.

diff --git a/plugins/lsp/wtf.nix b/plugins/lsp/wtf.nix
@@ -51,7 +51,7 @@ in {
           Default AI popup type.
         '';
 
-        openaiApiKey = helpers.mkNullOrOption (with types; either str helpers.rawType) ''
+        openaiApiKey = helpers.mkNullOrOption (with types; either str helpers.nixvimTypes.rawLua) ''
           An alternative way to set your API key.
         '';
 

diff --git a/plugins/pluginmanagers/packer.nix b/plugins/pluginmanagers/packer.nix
@@ -55,8 +55,8 @@ in {
                 helpers.mkNullOrOption
                 (oneOf [
                   str
-                  helpers.rawType
-                  (listOf (either str helpers.rawType))
+                  helpers.nixvimTypes.rawLua
+                  (listOf (either str helpers.nixvimTypes.rawLua))
                 ])
                 "Post-install hook";
 
@@ -67,11 +67,11 @@ in {
                 "Luarocks dependencies";
 
               config =
-                helpers.mkNullOrOption (either str helpers.rawType)
+                helpers.mkNullOrOption (either str helpers.nixvimTypes.rawLua)
                 "Code to run after this plugin is loaded";
 
               setup =
-                helpers.mkNullOrOption (either str helpers.rawType)
+                helpers.mkNullOrOption (either str helpers.nixvimTypes.rawLua)
                 "Code to be run before this plugin is loaded";
 
               cmd =
@@ -98,8 +98,8 @@ in {
                 helpers.mkNullOrOption
                 (oneOf [
                   str
-                  helpers.rawType
-                  (listOf (either str helpers.rawType))
+                  helpers.nixvimTypes.rawLua
+                  (listOf (either str helpers.nixvimTypes.rawLua))
                 ])
                 "Conditional test to load this plugin";
 

diff --git a/plugins/snippets/luasnip/default.nix b/plugins/snippets/luasnip/default.nix
@@ -60,12 +60,12 @@ in {
                 [
                   str
                   path
-                  helpers.rawType
+                  helpers.nixvimTypes.rawLua
                   (listOf (oneOf
                     [
                       str
                       path
-                      helpers.rawType
+                      helpers.nixvimTypes.rawLua
                     ]))
                 ]);
           };
@@ -122,12 +122,12 @@ in {
                   [
                     str
                     path
-                    helpers.rawType
+                    helpers.nixvimTypes.rawLua
                     (listOf (oneOf
                       [
                         str
                         path
-                        helpers.rawType
+                        helpers.nixvimTypes.rawLua
                       ]))
                   ]
                 )

diff --git a/plugins/statuslines/lualine.nix b/plugins/statuslines/lualine.nix
@@ -25,7 +25,7 @@ with lib; let
         (submodule {
           options = {
             name = mkOption {
-              type = types.either types.str helpers.rawType;
+              type = types.either types.str helpers.nixvimTypes.rawLua;
               description = "Component name or function";
               default = defaultName;
             };

diff --git a/plugins/telescope/file-browser.nix b/plugins/telescope/file-browser.nix
@@ -31,12 +31,12 @@ in {
 
     theme = helpers.mkNullOrOption types.str "Custom theme, will use your global theme by default.";
 
-    path = helpers.defaultNullOpts.mkNullable (types.either types.str helpers.rawType) "vim.loop.cwd()" ''
+    path = helpers.defaultNullOpts.mkNullable (types.either types.str helpers.nixvimTypes.rawLua) "vim.loop.cwd()" ''
       Directory to browse files from.
       `vim.fn.expanded` automatically.
     '';
 
-    cwd = helpers.defaultNullOpts.mkNullable (types.either types.str helpers.rawType) "vim.loop.cwd()" ''
+    cwd = helpers.defaultNullOpts.mkNullable (types.either types.str helpers.nixvimTypes.rawLua) "vim.loop.cwd()" ''
       Directory to browse folders from.
       `vim.fn.expanded` automatically.
     '';
@@ -131,7 +131,7 @@ in {
     mappings =
       helpers.mkNullOrOption (
         with types;
-          attrsOf (attrsOf (either str helpers.rawType))
+          attrsOf (attrsOf (either str helpers.nixvimTypes.rawLua))
       ) ''
         `fb_actions` mappings.
         Mappings can also be a lua function.

diff --git a/plugins/utils/auto-save.nix b/plugins/utils/auto-save.nix
@@ -32,7 +32,7 @@ in {
       executionMessage = {
         message =
           helpers.defaultNullOpts.mkNullable
-          (with types; either str helpers.rawType)
+          (with types; either str helpers.nixvimTypes.rawLua)
           ''
             {
               __raw = \'\'

diff --git a/plugins/utils/auto-session.nix b/plugins/utils/auto-session.nix
@@ -32,7 +32,7 @@ in {
 
         rootDir =
           helpers.defaultNullOpts.mkNullable
-          (with types; either str helpers.rawType)
+          (with types; either str helpers.nixvimTypes.rawLua)
           "{__raw = \"vim.fn.stdpath 'data' .. '/sessions/'\";}"
           ''
             Root directory for session files.
@@ -128,7 +128,7 @@ in {
         sessionControl = {
           controlDir =
             helpers.defaultNullOpts.mkNullable
-            (with types; either str helpers.rawType)
+            (with types; either str helpers.nixvimTypes.rawLua)
             "\"vim.fn.stdpath 'data' .. '/auto_session/'\""
             ''
               Auto session control dir, for control files, like alternating between two sessions