Merge remote-tracking branch 'upstream/main' into nixpkgs_module

.github/mergify.yml

@@ -11,7 +11,7 @@ queue_rules:
     update_method: rebase
     merge_method: fast-forward
     merge_conditions:
-      - check-success = buildbot/nix-eval
+      - check-success = buildbot/nix-build
     queue_conditions:
       - or:
           # Allow queuing PRs that have been approved

flake-modules/legacy-packages.nix

@@ -2,14 +2,24 @@
   perSystem =
     {
       pkgs,
-      config,
+      helpers,
       makeNixvimWithModule,
       ...
     }:
     {
       legacyPackages = rec {
         inherit makeNixvimWithModule;
         makeNixvim = module: makeNixvimWithModule { inherit module; };
+
+        nixvimConfiguration = helpers.modules.evalNixvim {
+          modules = [
+            { nixpkgs.pkgs = pkgs; }
+          ];
+          extraSpecialArgs = {
+            defaultPkgs = pkgs;
+          };
+          check = false;
+        };
       };
     };
 }

flake-modules/tests.nix

@@ -7,18 +7,11 @@
       system,
       helpers,
       makeNixvimWithModule,
+      self',
       ...
     }:
     let
-      evaluatedNixvim = helpers.modules.evalNixvim {
-        modules = [
-          { nixpkgs.pkgs = pkgs; }
-        ];
-        extraSpecialArgs = {
-          defaultPkgs = pkgs;
-        };
-        check = false;
-      };
+      inherit (self'.legacyPackages) nixvimConfiguration;
     in
     {
       checks = {
@@ -53,11 +46,11 @@
 
         maintainers = import ../tests/maintainers.nix { inherit pkgs; };
 
-        plugins-by-name = pkgs.callPackage ../tests/plugins-by-name.nix { inherit evaluatedNixvim; };
+        plugins-by-name = pkgs.callPackage ../tests/plugins-by-name.nix { inherit nixvimConfiguration; };
 
         generated = pkgs.callPackage ../tests/generated.nix { };
 
-        package-options = pkgs.callPackage ../tests/package-options.nix { inherit evaluatedNixvim; };
+        package-options = pkgs.callPackage ../tests/package-options.nix { inherit nixvimConfiguration; };
       } // import ../tests { inherit pkgs pkgsUnfree helpers; };
     };
 }

generated/efmls-configs.nix

@@ -81,6 +81,7 @@
     linter = {
       lang = "c";
       possible = [
+        "clang_format"
         "clang_tidy"
         "cppcheck"
         "cpplint"
@@ -135,6 +136,7 @@
     linter = {
       lang = "c++";
       possible = [
+        "clang_format"
         "clang_tidy"
         "clazy"
         "cppcheck"

lib/utils.nix

@@ -125,27 +125,98 @@ rec {
     end
   '';
 
+  /**
+    Convert the given String to a Lua [long literal].
+    For example, you could use this to safely pass a Vimscript string to the
+    `vim.cmd` function.
+
+    [long literal]: https://www.lua.org/manual/5.4/manual.html#3.1
+
+    # Examples
+
+    ```nix
+    nix-repl> toLuaLongLiteral "simple"
+    "[[simple]]"
+    ```
+
+    ```nix
+    nix-repl> toLuaLongLiteral "]]"
+    "[=[]]]=]"
+    ```
+
+    # Type
+
+    ```
+    toLuaLongLiteral :: String -> String
+    ```
+  */
+  toLuaLongLiteral =
+    string:
+    let
+      findTokens =
+        depth:
+        let
+          infix = lib.strings.replicate depth "=";
+          tokens.open = "[${infix}[";
+          tokens.close = "]${infix}]";
+        in
+        if lib.hasInfix tokens.close string then findTokens (depth + 1) else tokens;
+
+      tokens = findTokens 0;
+    in
+    tokens.open + string + tokens.close;
+
+  /**
+    Convert the given String into a Vimscript [:let-heredoc].
+    For example, you could use this to invoke [:lua].
+
+    [:let-heredoc]: https://neovim.io/doc/user/eval.html#%3Alet-heredoc
+    [:lua]: https://neovim.io/doc/user/lua.html#%3Alua-heredoc
+
+    # Examples
+
+    ```nix
+    toVimscriptHeredoc "simple"
+    => "<< EOF\nsimple\nEOF"
+    ```
+
+    ```nix
+    toVimscriptHeredoc "EOF"
+    => "<< EOFF\nEOF\nEOFF"
+    ```
+
+    # Type
+
+    ```
+    toVimscriptHeredoc :: String -> String
+    ```
+  */
+  toVimscriptHeredoc =
+    string:
+    let
+      findToken =
+        depth:
+        let
+          token = "EOF" + lib.strings.replicate depth "F";
+        in
+        if lib.hasInfix token string then findToken (depth + 1) else token;
+
+      token = findToken 0;
+    in
+    ''
+      << ${token}
+      ${string}
+      ${token}'';
+
   # Wrap Vimscript for using in lua,
   # but only if the string contains something other than whitespaces
-  # TODO: account for a possible ']]' in the string
   wrapVimscriptForLua =
-    string:
-    lib.optionalString (hasContent string) ''
-      vim.cmd([[
-      ${string}
-      ]])
-    '';
+    string: lib.optionalString (hasContent string) "vim.cmd(${toLuaLongLiteral string})";
 
   # Wrap lua script for using in Vimscript,
   # but only if the string contains something other than whitespaces
-  # TODO: account for a possible 'EOF' if the string
   wrapLuaForVimscript =
-    string:
-    lib.optionalString (hasContent string) ''
-      lua << EOF
-      ${string}
-      EOF
-    '';
+    string: lib.optionalString (hasContent string) "lua ${toVimscriptHeredoc string}";
 
   # Split a list into a several sub-list, each with a max-size of `size`
   groupListBySize =

plugins/by-name/alpha/default.nix

@@ -1,13 +1,13 @@
 {
   lib,
-  helpers,
   config,
   options,
   pkgs,
   ...
 }:
-with lib;
 let
+  inherit (lib) types mkOption;
+
   cfg = config.plugins.alpha;
 
   sectionType = types.submodule {
@@ -24,11 +24,12 @@ let
         description = "Type of section";
       };
 
-      val = helpers.mkNullOrOption (
-        with helpers.nixvimTypes;
+      val = lib.nixvim.mkNullOrOption (
+        with types;
         nullOr (oneOf [
+
           # "button", "text"
-          str
+          (maybeRaw str)
           # "padding"
           int
           (listOf (
@@ -52,7 +53,7 @@ in
 {
   options = {
     plugins.alpha = {
-      enable = mkEnableOption "alpha-nvim";
+      enable = lib.mkEnableOption "alpha-nvim";
 
       package = lib.mkPackageOption pkgs "alpha-nvim" {
         default = [
@@ -74,15 +75,15 @@ in
       ] { nullable = true; };
 
       theme = mkOption {
-        type = with helpers.nixvimTypes; nullOr (maybeRaw str);
-        apply = v: if isString v then helpers.mkRaw "require'alpha.themes.${v}'.config" else v;
+        type = with types; nullOr (maybeRaw str);
+        apply = v: if lib.isString v then lib.nixvim.mkRaw "require'alpha.themes.${v}'.config" else v;
         default = null;
         example = "dashboard";
         description = "You can directly use a pre-defined theme.";
       };
 
       layout = mkOption {
-        type = types.listOf sectionType;
+        type = with types; either (maybeRaw str) (listOf sectionType);
         default = [ ];
         description = "List of sections to layout for the dashboard";
         example = [
@@ -141,7 +142,7 @@ in
         ];
       };
 
-      opts = helpers.mkNullOrOption (with types; attrsOf anything) ''
+      opts = lib.nixvim.mkNullOrOption (with types; attrsOf anything) ''
         Optional global options.
       '';
     };
@@ -154,12 +155,12 @@ in
 
       opt = options.plugins.alpha;
     in
-    mkIf cfg.enable {
+    lib.mkIf cfg.enable {
       # TODO: deprecated 2024-08-29 remove after 24.11
       warnings = lib.mkIf opt.iconsEnabled.isDefined [
         ''
           nixvim (plugins.alpha):
-          The option definition `plugins.alpha.iconsEnabled' in ${showFiles opt.iconsEnabled.files} has been deprecated; please remove it.
+          The option definition `plugins.alpha.iconsEnabled' in ${lib.showFiles opt.iconsEnabled.files} has been deprecated; please remove it.
           You should use `plugins.alpha.iconsPackage' instead.
         ''
       ];
@@ -197,7 +198,8 @@ in
               });
         in
         ''
-          require('alpha').setup(${helpers.toLuaObject setupOptions})
+          require('alpha').setup(${lib.nixvim.toLuaObject setupOptions})
+          require('alpha.term')
         '';
     };
 }

plugins/by-name/compiler/default.nix

@@ -0,0 +1,19 @@
+{
+  lib,
+  ...
+}:
+lib.nixvim.neovim-plugin.mkNeovimPlugin {
+  name = "compiler";
+  originalName = "compiler.nvim";
+  package = "compiler-nvim";
+
+  maintainers = [ lib.maintainers.khaneliman ];
+
+  description = ''
+    > [!Note]
+    > Some languages require you manually install their compilers in your machine, so `compiler.nvim` is able to call them.
+    > Please check [here], as the packages will be different depending your operative system.
+
+    [here]: https://github.com/Zeioth/Compiler.nvim/wiki/how-to-install-the-required-dependencies
+  '';
+}

plugins/by-name/coq-thirdparty/default.nix

@@ -57,11 +57,6 @@ in
           src = "vimtex";
           short_name = "vTEX";
         }
-        {
-          src = "copilot";
-          short_name = "COP";
-          accept_key = "<c-f>";
-        }
         { src = "demo"; }
       ];
     };

plugins/by-name/direnv/default.nix

@@ -10,7 +10,6 @@ helpers.vim-plugin.mkVimPlugin {
   originalName = "direnv.vim";
   package = "direnv-vim";
   globalPrefix = "direnv_";
-  extraPackages = [ pkgs.direnv ];
 
   maintainers = [ helpers.maintainers.alisonjenkins ];
 
@@ -36,4 +35,14 @@ helpers.vim-plugin.mkVimPlugin {
       Stop echoing output from Direnv command.
     '';
   };
+
+  extraOptions = {
+    direnvPackage = lib.mkPackageOption pkgs "direnv" {
+      nullable = true;
+    };
+  };
+
+  extraConfig = cfg: {
+    extraPackages = [ cfg.direnvPackage ];
+  };
 }