diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index 58735c1..87bd3b6 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -139,3 +139,11 @@ configuration formats. - Add [neo-tree.nvim] as an alternative file-tree plugin. It will be available under `vim.filetree.neo-tree`, similar to nvimtree. + +- Add `print-nvf-config` & `print-nvf-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`. + - `print-nvf-config` will display your `init.lua`, in full. + - `print-nvf-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. diff --git a/modules/default.nix b/modules/default.nix index b5e8792..227cf20 100644 --- a/modules/default.nix +++ b/modules/default.nix @@ -113,10 +113,35 @@ inputs: { inherit (vimOptions) viAlias vimAlias withRuby withNodeJs withPython3; inherit extraLuaPackages extraPython3Packages; }; + + # Additional helper scripts for printing and displaying nvf configuration + # in your commandline. + printConfig = pkgs.writers.writeDashBin "print-nvf-config" '' + cat << EOF + ${vimOptions.builtLuaConfigRC} + EOF + ''; + + printConfigPath = pkgs.writers.writeDashBin "print-nvf-config-path" '' + realpath ${pkgs.writeTextFile { + name = "nvf-init.lua"; + text = vimOptions.builtLuaConfigRC; + }} + ''; in { inherit (module) options config; inherit (module._module.args) pkgs; - # expose wrapped neovim-package - neovim = neovim-wrapped; + # Expose wrapped neovim-package for userspace + # or module consumption. + neovim = pkgs.symlinkJoin { + name = "nvf-with-helpers"; + paths = [neovim-wrapped printConfig printConfigPath]; + postBuild = "echo helpers added"; + + meta = { + description = "Wrapped version of Neovim with additional helper scripts"; + mainProgram = "nvim"; + }; + }; }