From b4991515275acaf6f518f42df0e76052a828888c Mon Sep 17 00:00:00 2001 From: Ching Pei Yang <59727193+horriblename@users.noreply.github.com> Date: Fri, 13 Sep 2024 18:34:21 +0200 Subject: [PATCH 1/3] treewide: standardize border type (#341) * ui: allow custom listOf str border type * lib: extract shared borderType * remove TODO * allow ["|" "HighlightGroup"] for border char * docs: update rl notes --------- Co-authored-by: raf --- docs/release-notes/rl-0.7.md | 1 + lib/types/default.nix | 2 +- lib/types/plugins.nix | 4 ++++ modules/plugins/lsp/lspconfig/config.nix | 3 ++- .../lsp/nvim-code-action-menu/config.nix | 3 ++- modules/plugins/ui/borders/borders.nix | 17 ++++++++++------- modules/plugins/ui/breadcrumbs/breadcrumbs.nix | 16 ++++++---------- .../plugins/utility/binds/which-key/config.nix | 2 +- modules/plugins/visuals/fidget/fidget.nix | 4 ++-- 9 files changed, 29 insertions(+), 23 deletions(-) diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index 9ed01ad9..d7d1e036 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -53,6 +53,7 @@ configuration formats. longer filtered and thus should be used instead. - Add dap-go for better dap configurations - Make noice.nvim customizable +- Standardize border style options and add custom borders [rust-tools.nvim]: https://github.com/simrat39/rust-tools.nvim [rustaceanvim]: https://github.com/mrcjkb/rustaceanvim diff --git a/lib/types/default.nix b/lib/types/default.nix index 928bbaed..6751229c 100644 --- a/lib/types/default.nix +++ b/lib/types/default.nix @@ -9,7 +9,7 @@ typesCustom = import ./custom.nix {inherit lib;}; in { inherit (typesDag) dagOf; - inherit (typesPlugin) pluginsOpt extraPluginType mkPluginSetupOption luaInline pluginType; + inherit (typesPlugin) pluginsOpt extraPluginType mkPluginSetupOption luaInline pluginType borderType; inherit (typesLanguage) diagnostics mkGrammarOption; inherit (typesCustom) anythingConcatLists char; } diff --git a/lib/types/plugins.nix b/lib/types/plugins.nix index c0e89d66..7d24163e 100644 --- a/lib/types/plugins.nix +++ b/lib/types/plugins.nix @@ -51,9 +51,13 @@ }; }; }; + + borderPresets = ["none" "single" "double" "rounded" "solid" "shadow"]; in { inherit extraPluginType fromInputs pluginType; + borderType = either (enum borderPresets) (listOf (either str (listOf str))); + pluginsOpt = { description, example, diff --git a/modules/plugins/lsp/lspconfig/config.nix b/modules/plugins/lsp/lspconfig/config.nix index 15d42fdc..1c1f0a0a 100644 --- a/modules/plugins/lsp/lspconfig/config.nix +++ b/modules/plugins/lsp/lspconfig/config.nix @@ -7,6 +7,7 @@ inherit (lib.strings) optionalString; inherit (lib.attrsets) mapAttrs; inherit (lib.nvim.dag) entryAfter; + inherit (lib.nvim.lua) toLuaObject; cfg = config.vim.lsp; in { @@ -22,7 +23,7 @@ in { ${ optionalString config.vim.ui.borders.enable '' - require('lspconfig.ui.windows').default_options.border = '${config.vim.ui.borders.globalStyle}' + require('lspconfig.ui.windows').default_options.border = ${toLuaObject config.vim.ui.borders.globalStyle} '' } ''; diff --git a/modules/plugins/lsp/nvim-code-action-menu/config.nix b/modules/plugins/lsp/nvim-code-action-menu/config.nix index 9acc34d9..145cb609 100644 --- a/modules/plugins/lsp/nvim-code-action-menu/config.nix +++ b/modules/plugins/lsp/nvim-code-action-menu/config.nix @@ -6,6 +6,7 @@ inherit (lib.modules) mkIf; inherit (lib.nvim.dag) entryAnywhere; inherit (lib.nvim.binds) mkSetBinding addDescriptionsToMappings pushDownDefault; + inherit (lib.nvim.lua) toLuaObject; cfg = config.vim.lsp; @@ -25,7 +26,7 @@ in { pluginRC.code-action-menu = entryAnywhere '' -- border configuration - vim.g.code_action_menu_window_border = '${config.vim.ui.borders.plugins.code-action-menu.style}' + vim.g.code_action_menu_window_border = ${toLuaObject config.vim.ui.borders.plugins.code-action-menu.style} -- show individual sections of the code action menu ${lib.optionalString cfg.nvimCodeActionMenu.show.details "vim.g.code_action_menu_show_details = true"} diff --git a/modules/plugins/ui/borders/borders.nix b/modules/plugins/ui/borders/borders.nix index 37589dca..99515919 100644 --- a/modules/plugins/ui/borders/borders.nix +++ b/modules/plugins/ui/borders/borders.nix @@ -4,31 +4,34 @@ ... }: let inherit (lib.options) mkOption mkEnableOption; - inherit (lib.lists) optionals; - inherit (lib.types) enum; + inherit (lib.nvim.types) borderType; cfg = config.vim.ui.borders; - - defaultStyles = ["none" "single" "double" "rounded"]; in { options.vim.ui.borders = { enable = mkEnableOption "visible borders for most windows"; globalStyle = mkOption { - type = enum defaultStyles; + type = borderType; default = "rounded"; description = '' The global border style to use. + + If a list is given, it should have a length of eight or any divisor of + eight. The array will specify the eight chars building up the border in + a clockwise fashion starting with the top-left corner. You can specify + a different highlight group for each character by passing a + [char, "YourHighlightGroup"] instead ''; + example = ["╔" "═" "╗" "║" "╝" "═" "╚" "║"]; }; - # TODO: make per-plugin borders configurable plugins = let mkPluginStyleOption = name: { enable = mkEnableOption "borders for the ${name} plugin" // {default = cfg.enable;}; style = mkOption { - type = enum (defaultStyles ++ optionals (name != "which-key") ["shadow"]); + type = borderType; default = cfg.globalStyle; description = "The border style to use for the ${name} plugin"; }; diff --git a/modules/plugins/ui/breadcrumbs/breadcrumbs.nix b/modules/plugins/ui/breadcrumbs/breadcrumbs.nix index 18df8c05..e173688a 100644 --- a/modules/plugins/ui/breadcrumbs/breadcrumbs.nix +++ b/modules/plugins/ui/breadcrumbs/breadcrumbs.nix @@ -4,9 +4,9 @@ ... }: let inherit (lib.options) mkOption mkEnableOption; - inherit (lib.types) nullOr listOf enum bool str int; + inherit (lib.types) nullOr listOf enum bool str int either; inherit (lib.modules) mkRenamedOptionModule; - inherit (lib.nvim.types) mkPluginSetupOption; + inherit (lib.nvim.types) mkPluginSetupOption borderType; mkSimpleIconOption = default: mkOption { inherit default; @@ -212,8 +212,7 @@ in { # position = {} border = mkOption { - # TODO: let this type accept a custom string - type = enum ["single" "rounded" "double" "solid" "none"]; + type = borderType; default = config.vim.ui.borders.globalStyle; description = "border style to use"; }; @@ -236,8 +235,7 @@ in { */ border = mkOption { - # TODO: let this type accept a custom string - type = nullOr (enum ["single" "rounded" "double" "solid" "none"]); + type = borderType; default = config.vim.ui.borders.globalStyle; description = "border style to use for the left section of Navbuddy UI"; }; @@ -254,8 +252,7 @@ in { */ border = mkOption { - # TODO: let this type accept a custom string - type = nullOr (enum ["single" "rounded" "double" "solid" "none"]); + type = borderType; default = config.vim.ui.borders.globalStyle; description = "border style to use for the middle section of Navbuddy UI"; }; @@ -265,8 +262,7 @@ in { # there is no size option for the right section, it fills the remaining space right = { border = mkOption { - # TODO: let this type accept a custom string - type = nullOr (enum ["single" "rounded" "double" "solid" "none"]); + type = borderType; default = config.vim.ui.borders.globalStyle; description = "border style to use for the right section of Navbuddy UI"; }; diff --git a/modules/plugins/utility/binds/which-key/config.nix b/modules/plugins/utility/binds/which-key/config.nix index 03c85b4f..d7296880 100644 --- a/modules/plugins/utility/binds/which-key/config.nix +++ b/modules/plugins/utility/binds/which-key/config.nix @@ -25,7 +25,7 @@ in { ${optionalString config.vim.ui.borders.plugins.which-key.enable '' window = { - border = "${config.vim.ui.borders.plugins.which-key.style}", + border = ${toLuaObject config.vim.ui.borders.plugins.which-key.style}, }, ''} }) diff --git a/modules/plugins/visuals/fidget/fidget.nix b/modules/plugins/visuals/fidget/fidget.nix index c5f4eb66..79974bd1 100644 --- a/modules/plugins/visuals/fidget/fidget.nix +++ b/modules/plugins/visuals/fidget/fidget.nix @@ -7,7 +7,7 @@ inherit (lib.options) mkEnableOption mkOption literalExpression; inherit (lib.strings) toUpper; inherit (lib.types) int float bool str enum listOf attrsOf oneOf nullOr submodule; - inherit (lib.nvim.types) mkPluginSetupOption luaInline; + inherit (lib.nvim.types) mkPluginSetupOption luaInline borderType; inherit (lib.generators) mkLuaInline; in { imports = [ @@ -453,7 +453,7 @@ in { }; border = mkOption { description = "Border style of the notification window"; - type = enum ["none" "single" "double" "rounded" "solid" "shadow"]; + type = borderType; default = if config.vim.ui.borders.enable then config.vim.ui.borders.globalStyle From b9dcbec29cce992f35328468ed521bd095c734c9 Mon Sep 17 00:00:00 2001 From: TheSunCat Date: Fri, 13 Sep 2024 19:01:33 +0200 Subject: [PATCH 2/3] docs: fix typo in `custom-plugins.md` (#373) --- docs/manual/configuring/custom-plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual/configuring/custom-plugins.md b/docs/manual/configuring/custom-plugins.md index 3bcd324d..c58c4973 100644 --- a/docs/manual/configuring/custom-plugins.md +++ b/docs/manual/configuring/custom-plugins.md @@ -1,7 +1,7 @@ # Custom Plugins {#ch-custom-plugins} **nvf**, by default, exposes a wide variety of plugins as module options -for your convience and bundles necessary dependencies into **nvf**'s runtime. +for your convenience and bundles necessary dependencies into **nvf**'s runtime. In case a plugin is not available in **nvf**, you may consider making a pull request to **nvf** to include it as a module or you may add it to your configuration locally. From eb037b7bff62171004e9276d4efb9be7e7ce9d8e Mon Sep 17 00:00:00 2001 From: raf Date: Fri, 13 Sep 2024 20:54:08 +0300 Subject: [PATCH 3/3] ui/breadcrumbs: allow lualine winbar component to be disabled (#371) --- docs/release-notes/rl-0.7.md | 14 ++++++- modules/plugins/statusline/lualine/config.nix | 8 ++-- .../plugins/ui/breadcrumbs/breadcrumbs.nix | 42 +++++++++++++++---- 3 files changed, 52 insertions(+), 12 deletions(-) diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index d7d1e036..7c99a971 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -72,7 +72,8 @@ configuration formats. - Fix "Emac" typo -- Add [new-file-template.nvim] to automatically fill new file contents using templates. +- Add [new-file-template.nvim] to automatically fill new file contents using + templates. [diniamo](https://github.com/diniamo): @@ -147,11 +148,22 @@ configuration formats. - Add `nvf-print-config` & `nvf-print-config-path` helper scripts to Neovim closure. Both of those scripts have been automatically added to your PATH upon using neovimConfig or `programs.nvf.enable`. + - `nvf-print-config` will display your `init.lua`, in full. - `nvf-print-config-path` will display the path to _a clone_ of your `init.lua`. This is not the path used by the Neovim wrapper, but an identical clone. +- Add `vim.ui.breadcrumbs.lualine` to allow fine-tuning breadcrumbs behaviour on + Lualine. Only `vim.ui.breadcrumbs.lualine.winbar` is supported for the time + being. + - [](#opt-vim.ui.breadcrumbs.lualine.winbar.enable) has been added to allow + controlling the default behaviour of the `nvim-navic` component on Lualine, + which used to occupy `winbar.lualine_c` as long as breadcrumbs are enabled. + - `vim.ui.breadcrumbs.alwaysRender` has been renamed to + [](#opt-vim.ui.breadcrumbs.lualine.winbar.alwaysRender) to be conform to the + new format. + [ppenguin](https://github.com/ppenguin): - Telescope: diff --git a/modules/plugins/statusline/lualine/config.nix b/modules/plugins/statusline/lualine/config.nix index d5191994..ac587c03 100644 --- a/modules/plugins/statusline/lualine/config.nix +++ b/modules/plugins/statusline/lualine/config.nix @@ -11,7 +11,7 @@ inherit (lib.generators) mkLuaInline; cfg = config.vim.statusline.lualine; - breadcrumbsCfg = config.vim.ui.breadcrumbs; + bCfg = config.vim.ui.breadcrumbs; in { config = mkMerge [ # TODO: move into nvim-tree file @@ -20,13 +20,14 @@ in { extensions = ["nvim-tree"]; }; }) - (mkIf (breadcrumbsCfg.enable && breadcrumbsCfg.source == "nvim-navic") { + + (mkIf (bCfg.enable && bCfg.lualine.winbar.enable && bCfg.source == "nvim-navic") { vim.statusline.lualine.setupOpts = { # TODO: rewrite in new syntax winbar.lualine_c = mkDefault [ [ "navic" - (mkLuaInline "draw_empty = ${boolToString config.vim.ui.breadcrumbs.alwaysRender}") + (mkLuaInline "draw_empty = ${boolToString bCfg.lualine.winbar.alwaysRender}") ] ]; }; @@ -34,7 +35,6 @@ in { (mkIf cfg.enable { vim = { startPlugins = ["lualine"]; - pluginRC.lualine = entryAnywhere '' local lualine = require('lualine') lualine.setup ${toLuaObject cfg.setupOpts} diff --git a/modules/plugins/ui/breadcrumbs/breadcrumbs.nix b/modules/plugins/ui/breadcrumbs/breadcrumbs.nix index e173688a..2faee6c8 100644 --- a/modules/plugins/ui/breadcrumbs/breadcrumbs.nix +++ b/modules/plugins/ui/breadcrumbs/breadcrumbs.nix @@ -31,6 +31,8 @@ in { (renameSetupOpt ["sourceBuffer" "scrolloff"] ["source_buffer" "scrolloff"]) # TODO: every option under icon is renamed to first letter capitalized (renameSetupOpt ["icon"] ["icon"]) + + (mkRenamedOptionModule ["vim" "ui" "breadcrumbs" "alwaysRender"] ["vim" "ui" "breadcrumbs" "lualine" "winbar" "alwaysRender"]) ]; options.vim.ui.breadcrumbs = { @@ -43,17 +45,43 @@ in { ''; }; - # maybe this should be an option to *disable* alwaysRender optionally but oh well - # too late - alwaysRender = mkOption { - type = bool; - default = true; - description = "Whether to always display the breadcrumbs component on winbar (always renders winbar)"; + # Options for configuring Lualine integration of nvim-navic + lualine.winbar = { + enable = mkOption { + type = bool; + default = true; # for retaining previous behaviour + example = false; + description = '' + Whether to automatically configure a winbar component for + Lualine on the Winbar section. + + ::: {.note} + This is **set to `true` by default**, which means nvim-navic + will occupy `winbar.lualine_c` for the breadcrumbs feature + unless this option is set to `false`. + ::: + ''; + }; + + alwaysRender = mkOption { + type = bool; + default = true; + example = false; + description = '' + Whether to always display the breadcrumbs component + on winbar. + + ::: {.note} + This will pass `draw_empty` to the `nvim_navic` winbar + component, which causes the component to be drawn even + if it's empty + ::: + ''; + }; }; navbuddy = { enable = mkEnableOption "navbuddy LSP helper UI. Enabling this option automatically loads and enables nvim-navic"; - mappings = { close = mkOption { type = str;