nix-community.nixvim/plugins/bufferlines/bufferline.nix

{ config, pkgs, lib, ... }@args:
with lib;
let
  cfg = config.plugins.bufferline;
  optionWarnings = import ../../lib/option-warnings.nix args;
  helpers = import ../helpers.nix args;

  highlight = mkOption {
    type = types.nullOr (types.submodule ({ ... }: {
      options = {
        guifg = mkOption {
          type = types.nullOr types.str;
          description = "foreground color";
          default = null;
        };
        guibg = mkOption {
          type = types.nullOr types.str;
          description = "background color";
          default = null;
        };
      };
    }));
    default = { };
  };
in
{
  imports = [
    (optionWarnings.mkDeprecatedOption {
      option = [ "plugins" "bufferline" "indicatorIcon" ];
      alternative = [ "plugins" "bufferline" "indicator" "icon" ];
    })
  ];

  options = {
    plugins.bufferline = {
      enable = mkEnableOption "bufferline";
      package = helpers.mkPackageOption "bufferline" pkgs.vimPlugins.bufferline-nvim;
      numbers = mkOption {
        type = types.nullOr types.lines;
        description = "A lua function customizing the styling of numbers.";
        default = null;
      };
      closeCommand = mkOption {
        type = types.nullOr types.lines;
        description = "Command or function run when closing a buffer.";
        default = null;
      };
      rightMouseCommand = mkOption {
        type = types.nullOr types.lines;
        description = "Command or function run when right clicking on a buffer.";
        default = null;
      };
      leftMouseCommand = mkOption {
        type = types.nullOr types.lines;
        description = "Command or function run when clicking on a buffer.";
        default = null;
      };
      middleMouseCommand = mkOption {
        type = types.nullOr types.lines;
        description = "Command or function run when middle clicking on a buffer.";
        default = null;
      };
      # is deprecated, but might still work
      indicatorIcon = mkOption {
        type = types.nullOr types.str;
        description = "The Icon shown as a indicator for buffer. Changing it is NOT recommended,
        this is intended to be an escape hatch for people who cannot bear it for whatever reason.";
        default = null;
      };
      bufferCloseIcon = mkOption {
        type = types.nullOr types.str;
        description = "The close icon for each buffer.";
        default = null;
      };
      modifiedIcon = mkOption {
        type = types.nullOr types.str;
        description = "The icon indicating a buffer was modified.";
        default = null;
      };
      closeIcon = mkOption {
        type = types.nullOr types.str;
        description = "The close icon.";
        default = null;
      };
      leftTruncMarker = mkOption {
        type = types.nullOr types.str;
        default = null;
      };
      rightTruncMarker = mkOption {
        type = types.nullOr types.str;
        default = null;
      };
      nameFormatter = mkOption {
        type = types.nullOr types.lines;
        description = "A lua function that can be used to modify the buffer's lable. The argument 'buf' containing a name, path and bufnr is supplied.";
        default = null;
      };
      maxNameLength = mkOption {
        type = types.nullOr types.int;
        description = "Max length of a buffer name.";
        default = null;
      };
      maxPrefixLength = mkOption {
        type = types.nullOr types.int;
        description = "Max length of a buffer prefix (used when a buffer is de-duplicated)";
        default = null;
      };
      tabSize = mkOption {
        type = types.nullOr types.int;
        description = "Size of the tabs";
        default = null;
      };
      diagnostics = mkOption {
        type = types.nullOr (types.enum [ false "nvim_lsp" "coc" ]);
        default = null;
      };
      diagnosticsUpdateInInsert = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      diagnosticsIndicator = mkOption {
        type = types.nullOr helpers.rawType;
        default = null;
      };
      customFilter = mkOption {
        type = types.nullOr types.lines;
        default = null;
      };
      showBufferIcons = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      showBufferCloseIcons = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      showCloseIcon = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      showTabIndicators = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      persistBufferSort = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      separatorStyle = mkOption {
        type = types.nullOr (types.enum [ "slant" "thick" "thin" ]);
        default = null;
      };
      enforceRegularTabs = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      alwaysShowBufferline = mkOption {
        type = types.nullOr types.bool;
        default = null;
      };
      sortBy = mkOption {
        type = types.nullOr (types.enum [ "id" "extension" "relative_directory" "directory" "tabs" ]);
        default = null;
      };
      indicator = mkOption {
        default = { };
        type = types.nullOr (types.submodule ({ ... }: {
          options = {
            icon = mkOption {
              type = types.nullOr types.str;
              default = null;
            };
            style = mkOption {
              type = types.nullOr (types.enum [ "icon" "underline" "none" ]);
              default = null;
            };
          };
        }));
      };
      highlights = mkOption {
        default = { };
        type = types.nullOr (types.submodule ({ ... }: {
          options = {
            fill = highlight;
            background = highlight;

            tab = highlight;
            tabSelected = highlight;
            tabClose = highlight;

            closeButton = highlight;
            closeButtonVisible = highlight;
            closeButtonSelected = highlight;

            bufferVisible = highlight;
            bufferSelected = highlight;

            diagnostic = highlight;
            diagnosticVisible = highlight;
            diagnosticSelected = highlight;

            info = highlight;
            infoVisible = highlight;
            infoSelected = highlight;

            infoDiagnostic = highlight;
            infoDiagnosticVisible = highlight;
            infoDiagnosticSelected = highlight;

            warning = highlight;
            warningVisible = highlight;
            warningSelected = highlight;

            warningDiagnostic = highlight;
            warningDiagnosticVisible = highlight;
            warningDiagnosticSelected = highlight;

            error = highlight;
            errorVisible = highlight;
            errorSelected = highlight;

            errorDiagnostic = highlight;
            errorDiagnosticVisible = highlight;
            errorDiagnosticSelected = highlight;

            modified = highlight;
            modifiedVisible = highlight;
            modifiedSelected = highlight;

            duplicate = highlight;
            duplicateVisible = highlight;
            duplicateSelected = highlight;

            separator = highlight;
            separatorVisible = highlight;
            separatorSelected = highlight;

            indicatorSelected = highlight;

            pick = highlight;
            pickVisible = highlight;
            pickSelected = highlight;
          };
        }));
      };

      extraOptions = mkOption {
        type = types.attrs;
        default = { };
        description = "Extra options, will override others if defined";
      };
    };
  };

  config =
    let
      setupOptions = {
        options = {
          numbers = cfg.numbers;
          close_command = cfg.closeCommand;
          right_mouse_command = cfg.rightMouseCommand;
          left_mouse_command = cfg.leftMouseCommand;
          middle_mouse_command = cfg.middleMouseCommand;
          # deprecated, but might still work
          indicator_icon = cfg.indicatorIcon;
          indicator =
            if cfg.indicator != null then with cfg.indicator; {
              icon = icon;
              style = style;
            } else null;
          buffer_close_icon = cfg.bufferCloseIcon;
          modified_icon = cfg.modifiedIcon;
          close_icon = cfg.closeIcon;
          left_trunc_marker = cfg.leftTruncMarker;
          right_trunc_marker = cfg.rightTruncMarker;
          name_formatter = cfg.nameFormatter;
          max_name_length = cfg.maxNameLength;
          max_prefix_length = cfg.maxPrefixLength;
          tab_size = cfg.tabSize;
          diagnostics = cfg.diagnostics;
          diagnostics_update_in_insert = cfg.diagnosticsUpdateInInsert;
          diagnostics_indicator = cfg.diagnosticsIndicator;
          custom_filter = cfg.customFilter;
          show_buffer_icons = cfg.showBufferIcons;
          show_buffer_close_icons = cfg.showBufferCloseIcons;
          show_close_icon = cfg.showCloseIcon;
          show_tab_indicators = cfg.showTabIndicators;
          persist_buffer_sort = cfg.persistBufferSort;
          separator_style = cfg.separatorStyle;
          enforce_regular_tabs = cfg.enforceRegularTabs;
          always_show_bufferline = cfg.alwaysShowBufferline;
          sort_by = cfg.sortBy;
        } // cfg.extraOptions;
        highlights = if builtins.isNull cfg.highlights then null else with cfg.highlights; {
          fill = fill;
          background = background;

          tab = tab;
          tab_selected = tabSelected;
          tab_close = tabClose;
          close_button = closeButton;
          close_button_visible = closeButtonVisible;
          close_button_selected = closeButtonSelected;

          buffer_visible = bufferVisible;
          buffer_selected = bufferSelected;

          diagnostic = diagnostic;
          diagnostic_visible = diagnosticVisible;
          diagnostic_selected = diagnosticSelected;

          info = info;
          info_visible = infoVisible;
          info_selected = infoSelected;

          info_diagnostic = infoDiagnostic;
          info_diagnostic_visible = infoDiagnosticVisible;
          info_diagnostic_selected = infoDiagnosticSelected;

          warning = warning;
          warning_visible = warningVisible;
          warning_selected = warningSelected;

          warning_diagnostic = warningDiagnostic;
          warning_diagnostic_visible = warningDiagnosticVisible;
          warning_diagnostic_selected = warningDiagnosticSelected;

          error = error;
          error_visible = errorVisible;
          error_selected = errorSelected;

          error_dagnostic = errorDiagnostic;
          error_diagnostic_visible = errorDiagnosticVisible;
          error_diagnostic_selected = errorDiagnosticSelected;

          modified = modified;
          modified_visible = modifiedVisible;
          modified_selected = modifiedSelected;

          duplicate = duplicate;
          duplicate_visible = duplicateVisible;
          duplicate_selected = duplicateSelected;

          separator = separator;
          separator_visible = separatorVisible;
          separator_selected = separatorSelected;

          indicator_selected = indicatorSelected;

          pick = pick;
          pick_visible = pickVisible;
          pick_selected = pickSelected;

        };
      };
    in
    mkIf cfg.enable {
      extraPlugins = with pkgs.vimPlugins; [
        cfg.package
        nvim-web-devicons
      ];
      options.termguicolors = true;
      extraConfigLua = ''
        require('bufferline').setup${helpers.toLuaObject setupOptions}
      '';
    };
}