Merge pull request #957 from lackac/smart-splits

utility/smart-splits: init

configuration.nix

@@ -191,6 +191,7 @@ isMaximal: {
       surround.enable = isMaximal;
       leetcode-nvim.enable = isMaximal;
       multicursors.enable = isMaximal;
+      smart-splits.enable = isMaximal;
 
       motion = {
         hop.enable = true;

docs/release-notes/rl-0.8.md

@@ -431,5 +431,10 @@
 [lackac](https://github.com/lackac):
 
 [solarized.nvim]: https://github.com/maxmx03/solarized.nvim
+[smart-splits.nvim]: https://github.com/mrjones2014/smart-splits.nvim
 
 - Add [solarized.nvim] theme with support for multiple variants
+
+- Add [smart-splits.nvim] for navigating between Neovim windows and terminal multiplexer panes.
+  Available at `vim.utility.smart-splits`.
+

modules/plugins/utility/default.nix

@@ -19,6 +19,7 @@
     ./outline
     ./preview
     ./sleuth
+    ./smart-splits
     ./snacks-nvim
     ./surround
     ./telescope

modules/plugins/utility/smart-splits/config.nix

@@ -0,0 +1,51 @@
+{
+  pkgs,
+  config,
+  options,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+
+  cfg = config.vim.utility.smart-splits;
+  inherit (options.vim.utility.smart-splits) keymaps;
+  mkSmartSplitKey = act: let
+    key = cfg.keymaps.${act};
+  in
+    lib.optional (key != null) {
+      inherit key;
+      desc = keymaps.${act}.description;
+      action = ''function() require('smart-splits').${act}() end'';
+      mode = "n";
+      lua = true;
+    };
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      lazy.plugins.smart-splits = {
+        package = "smart-splits";
+        setupModule = "smart-splits";
+        inherit (cfg) setupOpts;
+
+        # plugin needs to be loaded right after startup so that the multiplexer detects vim running in the pane
+        event = ["DeferredUIEnter"];
+
+        keys = lib.flatten [
+          (mkSmartSplitKey "resize_left")
+          (mkSmartSplitKey "resize_down")
+          (mkSmartSplitKey "resize_up")
+          (mkSmartSplitKey "resize_right")
+          (mkSmartSplitKey "move_cursor_left")
+          (mkSmartSplitKey "move_cursor_down")
+          (mkSmartSplitKey "move_cursor_up")
+          (mkSmartSplitKey "move_cursor_right")
+          (mkSmartSplitKey "move_cursor_previous")
+          (mkSmartSplitKey "swap_buf_left")
+          (mkSmartSplitKey "swap_buf_down")
+          (mkSmartSplitKey "swap_buf_up")
+          (mkSmartSplitKey "swap_buf_right")
+        ];
+      };
+    };
+  };
+}

modules/plugins/utility/smart-splits/default.nix

@@ -0,0 +1,6 @@
+{
+  imports = [
+    ./config.nix
+    ./smart-splits.nix
+  ];
+}

modules/plugins/utility/smart-splits/smart-splits.nix

@@ -0,0 +1,37 @@
+{lib, ...}: let
+  inherit (lib.options) mkOption;
+  inherit (lib.types) bool;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+  inherit (lib.nvim.binds) mkMappingOption;
+in {
+  options.vim.utility.smart-splits = {
+    enable = mkOption {
+      type = bool;
+      default = false;
+      description = ''
+        Whether to enable smart-splits.nvim, a Neovim plugin for smart,
+        seamless, directional navigation and resizing of splits.
+
+        Supports tmux, Wezterm, Kitty, and Zellij multiplexer integrations.
+      '';
+    };
+
+    setupOpts = mkPluginSetupOption "smart-splits" {};
+
+    keymaps = {
+      resize_left = mkMappingOption "Resize Window/Pane Left" "<A-h>";
+      resize_down = mkMappingOption "Resize Window/Pane Down" "<A-j>";
+      resize_up = mkMappingOption "Resize Window/Pane Up" "<A-k>";
+      resize_right = mkMappingOption "Resize Window/Pane Right" "<A-l>";
+      move_cursor_left = mkMappingOption "Focus Window/Pane on the Left" "<C-h>";
+      move_cursor_down = mkMappingOption "Focus Window/Pane Below" "<C-j>";
+      move_cursor_up = mkMappingOption "Focus Window/Pane Above" "<C-k>";
+      move_cursor_right = mkMappingOption "Focus Window/Pane on the Right" "<C-l>";
+      move_cursor_previous = mkMappingOption "Focus Previous Window/Pane" "<C-\\>";
+      swap_buf_left = mkMappingOption "Swap Buffer Left" "<leader><leader>h";
+      swap_buf_down = mkMappingOption "Swap Buffer Down" "<leader><leader>j";
+      swap_buf_up = mkMappingOption "Swap Buffer Up" "<leader><leader>k";
+      swap_buf_right = mkMappingOption "Swap Buffer Right" "<leader><leader>l";
+    };
+  };
+}

npins/sources.json

@@ -2232,6 +2232,22 @@
       "url": "https://github.com/mrcjkb/rustaceanvim/archive/a0c8e9698ef90bcfdf42806a38bf55b612b65b18.tar.gz",
       "hash": "1j63qpal1n8m9kj3fdjjw81ljbsqjzph65q2cacwm5ziwi2xvncx"
     },
+    "smart-splits": {
+      "type": "GitRelease",
+      "repository": {
+        "type": "GitHub",
+        "owner": "mrjones2014",
+        "repo": "smart-splits.nvim"
+      },
+      "pre_releases": false,
+      "version_upper_bound": null,
+      "release_prefix": null,
+      "submodules": false,
+      "version": "v2.0.1",
+      "revision": "7c9bc1cfc0582c8c6851c38bb3338db644039cf7",
+      "url": "https://api.github.com/repos/mrjones2014/smart-splits.nvim/tarball/v2.0.1",
+      "hash": "0lhwkb07pdfi7dx9kbzynh0dxivhiryngkiy4565hyhxapfis5v7"
+    },
     "smartcolumn-nvim": {
       "type": "Git",
       "repository": {