From 514d4da2d3ff56b591d19f5a8c3f0d3210eea879 Mon Sep 17 00:00:00 2001
From: Christoph Koehler <christoph@zerodeviation.net>
Date: Tue, 1 Apr 2025 19:08:46 -0600
Subject: [PATCH] feat: add flash.nvim

A motion plugin, from Folke. https://github.com/folke/flash.nvim
---
 docs/release-notes/rl-0.8.md                  |  7 +++-
 modules/plugins/utility/motion/default.nix    |  1 +
 .../plugins/utility/motion/flash/config.nix   | 34 +++++++++++++++++
 .../plugins/utility/motion/flash/default.nix  |  6 +++
 .../plugins/utility/motion/flash/flash.nix    | 38 +++++++++++++++++++
 npins/sources.json                            | 13 +++++++
 6 files changed, 97 insertions(+), 2 deletions(-)
 create mode 100644 modules/plugins/utility/motion/flash/config.nix
 create mode 100644 modules/plugins/utility/motion/flash/default.nix
 create mode 100644 modules/plugins/utility/motion/flash/flash.nix

diff --git a/docs/release-notes/rl-0.8.md b/docs/release-notes/rl-0.8.md
index a3387fd6..368df9f5 100644
--- a/docs/release-notes/rl-0.8.md
+++ b/docs/release-notes/rl-0.8.md
@@ -301,6 +301,9 @@
 - Update default `telescope.setupOpts.pickers.find_files.find_command` to only
   include files (and therefore exclude directories from results)
 
-  [ckoehler](https://github.com/ckoehler):
+[ckoehler](https://github.com/ckoehler):
 
-  - Fix oil config referencing snacks
+[flash.nvim]: https://github.com/folke/flash.nvim
+
+- Fix oil config referencing snacks
+- Add [flash.nvim] plugin to `vim.utility.motion.flash-nvim`
diff --git a/modules/plugins/utility/motion/default.nix b/modules/plugins/utility/motion/default.nix
index 838fec78..10074939 100644
--- a/modules/plugins/utility/motion/default.nix
+++ b/modules/plugins/utility/motion/default.nix
@@ -1,5 +1,6 @@
 _: {
   imports = [
+    ./flash
     ./hop
     ./leap
     ./precognition
diff --git a/modules/plugins/utility/motion/flash/config.nix b/modules/plugins/utility/motion/flash/config.nix
new file mode 100644
index 00000000..3adf0de8
--- /dev/null
+++ b/modules/plugins/utility/motion/flash/config.nix
@@ -0,0 +1,34 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+  inherit (lib.nvim.binds) mkKeymap;
+  inherit (lib.nvim.lua) toLuaObject;
+  inherit (lib.nvim.dag) entryAnywhere;
+
+  cfg = config.vim.utility.motion.flash-nvim;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      lazy.plugins = {
+        "flash-nvim" = {
+          package = "flash-nvim";
+          setupModule = "flash";
+          setupOpts = cfg.setupOpts;
+
+          lazy = true;
+
+          keys = [
+            (mkKeymap ["n" "o" "x"] cfg.mappings.jump "<cmd>lua require(\"flash\").jump()<cr>" {desc = "Flash";})
+            (mkKeymap ["n" "o" "x"] cfg.mappings.treesitter "<cmd>lua require(\"flash\").treesitter()<cr>" {desc = "Flash Treesitter";})
+            (mkKeymap "o" cfg.mappings.remote "<cmd>lua require(\"flash\").remote()<cr>" {desc = "Remote Flash";})
+            (mkKeymap ["o" "x"] cfg.mappings.treesitter_search "<cmd>lua require(\"flash\").treesitter_search()<cr>" {desc = "Treesitter Search";})
+            (mkKeymap "c" cfg.mappings.toggle "<cmd>lua require(\"flash\").toggle()<cr>" {desc = "Toggle Flash Search";})
+          ];
+        };
+      };
+    };
+  };
+}
diff --git a/modules/plugins/utility/motion/flash/default.nix b/modules/plugins/utility/motion/flash/default.nix
new file mode 100644
index 00000000..5978df25
--- /dev/null
+++ b/modules/plugins/utility/motion/flash/default.nix
@@ -0,0 +1,6 @@
+{
+  imports = [
+    ./flash.nix
+    ./config.nix
+  ];
+}
diff --git a/modules/plugins/utility/motion/flash/flash.nix b/modules/plugins/utility/motion/flash/flash.nix
new file mode 100644
index 00000000..825b86a0
--- /dev/null
+++ b/modules/plugins/utility/motion/flash/flash.nix
@@ -0,0 +1,38 @@
+{lib, ...}: let
+  inherit (lib.options) mkEnableOption mkOption;
+  inherit (lib.types) nullOr str;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+in {
+  options.vim.utility.motion.flash-nvim = {
+    enable = mkEnableOption "enhanced code navigation with flash.nvim";
+    setupOpts = mkPluginSetupOption "flash-nvim" {};
+
+    mappings = {
+      jump = mkOption {
+        type = nullOr str;
+        default = "s";
+        description = "Jump";
+      };
+      treesitter = mkOption {
+        type = nullOr str;
+        default = "S";
+        description = "Treesitter";
+      };
+      remote = mkOption {
+        type = nullOr str;
+        default = "r";
+        description = "Remote Flash";
+      };
+      treesitter_search = mkOption {
+        type = nullOr str;
+        default = "R";
+        description = "Treesitter Search";
+      };
+      toggle = mkOption {
+        type = nullOr str;
+        default = "<c-s>";
+        description = "Toggle Flash Search";
+      };
+    };
+  };
+}
diff --git a/npins/sources.json b/npins/sources.json
index 74dc20c8..a8573213 100644
--- a/npins/sources.json
+++ b/npins/sources.json
@@ -471,6 +471,19 @@
       "url": "https://github.com/j-hui/fidget.nvim/archive/d9ba6b7bfe29b3119a610892af67602641da778e.tar.gz",
       "hash": "070jadci8x6zgxnsqaldjah1gm1p78wscsb9wpn5wn8mjkyk2m80"
     },
+    "flash-nvim": {
+      "type": "Git",
+      "repository": {
+        "type": "GitHub",
+        "owner": "folke",
+        "repo": "flash.nvim"
+      },
+      "branch": "main",
+      "submodules": false,
+      "revision": "3c942666f115e2811e959eabbdd361a025db8b63",
+      "url": "https://github.com/folke/flash.nvim/archive/3c942666f115e2811e959eabbdd361a025db8b63.tar.gz",
+      "hash": "1xil2lkyr404zni1qmkwrl9hvbwjjk52fmncg59vqmvdybwsnqni"
+    },
     "flutter-tools-nvim": {
       "type": "Git",
       "repository": {