flake/homes/modules/editor/neovim/default.nix

# TODO: look into changing to this:
# https://github.com/BirdeeHub/nix-wrapper-modules
{
  inputs,
  lib,
  ...
}: let
  inherit
    (inputs.nixcats)
    utils
    ;
in {
  imports = [
    inputs.nixcats.homeModule
  ];

  nixCats = {
    enable = true;
    nixpkgs_version = inputs.nixpkgs-unstable;
    addOverlays =
      [
        (utils.standardPluginOverlay inputs)
      ]
      ++ lib.optional (builtins.pathExists ./overlays.nix) ./overlays.nix;

    # see the packageDefinitions below.
    # This says which of those to install.
    packageNames = ["cryvim"];

    luaPath = ./.;

    # NOTE: the .replace vs .merge options are for modules based on existing configurations,
    # NOTE: they refer to how multiple categoryDefinitions get merged together by the module.
    # NOTE: for useage of this section, refer to :h nixCats.flake.outputs.categories
    categoryDefinitions.replace = {
      pkgs,
      settings,
      categories,
      extra,
      name,
      mkNvimPlugin,
      ...
    } @ packageDef: {
      lspsAndRuntimeDeps = with pkgs; {
        general = [
          ripgrep
          fd
        ];
        treesitter = [
          tree-sitter
        ];
        lang = {
          lua = [
            lua-language-server
            stylua
          ];
          nix = [
            nil
            nix-doc # TODO: i forgot what this is for
            nixfmt
          ];
          rust = [
            rust-analyzer
            rustfmt
          ];
          zig = [
            zls
          ];
          elixir = [
            elixir-ls
          ];
          gleam = [
            gleam
          ];
          haskell = [
            haskell-language-server
            ormolu
          ];
          java = [
            jdt-language-server
            javaPackages.compiler.openjdk17
            javaPackages.compiler.openjdk21
          ];
          protobuf = [
            protols
            buf
          ];
        };
      };

      startupPlugins = with pkgs.vimPlugins; {
        general = [
          lze
          plenary-nvim
          nvim-notify
          nvim-web-devicons
          base16-nvim
          mini-nvim
        ];
        treesitter = [
          nvim-treesitter-textobjects
          nvim-treesitter.withAllGrammars
        ];
      };

      optionalPlugins = with pkgs.vimPlugins; {
        general = [
        ];
        ui = [
          dressing-nvim
        ];
        qol = [
          undotree
          mini-hipatterns
        ];
        telescope = [
          telescope-nvim
          telescope-fzf-native-nvim
          telescope-ui-select-nvim
        ];
        fyler = [
          fyler-nvim
        ];
        lsp = [
          nvim-lspconfig
        ];
        completion = [
          blink-cmp
          nvim-cmp
          luasnip
          friendly-snippets
          cmp_luasnip
          cmp-buffer
          cmp-path
          cmp-nvim-lua
          cmp-nvim-lsp
          cmp-cmdline
          cmp-nvim-lsp-signature-help
          cmp-cmdline-history
          lspkind-nvim
        ];
        format = [
          conform-nvim
        ];
        comment = [
          comment-nvim
        ];
        lang = {
          java = [
            nvim-jdtls
          ];
        };
      };

      # shared libraries to be added to nvim runtime's LD_LIBRARY_PATH
      sharedLibraries = {
        general = with pkgs; [
          # libgit2
        ];
      };

      environmentVariables = {
        lang = {
          rust.lsp = {
            # it literally won't see the rust-analyzer provided to it
            RUST_ANALYZER_CMD = "${pkgs.rust-analyzer}/bin/rust-analyzer";
          };
          elixir.lsp = {
            ELIXIR_LS_CMD = "${pkgs.elixir-ls}/scripts/language_server.sh";
          };
          java.lsp = {
            JAVA_HOME = "${pkgs.javaPackages.compiler.openjdk17}";
            OPENJDK_17 = "${pkgs.javaPackages.compiler.openjdk17}";
            OPENJDK_21 = "${pkgs.javaPackages.compiler.openjdk21}";
          };
        };
      };

      extraWrapperArgs = {};
      # lists of the functions you would have passed to
      # python.withPackages or lua.withPackages

      # get the path to this python environment
      # in your lua config via
      # vim.g.python3_host_prog
      # or run from nvim terminal via :!<packagename>-python3
      extraPython3Packages = {};
      # populates $LUA_PATH and $LUA_CPATH
      extraLuaPackages = {};
    };

    # REF: :help nixCats.flake.outputs.packageDefinitions
    packageDefinitions.replace = {
      # these are the names of your packages
      # you can include as many as you wish.
      cryvim = {pkgs, ...}: {
        # they contain a settings set defined above
        # REF: :help nixCats.flake.outputs.settings
        settings = {
          wrapRc = true;
          aliases = [
            "ce"
          ];
        };

        # and a set of categories that you want
        # (and other information to pass to lua)
        categories = {
          general = true;

          ui = true;
          qol = true;
          telescope = true;
          fyler = true;
          lsp = true;
          completion = true;
          treesitter = true;
          format = true;
          comment = true;

          lang = {
            lua = true;
            nix = true;
            rust = true;
            zig = true;
            elixir = true;
            gleam = true;
            haskell = true;
            java = true;
            protobuf = true;
          };
        };
      };
    };
  };
}