plugins/wezterm: init

[samos667]

This pull request introduces a new Neovim plugin for wezterm and integrates it into the existing plugin system. The changes include adding the wezterm plugin to the molten plugin list, defining the wezterm plugin in its own file, and adding test cases for the new plugin.

New Plugin Addition:

• plugins/by-name/molten/default.nix: Added the wezterm plugin to the list of plugins and enabled it by default.
• plugins/by-name/wezterm/default.nix: Defined the wezterm plugin with its settings and maintainers.

Testing:

• tests/test-sources/plugins/by-name/wezterm/default.nix: Added test cases for the wezterm plugin to ensure it is enabled and its settings are correctly applied.

fixes #2596

[khaneliman]

@samos667 We updated flake lock today so you should be able to rebase this, now.

[samos667]

error: attribute 'samos667' missing

Sadge :'(

[khaneliman]

error: attribute 'samos667' missing

Sadge :'(

If you're not in nixpkgs maintainers, you can add yourself to our maintainers file in another commit.

[MattSturgeon]

We also have a test failure:

defaults> ERROR: Error detected while processing /nix/store/XXX-init.lua:
defaults> Wezterm failed to find 'wezterm' executable
defaults> Wezterm failed to find 'wezterm' executable

Perhaps the nixpkgs package doesn't have wezterm marked as a dependency?

[MattSturgeon]

The following patch causes the test to pass, however I believe this should be fixed upstream in nixpkgs.

diff --git a/plugins/by-name/wezterm/default.nix b/plugins/by-name/wezterm/default.nix
index aecb332e..e95b36a4 100644
--- a/plugins/by-name/wezterm/default.nix
+++ b/plugins/by-name/wezterm/default.nix
@@ -1,4 +1,4 @@
-{ lib, ... }:
+{ lib, pkgs, ... }:
 let
   inherit (lib.nixvim) defaultNullOpts;
 in
@@ -9,6 +9,10 @@ lib.nixvim.neovim-plugin.mkNeovimPlugin {
 
   maintainers = [ lib.maintainers.samos667 ];
 
+  extraPackages = [
+    pkgs.wezterm
+  ];
+
   settingsOptions = {
     create_commands = defaultNullOpts.mkBool true ''
       Whether to create plugin commands.

Or if not*, then we should have a nullable weztermPackage option.

weztermPackage = lib.mkPackageOption pkgs "wezterm" {
  nullable = true;
  # maybe also `default = null` and `example = [ "wezterm" ]`?
};

* Perhaps nixpkgs decide that bundling the dep leads to too many potential issues, such as if users have an overridden/custom wezterm installed to their PATH?

[GaetanLepage]

The following patch causes the test to pass, however I believe this should be fixed upstream in nixpkgs.

diff --git a/plugins/by-name/wezterm/default.nix b/plugins/by-name/wezterm/default.nix
index aecb332e..e95b36a4 100644
--- a/plugins/by-name/wezterm/default.nix
+++ b/plugins/by-name/wezterm/default.nix
@@ -1,4 +1,4 @@
-{ lib, ... }:
+{ lib, pkgs, ... }:
 let
   inherit (lib.nixvim) defaultNullOpts;
 in
@@ -9,6 +9,10 @@ lib.nixvim.neovim-plugin.mkNeovimPlugin {
 
   maintainers = [ lib.maintainers.samos667 ];
 
+  extraPackages = [
+    pkgs.wezterm
+  ];
+
   settingsOptions = {
     create_commands = defaultNullOpts.mkBool true ''
       Whether to create plugin commands.

This is still something we have not clearly agreed on in nixpkgs...
I think that the right approach here is having the suggested weztermPackage option.

[MattSturgeon]

What's the best default here? The package or null?

I'm assuming most users who enable this plugin will already have wezterm installed 🤔

[GaetanLepage]

Usually we set the package.

[MattSturgeon]

This would achieve that:

Suggested change

	weztermPackage = lib.mkPackageOption pkgs "wezterm" {
	nullable = true;
	default = null;
	example = [ "wezterm" ];
	};
	weztermPackage = lib.mkPackageOption pkgs "wezterm" {
	nullable = true;
	};

Is there any reason not to do that here?

[MattSturgeon]

@samos667 I've pushed up a couple tweaks. Let us know if you're happy and we should be good to approve & merge.

[GaetanLepage]

Why not adding a warning to check this ? This is usually what we do.

[samos667]

Seems good to me !

[MattSturgeon]

I believe @GaetanLepage is hoping you'll change the following before we approve/merge:

1. Introduce a warning for plugins/wezterm: init #2597 (comment)
2. Change the weztermPackage option to no longer default to null plugins/wezterm: init #2597 (comment)