neovim-flake/modules/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix

{lib, ...}: let
  inherit (lib.modules) mkRemovedOptionModule;
  inherit (lib.options) mkOption mkEnableOption;
  inherit (lib.types) submodule attrs;
  inherit (lib.nvim.types) mkPluginSetupOption;
in {
  imports = [
    (mkRemovedOptionModule ["vim" "visuals" "smoothScroll"] ''
      `vim.visuals.smoothScroll` has been removed. You may consider enabling the
      option `vim.visuals.cinnamon-nvim` to repliace previous smooth scrolling
      behaviour.
    '')
  ];

  options.vim.visuals.cinnamon-nvim = {
    enable = mkEnableOption "smooth scrolling for ANY command [cinnamon-nvim]";
    setupOpts = mkPluginSetupOption "cinnamon.nvim" {
      options = mkOption {
        type = attrs;
        default = {
          # Defaults provided for the sake of documentation only!
          # Who would've guessed setupOpts.options would be confusing?
          mode = "cursor";
          count_only = false;
        };
        description = "Scroll options";
      };

      keymaps = mkOption {
        description = "Keymap options for Cinnamon. Please see documentation before enablg";
        type = submodule {
          basic = mkEnableOption "basic animation keymaps";
          extra = mkEnableOption "extra animation keymaps";
        };
      };
    };
  };
}