<divclass="preface"><divclass="titlepage"><div><div><h1class="title"><aid="sec-preface"></a>Preface </h1></div></div></div><p>If you noticed a bug caused by neovim-flake then please consider reporting it over
</div><divclass="preface"><divclass="titlepage"><div><div><h1class="title"><aid="ch-try-it-out"></a>Try it out </h1></div></div></div><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-using-prebuild-configs">Using Prebuilt Configs</a></span></dt></dl></div><p>Thanks to the portability of Nix, you can try out neovim-flake without actually installing it to your machine.
Below are the commands you may run to try out different configurations provided by this flake. As of v0.5, three
configurations are provided:</p><divclass="itemizedlist"><ulclass="itemizedlist compact"style="list-style-type: disc;"><liclass="listitem"><p>Nix</p></li><liclass="listitem"><p>Tidal</p></li><liclass="listitem"><p>Maximal</p></li></ul></div><p>You may try out any of the provided configurations using the <codeclass="literal">nix run</code> command on a system where Nix is installed.</p><pre><codeclass="programlisting console">$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
$ nix run github:notashelf/neovim-flake#nix # will run the default minimal configuration
</code></pre><p>Do keep in mind that this is <spanclass="strong"><strong>susceptible to garbage collection</strong></span> meaning it will be removed from your Nix store
once you garbage collect. If you wish to install neovim-flake, please take a look at
<aclass="link"href="index.xhtml#ch-custom-configuration"title="Custom Configuration">custom-configuration</a> or <aclass="link"href="index.xhtml#ch-hm-module"title="Home Manager">home-manager</a> sections for installation
instructions.</p><divclass="section"><divclass="titlepage"><div><div><h2class="title"><aid="sec-using-prebuild-configs"></a>Using Prebuilt Configs </h2></div></div></div><divclass="toc"><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-available-configs">Available Configs</a></span></dt></dl></div><pre><codeclass="programlisting console">$ nix run github:notashelf/neovim-flake#nix
$ nix run github:notashelf/neovim-flake#tidal
$ nix run github:notashelf/neovim-flake#maximal
</code></pre><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-available-configs"></a>Available Configs </h3></div></div></div><divclass="section"><divclass="titlepage"><div><div><h4class="title"><aid="sec-configs-nix"></a>Nix </h4></div></div></div><p><codeclass="literal">Nix</code> configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins.
By running <codeclass="literal">nix run .</code>, which is the default package, you will build Neovim with this config.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h4class="title"><aid="sec-configs-tidal"></a>Tidal </h4></div></div></div><p>Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h4class="title"><aid="sec-configs-maximal"></a>Maximal </h4></div></div></div><p><codeclass="literal">Maximal</code> is the ultimate configuration that will enable support for more commonly used language as well as additional
complementary plugins. Keep in mind, however, that this will pull a lot of dependencies.</p><p>You are <spanclass="emphasis"><em>strongly</em></span> recommended to use the binary cache if you would like to try the Maximal configuration.</p>
</div>
</div>
</div>
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-custom-configuration"></a>Custom Configuration </h1></div></div></div><divclass="partintro"><p>Custom configuration is done with the <codeclass="literal">neovimConfiguration</code> while using the flake as a standalone package.
It takes in the configuration as a module. The output of the configuration function is an attrset.</p><pre><codeclass="programlisting nix">{
options = "The options that were available to configure";
config = "The outputted configuration";
pkgs = "The package set used to evaluate the module";
neovim = "The built neovim package";
}
</code></pre><p>The following is an example of a barebones vim configuration with the default theme enabled.</p><pre><codeclass="programlisting nix">{
inputs.neovim-flake = {
url = "github:notashelf/neovim-flake";
inputs.nixpkgs.follows = "nixpkgs";
};
outputs = {nixpkgs, neovim-flake, ...}: let
system = "x86_64-linux";
pkgs = nixpkgs.legacyPackages.${system};
configModule = {
# Add any custom options (and feel free to upstream them!)
</code></pre><p>Your built neovim configuration can be exposed as a flake output, or be added to your system packages to make
it available across your system. You may also consider passing the flake output to home-manager to make it available
to a specific user <spanclass="emphasis"><em>without</em></span> using the home-manager module.</p></div>
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-custom-package"></a>Custom Neovim Package </h1></div></div></div><divclass="partintro"><p>As of v0.5, you may now specify the neovim package that will be wrapped with your configuration. This is done with the <codeclass="literal">vim.package</code> option.</p><pre><codeclass="programlisting nix">{inputs, pkgs, ...}: {
</code></pre><p>The neovim-nightly-overlay always exposes an unwrapped package. If using a different source, you are highly recommended to get an “unwrapped” version of the neovim package,similar to <codeclass="literal">neovim-unwrapped</code> in nixpkgs.</p></div>
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-custom-plugins"></a>Custom Plugins </h1></div></div></div><divclass="partintro"><p>You can use custom plugins, before they are implemented in the flake.
To add a plugin, you need to add it to your config’s <codeclass="literal">config.vim.startPlugins</code> array.</p><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-new-method">New Method</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-old-method">Old Method</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#configuring-plugins">Configuring</a></span></dt></dl></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-new-method"></a>New Method </h2></div></div></div><p>As of version 0.5, we have a more extensive API for configuring plugins, under <codeclass="literal">vim.extraPlugins</code>.</p><p>Instead of using DAGs exposed by the library, you may use the extra plugin module as follows:</p><pre><codeclass="programlisting nix">{
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-old-method"></a>Old Method </h2></div></div></div><p>Users who have not yet updated to 0.5, or prefer a more hands-on approach may use the old method where the load order
of the plugins is determined by DAGs.</p><pre><codeclass="programlisting nix">{
# fetch plugin source from GitHub and add it to startPlugins
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="configuring-plugins"></a>Configuring </h2></div></div></div><p>Just making the plugin to your neovim configuration available might not always be enough.
In that case, you can write custom vimscript or lua config, using <codeclass="literal">config.vim.configRC</code> or <codeclass="literal">config.vim.luaConfigRC</code>
respectively. These options are attribute sets, and you need to give the configuration you’re adding some name, like this:</p><pre><codeclass="programlisting nix">{
# this will create an "aquarium" section in your init.vim with the contents of your custom config
# which will be *appended* to the rest of your configuration, inside your init.vim
</code></pre><divclass="note"><h3class="title">Note</h3><p>If your configuration needs to be put in a specific place in the config, you can use functions from
<codeclass="literal">inputs.neovim-flake.lib.nvim.dag</code> to order it.
Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix to find out more about
the DAG system.</p></div><p>Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue
with your findings so that we can make it available for everyone easily.</p>
</div>
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-default-configs"></a>Default Configs </h1></div></div></div><divclass="partintro"><p>While you can configure neovim-flake yourself using the builder, you can also use the pre-built configs that are available.
Here are a few default configurations you can use.</p><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-default-maximal">Maximal</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-default-nix">Nix</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-default-tidal">Tidal Cycles</a></span></dt></dl></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-default-maximal"></a>Maximal </h2></div></div></div><pre><codeclass="programlisting bash">$ nix shell github:notashelf/neovim-flake#maximal test.nix
</code></pre><p>It is the same fully configured neovim as with the <aclass="link"href="index.xhtml#sec-default-nix"title="Nix">Nix</a> config, but with every supported language enabled.</p><divclass="note"><h3class="title">Note</h3><p>Running the maximal config will download <spanclass="emphasis"><em>a lot</em></span> of packages as it is downloading language servers, formatters, and more.</p></div>
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-default-nix"></a>Nix </h2></div></div></div><pre><codeclass="programlisting bash">$ nix run github:notashelf/neovim-flake#nix test.nix
</code></pre><p>Enables all the of neovim plugins, with language support for specifically Nix. This lets you see what a fully configured neovim setup looks like without downloading a whole bunch of language servers and associated tools.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-default-tidal"></a>Tidal Cycles </h2></div></div></div><pre><codeclass="programlisting bash">$ nix run github:notashelf/neovim-flake#tidal file.tidal
</code></pre><p>Utilizing <aclass="link"href="https://github.com/tidalcycles/vim-tidal"target="_top">vim-tidal</a> and mitchmindtree’s fantastic
<aclass="link"href="https://github.com/mitchmindtree/tidalcycles.nix"target="_top">tidalcycles.nix</a> start playing with tidal cycles in a single command.</p><p>In your tidal file, type a cycle e.g. <codeclass="literal">d1 $ s "drum"</code> and then press <spanclass="emphasis"><em>ctrl+enter</em></span>. Super collider with superdirt, and a
modified GHCI with tidal will start up and begin playing. Note, you need jack enabled on your system. If you are using
pipewire, its as easy as setting <codeclass="literal">services.pipewire.jack.enable = true</code> in your configuration.</p>
</div>
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-hm-module"></a>Home Manager </h1></div></div></div><divclass="partintro"><p>The Home Manager module allows us to customize the different <codeclass="literal">vim</code> options from inside the home-manager configuration
and it is the preferred way of configuring neovim-flake, both on NixOS and non-NixOS systems.</p><p>To use it, we first add the input flake.</p><pre><codeclass="programlisting nix">{
neovim-flake = {
url = github:notashelf/neovim-flake;
# you can override input nixpkgs
inputs.nixpkgs.follows = "nixpkgs";
# you can also override individual plugins
# i.e inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- obsidian nvim needs to be in your inputs
};
}
</code></pre><p>Followed by importing the home-manager module somewhere in your configuration.</p><pre><codeclass="programlisting nix">{
# assuming neovim-flake is in your inputs and inputs is in the argset
# your settings need to go into the settings attribute set
# most settings are documented in the appendix
settings = {
vim.viAlias = false;
vim.vimAlias = true;
vim.lsp = {
enable = true;
};
};
};
}
</code></pre><divclass="note"><h3class="title">Note</h3><p>You may find all avaliable options in the <aclass="link"href="https://notashelf.github.io/neovim-flake/options"target="_top">appendix</a></p></div></div>
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-languages"></a>Language Support </h1></div></div></div><divclass="partintro"><p>Language specific support means there is a combination of language specific plugins, <codeclass="literal">treesitter</code> support, <codeclass="literal">nvim-lspconfig</code> language servers, and <codeclass="literal">null-ls</code> integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the <codeclass="literal">vim.languages</code> attribute. See the configuration docs for details.</p><divclass="itemizedlist"><ulclass="itemizedlist compact"style="list-style-type: disc;"><liclass="listitem"><p>Rust: <aclass="link"href="options.html#opt-vim.languages.rust.enable">vim.languages.rust.enable</a></p></li><liclass="listitem"><p>Nix: <aclass="link"href="options.html#opt-vim.languages.nix.enable">vim.languages.nix.enable</a></p></li><liclass="listitem"><p>SQL: <aclass="link"href="options.html#opt-vim.languages.sql.enable">vim.languages.sql.enable</a></p></li><liclass="listitem"><p>C/C++: <aclass="link"href="options.html#opt-vim.languages.clang.enable">vim.languages.clang.enable</a></p></li><liclass="listitem"><p>Typescript/Javascript: <aclass="link"href="options.html#opt-vim.languages.ts.enable">vim.languages.ts.enable</a></p></li><liclass="listitem"><p>Python: <aclass="link"href="options.html#opt-vim.languages.python.enable">vim.languages.python.enable</a>:</p></li><liclass="listitem"><p>Zig: <aclass="link"href="options.html#opt-vim.languages.zig.enable">vim.languages.zig.enable</a></p></li><liclass="listitem"><p>Markdown: <aclass="link"href="options.html#opt-vim.languages.markdown.enable">vim.languages.markdown.enable</a></p></li><liclass="listitem"><p>HTML: <aclass="link"href="options.html#opt-vim.languages.html.enable">vim.languages.html.enable</a></p></li><liclass="listitem"><p>Dart: <aclass="link"href="options.html#opt-vim.languages.dart.enable">vim.languages.dart.enable</a></p></li><liclass="listitem"><p>Go: <aclass="link"href="options.html#opt-vim.languages.go.enable">vim.languages.go.enable</a></p></li><liclass="listitem"><p>Lua: <aclass="link"href="options.html#opt-vim.languages.lua.enable">vim.languages.lua.enable</a></p></li><liclass="listitem"><p>PHP: <aclass="link"href="options.html#opt-vim.languages.php.enable">vim.languages.php.enable</a></p></li></ul></div><p>Adding support for more languages, and improving support for existing ones are great places
where you can contribute with a PR.</p><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-languages-custom-lsp-packages">LSP Custom Packages/Command</a></span></dt></dl></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-languages-custom-lsp-packages"></a>LSP Custom Packages/Command </h2></div></div></div><p>In any of the <codeclass="literal">opt.languages.<language>.lsp.package</code> options you can provide your own LSP package, or provide
the command to launch the language server, as a list of strings.</p><p>You can use this to skip automatic installation of a language server, and instead
use the one found in your <codeclass="literal">$PATH</code> during runtime, for example:</p><pre><codeclass="programlisting nix">vim.languages.java = {
</div><divclass="part"><divclass="titlepage"><div><div><h1class="title"><aid="ch-hacking"></a>Hacking neovim-flake </h1></div></div></div><divclass="partintro"><p>neovim-flake is designed for developers as much as it is for the end user. I would like any potential contributor
to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides
(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates
into neovim-flake’s development without leaving question marks in your head.</p><p>This section is mainly directed towards those who wish to contribute code into neovim-flake. If you wish to instead
report a bug or discuss a potential feature implementation, first look among the
already <aclass="link"href="https://github.com/notashelf/neovim-flake/issues"target="_top">open issues</a> and if no matching issue exists you may open
a <aclass="link"href="https://github.com/notashelf/neovim-flake/issues/new"target="_top">new issue</a> and describe your problem/request. While creating an
issue, please try to include as much information as you can, ideally also include relevant context in which an issue
occurs or a feature should be implemented.</p><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-contrib-getting-started">Getting Started</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines">Guidelines</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-testing-changes">Testing Changes</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-keybinds">Keybinds</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-additional-plugins">Adding Plugins</a></span></dt></dl></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-contrib-getting-started"></a>Getting Started </h2></div></div></div><p>You naturally would like to start by forking the repository. If you are new to git, have a look at GitHub’s
<aclass="link"href="https://help.github.com/articles/fork-a-repo/"target="_top">Fork a repo guide</a> for instructions on how you can do this. Once you have a fork of neovim-flake
you should create a branch starting at the most recent <codeclass="literal">main</code> branch.
Give your branch a reasonably descriptive name, suffixed by its type - i.e <codeclass="literal">feature/debugger</code> or <codeclass="literal">fix/pesky-bug</code>.</p><p>Implement your changes and commit them to the newly created branch and when you are happy with the result and positive
that it fulfills <aclass="link"href="index.xhtml#sec-guidelines"title="Guidelines">Guidelines</a>. Once you are confident everything is in order, push the branch to GitHub and
<aclass="link"href="https://help.github.com/articles/creating-a-pull-request"target="_top">create a pull request</a>, following the template that you will be prompted to fill.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-guidelines"></a>Guidelines </h2></div></div></div><divclass="toc"><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines-documentation">Adding Documentation</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines-formatting">Formatting Code</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines-commit-message-style">Formatting Commits</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines-commit-style">Commit Style</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines-ex-commit-message">Example Commit</a></span></dt><dt><spanclass="section"><ahref="index.xhtml#sec-guidelines-code-style">Code Style</a></span></dt></dl></div><p>If your contribution tightly follows the guidelines, then there is a good chance it will be merged without too much
trouble. Some of the guidelines will be strictly enforced, others will remain as gentle nudges towards the correct
direction. As we have no automated system enforcing those guidelines, please try to double check your changes before
making your pull request in order to avoid “faulty” code slipping by.</p><p>If you are uncertain how these rules affect the change you would like to make then feel free to start a
discussion in the <aclass="link"href="https://github.com/NotAShelf/neovim-flake/discussions"target="_top">discussions tab</a> ideally (but not necessarily)
before you start developing.</p><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-guidelines-documentation"></a>Adding Documentation </h3></div></div></div><p>Most, if not all, changes warrant changes to the documentation. Module options should be documented with
<aclass="link"href="https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup"target="_top">Nixpkgs-flavoured Markdown</a>, albeit with exceptions.</p><divclass="note"><h3class="title">Note</h3><p>As of v0.5, neovim-flake is itself documented using full markdown in both module options and the manual. With
v0.6, this manual has also been converted to markdown in full.</p></div><p>The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake
</div><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-guidelines-formatting"></a>Formatting Code </h3></div></div></div><p>Make sure your code is formatted as described in <aclass="link"href="index.xhtml#sec-guidelines-code-style"title="Code Style">code-style section</a>. To maintain consistency throughout
the project you are encouraged to browse through existing code and adopt its style also in new code.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-guidelines-commit-message-style"></a>Formatting Commits </h3></div></div></div><p>Similar to <aclass="link"href="index.xhtml#sec-guidelines-code-style"title="Code Style">code style guidelines</a> we encourage a consistent commit message format as described
in <aclass="link"href="index.xhtml#sec-guidelines-commit-style"title="Commit Style">commit style guidelines</a>.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-guidelines-commit-style"></a>Commit Style </h3></div></div></div><p>The commits in your pull request should be reasonably self-contained. Which means each and every commit in
a pull request should make sense both on its own and in general context. That is, a second commit should not resolve
an issue that is introduced in an earlier commit. In particular, you will be asked to amend any commit that
introduces syntax errors or similar problems even if they are fixed in a later commit.</p><p>The commit messages should follow the <aclass="link"href="https://chris.beams.io/posts/git-commit/#seven-rule"target="_top">seven rules</a>,
except for “Capitalize the subject line”. We also ask you to include the affected code component or module in
the first line. A commit message ideally, but not necessarily, follow the given template from home-manager’s own documentation</p><pre><codeclass="programlisting"> {component}: {description}
</code></pre><p>where <codeclass="literal">{component}</code> refers to the code component (or module) your change affects, <codeclass="literal">{description}</code> is a very brief
description of your change, and <codeclass="literal">{long description}</code> is an optional clarifying description. As a rare exception, if
there is no clear component, or your change affects many components, then the <codeclass="literal">{component}</code> part is optional.
See <aclass="link"href="index.xhtml#sec-guidelines-ex-commit-message"title="Example Commit">example commit message</a> for a commit message that fulfills these requirements.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-guidelines-ex-commit-message"></a>Example Commit </h3></div></div></div><p>The commit <aclass="link"href="https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef"target="_top">69f8e47e9e74c8d3d060ca22e18246b7f7d988ef</a> contains the commit message</p><pre><codeclass="programlisting">
The vterm buffer is backed by libvterm and can handle Starship prompts
without issues.
</code></pre><p>Long description can be ommitted if the change is too simple to warrant it. A minor fix in spelling or a formatting
change does not warrant long description, however, a module addition or removal does as you would like to provide the
relevant context for your changes.</p><p>Finally, when adding a new module, say <codeclass="literal">modules/foo.nix</code>, we use the fixed commit format <codeclass="literal">foo: add module</code>.
You can, of course, still include a long description if you wish.</p><p>In case of nested modules, i.e <codeclass="literal">modules/languages/java.nix</code> you are recommended to contain the parent as well - for
example <codeclass="literal">languages/java: some major change</code>.</p>
Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module
descriptions and documentation.</p><p><spanclass="strong"><strong>Nix</strong></span>
neovim-flake is formatted by the <aclass="link"href="https://github.com/kamadorueda/alejandra"target="_top">alejandra</a> tool and the formatting is checked in the pull
request and push workflows. Run the <codeclass="literal">nix fmt</code> command inside the project repository before submitting your
pull request.</p><p>While Alejandra is mostly opinionated on how code looks after formatting, certain changes are done at the
user’s discretion based on how the original code was structured.</p><p>Please use one line code for attribute sets that contain only one subset.
For example:</p><pre><codeclass="programlisting nix"># parent modules should always be unfolded
# which means module = { value = ... } instead of module.value = { ... }
module = {
value = mkEnableOption "some description" // { default = true; }; # merges can be done inline where possible
# same as parent modules, unfold submodules
subModule = {
# this is an option that contains more than one nested value
someOtherValue = mkOption {
type = lib.types.bool;
description = "Some other description";
default = true;
};
};
}
</code></pre><p>If you move a line down after the merge operator, Alejandra will automatically unfold the whole merged attrset
for you, which we <spanclass="strong"><strong>do not</strong></span> want.</p><pre><codeclass="programlisting nix">module = {
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-testing-changes"></a>Testing Changes </h2></div></div></div><p>Once you have made your changes, you will need to test them throughly. If it is a module, add your module option to
<codeclass="literal">configuration.nix</code> (located in the root of this project) inside <codeclass="literal">neovimConfiguration</code>. Enable it, and then run the
maximal configuration with <codeclass="literal">nix run .#maximal -Lv</code> to check for build errors. If neovim opens in the current directory
without any error messages (you can check the output of <codeclass="literal">:messages</code> inside neovim to see if there are any errors), then
your changes are good to go. Open your pull request, and it will be reviewed as soon as posssible.</p><p>If it is not a new module, but a change to an existing one, then make sure the module you have changed is enabled in the
maximal configuration by editing <codeclass="literal">configuration.nix</code>, and then run it with <codeclass="literal">nix run .#maximal -Lv</code>. Same procedure as
adding a new module will apply here.</p>
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-keybinds"></a>Keybinds </h2></div></div></div><divclass="toc"><dlclass="toc"><dt><spanclass="section"><ahref="index.xhtml#sec-custom-key-mappings">Custom Key Mappings Support for a Plugin</a></span></dt></dl></div><p>As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in
the <aclass="link"href="https://github.com/NotAShelf/neovim-flake/tree/main/lib"target="_top">extended standard library</a>. The following section contains
a general overview to how you may utilize said functions.</p><divclass="section"><divclass="titlepage"><div><div><h3class="title"><aid="sec-custom-key-mappings"></a>Custom Key Mappings Support for a Plugin </h3></div></div></div><p>To set a mapping, you should define it in <codeclass="literal">vim.maps.<<mode>></code>.
The available modes are:</p><divclass="itemizedlist"><ulclass="itemizedlist compact"style="list-style-type: disc;"><liclass="listitem"><p>normal</p></li><liclass="listitem"><p>insert</p></li><liclass="listitem"><p>select</p></li><liclass="listitem"><p>visual</p></li><liclass="listitem"><p>terminal</p></li><liclass="listitem"><p>normalVisualOp</p></li><liclass="listitem"><p>visualOnly</p></li><liclass="listitem"><p>operator</p></li><liclass="listitem"><p>insertCommand</p></li><liclass="listitem"><p>lang</p></li><liclass="listitem"><p>command</p></li></ul></div><p>An example, simple keybinding, can look like this:</p><pre><codeclass="programlisting nix">{
to see a list of them.</p><p><codeclass="literal">neovim-flake</code> provides a list of helper commands, so that you don’t have to write the mapping attribute sets every
time:</p><divclass="itemizedlist"><ulclass="itemizedlist compact"style="list-style-type: disc;"><liclass="listitem"><p><codeclass="literal">mkBinding = key: action: desc:</code> - makes a basic binding, with <codeclass="literal">silent</code> set to true.</p></li><liclass="listitem"><p><codeclass="literal">mkExprBinding = key: action: desc:</code> - makes an expression binding, with <codeclass="literal">lua</code>, <codeclass="literal">silent</code>, and <codeclass="literal">expr</code> set to true.</p></li><liclass="listitem"><p><codeclass="literal">mkLuaBinding = key: action: desc:</code> - makes an expression binding, with <codeclass="literal">lua</code>, and <codeclass="literal">silent</code> set to true.</p></li></ul></div><p>Note that the Lua in these bindings is actual Lua, not pasted into a <codeclass="literal">:lua</code> command.
Therefore, you either pass in a function like <codeclass="literal">require('someplugin').some_function</code>, without actually calling it,
or you define your own function, like <codeclass="literal">function() require('someplugin').some_function() end</code>.</p><p>Additionally, to not have to repeat the descriptions, there’s another utility function with its own set of functions:</p><p>Utility function that takes two attrsets:</p><divclass="itemizedlist"><ulclass="itemizedlist compact"style="list-style-type: disc;"><liclass="listitem"><p><codeclass="literal">{ someKey = "some_value" }</code></p></li><liclass="listitem"><p><codeclass="literal">{ someKey = { description = "Some Description"; }; }</code></p></li></ul></div><p>and merges them into <codeclass="literal">{ someKey = { value = "some_value"; description = "Some Description"; }; }</code></p><pre><codeclass="programlisting">addDescriptionsToMappings = actualMappings: mappingDefinitions:
</code></pre><p>This function can be used in combination with the same <codeclass="literal">mkBinding</code> functions as above, except they only take two
arguments - <codeclass="literal">binding</code> and <codeclass="literal">action</code>, and have different names:</p><divclass="itemizedlist"><ulclass="itemizedlist compact"style="list-style-type: disc;"><liclass="listitem"><p><codeclass="literal">mkSetBinding = binding: action:</code> - makes a basic binding, with <codeclass="literal">silent</code> set to true.</p></li><liclass="listitem"><p><codeclass="literal">mkSetExprBinding = binding: action:</code> - makes an expression binding, with <codeclass="literal">lua</code>, <codeclass="literal">silent</code>, and <codeclass="literal">expr</code> set to true.</p></li><liclass="listitem"><p><codeclass="literal">mkSetLuaBinding = binding: action:</code> - makes an expression binding, with <codeclass="literal">lua</code>, and <codeclass="literal">silent</code> set to true.</p></li></ul></div><p>You can read the source code of some modules to see them in action, but their usage should look something like this:</p><pre><codeclass="programlisting nix">
</code></pre><divclass="note"><h3class="title">Note</h3><p>If you have come across a plugin that has an API that doesn’t seem to easily allow custom keybindings,
don’t be scared to implement a draft PR. We’ll help you get it done.</p></div>
</div>
</div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="sec-additional-plugins"></a>Adding Plugins </h2></div></div></div><p>To add a new neovim plugin, first add the source url in the inputs section of <codeclass="literal">flake.nix</code></p><pre><codeclass="programlisting nix">
{
inputs = {
# ...
neodev-nvim = {
url = "github:folke/neodev.nvim";
flake = false;
};
# ...
};
}
</code></pre><p>Then add the name of the plugin into the <codeclass="literal">availablePlugins</code> variable in <codeclass="literal">lib/types/plugins.nix</code>:</p><pre><codeclass="programlisting nix"># ...
availablePlugins = [
# ...
"neodev-nvim"
];
</code></pre><p>You can now reference this plugin using its string name:</p><pre><codeclass="programlisting nix">config.vim.startPlugins = ["neodev-nvim"];
