diff --git a/index.html b/index.html index 30499e0..12dc8f5 100644 --- a/index.html +++ b/index.html @@ -1,12 +1,12 @@ -neovim-flake Manual
neovim-flake Manual
   Next

neovim-flake Manual

Preface
1. Try it out
1.1. Nix
1.2. Tidal
1.3. Maximal
1.4. Using Prebuilt Configs
2. Default Configs
2.1. Tidal Cycles
2.2. Nix
2.3. Maximal
3. Custom Configuration
4. Home Manager
4.1. Custom vim plugins
5. Language Support
A. Configuration Options
B. Release Notes
B.1. Release 0.1
B.1.1. Changelog
B.2. Release 0.2
B.2.1. Changelog
B.3. Release 0.3
B.3.1. Changelog

Preface

+neovim-flake Manual

neovim-flake Manual
   Next

neovim-flake Manual

Preface
1. Try it out
1.1. Nix
1.2. Tidal
1.3. Maximal
1.4. Using Prebuilt Configs
2. Default Configs
2.1. Tidal Cycles
2.2. Nix
2.3. Maximal
3. Custom Configuration
4. Custom Plugins
5. Home Manager
5.1. Custom vim/neovim plugins
6. Language Support
A. Configuration Options
B. Release Notes
B.1. Release 0.1
B.1.1. Changelog
B.2. Release 0.2
B.2.1. Changelog
B.3. Release 0.3
B.3.1. Changelog
B.4. Release 0.4
B.4.1. Changelog

Preface

If your problem is caused by a bug in neovim-flake then it should be reported on the neovim-flake issue tracker. Alongside bug reports, feature requests are also welcome over neovim-flake pull requests.

Chapter 1. Try it out

$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
-$ nix run github:notashelf/neovim-flake

1.1. Nix

By default LSP support for Nix is enabled alongside all complementary Neovim plugins. By running nix run ., which is the default package, +$ nix run github:notashelf/neovim-flake # will run the default configuration

1.1. Nix

By default LSP support for Nix is enabled alongside all complementary Neovim plugins. By running nix run ., which is the default package, you will build Neovim with this config.

1.2. Tidal

Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.

1.3. Maximal

Maximal is the ultimate configuration that will enable basically everything. Keep in mind, however, that this will pull a lot of dependencies.

You are strongly recommended to use the binary cache if you would like to try the Maximal configuration.

1.4. Using Prebuilt Configs

$ nix run github:notashelf/neovim-flake#nix
 $ nix run github:notashelf/neovim-flake#tidal
 $ nix run github:notashelf/neovim-flake#maximal

Chapter 2. Default Configs

While you can configure neovim-flake yourself using the builder, here are a few default configurations you can use.

2.1. Tidal Cycles

$ nix run github:notashelf/neovim-flake#tidal file.tidal

Utilizing vim-tidal and mitchmindtree’s fantastic tidalcycles.nix start playing with tidal cycles in a single command.

In your tidal file, type a cycle e.g. d1 $ s "drum" and then press ctrl+enter. 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 services.pipewire.jack.enable = true.

2.2. Nix

$ nix run github:notashelf/neovim-flake#nix test.nix

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.

2.3. Maximal

$ nix shell github:notashelf/neovim-flake#maximal test.nix

It is the same fully configured neovim as with the Nix config, but with every supported language enabled.

Note

Running the maximal config will download a lot of packages as it is downloading language servers, formatters, and more.

Chapter 3. Custom Configuration

Custom configuration is done with the neovimConfiguration function. It takes in the configuration as a module. The output of the configuration function is an attrset.

{
@@ -39,7 +39,21 @@ $ nix run github:notashelf/neovim-flake#maximal

Chapter 4. Home Manager

The Home Manager module allows us to customize the different vim options. To use it, we first add the input flake.

{
+}

Chapter 4. Custom Plugins

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 config.vim.startPlugins array. +This is an example of adding the FrenzyExists/aquarium-vim plugin:

{
+  config.vim.startPlugins = [
+    (pkgs.fetchFromGitHub {
+      owner = "FrenzyExists";
+      repo = "aquarium-vim";
+      rev = "d09b1feda1148797aa5ff0dbca8d8e3256d028d5";
+      sha256 = "CtyEhCcGxxok6xFQ09feWpdEBIYHH+GIFVOaNZx10Bs=";
+    })
+  ];
+}

However, just making the plugin available might not be enough. In that case, you can write custom vimscript or lua config, using config.vim.configRC or config.vim.luaConfigRC respectively. +These options are attribute sets, and you need to give the configuration you’re adding some name, like this:

{
+  config.vim.configRC.aquarium = "colorscheme aquiarum";
+}

Note: If your configuration needs to be put in a specific place in the config, you can use functions from inputs.neovim-flake.lib.nvim.dag to order it. Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix.

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.

Chapter 5. Home Manager

The Home Manager module allows us to customize the different vim options. To use it, we first add the input flake.

{
   neovim-flake = {
     url = github:notashelf/neovim-flake;
     # you can override input nixpkgs
@@ -60,14 +74,15 @@ $ nix run github:notashelf/neovim-flake#maximal

4.1. Custom vim plugins

It’s possible to add custom vim plugins by using the startPlugins and lua DAG settings. First we install the plugin by adding it to startPlugins. This example uses nvim-surround, but the process will be similar for other plugins as well.

{
+}

5.1. Custom vim/neovim plugins

It is possible to add custom plugins to your configuration by using the vim.startPlugins option and the this flake’s lua DAG library.

Start by adding it to startPlugins. This example uses nvim-surround, but the process will be similar for other plugins as well.

{
   programs.neovim-flake = {
     enable = true;
     settings = {
       vim.startPlugins = [ pkgs.vimPlugins.nvim-surround ];
     };
   };
-}

Then we continue by requiring the plugin in lua using DAG settings. Please note that you’re able to name this setting to however you want, the name will add a --SECTION <name> in the init.vim, under which it will be initialized.

{
+}

Followed by requiring the plugin, should it need one, in the lua DAG. Please note that you’re able to name the DAG to however you want, the name will add a --SECTION <name> in the init.vim, under which it will be initialized. lib.nvim.dag.entryAfter ["name"] could also be used to initialize a plugin only after a previous plugin has beeni initialize +Your final setup will likely look like this, where nvim-flake refers to your flake input or fetch.

{
   programs.neovim-flake = {
     enable = true;
     settings = {
@@ -77,7 +92,7 @@ $ nix run github:notashelf/neovim-flake#maximal

Chapter 5. Language Support

Language specific support means there is a combination of language specific plugins, treesitter support, nvim-lspconfig language servers, and null-ls integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the vim.languages attribute. See the configuration docs for details.

  • +}

Chapter 6. Language Support

Language specific support means there is a combination of language specific plugins, treesitter support, nvim-lspconfig language servers, and null-ls integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the vim.languages attribute. See the configuration docs for details.