mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-07-10 17:24:32 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

plugins/bufferlines/barbar: migrate helpers -> lib.nixvim

Browse source
This commit is contained in:
Austin Horstman 2024-08-22 09:20:54 -05:00
parent fe12a092f6
commit b470800240
No known key found for this signature in database
1 changed files with 67 additions and 63 deletions
Download patch file Download diff file Expand all files Collapse all files

130
plugins/bufferlines/barbar.nix
View file

@ -1,12 +1,18 @@
{ {
lib, lib,
helpers,
config, config,
pkgs, pkgs,
... ...
}: }:
with lib; with lib;
let let
inherit (lib.nixvim)
defaultNullOpts
keymaps
mkNullOrOption
mkNullOrOption'
mkNullOrStr
;
keymapsActions = { keymapsActions = {
previous = "Previous"; previous = "Previous";
next = "Next"; next = "Next";
@ -45,7 +51,7 @@ let
orderByWindowNumber = "OrderByWindowNumber"; orderByWindowNumber = "OrderByWindowNumber";
}; };
in in
helpers.neovim-plugin.mkNeovimPlugin config { lib.nixvim.neovim-plugin.mkNeovimPlugin config {
name = "barbar"; name = "barbar";
originalName = "barbar.nvim"; originalName = "barbar.nvim";
defaultPackage = pkgs.vimPlugins.barbar-nvim; defaultPackage = pkgs.vimPlugins.barbar-nvim;
@ -193,15 +199,15 @@ helpers.neovim-plugin.mkNeovimPlugin config {
extraOptions = { extraOptions = {
keymaps = mapAttrs ( keymaps = mapAttrs (
optionName: funcName: optionName: funcName:
helpers.mkNullOrOption' { mkNullOrOption' {
type = helpers.keymaps.mkMapOptionSubmodule { type = keymaps.mkMapOptionSubmodule {
defaults = { defaults = {
mode = "n"; mode = "n";
action = "<Cmd>Buffer${funcName}<CR>"; action = "<Cmd>Buffer${funcName}<CR>";
}; };
lua = true; lua = true;
}; };
apply = v: if v == null then null else helpers.keymaps.removeDeprecatedMapAttrs v; apply = v: if v == null then null else keymaps.removeDeprecatedMapAttrs v;
description = "Keymap for function Buffer${funcName}"; description = "Keymap for function Buffer${funcName}";
} }
) keymapsActions; ) keymapsActions;
@ -215,34 +221,32 @@ helpers.neovim-plugin.mkNeovimPlugin config {
}; };
settingsOptions = { settingsOptions = {
animation = helpers.defaultNullOpts.mkBool true '' animation = defaultNullOpts.mkBool true ''
Enable/disable animations. Enable/disable animations.
''; '';
auto_hide = auto_hide = defaultNullOpts.mkNullableWithRaw (with types; either int (enum [ false ])) (-1) ''
helpers.defaultNullOpts.mkNullableWithRaw (with types; either int (enum [ false ])) (-1) Automatically hide the 'tabline' when there are this many buffers left.
'' Set to any value less than `0` to disable.
Automatically hide the 'tabline' when there are this many buffers left.
Set to any value less than `0` to disable.
For example: `auto_hide = 0` hides the 'tabline' when there would be zero buffers shown, For example: `auto_hide = 0` hides the 'tabline' when there would be zero buffers shown,
`auto_hide = 1` hides the 'tabline' when there would only be one, etc. `auto_hide = 1` hides the 'tabline' when there would only be one, etc.
''; '';
clickable = helpers.defaultNullOpts.mkBool true '' clickable = defaultNullOpts.mkBool true ''
If set, you can left-click on a tab to switch to that buffer, and middle-click to delete it. If set, you can left-click on a tab to switch to that buffer, and middle-click to delete it.
''; '';
exclude_ft = helpers.defaultNullOpts.mkListOf types.str [ ] '' exclude_ft = defaultNullOpts.mkListOf types.str [ ] ''
Excludes filetypes from appearing in the tabs. Excludes filetypes from appearing in the tabs.
''; '';
exclude_name = helpers.defaultNullOpts.mkListOf types.str [ ] '' exclude_name = defaultNullOpts.mkListOf types.str [ ] ''
Excludes buffers matching name from appearing in the tabs. Excludes buffers matching name from appearing in the tabs.
''; '';
focus_on_close = focus_on_close =
helpers.defaultNullOpts.mkEnumFirstDefault defaultNullOpts.mkEnumFirstDefault
[ [
"left" "left"
"previous" "previous"
@ -258,44 +262,44 @@ helpers.neovim-plugin.mkNeovimPlugin config {
''; '';
hide = { hide = {
alternate = helpers.defaultNullOpts.mkBool false '' alternate = defaultNullOpts.mkBool false ''
Controls the visibility of the `|alternate-file|`. Controls the visibility of the `|alternate-file|`.
`highlight_alternate` must be `true`. `highlight_alternate` must be `true`.
''; '';
current = helpers.defaultNullOpts.mkBool false '' current = defaultNullOpts.mkBool false ''
Controls the visibility of the current buffer. Controls the visibility of the current buffer.
''; '';
extensions = helpers.defaultNullOpts.mkBool false '' extensions = defaultNullOpts.mkBool false ''
Controls the visibility of file extensions. Controls the visibility of file extensions.
''; '';
inactive = helpers.defaultNullOpts.mkBool false '' inactive = defaultNullOpts.mkBool false ''
Controls visibility of `|hidden-buffer|`s and `|inactive-buffer|`s. Controls visibility of `|hidden-buffer|`s and `|inactive-buffer|`s.
''; '';
visible = helpers.defaultNullOpts.mkBool false '' visible = defaultNullOpts.mkBool false ''
Controls visibility of `|active-buffer|`s. Controls visibility of `|active-buffer|`s.
`highlight_visible` must be `true`. `highlight_visible` must be `true`.
''; '';
}; };
highlight_alternate = helpers.defaultNullOpts.mkBool false '' highlight_alternate = defaultNullOpts.mkBool false ''
Enables highlighting of alternate buffers. Enables highlighting of alternate buffers.
''; '';
highlight_inactive_file_icons = helpers.defaultNullOpts.mkBool false '' highlight_inactive_file_icons = defaultNullOpts.mkBool false ''
Enables highlighting the file icons of inactive buffers. Enables highlighting the file icons of inactive buffers.
''; '';
highlight_visible = helpers.defaultNullOpts.mkBool true '' highlight_visible = defaultNullOpts.mkBool true ''
Enables highlighting of visible buffers. Enables highlighting of visible buffers.
''; '';
icons = { icons = {
buffer_index = buffer_index =
helpers.defaultNullOpts.mkNullableWithRaw defaultNullOpts.mkNullableWithRaw
( (
with types; with types;
either bool (enum [ either bool (enum [
@ -306,7 +310,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
false false
"If `true`, show the index of the buffer with respect to the ordering of the buffers in the tabline."; "If `true`, show the index of the buffer with respect to the ordering of the buffers in the tabline.";
buffer_number = helpers.defaultNullOpts.mkNullableWithRaw ( buffer_number = defaultNullOpts.mkNullableWithRaw (
with types; with types;
either bool (enum [ either bool (enum [
"superscript" "superscript"
@ -314,7 +318,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
]) ])
) false "If `true`, show the `bufnr` for the associated buffer."; ) false "If `true`, show the `bufnr` for the associated buffer.";
button = helpers.defaultNullOpts.mkNullableWithRaw (with types; either str (enum [ false ])) "" '' button = defaultNullOpts.mkNullableWithRaw (with types; either str (enum [ false ])) "" ''
The button which is clicked to close / save a buffer, or indicate that it is pinned. The button which is clicked to close / save a buffer, or indicate that it is pinned.
Use `false` to disable it. Use `false` to disable it.
''; '';
@ -325,11 +329,11 @@ helpers.neovim-plugin.mkNeovimPlugin config {
options = options =
let let
mkDiagnosticIconOptions = iconDefault: { mkDiagnosticIconOptions = iconDefault: {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = defaultNullOpts.mkBool false ''
Enable showing diagnostics of this `|diagnostic-severity|` in the 'tabline'. Enable showing diagnostics of this `|diagnostic-severity|` in the 'tabline'.
''; '';
icon = helpers.defaultNullOpts.mkStr iconDefault '' icon = defaultNullOpts.mkStr iconDefault ''
The icon which accompanies the number of diagnostics. The icon which accompanies the number of diagnostics.
''; '';
}; };
@ -341,9 +345,9 @@ helpers.neovim-plugin.mkNeovimPlugin config {
"vim.diagnostic.severity.WARN" = mkDiagnosticIconOptions " "; "vim.diagnostic.severity.WARN" = mkDiagnosticIconOptions " ";
}; };
}; };
apply = helpers.toRawKeys; apply = lib.nixvim.toRawKeys;
default = { }; default = { };
defaultText = helpers.pluginDefaultText { defaultText = lib.nixvim.pluginDefaultText {
inherit default; inherit default;
pluginDefault = { pluginDefault = {
"vim.diagnostic.severity.ERROR" = { "vim.diagnostic.severity.ERROR" = {
@ -386,18 +390,18 @@ helpers.neovim-plugin.mkNeovimPlugin config {
}; };
gitsigns = gitsigns =
helpers.defaultNullOpts.mkAttrsOf defaultNullOpts.mkAttrsOf
( (
with types; with types;
submodule { submodule {
freeformType = with types; attrsOf anything; freeformType = with types; attrsOf anything;
options = { options = {
enabled = helpers.defaultNullOpts.mkBool true '' enabled = defaultNullOpts.mkBool true ''
Enables showing git changes of this type. Enables showing git changes of this type.
Requires `|gitsigns.nvim|`. Requires `|gitsigns.nvim|`.
''; '';
icon = helpers.mkNullOrStr '' icon = mkNullOrStr ''
The icon which accompanies the number of git status. The icon which accompanies the number of git status.
To disable the icon but still show the count, set to an empty string. To disable the icon but still show the count, set to an empty string.
@ -421,30 +425,30 @@ helpers.neovim-plugin.mkNeovimPlugin config {
} }
"Gitsigns icons."; "Gitsigns icons.";
filename = helpers.defaultNullOpts.mkBool true '' filename = defaultNullOpts.mkBool true ''
If `true`, show the name of the file. If `true`, show the name of the file.
''; '';
filetype = { filetype = {
custom_colors = helpers.defaultNullOpts.mkBool false '' custom_colors = defaultNullOpts.mkBool false ''
If `true`, the `Buffer<status>Icon` color will be used for icon colors. If `true`, the `Buffer<status>Icon` color will be used for icon colors.
''; '';
enabled = helpers.defaultNullOpts.mkBool true '' enabled = defaultNullOpts.mkBool true ''
Filetype `true`, show the `devicons` for the associated buffer's `filetype`. Filetype `true`, show the `devicons` for the associated buffer's `filetype`.
''; '';
}; };
separator = { separator = {
left = helpers.defaultNullOpts.mkStr "▎" '' left = defaultNullOpts.mkStr "▎" ''
The left separator between buffers in the tabline. The left separator between buffers in the tabline.
''; '';
right = helpers.defaultNullOpts.mkStr "" '' right = defaultNullOpts.mkStr "" ''
The right separator between buffers in the tabline. The right separator between buffers in the tabline.
''; '';
separator_at_end = helpers.defaultNullOpts.mkBool true '' separator_at_end = defaultNullOpts.mkBool true ''
If true, add an additional separator at the end of the buffer list. If true, add an additional separator at the end of the buffer list.
Can be used to create a visual separation when the inactive buffer background color is the Can be used to create a visual separation when the inactive buffer background color is the
same as the fill region background color. same as the fill region background color.
@ -455,7 +459,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
# - It would make the module way more complex # - It would make the module way more complex
# - Most users will not be setting a lot of options under this category # - Most users will not be setting a lot of options under this category
# -> `attrsOf anything` # -> `attrsOf anything`
modified = helpers.defaultNullOpts.mkAttrsOf types.anything { button = "●"; } '' modified = defaultNullOpts.mkAttrsOf types.anything { button = "●"; } ''
The icons which should be used for a 'modified' buffer. The icons which should be used for a 'modified' buffer.
Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc). Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc).
''; '';
@ -465,7 +469,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
# - Most users will not be setting a lot of options under this category # - Most users will not be setting a lot of options under this category
# -> `attrsOf anything` # -> `attrsOf anything`
pinned = pinned =
helpers.defaultNullOpts.mkAttrsOf types.anything defaultNullOpts.mkAttrsOf types.anything
{ {
button = false; button = false;
filename = false; filename = false;
@ -480,7 +484,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
# - It would make the module way more complex # - It would make the module way more complex
# - Most users will not be setting a lot of options under this category # - Most users will not be setting a lot of options under this category
# -> `attrsOf anything` # -> `attrsOf anything`
alternate = helpers.mkNullOrOption (with helpers.nixvimTypes; maybeRaw (attrsOf anything)) '' alternate = mkNullOrOption (with types; maybeRaw (attrsOf anything)) ''
The icons which should be used for the `|alternate-file|`. The icons which should be used for the `|alternate-file|`.
Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc) as well as Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc) as well as
`modified` and `pinned`. `modified` and `pinned`.
@ -490,7 +494,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
# - It would make the module way more complex # - It would make the module way more complex
# - Most users will not be setting a lot of options under this category # - Most users will not be setting a lot of options under this category
# -> `attrsOf anything` # -> `attrsOf anything`
current = helpers.mkNullOrOption (with helpers.nixvimTypes; maybeRaw (attrsOf anything)) '' current = mkNullOrOption (with types; maybeRaw (attrsOf anything)) ''
The icons which should be used for current buffer. The icons which should be used for current buffer.
Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc) as well as Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc) as well as
`modified` and `pinned`. `modified` and `pinned`.
@ -501,7 +505,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
# - Most users will not be setting a lot of options under this category # - Most users will not be setting a lot of options under this category
# -> `attrsOf anything` # -> `attrsOf anything`
inactive = inactive =
helpers.defaultNullOpts.mkAttrsOf types.anything defaultNullOpts.mkAttrsOf types.anything
{ {
separator = { separator = {
left = "▎"; left = "▎";
@ -518,14 +522,14 @@ helpers.neovim-plugin.mkNeovimPlugin config {
# - It would make the module way more complex # - It would make the module way more complex
# - Most users will not be setting a lot of options under this category # - Most users will not be setting a lot of options under this category
# -> `attrsOf anything` # -> `attrsOf anything`
visible = helpers.mkNullOrOption (with helpers.nixvimTypes; maybeRaw (attrsOf anything)) '' visible = mkNullOrOption (with types; maybeRaw (attrsOf anything)) ''
The icons which should be used for `|active-buffer|`s. The icons which should be used for `|active-buffer|`s.
Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc) as well as Supports all the base options (e.g. `buffer_index`, `filetype.enabled`, etc) as well as
`modified` and `pinned`. `modified` and `pinned`.
''; '';
preset = preset =
helpers.defaultNullOpts.mkEnumFirstDefault defaultNullOpts.mkEnumFirstDefault
[ [
"default" "default"
"powerline" "powerline"
@ -540,60 +544,60 @@ helpers.neovim-plugin.mkNeovimPlugin config {
''; '';
}; };
insert_at_start = helpers.defaultNullOpts.mkBool false '' insert_at_start = defaultNullOpts.mkBool false ''
If `true`, new buffers appear at the start of the list. If `true`, new buffers appear at the start of the list.
Default is to open after the current buffer. Default is to open after the current buffer.
Has priority over `insert_at_end`. Has priority over `insert_at_end`.
''; '';
insert_at_end = helpers.defaultNullOpts.mkBool false '' insert_at_end = defaultNullOpts.mkBool false ''
If `true`, new buffers appear at the end of the list. If `true`, new buffers appear at the end of the list.
Default is to open after the current buffer. Default is to open after the current buffer.
''; '';
letters = helpers.defaultNullOpts.mkStr "asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP" '' letters = defaultNullOpts.mkStr "asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP" ''
New buffer letters are assigned in this order. New buffer letters are assigned in this order.
This order is optimal for the QWERTY keyboard layout but might need adjustment for other layouts. This order is optimal for the QWERTY keyboard layout but might need adjustment for other layouts.
''; '';
maximum_padding = helpers.defaultNullOpts.mkUnsignedInt 4 '' maximum_padding = defaultNullOpts.mkUnsignedInt 4 ''
Sets the maximum padding width with which to surround each tab. Sets the maximum padding width with which to surround each tab.
''; '';
maximum_length = helpers.defaultNullOpts.mkUnsignedInt 30 '' maximum_length = defaultNullOpts.mkUnsignedInt 30 ''
Sets the maximum buffer name length. Sets the maximum buffer name length.
''; '';
minimum_length = helpers.defaultNullOpts.mkUnsignedInt 0 '' minimum_length = defaultNullOpts.mkUnsignedInt 0 ''
Sets the minimum buffer name length. Sets the minimum buffer name length.
''; '';
minimum_padding = helpers.defaultNullOpts.mkUnsignedInt 1 '' minimum_padding = defaultNullOpts.mkUnsignedInt 1 ''
Sets the minimum padding width with which to surround each tab. Sets the minimum padding width with which to surround each tab.
''; '';
no_name_title = helpers.defaultNullOpts.mkStr null '' no_name_title = defaultNullOpts.mkStr null ''
Sets the name of unnamed buffers. Sets the name of unnamed buffers.
By default format is `'[Buffer X]'` where `X` is the buffer number. By default format is `'[Buffer X]'` where `X` is the buffer number.
However, only a static string is accepted here. However, only a static string is accepted here.
''; '';
semantic_letters = helpers.defaultNullOpts.mkBool true '' semantic_letters = defaultNullOpts.mkBool true ''
If `true`, the letters for each buffer in buffer-pick mode will be assigned based on their name. If `true`, the letters for each buffer in buffer-pick mode will be assigned based on their name.
Otherwise (or in case all letters are already assigned), the behavior is to assign letters in Otherwise (or in case all letters are already assigned), the behavior is to assign letters in
the order of provided to `letters`. the order of provided to `letters`.
''; '';
sidebar_filetypes = helpers.defaultNullOpts.mkAttrsOf ( sidebar_filetypes = defaultNullOpts.mkAttrsOf (
with types; with types;
either (enum [ true ]) (submodule { either (enum [ true ]) (submodule {
freeformType = with types; attrsOf anything; freeformType = with types; attrsOf anything;
options = { options = {
align = align =
helpers.defaultNullOpts.mkEnumFirstDefault defaultNullOpts.mkEnumFirstDefault
[ [
"left" "left"
"center" "center"
@ -603,19 +607,19 @@ helpers.neovim-plugin.mkNeovimPlugin config {
Aligns the `sidebar_filetypes.<name>.text`. Aligns the `sidebar_filetypes.<name>.text`.
''; '';
event = helpers.defaultNullOpts.mkStr "BufWinLeave" '' event = defaultNullOpts.mkStr "BufWinLeave" ''
The event which the sidebar executes when leaving. The event which the sidebar executes when leaving.
The `event` which is `|autocmd-execute|`d when the sidebar closes. The `event` which is `|autocmd-execute|`d when the sidebar closes.
''; '';
text = helpers.defaultNullOpts.mkStr null '' text = defaultNullOpts.mkStr null ''
The text which will fill the offset. The text which will fill the offset.
''; '';
}; };
}) })
) { } "Control which filetypes will cause barbar to add an offset."; ) { } "Control which filetypes will cause barbar to add an offset.";
tabpages = helpers.defaultNullOpts.mkBool true '' tabpages = defaultNullOpts.mkBool true ''
Enable/disable current/total tabpages indicator (top right corner). Enable/disable current/total tabpages indicator (top right corner).
''; '';
}; };