mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-02-07 17:43:21 +00:00
docs/tips: distinguish pure and impure installation methods for raw lua
Some checks are pending
Check for typos in the source tree / check-typos (push) Waiting to run
Some checks are pending
Check for typos in the source tree / check-typos (push) Waiting to run
This commit is contained in:
parent
3843e14b3a
commit
b3154b6da7
1 changed files with 64 additions and 3 deletions
|
@ -3,10 +3,71 @@
|
||||||
We recognize that you might not always want to configure your setup purely in
|
We recognize that you might not always want to configure your setup purely in
|
||||||
Nix, sometimes doing things in Lua is simply the "superior" option. In such a
|
Nix, sometimes doing things in Lua is simply the "superior" option. In such a
|
||||||
case you might want to configure your Neovim instance using Lua, and nothing but
|
case you might want to configure your Neovim instance using Lua, and nothing but
|
||||||
Lua. It is also possible to mix Lua and Nix configurations through the following
|
Lua. It is also possible to mix Lua and Nix configurations.
|
||||||
method.
|
|
||||||
|
|
||||||
## Custom Configuration Directory {#sec-custom-config-dir}
|
Pure Lua or hybrid Lua/Nix configurations can be achieved in two different ways.
|
||||||
|
_Purely_, by modifying Neovim's runtime directory or _impurely_ by placing Lua
|
||||||
|
configuration in a directory found in `$HOME`. For your convenience, this
|
||||||
|
section will document both methods as they can be used.
|
||||||
|
|
||||||
|
## Pure Runtime Directory {#sec-pure-nvf-runtime}
|
||||||
|
|
||||||
|
As of 0.6, nvf allows you to modify Neovim's runtime path to suit your needs.
|
||||||
|
One of the ways the new runtime option is to add a configuration **located
|
||||||
|
relative to your `flake.nix`**, which must be version controlled in pure flakes
|
||||||
|
manner.
|
||||||
|
|
||||||
|
```nix
|
||||||
|
{
|
||||||
|
# Let us assume we are in the repository root, i.e., the same directory as the
|
||||||
|
# flake.nix. For the sake of the argument, we will assume that the Neovim lua
|
||||||
|
# configuration is in a nvim/ directory relative to flake.nix.
|
||||||
|
vim = {
|
||||||
|
additionalRuntimeDirectories = [
|
||||||
|
# This will be added to Neovim's runtime paths. Conceptually, this behaves
|
||||||
|
# very similarly to ~/.config/nvim but you may not place a top-level
|
||||||
|
# init.lua to be able to require it directly.
|
||||||
|
./nvim
|
||||||
|
];
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This will add the `nvim` directory, or rather, the _store path_ that will be
|
||||||
|
realised after your flake gets copied to the Nix store, to Neovim's runtime
|
||||||
|
directory. You may now create a `lua/myconfig` directory within this nvim
|
||||||
|
directory, and call it with [](#opt-vim.luaConfigRC).
|
||||||
|
|
||||||
|
```nix
|
||||||
|
{pkgs, ...}: {
|
||||||
|
vim = {
|
||||||
|
additionalRuntimeDirectories = [
|
||||||
|
# You can list more than one file here.
|
||||||
|
./nvim-custom-1
|
||||||
|
|
||||||
|
# To make sure list items are ordered, use lib.mkBefore or lib.mkAfter
|
||||||
|
# Simply placing list items in a given order will **not** ensure that
|
||||||
|
# this list will be deterministic.
|
||||||
|
./nvim-custom-2
|
||||||
|
];
|
||||||
|
|
||||||
|
startPlugins = [pkgs.vimPlugins.gitsigns];
|
||||||
|
|
||||||
|
# Neovim supports in-line syntax highlighting for multi-line strings.
|
||||||
|
# Simply place the filetype in a /* comment */ before the line.
|
||||||
|
luaConfigRC.myconfig = /* lua */ ''
|
||||||
|
-- Call the Lua module from ./nvim/lua/myconfig
|
||||||
|
require("myconfig")
|
||||||
|
|
||||||
|
-- Any additional Lua configuration that you might want *after* your own
|
||||||
|
-- configuration. For example, a plugin setup call.
|
||||||
|
require('gitsigns').setup({})
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Impure Absolute Directory {#sec-impure-absolute-dir}
|
||||||
|
|
||||||
[Neovim 0.9]: https://github.com/neovim/neovim/pull/22128
|
[Neovim 0.9]: https://github.com/neovim/neovim/pull/22128
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue