From e949a51c550ce9773bc057e28ad9264bc9306bf6 Mon Sep 17 00:00:00 2001 From: Ching Pei Yang <59727193+horriblename@users.noreply.github.com> Date: Sat, 24 Aug 2024 19:48:20 +0200 Subject: [PATCH 01/17] rust/clang: update lldb binary name (#365) --- modules/plugins/languages/clang.nix | 2 +- modules/plugins/languages/rust.nix | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/plugins/languages/clang.nix b/modules/plugins/languages/clang.nix index 0b3ffcf..bb30cc9 100644 --- a/modules/plugins/languages/clang.nix +++ b/modules/plugins/languages/clang.nix @@ -57,7 +57,7 @@ dapConfig = '' dap.adapters.lldb = { type = 'executable', - command = '${cfg.dap.package}/bin/lldb-vscode', + command = '${cfg.dap.package}/bin/lldb-dap', name = 'lldb' } dap.configurations.cpp = { diff --git a/modules/plugins/languages/rust.nix b/modules/plugins/languages/rust.nix index 39a8c36..0f59576 100644 --- a/modules/plugins/languages/rust.nix +++ b/modules/plugins/languages/rust.nix @@ -173,7 +173,7 @@ in { dap = { adapter = { type = "executable", - command = "${cfg.dap.package}/bin/lldb-vscode", + command = "${cfg.dap.package}/bin/lldb-dap", name = "rustacean_lldb", }, }, From c757d28ff768ae5c8522c3059dfb8fb90e74ba07 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 27 Aug 2024 22:27:51 +0300 Subject: [PATCH 02/17] flake: update nixpkgs input --- flake.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/flake.lock b/flake.lock index 3fcb387..8c0a17b 100644 --- a/flake.lock +++ b/flake.lock @@ -129,11 +129,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1722141560, - "narHash": "sha256-Ul3rIdesWaiW56PS/Ak3UlJdkwBrD4UcagCmXZR9Z7Y=", + "lastModified": 1724395761, + "narHash": "sha256-zRkDV/nbrnp3Y8oCADf5ETl1sDrdmAW6/bBVJ8EbIdQ=", "owner": "nixos", "repo": "nixpkgs", - "rev": "038fb464fcfa79b4f08131b07f2d8c9a6bcc4160", + "rev": "ae815cee91b417be55d43781eb4b73ae1ecc396c", "type": "github" }, "original": { From 67abc51902826c802a1a77961422b5e18c6f8e44 Mon Sep 17 00:00:00 2001 From: diniamo <55629891+diniamo@users.noreply.github.com> Date: Thu, 5 Sep 2024 20:06:24 +0200 Subject: [PATCH 03/17] treewide: remove the theme section from the DAG order dependance (#369) * treewide: remove the theme section from the DAG order dependance * docs/dag-entries: correct theme entry note --- docs/manual/configuring/dag-entries.md | 2 +- modules/plugins/theme/theme.nix | 4 ++-- modules/wrapper/rc/config.nix | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/manual/configuring/dag-entries.md b/docs/manual/configuring/dag-entries.md index 5f4f4f6..d5afa9b 100644 --- a/docs/manual/configuring/dag-entries.md +++ b/docs/manual/configuring/dag-entries.md @@ -11,7 +11,7 @@ entries in nvf: inserted before the rest of the DAG 2. `globalsScript` - used to set globals defined in `vim.globals` 3. `basic` - used to set basic configuration options -4. `theme` - used to set up the theme, which has to be done before other plugins +4. `theme` (this is simply placed before `pluginConfigs`, meaning that surrounding entries don't depend on it) - used to set up the theme, which has to be done before other plugins 5. `pluginConfigs` - the result of the nested `vim.pluginRC` (internal option, see the [Custom Plugins](/index.xhtml#ch-custom-plugins) page for adding your own plugins) DAG, used to set up internal plugins diff --git a/modules/plugins/theme/theme.nix b/modules/plugins/theme/theme.nix index bcc476b..85f8430 100644 --- a/modules/plugins/theme/theme.nix +++ b/modules/plugins/theme/theme.nix @@ -7,7 +7,7 @@ inherit (lib.attrsets) attrNames; inherit (lib.types) bool lines enum; inherit (lib.modules) mkIf; - inherit (lib.nvim.dag) entryAfter; + inherit (lib.nvim.dag) entryBefore; cfg = config.vim.theme; supportedThemes = import ./supported-themes.nix { @@ -45,7 +45,7 @@ in { config = mkIf cfg.enable { vim = { startPlugins = [cfg.name]; - luaConfigRC.theme = entryAfter ["basic"] '' + luaConfigRC.theme = entryBefore ["pluginConfigs"] '' ${cfg.extraConfig} ${supportedThemes.${cfg.name}.setup {inherit (cfg) style transparent;}} ''; diff --git a/modules/wrapper/rc/config.nix b/modules/wrapper/rc/config.nix index 78edb59..8ebf1c2 100644 --- a/modules/wrapper/rc/config.nix +++ b/modules/wrapper/rc/config.nix @@ -133,8 +133,8 @@ in { vim = { luaConfigRC = { globalsScript = entryAnywhere (concatLines globalsScript); - # basic, theme - pluginConfigs = entryAfter ["theme"] pluginConfigs; + # basic + pluginConfigs = entryAfter ["basic"] pluginConfigs; extraPluginConfigs = entryAfter ["pluginConfigs"] extraPluginConfigs; mappings = entryAfter ["extraPluginConfigs"] mappings; }; From 9eb6159ca3dc1bfb7d512528756dd1e2f1abb4ad Mon Sep 17 00:00:00 2001 From: ppenguin Date: Sun, 8 Sep 2024 17:44:42 +0200 Subject: [PATCH 04/17] Telescope: fix projects binding, add Telescope resume in default (#370) * Telescope: fix projects binding, add Telescope resume in default The projects command had a typo preventing it from working; the keybinding description was the same as for Telescope files. Added `fr` for Telescope resume per default. * Add info to release notes --- docs/release-notes/rl-0.7.md | 6 + modules/plugins/utility/telescope/config.nix | 127 +++++++++--------- .../plugins/utility/telescope/telescope.nix | 4 +- 3 files changed, 73 insertions(+), 64 deletions(-) diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index 0d607f9..9ed01ad 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -150,3 +150,9 @@ configuration formats. - `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. + +[ppenguin](https://github.com/ppenguin): + +- Telescope: + - Fixed `project-nvim` command and keybinding + - Added default ikeybind/command for `Telescope resume` (`fr`) diff --git a/modules/plugins/utility/telescope/config.nix b/modules/plugins/utility/telescope/config.nix index 2ec7d3d..68af964 100644 --- a/modules/plugins/utility/telescope/config.nix +++ b/modules/plugins/utility/telescope/config.nix @@ -17,75 +17,78 @@ mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions; in { config = mkIf cfg.enable { - vim.startPlugins = [ - "telescope" - "plenary-nvim" - ]; + vim = { + startPlugins = [ + "telescope" + "plenary-nvim" + ]; - vim.maps.normal = mkMerge [ - (mkSetBinding mappings.findFiles " Telescope find_files") - (mkSetBinding mappings.liveGrep " Telescope live_grep") - (mkSetBinding mappings.buffers " Telescope buffers") - (mkSetBinding mappings.helpTags " Telescope help_tags") - (mkSetBinding mappings.open " Telescope") + maps.normal = mkMerge [ + (mkSetBinding mappings.findFiles " Telescope find_files") + (mkSetBinding mappings.liveGrep " Telescope live_grep") + (mkSetBinding mappings.buffers " Telescope buffers") + (mkSetBinding mappings.helpTags " Telescope help_tags") + (mkSetBinding mappings.open " Telescope") + (mkSetBinding mappings.resume " Telescope resume") - (mkSetBinding mappings.gitCommits " Telescope git_commits") - (mkSetBinding mappings.gitBufferCommits " Telescope git_bcommits") - (mkSetBinding mappings.gitBranches " Telescope git_branches") - (mkSetBinding mappings.gitStatus " Telescope git_status") - (mkSetBinding mappings.gitStash " Telescope git_stash") + (mkSetBinding mappings.gitCommits " Telescope git_commits") + (mkSetBinding mappings.gitBufferCommits " Telescope git_bcommits") + (mkSetBinding mappings.gitBranches " Telescope git_branches") + (mkSetBinding mappings.gitStatus " Telescope git_status") + (mkSetBinding mappings.gitStash " Telescope git_stash") - (mkIf config.vim.lsp.enable (mkMerge [ - (mkSetBinding mappings.lspDocumentSymbols " Telescope lsp_document_symbols") - (mkSetBinding mappings.lspWorkspaceSymbols " Telescope lsp_workspace_symbols") + (mkIf config.vim.lsp.enable (mkMerge [ + (mkSetBinding mappings.lspDocumentSymbols " Telescope lsp_document_symbols") + (mkSetBinding mappings.lspWorkspaceSymbols " Telescope lsp_workspace_symbols") - (mkSetBinding mappings.lspReferences " Telescope lsp_references") - (mkSetBinding mappings.lspImplementations " Telescope lsp_implementations") - (mkSetBinding mappings.lspDefinitions " Telescope lsp_definitions") - (mkSetBinding mappings.lspTypeDefinitions " Telescope lsp_type_definitions") - (mkSetBinding mappings.diagnostics " Telescope diagnostics") - ])) + (mkSetBinding mappings.lspReferences " Telescope lsp_references") + (mkSetBinding mappings.lspImplementations " Telescope lsp_implementations") + (mkSetBinding mappings.lspDefinitions " Telescope lsp_definitions") + (mkSetBinding mappings.lspTypeDefinitions " Telescope lsp_type_definitions") + (mkSetBinding mappings.diagnostics " Telescope diagnostics") + ])) - ( - mkIf config.vim.treesitter.enable - (mkSetBinding mappings.treesitter " Telescope treesitter") - ) + ( + mkIf config.vim.treesitter.enable + (mkSetBinding mappings.treesitter " Telescope treesitter") + ) - ( - mkIf config.vim.projects.project-nvim.enable - (mkSetBinding mappings.findProjects "") - ) - ]; + ( + mkIf config.vim.projects.project-nvim.enable + (mkSetBinding mappings.findProjects " Telescope projects") + ) + ]; - vim.binds.whichKey.register = pushDownDefault { - "f" = "+Telescope"; - "fl" = "Telescope LSP"; - "fm" = "Cellular Automaton"; - "fv" = "Telescope Git"; - "fvc" = "Commits"; + binds.whichKey.register = pushDownDefault { + "f" = "+Telescope"; + "fl" = "Telescope LSP"; + "fm" = "Cellular Automaton"; + "fv" = "Telescope Git"; + "fvc" = "Commits"; + }; + + pluginRC.telescope = entryAnywhere '' + local telescope = require('telescope') + telescope.setup(${toLuaObject cfg.setupOpts}) + + ${ + if config.vim.ui.noice.enable + then "telescope.load_extension('noice')" + else "" + } + + ${ + if config.vim.notify.nvim-notify.enable + then "telescope.load_extension('notify')" + else "" + } + + ${ + if config.vim.projects.project-nvim.enable + then "telescope.load_extension('projects')" + else "" + } + ''; }; - - vim.pluginRC.telescope = entryAnywhere '' - local telescope = require('telescope') - telescope.setup(${toLuaObject cfg.setupOpts}) - - ${ - if config.vim.ui.noice.enable - then "telescope.load_extension('noice')" - else "" - } - - ${ - if config.vim.notify.nvim-notify.enable - then "telescope.load_extension('notify')" - else "" - } - - ${ - if config.vim.projects.project-nvim.enable - then "telescope.load_extension('projects')" - else "" - } - ''; }; } diff --git a/modules/plugins/utility/telescope/telescope.nix b/modules/plugins/utility/telescope/telescope.nix index bebe6c8..031f00d 100644 --- a/modules/plugins/utility/telescope/telescope.nix +++ b/modules/plugins/utility/telescope/telescope.nix @@ -150,13 +150,13 @@ in { options.vim.telescope = { mappings = { - findProjects = mkMappingOption "Find files [Telescope]" "fp"; - + findProjects = mkMappingOption "Find projects [Telescope]" "fp"; findFiles = mkMappingOption "Find files [Telescope]" "ff"; liveGrep = mkMappingOption "Live grep [Telescope]" "fg"; buffers = mkMappingOption "Buffers [Telescope]" "fb"; helpTags = mkMappingOption "Help tags [Telescope]" "fh"; open = mkMappingOption "Open [Telescope]" "ft"; + resume = mkMappingOption "Resume (previous search) [Telescope]" "fr"; gitCommits = mkMappingOption "Git commits [Telescope]" "fvcw"; gitBufferCommits = mkMappingOption "Git buffer commits [Telescope]" "fvcb"; From 99de583e21283d1fd36d731e202f003146e4a4c3 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Fri, 13 Sep 2024 11:59:09 +0300 Subject: [PATCH 05/17] flake: bump mnw Prioritize nvf's instance of neovim over pkgs.neovim --- flake.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/flake.lock b/flake.lock index 8c0a17b..467a778 100644 --- a/flake.lock +++ b/flake.lock @@ -69,11 +69,11 @@ }, "mnw": { "locked": { - "lastModified": 1724456641, - "narHash": "sha256-SMgnviF6ofBPbyV3+rljPGcX0Hn9HBOhgXE10Cyjaic=", + "lastModified": 1726188505, + "narHash": "sha256-3dkxJo6y/aKfwkAg6YnpdiQAoZKgHhWHz7ilGJHCoVU=", "owner": "Gerg-L", "repo": "mnw", - "rev": "c261925dbbf02f523af0e8add844df64fddf0359", + "rev": "ea00b3d2162d85dd085a6ba6d49aa2a186e588e7", "type": "github" }, "original": { From b347757f8a1acec4c53f5811bf8af70de5c06129 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Fri, 13 Sep 2024 12:07:46 +0300 Subject: [PATCH 06/17] flake: bump nixpkgs input Fixes #368 --- flake.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/flake.lock b/flake.lock index 467a778..574e222 100644 --- a/flake.lock +++ b/flake.lock @@ -129,11 +129,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1724395761, - "narHash": "sha256-zRkDV/nbrnp3Y8oCADf5ETl1sDrdmAW6/bBVJ8EbIdQ=", + "lastModified": 1726142289, + "narHash": "sha256-Jks8O42La+nm5AMTSq/PvM5O+fUAhIy0Ce1QYqLkyZ4=", "owner": "nixos", "repo": "nixpkgs", - "rev": "ae815cee91b417be55d43781eb4b73ae1ecc396c", + "rev": "280db3decab4cbeb22a4599bd472229ab74d25e1", "type": "github" }, "original": { 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 07/17] 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 9ed01ad..d7d1e03 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 928bbae..6751229 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 c0e89d6..7d24163 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 15d42fd..1c1f0a0 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 9acc34d..145cb60 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 37589dc..9951591 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 18df8c0..e173688 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 03c85b4..d729688 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 c5f4eb6..79974bd 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 08/17] 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 3bcd324..c58c497 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 09/17] 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 d7d1e03..7c99a97 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 d519199..ac587c0 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 e173688..2faee6c 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; From cb7ff874e2199ba8a4f87cbaa39bdff0d4d28484 Mon Sep 17 00:00:00 2001 From: raf Date: Mon, 16 Sep 2024 13:28:33 +0300 Subject: [PATCH 10/17] languages/python: add basedpyright & python-lsp-server (#372) * languages/python: add basedpyright LSP * languages/python: make basedpyright the default language server * languages/python: add python-lsp-server * docs: update 0.7 release notes --- docs/release-notes/rl-0.7.md | 8 ++++++- modules/plugins/languages/python.nix | 35 ++++++++++++++++++++++++++-- 2 files changed, 40 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index 7c99a97..ce5d8bd 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -95,7 +95,6 @@ configuration formats. plugin's options can now be found under `indentBlankline.setupOpts`, the previous iteration of the module also included out of place/broken options, which have been removed for the time being. These are: - - `listChar` - this was already unused - `fillChar` - this had nothing to do with the plugin, please configure it yourself by adding `vim.opt.listchars:append({ space = '' })` to your @@ -157,6 +156,7 @@ configuration formats. - 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. @@ -164,6 +164,12 @@ configuration formats. [](#opt-vim.ui.breadcrumbs.lualine.winbar.alwaysRender) to be conform to the new format. +- Add [basedpyright](https://github.com/detachhead/basedpyright) as a Python LSP + server and make it default. + +- Add [python-lsp-server](https://github.com/python-lsp/python-lsp-server) as an + additional Python LSP server. + [ppenguin](https://github.com/ppenguin): - Telescope: diff --git a/modules/plugins/languages/python.nix b/modules/plugins/languages/python.nix index a113a6c..61aedce 100644 --- a/modules/plugins/languages/python.nix +++ b/modules/plugins/languages/python.nix @@ -14,7 +14,7 @@ cfg = config.vim.languages.python; - defaultServer = "pyright"; + defaultServer = "basedpyright"; servers = { pyright = { package = pkgs.pyright; @@ -30,6 +30,36 @@ } ''; }; + + basedpyright = { + package = pkgs.basedpyright; + lspConfig = '' + lspconfig.basedpyright.setup{ + capabilities = capabilities; + on_attach = default_on_attach; + cmd = ${ + if isList cfg.lsp.package + then expToLua cfg.lsp.package + else ''{"${cfg.lsp.package}/bin/basedpyright-langserver", "--stdio"}'' + } + } + ''; + }; + + python-lsp-server = { + package = pkgs.python-lsp-server; + lspConfig = '' + lspconfig.pylsp.setup{ + capabilities = capabilities; + on_attach = default_on_attach; + cmd = ${ + if isList cfg.lsp.package + then expToLua cfg.lsp.package + else ''{"${cfg.lsp.package}/bin/pylsp"}'' + } + } + ''; + }; }; defaultFormat = "black"; @@ -61,11 +91,12 @@ black-and-isort = { package = pkgs.writeShellApplication { name = "black"; + runtimeInputs = [pkgs.black pkgs.isort]; text = '' black --quiet - "$@" | isort --profile black - ''; - runtimeInputs = [pkgs.black pkgs.isort]; }; + nullConfig = '' table.insert( ls_sources, From e40d7a2a56382937db96f2755f075429beb6dde1 Mon Sep 17 00:00:00 2001 From: raf Date: Thu, 19 Sep 2024 19:07:25 +0000 Subject: [PATCH 11/17] neovim/basic: add undofile options (#367) `vim.undoFile.enable` and `vim.undoFile.path` can be used to manipulate whether undofile will be enabled, and the location if it is enabled. --- modules/neovim/init/basic.nix | 204 +++++++++++++++++++--------------- 1 file changed, 116 insertions(+), 88 deletions(-) diff --git a/modules/neovim/init/basic.nix b/modules/neovim/init/basic.nix index 07bb70d..2114dcb 100644 --- a/modules/neovim/init/basic.nix +++ b/modules/neovim/init/basic.nix @@ -3,11 +3,13 @@ lib, ... }: let - inherit (lib.options) mkOption literalExpression; + inherit (lib.options) mkOption mkEnableOption literalExpression literalMD; inherit (lib.strings) optionalString; - inherit (lib.types) enum bool str int; + inherit (lib.types) enum bool str int either; + inherit (lib.generators) mkLuaInline; inherit (lib.nvim.dag) entryAfter; inherit (lib.nvim.lua) toLuaObject; + inherit (lib.nvim.types) luaInline; cfg = config.vim; in { @@ -158,112 +160,138 @@ in { default = "sensitive"; description = "Set the case sensitivity of search"; }; + + undoFile = { + enable = mkEnableOption "undofile for persistent undo behaviour"; + path = mkOption { + type = either str luaInline; + default = mkLuaInline "vim.fn.stdpath('state') .. '/undo'"; + defaultText = literalMD '' + ```nix + mkLuaInline "vim.fn.stdpath('state') .. '/undo'" + ``` + ''; + example = literalMD '' + ```nix + mkLuaInline "os.getenv('XDG_DATA_HOME') .. '/nvf/undo'" + ``` + ''; + description = "Path to the directory in which undo history will be stored"; + }; + }; }; - config.vim.luaConfigRC.basic = entryAfter ["globalsScript"] '' - -- Settings that are set for everything - vim.o.encoding = "utf-8" - vim.o.hidden = true - vim.opt.shortmess:append("c") - vim.o.expandtab = true - vim.o.mouse = ${toLuaObject cfg.mouseSupport} - vim.o.tabstop = ${toLuaObject cfg.tabWidth} - vim.o.shiftwidth = ${toLuaObject cfg.tabWidth} - vim.o.softtabstop = ${toLuaObject cfg.tabWidth} - vim.o.cmdheight = ${toLuaObject cfg.cmdHeight} - vim.o.updatetime = ${toLuaObject cfg.updateTime} - vim.o.tm = ${toLuaObject cfg.mapTimeout} - vim.o.cursorlineopt = ${toLuaObject cfg.cursorlineOpt} - vim.o.scrolloff = ${toLuaObject cfg.scrollOffset} - vim.g.mapleader = ${toLuaObject cfg.leaderKey} - vim.g.maplocalleader = ${toLuaObject cfg.leaderKey} + config = { + vim.luaConfigRC.basic = entryAfter ["globalsScript"] '' + -- Settings that are set for everything + vim.o.encoding = "utf-8" + vim.o.hidden = true + vim.opt.shortmess:append("c") + vim.o.expandtab = true + vim.o.mouse = ${toLuaObject cfg.mouseSupport} + vim.o.tabstop = ${toLuaObject cfg.tabWidth} + vim.o.shiftwidth = ${toLuaObject cfg.tabWidth} + vim.o.softtabstop = ${toLuaObject cfg.tabWidth} + vim.o.cmdheight = ${toLuaObject cfg.cmdHeight} + vim.o.updatetime = ${toLuaObject cfg.updateTime} + vim.o.tm = ${toLuaObject cfg.mapTimeout} + vim.o.cursorlineopt = ${toLuaObject cfg.cursorlineOpt} + vim.o.scrolloff = ${toLuaObject cfg.scrollOffset} + vim.g.mapleader = ${toLuaObject cfg.leaderKey} + vim.g.maplocalleader = ${toLuaObject cfg.leaderKey} - ${optionalString cfg.splitBelow '' - vim.o.splitbelow = true - ''} + ${optionalString cfg.undoFile.enable '' + vim.o.undofile = true + vim.o.undodir = ${toLuaObject cfg.undoFile.path} + ''} - ${optionalString cfg.splitRight '' - vim.o.splitright = true - ''} + ${optionalString cfg.splitBelow '' + vim.o.splitbelow = true + ''} - ${optionalString cfg.showSignColumn '' - vim.o.signcolumn = "yes" - ''} + ${optionalString cfg.splitRight '' + vim.o.splitright = true + ''} - ${optionalString cfg.autoIndent '' - vim.o.autoindent = true - ''} + ${optionalString cfg.showSignColumn '' + vim.o.signcolumn = "yes" + ''} - ${optionalString cfg.preventJunkFiles '' - vim.o.swapfile = false - vim.o.backup = false - vim.o.writebackup = false - ''} + ${optionalString cfg.autoIndent '' + vim.o.autoindent = true + ''} - ${optionalString (cfg.bell == "none") '' - vim.o.errorbells = false - vim.o.visualbell = false - ''} + ${optionalString cfg.preventJunkFiles '' + vim.o.swapfile = false + vim.o.backup = false + vim.o.writebackup = false + ''} - ${optionalString (cfg.bell == "on") '' - vim.o.visualbell = false - ''} + ${optionalString (cfg.bell == "none") '' + vim.o.errorbells = false + vim.o.visualbell = false + ''} - ${optionalString (cfg.bell == "visual") '' - vim.o.errorbells = false - ''} + ${optionalString (cfg.bell == "on") '' + vim.o.visualbell = false + ''} - ${optionalString (cfg.lineNumberMode == "relative") '' - vim.o.relativenumber = true - ''} + ${optionalString (cfg.bell == "visual") '' + vim.o.errorbells = false + ''} - ${optionalString (cfg.lineNumberMode == "number") '' - vim.o.number = true - ''} + ${optionalString (cfg.lineNumberMode == "relative") '' + vim.o.relativenumber = true + ''} - ${optionalString (cfg.lineNumberMode == "relNumber") '' - vim.o.number = true - vim.o.relativenumber = true - ''} + ${optionalString (cfg.lineNumberMode == "number") '' + vim.o.number = true + ''} - ${optionalString cfg.useSystemClipboard '' - vim.opt.clipboard:append("unnamedplus") - ''} + ${optionalString (cfg.lineNumberMode == "relNumber") '' + vim.o.number = true + vim.o.relativenumber = true + ''} - ${optionalString cfg.syntaxHighlighting '' - vim.cmd("syntax on") - ''} + ${optionalString cfg.useSystemClipboard '' + vim.opt.clipboard:append("unnamedplus") + ''} - ${optionalString (!cfg.wordWrap) '' - vim.o.wrap = false - ''} + ${optionalString cfg.syntaxHighlighting '' + vim.cmd("syntax on") + ''} - ${optionalString cfg.hideSearchHighlight '' - vim.o.hlsearch = false - vim.o.incsearch = true - ''} + ${optionalString (!cfg.wordWrap) '' + vim.o.wrap = false + ''} - ${optionalString cfg.colourTerm '' - vim.o.termguicolors = true - ''} + ${optionalString cfg.hideSearchHighlight '' + vim.o.hlsearch = false + vim.o.incsearch = true + ''} - ${optionalString (!cfg.enableEditorconfig) '' - vim.g.editorconfig = false - ''} + ${optionalString cfg.colourTerm '' + vim.o.termguicolors = true + ''} - ${optionalString (cfg.searchCase == "ignore") '' - vim.o.smartcase = false - vim.o.ignorecase = true - ''} + ${optionalString (!cfg.enableEditorconfig) '' + vim.g.editorconfig = false + ''} - ${optionalString (cfg.searchCase == "smart") '' - vim.o.smartcase = true - vim.o.ignorecase = true - ''} + ${optionalString (cfg.searchCase == "ignore") '' + vim.o.smartcase = false + vim.o.ignorecase = true + ''} - ${optionalString (cfg.searchCase == "sensitive") '' - vim.o.smartcase = false - vim.o.ignorecase = false - ''} - ''; + ${optionalString (cfg.searchCase == "smart") '' + vim.o.smartcase = true + vim.o.ignorecase = true + ''} + + ${optionalString (cfg.searchCase == "sensitive") '' + vim.o.smartcase = false + vim.o.ignorecase = false + ''} + ''; + }; } From 99ace503adaae13e50ddf3f4d2813fdb43be25ca Mon Sep 17 00:00:00 2001 From: diniamo <55629891+diniamo@users.noreply.github.com> Date: Fri, 20 Sep 2024 17:51:11 +0200 Subject: [PATCH 12/17] fastaction: add module (#376) * plugins/lsp: add code-actions module; add fastaction.nvim * deprecate nvimCodeActionMenu * fastaction-nvim: move range_code_action to visual maps * fastaction: move to vim.ui, remove mappings, enable register_ui_select by default * fastaction: add missing documentation * fastaction: support vim.ui.borders * treewide: clean up nvim-code-action-menu remnants * docs: add missing section ids --------- Co-authored-by: NotAShelf --- configuration.nix | 2 +- docs/release-notes/rl-0.7.md | 16 ++++++++ flake.lock | 34 ++++++++--------- flake.nix | 4 +- flake/modules/home-manager.nix | 1 - flake/modules/nixos.nix | 1 - modules/extra/deprecations.nix | 7 ++++ modules/plugins/lsp/default.nix | 1 - modules/plugins/lsp/lspsaga/config.nix | 2 +- .../lsp/nvim-code-action-menu/config.nix | 38 ------------------- .../nvim-code-action-menu.nix | 20 ---------- modules/plugins/ui/borders/borders.nix | 2 +- modules/plugins/ui/default.nix | 1 + modules/plugins/ui/fastaction/config.nix | 24 ++++++++++++ .../fastaction}/default.nix | 2 +- .../plugins/ui/fastaction/fastaction-nvim.nix | 9 +++++ modules/plugins/visuals/config.nix | 2 - 17 files changed, 80 insertions(+), 86 deletions(-) delete mode 100644 modules/plugins/lsp/nvim-code-action-menu/config.nix delete mode 100644 modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix create mode 100644 modules/plugins/ui/fastaction/config.nix rename modules/plugins/{lsp/nvim-code-action-menu => ui/fastaction}/default.nix (55%) create mode 100644 modules/plugins/ui/fastaction/fastaction-nvim.nix diff --git a/configuration.nix b/configuration.nix index b0c613b..7479012 100644 --- a/configuration.nix +++ b/configuration.nix @@ -17,7 +17,6 @@ isMaximal: { lspkind.enable = false; lightbulb.enable = true; lspsaga.enable = false; - nvimCodeActionMenu.enable = isMaximal; trouble.enable = true; lspSignature.enable = true; lsplines.enable = isMaximal; @@ -204,6 +203,7 @@ isMaximal: { go = ["90" "130"]; }; }; + fastaction.enable = true; }; assistant = { diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index ce5d8bd..cf250e0 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -4,6 +4,8 @@ Release notes for release 0.7 ## Breaking Changes and Migration Guide {#sec-breaking-changes-and-migration-guide-0-7} +### `vim.configRC` removed {#sec-vim-configrc-removed} + In v0.7 we are removing `vim.configRC` in favor of making `vim.luaConfigRC` the top-level DAG, and thereby making the entire configuration Lua based. This change introduces a few breaking changes: @@ -24,6 +26,17 @@ making good use of its extensive Lua API. Additionally, Vimscript is slow and brings unnecessary performance overhead while working with different configuration formats. +### `vim.lsp.nvimCodeActionMenu` removed in favor of `vim.ui.fastaction` {#sec-nvim-code-action-menu-deprecation} + +The nvim-code-action-menu plugin has been archived and broken for a long time, +so it's being replaced with a young, but better alternative called +fastaction.nvim. Simply remove everything set under +`vim.lsp.nvimCodeActionMenu`, and set `vim.ui.fastaction.enable` to `true`. + +Note that we are looking to add more alternatives in the future like +dressing.nvim and actions-preview.nvim, in case fastaction doesn't work for +everyone. + ## Changelog {#sec-release-0.7-changelog} [ItsSorae](https://github.com/ItsSorae): @@ -103,6 +116,9 @@ configuration formats. yourself by adding `vim.opt.listchars:append({ eol = '' })` to your lua configuration +- Replace `vim.lsp.nvimCodeActionMenu` with `vim.ui.fastaction`, see the + breaking changes section above for more details + [Neovim documentation on `vim.cmd`]: https://neovim.io/doc/user/lua.html#vim.cmd() - Make Neovim's configuration file entirely Lua based. This comes with a few diff --git a/flake.lock b/flake.lock index 574e222..a39bf46 100644 --- a/flake.lock +++ b/flake.lock @@ -571,6 +571,22 @@ "type": "github" } }, + "plugin-fastaction-nvim": { + "flake": false, + "locked": { + "lastModified": 1721396662, + "narHash": "sha256-L7na78FsE+QHlEwxMpiwQcoOPhtmrknvdTZfzUoDANI=", + "owner": "Chaitanyabsprip", + "repo": "fastaction.nvim", + "rev": "2384dea7ba81d2709d0bee0e4bc7a8831ff13a9d", + "type": "github" + }, + "original": { + "owner": "Chaitanyabsprip", + "repo": "fastaction.nvim", + "type": "github" + } + }, "plugin-fidget-nvim": { "flake": false, "locked": { @@ -1052,22 +1068,6 @@ "type": "github" } }, - "plugin-nvim-code-action-menu": { - "flake": false, - "locked": { - "lastModified": 1702287297, - "narHash": "sha256-pY+aP9iBuJhvDZzVEsOHZmnfaq3vUP7TfKEEQrj+Mo8=", - "owner": "weilbith", - "repo": "nvim-code-action-menu", - "rev": "8c7672a4b04d3cc4edd2c484d05b660a9cb34a1b", - "type": "github" - }, - "original": { - "owner": "weilbith", - "repo": "nvim-code-action-menu", - "type": "github" - } - }, "plugin-nvim-colorizer-lua": { "flake": false, "locked": { @@ -1855,6 +1855,7 @@ "plugin-dracula": "plugin-dracula", "plugin-dressing-nvim": "plugin-dressing-nvim", "plugin-elixir-tools": "plugin-elixir-tools", + "plugin-fastaction-nvim": "plugin-fastaction-nvim", "plugin-fidget-nvim": "plugin-fidget-nvim", "plugin-flutter-tools": "plugin-flutter-tools", "plugin-gesture-nvim": "plugin-gesture-nvim", @@ -1885,7 +1886,6 @@ "plugin-nvim-autopairs": "plugin-nvim-autopairs", "plugin-nvim-bufferline-lua": "plugin-nvim-bufferline-lua", "plugin-nvim-cmp": "plugin-nvim-cmp", - "plugin-nvim-code-action-menu": "plugin-nvim-code-action-menu", "plugin-nvim-colorizer-lua": "plugin-nvim-colorizer-lua", "plugin-nvim-cursorline": "plugin-nvim-cursorline", "plugin-nvim-dap": "plugin-nvim-dap", diff --git a/flake.nix b/flake.nix index c00e9b8..0684972 100644 --- a/flake.nix +++ b/flake.nix @@ -133,8 +133,8 @@ flake = false; }; - plugin-nvim-code-action-menu = { - url = "github:weilbith/nvim-code-action-menu"; + plugin-fastaction-nvim = { + url = "github:Chaitanyabsprip/fastaction.nvim"; flake = false; }; diff --git a/flake/modules/home-manager.nix b/flake/modules/home-manager.nix index 66a3552..77b8448 100644 --- a/flake/modules/home-manager.nix +++ b/flake/modules/home-manager.nix @@ -67,7 +67,6 @@ in { formatOnSave = true; lightbulb.enable = true; lspsaga.enable = false; - nvimCodeActionMenu.enable = true; trouble.enable = true; lspSignature.enable = true; rust.enable = false; diff --git a/flake/modules/nixos.nix b/flake/modules/nixos.nix index e1e81f1..022b3d9 100644 --- a/flake/modules/nixos.nix +++ b/flake/modules/nixos.nix @@ -67,7 +67,6 @@ in { formatOnSave = true; lightbulb.enable = true; lspsaga.enable = false; - nvimCodeActionMenu.enable = true; trouble.enable = true; lspSignature.enable = true; rust.enable = false; diff --git a/modules/extra/deprecations.nix b/modules/extra/deprecations.nix index cb06380..388913a 100644 --- a/modules/extra/deprecations.nix +++ b/modules/extra/deprecations.nix @@ -7,5 +7,12 @@ in { Tidalcycles language support has been removed as of 2024-06-06 as it was long unmaintained. If you depended on this functionality, please open an issue. '') + + # 2024-07-20 + (mkRemovedOptionModule ["vim" "lsp" "nvimCodeActionMenu"] '' + nvimCodeActionMenu has been deprecated and removed upstream. As of 0.7, fastaction will be + available under `vim.ui.fastaction` as a replacement. Simply remove everything under + `vim.lsp.nvimCodeActionMenu`, and set `vim.ui.fastaction.enable` to `true`. + '') ]; } diff --git a/modules/plugins/lsp/default.nix b/modules/plugins/lsp/default.nix index f8408aa..a5d5163 100644 --- a/modules/plugins/lsp/default.nix +++ b/modules/plugins/lsp/default.nix @@ -10,7 +10,6 @@ # lsp plugins ./lspsaga - ./nvim-code-action-menu ./trouble ./lsp-signature ./lightbulb diff --git a/modules/plugins/lsp/lspsaga/config.nix b/modules/plugins/lsp/lspsaga/config.nix index 71c9025..6605087 100644 --- a/modules/plugins/lsp/lspsaga/config.nix +++ b/modules/plugins/lsp/lspsaga/config.nix @@ -36,7 +36,7 @@ in { (mkSetLuaBinding mappings.nextDiagnostic "require('lspsaga.diagnostic').navigate('next')") (mkSetLuaBinding mappings.previousDiagnostic "require('lspsaga.diagnostic').navigate('prev')") - (mkIf (!cfg.nvimCodeActionMenu.enable) (mkSetLuaBinding mappings.codeAction "require('lspsaga.codeaction').code_action")) + (mkSetLuaBinding mappings.codeAction "require('lspsaga.codeaction').code_action") (mkIf (!cfg.lspSignature.enable) (mkSetLuaBinding mappings.signatureHelp "require('lspsaga.signaturehelp').signature_help")) ]; }; diff --git a/modules/plugins/lsp/nvim-code-action-menu/config.nix b/modules/plugins/lsp/nvim-code-action-menu/config.nix deleted file mode 100644 index 145cb60..0000000 --- a/modules/plugins/lsp/nvim-code-action-menu/config.nix +++ /dev/null @@ -1,38 +0,0 @@ -{ - config, - lib, - ... -}: let - 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; - - self = import ./nvim-code-action-menu.nix {inherit lib;}; - mappingDefinitions = self.options.vim.lsp.nvimCodeActionMenu.mappings; - mappings = addDescriptionsToMappings cfg.nvimCodeActionMenu.mappings mappingDefinitions; -in { - config = mkIf (cfg.enable && cfg.nvimCodeActionMenu.enable) { - vim = { - startPlugins = ["nvim-code-action-menu"]; - - maps.normal = mkSetBinding mappings.open ":CodeActionMenu"; - - binds.whichKey.register = pushDownDefault { - "c" = "+CodeAction"; - }; - - pluginRC.code-action-menu = entryAnywhere '' - -- border configuration - 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"} - ${lib.optionalString cfg.nvimCodeActionMenu.show.diff "vim.g.code_action_menu_show_diff = true"} - ${lib.optionalString cfg.nvimCodeActionMenu.show.actionKind "vim.g.code_action_menu_show_action_kind = true"} - ''; - }; - }; -} diff --git a/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix b/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix deleted file mode 100644 index c303f7c..0000000 --- a/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix +++ /dev/null @@ -1,20 +0,0 @@ -{lib, ...}: let - inherit (lib.options) mkEnableOption; - inherit (lib.nvim.binds) mkMappingOption; -in { - options.vim.lsp = { - nvimCodeActionMenu = { - enable = mkEnableOption "nvim code action menu"; - - show = { - details = mkEnableOption "Show details" // {default = true;}; - diff = mkEnableOption "Show diff" // {default = true;}; - actionKind = mkEnableOption "Show action kind" // {default = true;}; - }; - - mappings = { - open = mkMappingOption "Open code action menu [nvim-code-action-menu]" "ca"; - }; - }; - }; -} diff --git a/modules/plugins/ui/borders/borders.nix b/modules/plugins/ui/borders/borders.nix index 9951591..cf19d38 100644 --- a/modules/plugins/ui/borders/borders.nix +++ b/modules/plugins/ui/borders/borders.nix @@ -43,7 +43,7 @@ in { lspsaga = mkPluginStyleOption "lspsaga"; nvim-cmp = mkPluginStyleOption "nvim-cmp"; lsp-signature = mkPluginStyleOption "lsp-signature"; - code-action-menu = mkPluginStyleOption "code-actions-menu"; + fastaction = mkPluginStyleOption "fastaction"; }; }; } diff --git a/modules/plugins/ui/default.nix b/modules/plugins/ui/default.nix index 262cdbb..3407660 100644 --- a/modules/plugins/ui/default.nix +++ b/modules/plugins/ui/default.nix @@ -8,5 +8,6 @@ ./illuminate ./breadcrumbs ./borders + ./fastaction ]; } diff --git a/modules/plugins/ui/fastaction/config.nix b/modules/plugins/ui/fastaction/config.nix new file mode 100644 index 0000000..79c3e25 --- /dev/null +++ b/modules/plugins/ui/fastaction/config.nix @@ -0,0 +1,24 @@ +{ + config, + lib, + ... +}: let + inherit (lib.modules) mkIf mkDefault; + inherit (lib.nvim.dag) entryAnywhere; + inherit (lib.nvim.lua) toLuaObject; + + cfg = config.vim.ui.fastaction; + borderCfg = config.vim.ui.borders.plugins.fastaction; +in { + config = mkIf cfg.enable { + vim = { + ui.fastaction.setupOpts = { + register_ui_select = mkDefault true; + popup.border = mkIf borderCfg.enable borderCfg.style; + }; + + startPlugins = ["fastaction-nvim"]; + pluginRC.fastaction = entryAnywhere "require('fastaction').setup(${toLuaObject cfg.setupOpts})"; + }; + }; +} diff --git a/modules/plugins/lsp/nvim-code-action-menu/default.nix b/modules/plugins/ui/fastaction/default.nix similarity index 55% rename from modules/plugins/lsp/nvim-code-action-menu/default.nix rename to modules/plugins/ui/fastaction/default.nix index f94dd22..ef5c2bc 100644 --- a/modules/plugins/lsp/nvim-code-action-menu/default.nix +++ b/modules/plugins/ui/fastaction/default.nix @@ -1,6 +1,6 @@ { imports = [ - ./nvim-code-action-menu.nix + ./fastaction-nvim.nix ./config.nix ]; } diff --git a/modules/plugins/ui/fastaction/fastaction-nvim.nix b/modules/plugins/ui/fastaction/fastaction-nvim.nix new file mode 100644 index 0000000..52ac59a --- /dev/null +++ b/modules/plugins/ui/fastaction/fastaction-nvim.nix @@ -0,0 +1,9 @@ +{lib, ...}: let + inherit (lib.options) mkEnableOption; + inherit (lib.nvim.types) mkPluginSetupOption; +in { + options.vim.ui.fastaction = { + enable = mkEnableOption "overriding vim.ui.select with fastaction.nvim"; + setupOpts = mkPluginSetupOption "fastaction" {}; + }; +} diff --git a/modules/plugins/visuals/config.nix b/modules/plugins/visuals/config.nix index 1dfc661..1457ff3 100644 --- a/modules/plugins/visuals/config.nix +++ b/modules/plugins/visuals/config.nix @@ -45,8 +45,6 @@ in { 'noice', 'NvimTree', 'alpha', - 'code-action-menu-menu', - 'code-action-menu-warning-message', 'notify', 'Navbuddy' }, From 57be605ed411c1de4a9fa0b1951aa31f56fbde18 Mon Sep 17 00:00:00 2001 From: Gerg-L <88247690+Gerg-L@users.noreply.github.com> Date: Sun, 22 Sep 2024 19:52:10 +0000 Subject: [PATCH 13/17] lib.neovimConfiguration: deprecated extraModules and configuration (#377) * lib.neovimConfiguration: deprecated extraModules and configuration * docs: various fixes --- .github/workflows/manual.yml | 37 +++-- docs/default.nix | 268 ++++++++++++++++------------------- docs/html-open-tool.nix | 23 ++- docs/manual.nix | 35 ++--- flake/packages.nix | 1 + lib/configuration.nix | 18 --- lib/default.nix | 2 +- modules/default.nix | 27 +++- modules/modules.nix | 129 ++++++++--------- 9 files changed, 257 insertions(+), 283 deletions(-) delete mode 100644 lib/configuration.nix diff --git a/.github/workflows/manual.yml b/.github/workflows/manual.yml index 34c11ff..23381e4 100644 --- a/.github/workflows/manual.yml +++ b/.github/workflows/manual.yml @@ -1,4 +1,5 @@ name: "Build and deploy documentation" + on: workflow_dispatch: push: @@ -7,6 +8,7 @@ on: paths: # build the manuals only when docs directory is updated - docs/** + - modules/** # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: @@ -20,23 +22,34 @@ concurrency: cancel-in-progress: true jobs: + check_date: + runs-on: ubuntu-latest + name: Check latest commit + outputs: + should_run: ${{ steps.should_run.outputs.should_run }} + steps: + - uses: actions/checkout@v4.1.7 + - name: print latest_commit + run: echo ${{ github.sha }} + + - id: should_run + continue-on-error: true + name: check latest commit is less than a day + if: ${{ github.event_name == 'schedule' }} + run: test -z $(git rev-list --after="24 hours" ${{ github.sha }}) && echo "::set-output name=should_run::false" + publish: + needs: check_date + if: ${{ needs.check_date.outputs.should_run != 'false' }} runs-on: ubuntu-latest steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Install Nix - uses: DeterminateSystems/nix-installer-action@main + - uses: actions/checkout@v4.1.7 + - uses: DeterminateSystems/nix-installer-action@main - uses: DeterminateSystems/magic-nix-cache-action@main - - - name: Build - run: | - nix build '.#docs' + - run: | + nix build .#docs cp -r result/share/doc/nvf public - - - name: Deploy - uses: peaceiris/actions-gh-pages@v4 + - uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public diff --git a/docs/default.nix b/docs/default.nix index b48daf5..4a9d2f8 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -2,131 +2,135 @@ inputs, pkgs, lib, - manpageUrls ? pkgs.path + "/doc/manpage-urls.json", - ... }: let - inherit (lib.modules) mkForce evalModules; - inherit (lib.strings) hasPrefix removePrefix; - inherit (lib.attrsets) isAttrs mapAttrs optionalAttrs recursiveUpdate isDerivation; - inherit (builtins) fromJSON readFile; + inherit ((lib.importJSON ../release.json)) release; - # release data - release-config = fromJSON (readFile ../release.json); - revision = release-config.release; - - # From home-manager: - # - # Recursively replace each derivation in the given attribute set - # with the same derivation but with the `outPath` attribute set to - # the string `"\${pkgs.attribute.path}"`. This allows the - # documentation to refer to derivations through their values without - # establishing an actual dependency on the derivation output. - # - # This is not perfect, but it seems to cover a vast majority of use - # cases. - # - # Caveat: even if the package is reached by a different means, the - # path above will be shown and not e.g. - # `${config.services.foo.package}`. - scrubDerivations = prefixPath: attrs: let - scrubDerivation = name: value: let - pkgAttrName = prefixPath + "." + name; - in - if isAttrs value - then - scrubDerivations pkgAttrName value - // optionalAttrs (isDerivation value) { - outPath = "\${${pkgAttrName}}"; - } - else value; - in - mapAttrs scrubDerivation attrs; - - # Make sure the used package is scrubbed to avoid actually - # instantiating derivations. - scrubbedPkgsModule = { - imports = [ - { - _module.args = { - pkgs = mkForce (scrubDerivations "pkgs" pkgs); - pkgs_i686 = mkForce {}; - }; - } - ]; - }; - - # Specify the path to the module entrypoint - nvimPath = toString ./..; - buildOptionsDocs = args @ { - modules, - includeModuleSystemOptions ? true, - warningsAreErrors ? true, - ... - }: let - inherit ((evalModules {inherit modules;})) options; - - # Declaration of the Github site URL. - # Takes a user, repo, and subpath, and returns a declaration site - # as a string. - githubDeclaration = user: repo: subpath: let - urlRef = "github.com"; - branch = "main"; - in { - url = "https://${urlRef}/${user}/${repo}/blob/${branch}/${subpath}"; - name = "<${repo}/${subpath}>"; - }; - in - pkgs.buildPackages.nixosOptionsDoc ({ - inherit warningsAreErrors; - - options = - if includeModuleSystemOptions - then options - else builtins.removeAttrs options ["_module"]; - - transformOptions = opt: - recursiveUpdate opt { - # Clean up declaration sites to not refer to the nvf - # source tree. - declarations = map (decl: - if hasPrefix nvimPath (toString decl) - then - githubDeclaration "notashelf" "nvf" - (removePrefix "/" (removePrefix nvimPath (toString decl))) - else if decl == "lib/modules.nix" - then - # TODO: handle this in a better way (may require upstream - # changes to nixpkgs) - githubDeclaration "NixOS" "nixpkgs" decl - else decl) - opt.declarations; - }; - } - // builtins.removeAttrs args ["modules" "includeModuleSystemOptions"]); - - nvimModuleDocs = buildOptionsDocs { + nvimModuleDocs = pkgs.nixosOptionsDoc { variablelistId = "nvf-options"; + warningsAreErrors = true; - modules = - import ../modules/modules.nix { - inherit lib pkgs; - check = false; - } - ++ [scrubbedPkgsModule]; + inherit + ( + (lib.evalModules { + modules = + import ../modules/modules.nix { + inherit lib pkgs; + } + ++ [ + ( + let + # From nixpkgs: + # + # Recursively replace each derivation in the given attribute set + # with the same derivation but with the `outPath` attribute set to + # the string `"\${pkgs.attribute.path}"`. This allows the + # documentation to refer to derivations through their values without + # establishing an actual dependency on the derivation output. + # + # This is not perfect, but it seems to cover a vast majority of use + # cases. + # + # Caveat: even if the package is reached by a different means, the + # path above will be shown and not e.g. + # `${config.services.foo.package}`. + scrubDerivations = namePrefix: pkgSet: + builtins.mapAttrs ( + name: value: let + wholeName = "${namePrefix}.${name}"; + in + if builtins.isAttrs value + then + scrubDerivations wholeName value + // lib.optionalAttrs (lib.isDerivation value) { + inherit (value) drvPath; + outPath = "\${${wholeName}}"; + } + else value + ) + pkgSet; + in { + _module = { + check = false; + args.pkgs = lib.mkForce (scrubDerivations "pkgs" pkgs); + }; + } + ) + ]; + }) + ) + options + ; + + transformOptions = opt: + opt + // { + declarations = + map ( + decl: + if lib.hasPrefix (toString ../.) (toString decl) + then + lib.pipe decl [ + toString + (lib.removePrefix (toString ../.)) + (lib.removePrefix "/") + (x: { + url = "https://github.com/NotAShelf/nvf/blob/main/${decl}"; + name = ""; + }) + ] + else if decl == "lib/modules.nix" + then { + url = "https://github.com/NixOS/nixpkgs/blob/master/${decl}"; + name = ""; + } + else decl + ) + opt.declarations; + }; }; + # Generate the HTML manual pages + html = pkgs.callPackage ./manual.nix { + inherit release; + inherit (nvimModuleDocs) optionsJSON; + }; +in { + inherit (inputs) nmd; + + # TODO: Use `hmOptionsDocs.optionsJSON` directly once upstream + # `nixosOptionsDoc` is more customizable. + options.json = + pkgs.runCommand "options.json" + { + meta.description = "List of nvf options in JSON format"; + } + '' + mkdir -p $out/{share/doc,nix-support} + cp -a ${nvimModuleDocs.optionsJSON}/share/doc/nixos $out/share/doc/nvf + substitute \ + ${nvimModuleDocs.optionsJSON}/nix-support/hydra-build-products \ + $out/nix-support/hydra-build-products \ + --replace \ + '${nvimModuleDocs.optionsJSON}/share/doc/nixos' \ + "$out/share/doc/nvf" + ''; + # Generate the `man home-configuration.nix` package - nvf-configuration-manual = - pkgs.runCommand "nvf-reference-manpage" { - nativeBuildInputs = [pkgs.buildPackages.installShellFiles pkgs.nixos-render-docs]; + manPages = + pkgs.runCommand "nvf-reference-manpage" + { + nativeBuildInputs = [ + pkgs.buildPackages.installShellFiles + pkgs.nixos-render-docs + ]; allowedReferences = ["out"]; - } '' + } + '' # Generate manpages. - mkdir -p $out/share/man/man5 - mkdir -p $out/share/man/man1 + mkdir -p $out/share/man/{man5,man1} nixos-render-docs -j $NIX_BUILD_CORES options manpage \ - --revision ${revision} \ + --revision ${release} \ --header ${./man/header.5} \ --footer ${./man/footer.5} \ ${nvimModuleDocs.optionsJSON}/share/doc/nixos/options.json \ @@ -135,38 +139,8 @@ cp ${./man/nvf.1} $out/share/man/man1/nvf.1 ''; - # Generate the HTML manual pages - nvf-manual = pkgs.callPackage ./manual.nix { - inherit revision manpageUrls; - outputPath = "share/doc/nvf"; - options = { - nvf = nvimModuleDocs.optionsJSON; - }; + manual = { + inherit html; + htmlOpenTool = pkgs.callPackage ./html-open-tool.nix {inherit html;}; }; - - html = nvf-manual; - htmlOpenTool = pkgs.callPackage ./html-open-tool.nix {} {inherit html;}; -in { - inherit (inputs) nmd; - - options = { - # TODO: Use `hmOptionsDocs.optionsJSON` directly once upstream - # `nixosOptionsDoc` is more customizable. - json = - pkgs.runCommand "options.json" { - meta.description = "List of nvf options in JSON format"; - } '' - mkdir -p $out/{share/doc,nix-support} - cp -a ${nvimModuleDocs.optionsJSON}/share/doc/nixos $out/share/doc/nvf - substitute \ - ${nvimModuleDocs.optionsJSON}/nix-support/hydra-build-products \ - $out/nix-support/hydra-build-products \ - --replace \ - '${nvimModuleDocs.optionsJSON}/share/doc/nixos' \ - "$out/share/doc/nvf" - ''; - }; - - manPages = nvf-configuration-manual; - manual = {inherit html htmlOpenTool;}; } diff --git a/docs/html-open-tool.nix b/docs/html-open-tool.nix index 756feba..d430d24 100644 --- a/docs/html-open-tool.nix +++ b/docs/html-open-tool.nix @@ -2,13 +2,9 @@ writeShellScriptBin, makeDesktopItem, symlinkJoin, -}: { html, - pathName ? "nvf", - projectName ? pathName, - name ? "${pathName}-help", }: let - helpScript = writeShellScriptBin name '' + helpScript = writeShellScriptBin "nvf-help" '' set -euo pipefail if [[ ! -v BROWSER || -z $BROWSER ]]; then @@ -24,20 +20,23 @@ echo "$0: unable to start a web browser; please set \$BROWSER" exit 1 else - exec "$BROWSER" "${html}/share/doc/${pathName}/index.xhtml" + exec "$BROWSER" "${html}/share/doc/nvf/index.xhtml" fi ''; desktopItem = makeDesktopItem { - name = "${pathName}-manual"; - desktopName = "${projectName} Manual"; - genericName = "View ${projectName} documentation in a web browser"; + name = "nvf-manual"; + desktopName = "nvf Manual"; + genericName = "View nvf documentation in a web browser"; icon = "nix-snowflake"; - exec = "${helpScript}/bin/${name}"; + exec = "${helpScript}/bin/nvf-help"; categories = ["System"]; }; in symlinkJoin { - inherit name; - paths = [helpScript desktopItem]; + name = "nvf-help"; + paths = [ + helpScript + desktopItem + ]; } diff --git a/docs/manual.nix b/docs/manual.nix index 14e8ae2..f5b23d0 100644 --- a/docs/manual.nix +++ b/docs/manual.nix @@ -4,11 +4,10 @@ # build inputs nixos-render-docs, documentation-highlighter, + path, # nrd configuration - manpageUrls, - revision, - options, - outputPath ? "share/doc/nvf", + release, + optionsJSON, }: stdenvNoCC.mkDerivation { name = "nvf-manual"; @@ -20,9 +19,11 @@ stdenvNoCC.mkDerivation { nativeBuildInputs = [nixos-render-docs]; buildPhase = '' - mkdir -p out/{highlightjs,media} + dest="$out/share/doc/nvf" + mkdir -p "$(dirname "$dest")" + mkdir -p $dest/{highlightjs,media} - cp -vt out/highlightjs \ + cp -vt $dest/highlightjs \ ${documentation-highlighter}/highlight.pack.js \ ${documentation-highlighter}/LICENSE \ ${documentation-highlighter}/mono-blue.css \ @@ -31,38 +32,32 @@ stdenvNoCC.mkDerivation { substituteInPlace ./options.md \ --subst-var-by \ OPTIONS_JSON \ - ${options.nvf}/share/doc/nixos/options.json + ${optionsJSON}/share/doc/nixos/options.json substituteInPlace ./manual.md \ --subst-var-by \ NVF_VERSION \ - ${revision} + ${release} # copy stylesheet - cp ${./static/style.css} out/style.css + cp ${./static/style.css} "$dest/style.css" # copy release notes cp -vr ${./release-notes} release-notes # generate manual from nixos-render-docs manual html \ - --manpage-urls ${manpageUrls} \ - --revision ${lib.trivial.revisionWithDefault revision} \ + --manpage-urls ${path + "/doc/manpage-urls.json"} \ + --revision ${lib.trivial.revisionWithDefault release} \ --stylesheet style.css \ --script highlightjs/highlight.pack.js \ --script highlightjs/loader.js \ --toc-depth 2 \ --section-toc-depth 1 \ manual.md \ - out/index.xhtml - ''; + "$dest/index.xhtml" - installPhase = '' - dest="$out/${outputPath}" - mkdir -p "$(dirname "$dest")" - mv out "$dest" - - mkdir -p $out/nix-support/ - echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products + mkdir -p $out/nix-support/ + echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products ''; } diff --git a/flake/packages.nix b/flake/packages.nix index f8ad3c2..84514a2 100644 --- a/flake/packages.nix +++ b/flake/packages.nix @@ -8,6 +8,7 @@ docs = import ../docs {inherit pkgs inputs lib;}; in { packages = { + inherit (docs.manual) htmlOpenTool; # Documentation docs = docs.manual.html; docs-html = docs.manual.html; diff --git a/lib/configuration.nix b/lib/configuration.nix deleted file mode 100644 index 1f3c59a..0000000 --- a/lib/configuration.nix +++ /dev/null @@ -1,18 +0,0 @@ -{ - inputs, - lib, -}: let - modulesWithInputs = import ../modules inputs; -in - { - modules ? [], - pkgs, - check ? true, - extraSpecialArgs ? {}, - extraModules ? [], - ... - }: - modulesWithInputs { - inherit pkgs lib check extraSpecialArgs extraModules; - configuration.imports = modules; - } diff --git a/lib/default.nix b/lib/default.nix index 2e4b7f8..a418cff 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -11,5 +11,5 @@ languages = import ./languages.nix {inherit lib;}; lists = import ./lists.nix {inherit lib;}; lua = import ./lua.nix {inherit lib;}; - neovimConfiguration = import ./configuration.nix {inherit inputs lib;}; + neovimConfiguration = import ../modules {inherit inputs lib;}; } diff --git a/modules/default.nix b/modules/default.nix index 1ae3b03..6a95080 100644 --- a/modules/default.nix +++ b/modules/default.nix @@ -1,10 +1,13 @@ -inputs: { - configuration, - pkgs, +{ + inputs, lib, - check ? true, +}: { + pkgs, extraSpecialArgs ? {}, + modules ? [], + # deprecated extraModules ? [], + configuration ? {}, }: let inherit (pkgs) vimPlugins; inherit (lib.strings) isString toString; @@ -13,13 +16,25 @@ inputs: { # import modules.nix with `check`, `pkgs` and `lib` as arguments # check can be disabled while calling this file is called # to avoid checking in all modules - nvimModules = import ./modules.nix {inherit pkgs check lib;}; + nvimModules = import ./modules.nix {inherit pkgs lib;}; # evaluate the extended library with the modules # optionally with any additional modules passed by the user module = lib.evalModules { specialArgs = extraSpecialArgs // {modulesPath = toString ./.;}; - modules = concatLists [[configuration] nvimModules extraModules]; + modules = concatLists [ + nvimModules + modules + (lib.optional (configuration != {}) (lib.warn '' + nvf: passing 'configuration' to lib.neovimConfiguration is deprecated. + '' + configuration)) + + (lib.optionals (extraModules != []) (lib.warn '' + nvf: passing 'extraModules' to lib.neovimConfiguration is deprecated, use 'modules' instead. + '' + extraModules)) + ]; }; # alias to the internal configuration diff --git a/modules/modules.nix b/modules/modules.nix index a00cea6..195652d 100644 --- a/modules/modules.nix +++ b/modules/modules.nix @@ -1,77 +1,72 @@ { - check ? true, pkgs, lib, }: let inherit (lib.modules) mkDefault; inherit (lib.lists) concatLists; + allModules = let + # The core neovim modules. + # Contains configuration for core neovim features + # such as spellchecking, mappings, and the init script (init.vim). + neovim = map (p: "${./neovim}/${p}") [ + "init" + "mappings" + ]; - # The core neovim modules. - # Contains configuration for core neovim features - # such as spellchecking, mappings, and the init script (init.vim). - neovim = map (p: ./neovim + "/${p}") [ - "init" - "mappings" - ]; + # Individual plugin modules, separated by the type of plugin. + # While adding a new type, you must make sure your type is + # included in the list below. + plugins = map (p: "${./plugins}/${p}") [ + "assistant" + "autopairs" + "comments" + "completion" + "dashboard" + "debugger" + "filetree" + "git" + "languages" + "lsp" + "minimap" + "notes" + "projects" + "rich-presence" + "session" + "snippets" + # "spellcheck" # FIXME: see neovim/init/spellcheck.nix + "statusline" + "tabline" + "terminal" + "theme" + "treesitter" + "ui" + "utility" + "visuals" + ]; - # Individual plugin modules, separated by the type of plugin. - # While adding a new type, you must make sure your type is - # included in the list below. - plugins = map (p: ./plugins + "/${p}") [ - "assistant" - "autopairs" - "comments" - "completion" - "dashboard" - "debugger" - "filetree" - "git" - "languages" - "lsp" - "minimap" - "notes" - "projects" - "rich-presence" - "session" - "snippets" - # "spellcheck" # FIXME: see neovim/init/spellcheck.nix - "statusline" - "tabline" - "terminal" - "theme" - "treesitter" - "ui" - "utility" - "visuals" - ]; + # The neovim wrapper, used to build a wrapped neovim package + # using the configuration passed in `neovim` and `plugins` modules. + wrapper = map (p: "${./wrapper}/${p}") [ + "build" + "rc" + "warnings" + ]; - # The neovim wrapper, used to build a wrapped neovim package - # using the configuration passed in `neovim` and `plugins` modules. - wrapper = map (p: ./wrapper + "/${p}") [ - "build" - "rc" - "warnings" - ]; - - # Extra modules, such as deprecation warnings - # or renames in one place. - extra = map (p: ./extra + "/${p}") [ - "deprecations.nix" - ]; - - allModules = concatLists [neovim plugins wrapper extra]; - - pkgsModule = {config, ...}: { - config = { - _module = { - inherit check; - args = { - baseModules = allModules; - pkgsPath = mkDefault pkgs.path; - pkgs = mkDefault pkgs; - }; - }; - }; - }; + # Extra modules, such as deprecation warnings + # or renames in one place. + extra = map (p: "${./extra}/${p}") [ + "deprecations.nix" + ]; + in + concatLists [neovim plugins wrapper extra]; in - allModules ++ [pkgsModule] + allModules + ++ [ + { + _module.args = { + baseModules = allModules; + pkgsPath = mkDefault pkgs.path; + pkgs = mkDefault pkgs; + }; + } + ] From a85ac83182fe4507cc2ed1a4ff408c4022a61bce Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 24 Sep 2024 06:05:47 +0300 Subject: [PATCH 14/17] flake: minor cleanup - Get rid of Zig input (nixpkgs one is alright.) - Minor typo fixes --- flake.lock | 70 +----------------------------------------------------- flake.nix | 7 ++---- 2 files changed, 3 insertions(+), 74 deletions(-) diff --git a/flake.lock b/flake.lock index a39bf46..780614b 100644 --- a/flake.lock +++ b/flake.lock @@ -1,21 +1,5 @@ { "nodes": { - "flake-compat": { - "flake": false, - "locked": { - "lastModified": 1673956053, - "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=", - "owner": "edolstra", - "repo": "flake-compat", - "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9", - "type": "github" - }, - "original": { - "owner": "edolstra", - "repo": "flake-compat", - "type": "github" - } - }, "flake-parts": { "inputs": { "nixpkgs-lib": "nixpkgs-lib" @@ -52,21 +36,6 @@ "type": "github" } }, - "flake-utils_2": { - "locked": { - "lastModified": 1659877975, - "narHash": "sha256-zllb8aq3YO3h8B/U0/J1WBgAL8EX5yWf5pMj3G0NAmc=", - "owner": "numtide", - "repo": "flake-utils", - "rev": "c0e246b9b83f637f4681389ecabcb2681b4f3af0", - "type": "github" - }, - "original": { - "owner": "numtide", - "repo": "flake-utils", - "type": "github" - } - }, "mnw": { "locked": { "lastModified": 1726188505, @@ -171,22 +140,6 @@ "type": "github" } }, - "nixpkgs_3": { - "locked": { - "lastModified": 1702350026, - "narHash": "sha256-A+GNZFZdfl4JdDphYKBJ5Ef1HOiFsP18vQe9mqjmUis=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "9463103069725474698139ab10f17a9d125da859", - "type": "github" - }, - "original": { - "owner": "NixOS", - "ref": "nixos-23.05", - "repo": "nixpkgs", - "type": "github" - } - }, "nmd": { "flake": false, "locked": { @@ -1933,8 +1886,7 @@ "plugin-vim-vsnip": "plugin-vim-vsnip", "plugin-which-key": "plugin-which-key", "rnix-lsp": "rnix-lsp", - "systems": "systems_2", - "zig": "zig" + "systems": "systems_2" } }, "rust-overlay": { @@ -2006,26 +1958,6 @@ "repo": "flake-utils", "type": "github" } - }, - "zig": { - "inputs": { - "flake-compat": "flake-compat", - "flake-utils": "flake-utils_2", - "nixpkgs": "nixpkgs_3" - }, - "locked": { - "lastModified": 1716725305, - "narHash": "sha256-LIz08gALt2wlutGXAEhNroEoIuPV5ePQB8LI4WzXcy8=", - "owner": "mitchellh", - "repo": "zig-overlay", - "rev": "93b02a697561ecd438cfa5779727b5a1c300cb4c", - "type": "github" - }, - "original": { - "owner": "mitchellh", - "repo": "zig-overlay", - "type": "github" - } } }, "root": "root", diff --git a/flake.nix b/flake.nix index 0684972..c4996fc 100644 --- a/flake.nix +++ b/flake.nix @@ -90,10 +90,7 @@ flake = false; }; - # TODO: get zig from the zig overlay instead of nixpkgs - zig.url = "github:mitchellh/zig-overlay"; - - # Langauge server (use master instead of nixpkgs) + # Language servers (use master instead of nixpkgs) rnix-lsp.url = "github:nix-community/rnix-lsp"; nil = { url = "github:oxalica/nil"; @@ -159,7 +156,7 @@ flake = false; }; - # language support + # Language support plugin-sqls-nvim = { url = "github:nanotee/sqls.nvim"; flake = false; From 27b3524508075bcede63de961b974e04734d5974 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 24 Sep 2024 06:07:44 +0300 Subject: [PATCH 15/17] flake: bump nixpkgs --- flake.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/flake.lock b/flake.lock index 780614b..6b4b715 100644 --- a/flake.lock +++ b/flake.lock @@ -98,11 +98,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1726142289, - "narHash": "sha256-Jks8O42La+nm5AMTSq/PvM5O+fUAhIy0Ce1QYqLkyZ4=", + "lastModified": 1726871744, + "narHash": "sha256-V5LpfdHyQkUF7RfOaDPrZDP+oqz88lTJrMT1+stXNwo=", "owner": "nixos", "repo": "nixpkgs", - "rev": "280db3decab4cbeb22a4599bd472229ab74d25e1", + "rev": "a1d92660c6b3b7c26fb883500a80ea9d33321be2", "type": "github" }, "original": { From 842b45b969c8280e474f0bb55b93ab0e32e47033 Mon Sep 17 00:00:00 2001 From: raf Date: Tue, 24 Sep 2024 03:20:56 +0000 Subject: [PATCH 16/17] languages/ts: update lspconfig; rename tsserver to ts_ls (#379) Silence lspconfig, Microsoft naming convention is speaking. --- flake.lock | 6 ++-- modules/plugins/languages/ts.nix | 47 ++++++++++++++++++++++++++++++-- 2 files changed, 47 insertions(+), 6 deletions(-) diff --git a/flake.lock b/flake.lock index 6b4b715..377c084 100644 --- a/flake.lock +++ b/flake.lock @@ -1136,11 +1136,11 @@ "plugin-nvim-lspconfig": { "flake": false, "locked": { - "lastModified": 1716498901, - "narHash": "sha256-PMMqPDnq4Q8gWeKQ2WPE+pOf1R1G61wJ+bAWkHpQlzE=", + "lastModified": 1727085470, + "narHash": "sha256-IPpUZEMIL7+4mmqQLy9JeT0cW15/SH3Hx8kyksVcqC0=", "owner": "neovim", "repo": "nvim-lspconfig", - "rev": "b972e7154bc94ab4ecdbb38c8edbccac36f83996", + "rev": "dd329912c8d446240584a2dbcd3802af3a19105a", "type": "github" }, "original": { diff --git a/modules/plugins/languages/ts.nix b/modules/plugins/languages/ts.nix index dd1bde6..e6e718e 100644 --- a/modules/plugins/languages/ts.nix +++ b/modules/plugins/languages/ts.nix @@ -17,12 +17,12 @@ cfg = config.vim.languages.ts; - defaultServer = "tsserver"; + defaultServer = "ts_ls"; servers = { - tsserver = { + ts_ls = { package = pkgs.typescript-language-server; lspConfig = '' - lspconfig.tsserver.setup { + lspconfig.ts_ls.setup { capabilities = capabilities; on_attach = attach_keymaps, cmd = ${ @@ -49,6 +49,24 @@ } ''; }; + + # Here for backwards compatibility. Still consider tsserver a valid + # configuration in the enum, but assert if it's set to *properly* + # redirect the user to the correct server. + tsserver = { + package = pkgs.typescript-language-server; + lspConfig = '' + lspconfig.ts_ls.setup { + capabilities = capabilities; + on_attach = attach_keymaps, + cmd = ${ + if isList cfg.lsp.package + then expToLua cfg.lsp.package + else ''{"${cfg.lsp.package}/bin/typescript-language-server", "--stdio"}'' + } + } + ''; + }; }; # TODO: specify packages @@ -65,6 +83,7 @@ ) ''; }; + prettierd = { package = pkgs.prettierd; nullConfig = '' @@ -94,6 +113,7 @@ }; }; in { + _file = ./ts.nix; options.vim.languages.ts = { enable = mkEnableOption "Typescript/Javascript language support"; @@ -190,11 +210,32 @@ in { }; }) + # Extensions (mkIf cfg.extensions."ts-error-translator".enable { vim.startPlugins = ["ts-error-translator"]; vim.pluginRC.ts-error-translator = entryAnywhere '' require("ts-error-translator").setup(${toLuaObject cfg.extensions.ts-error-translator.setupOpts}) ''; }) + + # Warn the user if they have set the default server name to tsserver to match upstream (us) + # The name "tsserver" has been deprecated in lspconfig, and now should be called ts_ls. This + # is a purely cosmetic change, but emits a warning if not accounted for. + { + assertions = [ + { + assertion = cfg.lsp.enable -> cfg.lsp.server != "tsserver"; + message = '' + As of a recent lspconfig update, he `tsserver` configuration has been renamed + to `ts_ls` to match upstream behaviour of `lspconfig`, and the name `tsserver` + is no longer considered valid by nvf. Please set `vim.languages.ts.lsp.server` + to `"ts_ls"` instead of to `${cfg.lsp.server}` + + Please see for more details + about this change. + ''; + } + ]; + } ]); } From 316f25a0f62696b289ad4b944789beaae7fa9415 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 24 Sep 2024 06:27:06 +0300 Subject: [PATCH 17/17] docs: minor formatting changes Gerg I swear to god... --- docs/default.nix | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/default.nix b/docs/default.nix index 4a9d2f8..cce02b1 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -100,11 +100,9 @@ in { # TODO: Use `hmOptionsDocs.optionsJSON` directly once upstream # `nixosOptionsDoc` is more customizable. options.json = - pkgs.runCommand "options.json" - { + pkgs.runCommand "options.json" { meta.description = "List of nvf options in JSON format"; - } - '' + } '' mkdir -p $out/{share/doc,nix-support} cp -a ${nvimModuleDocs.optionsJSON}/share/doc/nixos $out/share/doc/nvf substitute \ @@ -117,15 +115,13 @@ in { # Generate the `man home-configuration.nix` package manPages = - pkgs.runCommand "nvf-reference-manpage" - { + pkgs.runCommand "nvf-reference-manpage" { nativeBuildInputs = [ pkgs.buildPackages.installShellFiles pkgs.nixos-render-docs ]; allowedReferences = ["out"]; - } - '' + } '' # Generate manpages. mkdir -p $out/share/man/{man5,man1}