diff --git a/flake.nix b/flake.nix index 80174f9..e63f7ca 100644 --- a/flake.nix +++ b/flake.nix @@ -27,19 +27,33 @@ }; homeManagerModules = { - neovim-flake = { + neovim-flake = + nixpkgs.lib.warn '' + homeManagerModules.neovim-flake has been deprecated. + Plese use the homeManagereModules.nvf instead + '' + self.homeManagerModules.nvf; + + nvf = { imports = [(import ./flake/modules/home-manager.nix self.packages inputs)]; }; - default = self.homeManagerModules.neovim-flake; + default = self.homeManagerModules.nvf; }; nixosModules = { - neovim-flake = { + neovim-flake = + nixpkgs.lib.warn '' + nixosModules.neovim-flake has been deprecated. + Please use the nixosModules.nvf instead + '' + self.nixosModules.neovim-flake; + + nvf = { imports = [(import ./flake/modules/nixos.nix self.packages inputs)]; }; - default = self.nixosModules.neovim-flake; + default = self.nixosModules.nvf; }; }; diff --git a/flake/packages.nix b/flake/packages.nix index dec0614..eb6c946 100644 --- a/flake/packages.nix +++ b/flake/packages.nix @@ -33,7 +33,7 @@ inherit (config.legacyPackages) neovim-nix; in dockerTools.buildImage { - name = "neovim-flake"; + name = "nvf"; tag = "latest"; copyToRoot = buildEnv { diff --git a/lib/stdlib-extended.nix b/lib/stdlib-extended.nix index 2e05650..4bd63b9 100644 --- a/lib/stdlib-extended.nix +++ b/lib/stdlib-extended.nix @@ -9,7 +9,7 @@ nixpkgsLib.extend (self: super: { # Makes our custom functions available under `lib.nvim` where stdlib-extended.nix is imported # with the appropriate arguments. For end-users, a `lib` output will be accessible from the flake. - # E.g. for an input called `neovim-flake`, `inputs.neovim-flake.lib.nvim` will return the set + # E.g. for an input called `nvf`, `inputs.nvf.lib.nvim` will return the set # below. nvim = import ./. { inherit inputs; diff --git a/modules/neovim/init/spellcheck.nix b/modules/neovim/init/spellcheck.nix index 1995532..7a41f25 100644 --- a/modules/neovim/init/spellcheck.nix +++ b/modules/neovim/init/spellcheck.nix @@ -16,7 +16,7 @@ in { ]; options.vim.spellcheck = { - enable = mkEnableOption "neovim's built-in spellchecking"; + enable = mkEnableOption "Neovim's built-in spellchecking"; languages = mkOption { type = listOf str; default = ["en"]; @@ -27,7 +27,7 @@ in { To add your own language files, you may place your `spell` directory in either `~/.config/nvim` or the [additionalRuntimePaths](#opt-vim.additionalRuntimePaths) - directory provided by neovim-flake. + directory provided by **nvf**. ''; }; @@ -38,7 +38,7 @@ in { description = '' A list of filetypes for which spellchecking will be disabled. - You may use `echo &filetype` in neovim to find out the + You may use `echo &filetype` in Neovim to find out the filetype for a specific buffer. ''; }; diff --git a/modules/plugins/rich-presence/neocord/neocord.nix b/modules/plugins/rich-presence/neocord/neocord.nix index 1d6e625..ef4a659 100644 --- a/modules/plugins/rich-presence/neocord/neocord.nix +++ b/modules/plugins/rich-presence/neocord/neocord.nix @@ -7,10 +7,12 @@ in { imports = [ (mkRemovedOptionModule ["vim" "presence" "presence-nvim"] '' - The option vim.presence.presence-nvim has been deprecated in favor of the new neocord module. - Options provided by the plugin remain mostly the same, but manual migration is required. + The option vim.presence.presence-nvim has been deprecated in favor of the new + neocord module. Options provided by the plugin remain mostly the same, but manual + migration is required. - Please see neocord documentation and the neovim-flake options for more info + Please see neocord documentation and options page on the **nvf** manual + for mor einformation '') ] ++ (map diff --git a/modules/plugins/treesitter/treesitter.nix b/modules/plugins/treesitter/treesitter.nix index 916b796..8b06642 100644 --- a/modules/plugins/treesitter/treesitter.nix +++ b/modules/plugins/treesitter/treesitter.nix @@ -27,7 +27,7 @@ in { description = '' List of treesitter grammars to install. - For languages already supported by neovim-flake, you may + For languages already supported by nvf, you may use the {option}`vim.language..treesitter` options, which will automatically add the required grammars to this. ''; @@ -39,6 +39,7 @@ in { description = '' Whether to add the default grammars to the list of grammars to install. + This option is only relevant if treesitter has been enabled. ''; }; diff --git a/modules/wrapper/build/options.nix b/modules/wrapper/build/options.nix index 0711046..8816cbe 100644 --- a/modules/wrapper/build/options.nix +++ b/modules/wrapper/build/options.nix @@ -12,11 +12,14 @@ in { type = package; default = pkgs.neovim-unwrapped; description = '' - The neovim package to use. + The neovim package to use for the wrapper. This + corresponds to the package that will be wrapped + with your plugins and settings. ::: {.warning} You will need to use an unwrapped package for this - option to work as intended. + option to work as intended. Using an already wrapped + package here may yield undesirable results. ::: ''; }; @@ -74,8 +77,7 @@ in { set up after builtin plugins. This option takes a special type that allows you to order - your custom plugins using neovim-flake's modified DAG - library. + your custom plugins using nvf's modified DAG library. ''; example = literalExpression '' diff --git a/modules/wrapper/rc/options.nix b/modules/wrapper/rc/options.nix index 21da8b2..106701e 100644 --- a/modules/wrapper/rc/options.nix +++ b/modules/wrapper/rc/options.nix @@ -102,7 +102,7 @@ in { If this option is passed as a DAG, it will be resolved according to the DAG resolution rules (e.g. entryBefore - or entryAfter) as per the neovim-flake library. + or entryAfter) as per the **nvf** extended library. ''; example = literalMD '' @@ -182,7 +182,7 @@ in { If this option is passed as a DAG, it will be resolved according to the DAG resolution rules (e.g. entryBefore - or entryAfter) as per the neovim-flake library. + or entryAfter) as per the **nvf** extended library. ''; example = literalMD ''