From 10ff6d5b3dd1c7725e0acd627c9fcc75c9d3bf61 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 9 Oct 2023 11:44:02 +0000 Subject: [PATCH] deploy: fc651e654f736b2b89f268347726273211c6fc25 --- index.html | 350 +++++++++++++++++++++++++++++++++++++++++---- options.html | 38 ++--- release-notes.html | 50 ++++++- 3 files changed, 390 insertions(+), 48 deletions(-) diff --git a/index.html b/index.html index a21eab61..954dccb5 100644 --- a/index.html +++ b/index.html @@ -1,15 +1,27 @@ -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
4.1. New Method
4.2. Old Method
5. Custom Neovim Package
6. Home Manager
7. Language Support
7.1. LSP Custom Packages/Command
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 # 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
+neovim-flake Manual
neovim-flake Manual
   Next
neovim-flake Manual
Preface
1. Try it out
1.1. Using Prebuilt Configs
1.2. Available Configs
1.2.1. Nix
1.2.2. Tidal
1.2.3. Maximal
2. Default Configs
2.1. Tidal Cycles
2.2. Nix
2.3. Maximal
3. Custom Configuration
4. Custom Neovim Package
5. Custom Plugins
5.1. New Method
5.2. Old Method
6. Home Manager
7. Language Support
7.1. LSP Custom Packages/Command
8. Hacking neovim-flake
8.1. Getting started
8.2. Guidelines
8.2.1. Add adequate documentation
8.2.2. Format your code
8.2.3. Format your commit messages
8.2.4. Commits
8.2.5. Code Style
8.3. Testing Your Changes
8.4. Keybinds
8.4.1. Custom Key Mappings Support for a Plugin
8.5. Adding Plugins
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
B.5. Release 0.5
B.5.1. Changelog
Preface

+    If you believe your problem is caused by a bug in neovim-flake then please consider reporting it over
+    the neovim-flake issue tracker.
+    Bugfixes, feature additions and upstream changes are welcome over
+    the neovim-flake pull requests tab.
+  
Chapter 1. Try it out
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:
  • 
+Nix
+
  • 
+Tidal
+
  • 
+Maximal
+
You may try out any of the provided configurations using the nix run command on a system where Nix is installed.
$ 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
Do keep in mind that this is susceptible to garbage collection 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
+custom-configuration or home-manager sections for installation
+instructions.
1.1. 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.
{
+$ nix run github:notashelf/neovim-flake#maximal
1.2. Available Configs
1.2.1. Nix
Nix configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins.
+By running nix run ., which is the default package, you will build Neovim with this config.
1.2.2. Tidal
Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.
1.2.3. Maximal
Maximal 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.
You are strongly recommended to use the binary cache if you would like to try the Maximal configuration.
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 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.
{
   options = "The options that were available to configure";
   config = "The outputted configuration";
   pkgs = "The package set used to evaluate the module";
@@ -37,10 +49,30 @@ $ nix run github:notashelf/neovim-flake#maximal

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.

4.1. New Method

As of version 0.5, we have a more extensive API for configuring plugins, under vim.extraPlugins.

Instead of using DAGs exposed by the library, you may use the extra plugin module as follows:

{
+}

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 without using the home-manager module.

Chapter 4. Custom Neovim Package

As of v0.5, you may now specify the neovim package that will be wrapped with your configuration. This is done with the vim.package option.

{inputs, pkgs, ...}: {
+  # using the neovim-nightly overlay
+  config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
+}

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 neovim-unwrapped in nixpkgs.

Chapter 5. 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.

5.1. New Method

As of version 0.5, we have a more extensive API for configuring plugins, under vim.extraPlugins.

Instead of using DAGs exposed by the library, you may use the extra plugin module as follows:

{
   config.vim.extraPlugins = with pkgs.vimPlugins; {
     aerial = {
       package = aerial-nvim;
@@ -57,7 +89,8 @@ To add a plugin, you need to add it to your config’s con
       after = ["aerial"];
     };
   };
-}

4.2. Old Method

Users who have not yet updated to 0.5, or prefer a more hands-on approach may use the old method where the load orderof the plugins is determined by DAGs.

{
+}

5.2. Old Method

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.

{
   # fetch plugin source from GitHub and add it to startPlugins
   config.vim.startPlugins = [
     (pkgs.fetchFromGitHub {
@@ -67,25 +100,53 @@ To add a plugin, you need to add it to your config’s con
       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. +}

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:

{
+  # 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
   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. Custom Neovim Package

As of v0.5, you may now specify the neovim package that will be wrapped with your configuration. This is done with the vim.package option.

{inputs, pkgs, ...}: {
-  # using the neovim-nightly overlay
-  config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
-}

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 neovim-unwrapped in nixpkgs.

Chapter 6. Home Manager

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

{
+}

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 to find out more about +the DAG system.

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 6. Home Manager

The Home Manager module allows us to customize the different vim options from inside the home-manager configuration +and it is the preferred way of configuring neovim-flake, both on NixOS and non-NixOS systems.

To use it, we first add the input flake.

{
   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
   };
-}

Followed by importing the HM module.

{
-  imports = [ neovim-flake.homeManagerModules.default ];
-}

Then we should be able to use the given module. E.g.

{
+}

Followed by importing the home-manager module somewhere in your configuration.

{
+  # assuming neovim-flake is in your inputs and inputs is in the argset
+  imports = [ inputs.neovim-flake.homeManagerModules.default ];
+}

An example installation for standalone home-manager would look like this:

{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    home-manager.url = "github:nix-community/home-manager";
+    stylix.url = "github:notashelf/neovim-flake";
+  };
+
+  outputs = { nixpkgs, home-manager, neovim-flake ... }: let
+  system = "x86_64-linux"; in {
+    # ↓ this is the home-manager output in the flake schema
+    homeConfigurations."yourUsername»" = home-manager.lib.homeManagerConfiguration {
+      pkgs = nixpkgs.legacyPackages.x86_64-linux;
+      modules = [
+        neovim-flake.homeManagerModules.default # <- this imports the home-manager module that provides the options
+        ./home.nix # your home-manager configuration, probably where you will want to add programs.neovim-flake options
+      ];
+    };
+  };
+}

Once the module is imported, we will be able to define the following options (and much more) from inside the +home-manager configuration.

{
   programs.neovim-flake = {
 
     enable = true;
-    # your settings need to go into the settings attrset
+    # your settings need to go into the settings attribute set
+    # most settings are documented in the appendix
     settings = {
       vim.viAlias = false;
       vim.vimAlias = true;
@@ -94,7 +155,7 @@ These options are attribute sets, and you need to give the configuration you’r
       };
     };
   };
-}

Chapter 7. 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.

  • +}

    Note

    You may find all avaliable options in the appendix

Chapter 7. 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.

Adding support for more languages, and improving support for existing ones are great places where you can contribute with a PR.

7.1. LSP Custom Packages/Command

In any of the opt.languages.<language>.lsp.package options you can provide your own LSP package, or provide the command to launch the language server, as a list of strings.

You can use this to skip automatic installation of a language server, and instead use the one found in your $PATH during runtime, for example:

vim.languages.java = {
-        lsp = {
-                enable = true;
-                package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"];
+
  • 
+Lua: vim.languages.lua.enable
+

    • Adding support for more languages, and improving support for existing ones are great places +where you can contribute with a PR.

    7.1. LSP Custom Packages/Command

    In any of the opt.languages.<language>.lsp.package options you can provide your own LSP package, or provide +the command to launch the language server, as a list of strings.

    You can use this to skip automatic installation of a language server, and instead +use the one found in your $PATH during runtime, for example:

    vim.languages.java = {
+  lsp = {
+    enable = true;
+        package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"];
+  };
+}

    Chapter 8. Hacking neovim-flake

    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.

    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 open issues and +if no matching issue exists you may open a new issue 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.

    8.1. Getting started

    You naturally would like to start by forking the repository. If you are new to git, have a look at GitHub’s +Fork a repo guide 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 main branch. +Give your branch a reasonably descriptive name, suffixed by its type - i.e feature/debugger or fix/pesky-bug.

    Implement your changes and commit them to the newly created branch and when you are happy with the result and positive +that it fulfills Section 8.2, “Guidelines”. Once you are confident everything is in order, push the branch to GitHub and

    8.2. Guidelines

    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.

    If you are uncertain how these rules affect the change you would like to make then feel free to start a +discussion in the discussions tab ideally (but not necessarily) before you start developing.

    8.2.1. Add adequate documentation

    Most, if not all, changes warrant changes to the documentation. Module options should be documented with +Nixpkgs-flavoured Markdown, albeit with exceptions. +neovim-flake is itself documented using a combination of DocBook and AsciiDoc conventions.

    The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake +(such as this page) can be generated and opened by typing the following in a shell within a clone of the +neovim-flake Git repository:

    $ nix build .#docs-html
+$ xdg-open ./result/share/doc/neovim-flake/index.html

    8.2.2. Format your code

    Make sure your code is formatted as described in Section 8.2.5, “Code Style”. To maintain consistency throughout the project +you are encouraged to browse through existing code and adopt its style also in new code.

    8.2.3. Format your commit messages

    Similar to Section 8.2.2, “Format your code” we encourage a consistent commit message format as described +in Section 8.2.4, “Commits”.

    8.2.4. Commits

    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.

    The commit messages should follow the seven rules, 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

    {component}: {description}
+
+{long description}

    where {component} refers to the code component (or module) your change affects, {description} is a very brief +description of your change, and {long description} is an optional clarifying description. As a rare exception, if +there is no clear component, or your change affects many components, then the {component} part is optional. +See Example 8.1, “Compliant commit message” for a commit message that fulfills these requirements.

    Example 8.1. Compliant commit message

    The commit 69f8e47e9e74c8d3d060ca22e18246b7f7d988ef contains the commit message

    starship: allow running in Emacs if vterm is used
+
+The vterm buffer is backed by libvterm and can handle Starship prompts
+without issues.

    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.

    Finally, when adding a new module, say modules/foo.nix, we use the fixed commit format foo: add module. +You can, of course, still include a long description if you wish.

    In case of nested modules, i.e modules/languages/java.nix you are recommended to contain the parent as well - for +example languages/java: some major change.

    8.2.5. Code Style

    Treewide +Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module +descriptions and documentation.

    Nix +neovim-flake is formatted by the alejandra tool and the formatting is checked in the pull +request and push workflows. Run the nix fmt command inside the project repository before submitting your +pull request.

    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.

    Please use one line code for attribute sets that contain only one subset. +For example:

    # parent modules should always be unfolded
+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;
         };
-}
       Next
       Appendix A. Configuration Options
    \ No newline at end of file + }; +}

    If you move a line down after the merge operator, Alejandra will automatically unfold the whole merged attrset +for you, which we do not want.

    module = {
+    key = mkEnableOption "some description" // {
+        default = true; # we want this to be inline
+    };
+    # ...
+}

    For lists, it is mostly up to your own discretion how you want to format them, but please try to unfold lists if +they contain multiple items and especially if they are to include comments.

    # this is ok
+acceptableList = [
+    item1 # comment
+    item2
+    item3 # some other comment
+    item4
+];
+
+# this is not ok
+listToBeAvoided = [item1 item2 /* comment */ item3 item4];
+
+# this is ok
+singleItemList = [item1];

    8.3. Testing Your Changes

    Once you have made your changes, you will need to test them throughly. If it is a module, add your module option to +configuration.nix (located in the root of this project) inside neovimConfiguration. Enable it, and then run the +maximal configuration with nix run .#maximal -Lv to check for build errors. If neovim opens in the current directory +without any error messages (you can check the output of :messages 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.

    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 configuration.nix, and then run it with nix run .#maximal -Lv. Same procedure as +adding a new module will apply here.

    8.4. Keybinds

    As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in +the extended standard library. The following section contains +a general overview to how you may utilize said functions.

    8.4.1. Custom Key Mappings Support for a Plugin

    To set a mapping, you should define it in vim.maps.<<mode>>. +The available modes are:

    • +normal +
    • +insert +
    • +select +
    • +visual +
    • +terminal +
    • +normalVisualOp +
    • +visualOnly +
    • +operator +
    • +insertCommand +
    • +lang +
    • +command +

    An example, simple keybinding, can look like this:

    {
+  vim.maps.normal = {
+    "<leader>wq" = {
+      action = ":wq<CR>";
+      silent = true;
+      desc = "Save file and quit";
+    };
+  };
+}

    There are many settings available in the options. Please refer to the documentation to see a list of them.

    neovim-flake provides a list of helper commands, so that you don’t have to write the mapping attribute sets every +time:

    • +mkBinding = key: action: desc: - makes a basic binding, with silent set to true. +
    • +mkExprBinding = key: action: desc: - makes an expression binding, with lua, silent, and expr set to true. +
    • +mkLuaBinding = key: action: desc: - makes an expression binding, with lua, and silent set to true. +

    Note that the Lua in these bindings is actual Lua, not pasted into a :lua command. +Therefore, you either pass in a function like require('someplugin').some_function, without actually calling it, +or you define your own function, like function() require('someplugin').some_function() end.

    Additionally, to not have to repeat the descriptions, there’s another utility function with its own set of functions:

    # Utility function that takes two attrsets:
+# { someKey = "some_value" } and
+# { someKey = { description = "Some Description"; }; }
+# and merges them into
+# { someKey = { value = "some_value"; description = "Some Description"; }; }
+
+addDescriptionsToMappings = actualMappings: mappingDefinitions:

    This function can be used in combination with the same mkBinding functions as above, except they only take two +arguments - binding and action, and have different names:

    • +mkSetBinding = binding: action: - makes a basic binding, with silent set to true. +
    • +mkSetExprBinding = binding: action: - makes an expression binding, with lua, silent, and expr set to true. +
    • +mkSetLuaBinding = binding: action: - makes an expression binding, with lua, and silent set to true. +

    You can read the source code of some modules to see them in action, but their usage should look something like this:

    # plugindefinition.nix
+{lib, ...}:
+with lib; {
+  options.vim.plugin = {
+    enable = mkEnableOption "Enable plugin";
+
+    # Mappings should always be inside an attrset called mappings
+    mappings = {
+      # mkMappingOption is a helper function from lib,
+      # that takes a description (which will also appear in which-key),
+      # and a default mapping (which can be null)
+      toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc";
+      toggleCurrentBlock = mkMappingOption "Toggle current block comment" "gbc";
+
+      toggleOpLeaderLine = mkMappingOption "Toggle line comment" "gc";
+      toggleOpLeaderBlock = mkMappingOption "Toggle block comment" "gb";
+
+      toggleSelectedLine = mkMappingOption "Toggle selected comment" "gc";
+      toggleSelectedBlock = mkMappingOption "Toggle selected block" "gb";
+    };
+  };
+}
    # config.nix
+{
+  pkgs,
+  config,
+  lib,
+  ...
+}:
+with lib;
+with builtins; let
+  cfg = config.vim.plugin;
+  self = import ./plugindefinition.nix {inherit lib;};
+  mappingDefinitions = self.options.vim.plugin;
+
+  # addDescriptionsToMappings is a helper function from lib,
+  # that merges mapping values and their descriptions
+  # into one nice attribute set
+  mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions;
+in {
+  config = mkIf (cfg.enable) {
+    # ...
+
+    vim.maps.normal = mkMerge [
+      # mkSetBinding is another helper function from lib,
+      # that actually adds the mapping with a description.
+      (mkSetBinding mappings.findFiles "<cmd> Telescope find_files<CR>")
+      (mkSetBinding mappings.liveGrep "<cmd> Telescope live_grep<CR>")
+      (mkSetBinding mappings.buffers "<cmd> Telescope buffers<CR>")
+      (mkSetBinding mappings.helpTags "<cmd> Telescope help_tags<CR>")
+      (mkSetBinding mappings.open "<cmd> Telescope<CR>")
+
+      (mkSetBinding mappings.gitCommits "<cmd> Telescope git_commits<CR>")
+      (mkSetBinding mappings.gitBufferCommits "<cmd> Telescope git_bcommits<CR>")
+      (mkSetBinding mappings.gitBranches "<cmd> Telescope git_branches<CR>")
+      (mkSetBinding mappings.gitStatus "<cmd> Telescope git_status<CR>")
+      (mkSetBinding mappings.gitStash "<cmd> Telescope git_stash<CR>")
+
+      (mkIf config.vim.lsp.enable (mkMerge [
+        (mkSetBinding mappings.lspDocumentSymbols "<cmd> Telescope lsp_document_symbols<CR>")
+        (mkSetBinding mappings.lspWorkspaceSymbols "<cmd> Telescope lsp_workspace_symbols<CR>")
+
+        (mkSetBinding mappings.lspReferences "<cmd> Telescope lsp_references<CR>")
+        (mkSetBinding mappings.lspImplementations "<cmd> Telescope lsp_implementations<CR>")
+        (mkSetBinding mappings.lspDefinitions "<cmd> Telescope lsp_definitions<CR>")
+        (mkSetBinding mappings.lspTypeDefinitions "<cmd> Telescope lsp_type_definitions<CR>")
+        (mkSetBinding mappings.diagnostics "<cmd> Telescope diagnostics<CR>")
+      ]))
+
+      (
+        mkIf config.vim.treesitter.enable
+        (mkSetBinding mappings.treesitter "<cmd> Telescope treesitter<CR>")
+      )
+    ];
+
+    # ...
+  };
+}

    Note

    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.

    8.5. Adding Plugins

    To add a new neovim plugin, first add the source url in the inputs section of flake.nix

    {
+    inputs = {
+        # ...
+        neodev-nvim = {
+            url = "github:folke/neodev.nvim";
+            flake = false;
+        };
+    };
+}

    Then add the name of the plugin into the availablePlugins variable in lib/types/plugins.nix:

    # ...
+availablePlugins = [
+    # ...
+    "neodev-nvim"
+];

    You can now reference this plugin using its string name:

    config.vim.startPlugins = ["neodev-nvim"];
       Next
       Appendix A. Configuration Options
    \ No newline at end of file diff --git a/options.html b/options.html index 3a521eeb..b6986f80 100644 --- a/options.html +++ b/options.html @@ -28,7 +28,7 @@ the nixpkgs.pkgs option.

    vim.enableLuaLoader

    Whether to enable experimental Lua module loader to speed up the start up process.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/basic/module.nix> -
    vim.package

    The neovim package to use. You will need to use an unwrapped package for this option to work as intended.

    Type: package

    Default: <derivation neovim-unwrapped-0.9.1>

    Declared by:

    +
    vim.package

    The neovim package to use. You will need to use an unwrapped package for this option to work as intended.

    Type: package

    Default: <derivation neovim-unwrapped-0.9.2>

    Declared by:

    <neovim-flake/modules/basic/module.nix>
    vim.assistant.copilot.enable

    Whether to enable GitHub Copilot AI assistant.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/assistant/copilot/copilot.nix> @@ -38,7 +38,7 @@ the nixpkgs.pkgs option.

    Type: string

    Default: "\${pkgs.nodejs-slim.out}/bin/node"

    Declared by:

    <neovim-flake/modules/assistant/copilot/copilot.nix>
    vim.assistant.copilot.copilotNodePackage

    The nodeJS package that will be used for GitHub Copilot. If you are using a custom node command -you may want to set this option to null so that the package is not pulled from nixpkgs.

    Type: null or package

    Default: <derivation nodejs-slim-18.16.1>

    Declared by:

    +you may want to set this option to null so that the package is not pulled from nixpkgs.

    Type: null or package

    Default: <derivation nodejs-slim-18.18.0>

    Declared by:

    <neovim-flake/modules/assistant/copilot/copilot.nix>
    vim.assistant.copilot.mappings.panel.accept

    Accept suggestion

    Type: null or string

    Default: "<CR>"

    Declared by:

    <neovim-flake/modules/assistant/copilot/copilot.nix> @@ -785,7 +785,7 @@ https://www.reddit.com/r/neovim/comments/orfpcd/question_does_the_c_parser_from_ <neovim-flake/modules/languages/clang.nix>
    vim.languages.clang.lsp.enable

    Whether to enable Enable clang LSP support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/clang.nix> -
    vim.languages.clang.lsp.package

    clang LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation ccls-0.20220729>

    Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

    Declared by:

    +
    vim.languages.clang.lsp.package

    clang LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation ccls-0.20230717>

    Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

    Declared by:

    <neovim-flake/modules/languages/clang.nix>
    vim.languages.clang.lsp.opts

    Options to pass to clang LSP server

    Type: null or string

    Default: null

    Declared by:

    <neovim-flake/modules/languages/clang.nix> @@ -841,7 +841,7 @@ If you are using a flutter SDK installed from a different source and encounter t <neovim-flake/modules/languages/go.nix>
    vim.languages.go.lsp.enable

    Whether to enable Enable Go LSP support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/go.nix> -
    vim.languages.go.lsp.package

    Go LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation gopls-0.12.4>

    Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

    Declared by:

    +
    vim.languages.go.lsp.package

    Go LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation gopls-0.13.2>

    Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

    Declared by:

    <neovim-flake/modules/languages/go.nix>
    vim.languages.go.lsp.server

    Go LSP server to use

    Type: value "gopls" (singular enum)

    Default: "gopls"

    Declared by:

    <neovim-flake/modules/languages/go.nix> @@ -861,7 +861,7 @@ If you are using a flutter SDK installed from a different source and encounter t <neovim-flake/modules/languages/java.nix>
    vim.languages.java.lsp.enable

    Whether to enable Java LSP support (java-language-server).

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/java.nix> -
    vim.languages.java.lsp.package

    java language server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation jdt-language-server-1.21.0>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    +
    vim.languages.java.lsp.package

    java language server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation jdt-language-server-1.26.0>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    <neovim-flake/modules/languages/java.nix>
    vim.languages.java.treesitter.enable

    Whether to enable Enable Java treesitter.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/java.nix> @@ -871,7 +871,7 @@ If you are using a flutter SDK installed from a different source and encounter t <neovim-flake/modules/languages/lua.nix>
    vim.languages.lua.lsp.enable

    Whether to enable Enable Lua LSP support via LuaLS.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/lua.nix> -
    vim.languages.lua.lsp.package

    LuaLS package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation lua-language-server-3.6.25>

    Declared by:

    +
    vim.languages.lua.lsp.package

    LuaLS package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation lua-language-server-3.7.0>

    Declared by:

    <neovim-flake/modules/languages/lua.nix>
    vim.languages.lua.lsp.neodev.enable

    Whether to enable Enable neodev.nvim integration, useful for neovim plugin developers.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/lua.nix> @@ -906,7 +906,7 @@ If you are using a flutter SDK installed from a different source and encounter t <neovim-flake/modules/languages/nix.nix>
    vim.languages.nix.lsp.enable

    Whether to enable Enable Nix LSP support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/nix.nix> -
    vim.languages.nix.lsp.package

    Nix LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation nil-2023-05-09>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    +
    vim.languages.nix.lsp.package

    Nix LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation nil-2023-08-09>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    <neovim-flake/modules/languages/nix.nix>
    vim.languages.nix.lsp.server

    Nix LSP server to use

    Type: string

    Default: "nil"

    Declared by:

    <neovim-flake/modules/languages/nix.nix> @@ -925,19 +925,19 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/python.nix>
    vim.languages.python.format.enable

    Whether to enable Enable Python formatting.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/python.nix> -
    vim.languages.python.format.package

    Python formatter package

    Type: package

    Default: <derivation black-23.3.0>

    Declared by:

    +
    vim.languages.python.format.package

    Python formatter package

    Type: package

    Default: <derivation black-23.9.1>

    Declared by:

    <neovim-flake/modules/languages/python.nix>
    vim.languages.python.format.type

    Python formatter to use

    Type: value "black" (singular enum)

    Default: "black"

    Declared by:

    <neovim-flake/modules/languages/python.nix>
    vim.languages.python.lsp.enable

    Whether to enable Enable Python LSP support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/python.nix> -
    vim.languages.python.lsp.package

    python LSP server package, or the command to run as a list of strings

    Type: package or list of Concatenated string

    Default: <derivation pyright-1.1.318>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    +
    vim.languages.python.lsp.package

    python LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation pyright-1.1.329>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    <neovim-flake/modules/languages/python.nix>
    vim.languages.python.lsp.server

    Python LSP server to use

    Type: value "pyright" (singular enum)

    Default: "pyright"

    Declared by:

    <neovim-flake/modules/languages/python.nix>
    vim.languages.python.treesitter.enable

    Whether to enable Enable Python treesitter.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/python.nix> -
    vim.languages.python.treesitter.package

    Python treesitter grammar to use

    Type: package

    Default: <derivation python-grammar-0.0.0+rev=7c8930b>

    Declared by:

    +
    vim.languages.python.treesitter.package

    Python treesitter grammar to use

    Type: package

    Default: <derivation python-grammar-0.0.0+rev=a901729>

    Declared by:

    <neovim-flake/modules/languages/python.nix>
    vim.languages.rust.enable

    Whether to enable Rust language support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/rust.nix> @@ -951,7 +951,7 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/rust.nix>
    vim.languages.rust.lsp.enable

    Whether to enable Rust LSP support (rust-analyzer with extra tools).

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/rust.nix> -
    vim.languages.rust.lsp.package

    rust-analyzer package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation rust-analyzer-2023-07-17>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    +
    vim.languages.rust.lsp.package

    rust-analyzer package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation rust-analyzer-2023-10-02>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    <neovim-flake/modules/languages/rust.nix>
    vim.languages.rust.lsp.opts

    Options to pass to rust analyzer

    Type: string

    Default: ""

    Declared by:

    <neovim-flake/modules/languages/rust.nix> @@ -971,7 +971,7 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/sql.nix>
    vim.languages.sql.format.enable

    Whether to enable Enable SQL formatting.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/sql.nix> -
    vim.languages.sql.format.package

    SQL formatter package

    Type: package

    Default: <derivation sqlfluff-2.1.2>

    Declared by:

    +
    vim.languages.sql.format.package

    SQL formatter package

    Type: package

    Default: <derivation sqlfluff-2.3.2>

    Declared by:

    <neovim-flake/modules/languages/sql.nix>
    vim.languages.sql.format.type

    SQL formatter to use

    Type: value "sqlfluff" (singular enum)

    Default: "sqlfluff"

    Declared by:

    <neovim-flake/modules/languages/sql.nix> @@ -983,7 +983,7 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/sql.nix>
    vim.languages.sql.treesitter.enable

    Whether to enable Enable SQL treesitter.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/sql.nix> -
    vim.languages.sql.treesitter.package

    SQL treesitter grammar to use

    Type: package

    Default: <derivation sql-grammar-0.0.0+rev=9fc30c9>

    Declared by:

    +
    vim.languages.sql.treesitter.package

    SQL treesitter grammar to use

    Type: package

    Default: <derivation sql-grammar-0.0.0+rev=39750c4>

    Declared by:

    <neovim-flake/modules/languages/sql.nix>
    vim.languages.svelte.enable

    Whether to enable Svelte language support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/svelte.nix> @@ -995,13 +995,13 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/svelte.nix>
    vim.languages.svelte.format.enable

    Whether to enable Enable Svelte formatting.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/svelte.nix> -
    vim.languages.svelte.format.package

    Svelte formatter package

    Type: package

    Default: <derivation prettier-3.0.0>

    Declared by:

    +
    vim.languages.svelte.format.package

    Svelte formatter package

    Type: package

    Default: <derivation prettier-3.0.3>

    Declared by:

    <neovim-flake/modules/languages/svelte.nix>
    vim.languages.svelte.format.type

    Svelte formatter to use

    Type: value "prettier" (singular enum)

    Default: "prettier"

    Declared by:

    <neovim-flake/modules/languages/svelte.nix>
    vim.languages.svelte.lsp.enable

    Whether to enable Enable Svelte LSP support.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/svelte.nix> -
    vim.languages.svelte.lsp.package

    Svelte LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation svelte-language-server-0.15.16>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    +
    vim.languages.svelte.lsp.package

    Svelte LSP server package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation svelte-language-server-0.15.19>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    <neovim-flake/modules/languages/svelte.nix>
    vim.languages.svelte.lsp.server

    Svelte LSP server to use

    Type: value "svelte" (singular enum)

    Default: "svelte"

    Declared by:

    <neovim-flake/modules/languages/svelte.nix> @@ -1019,7 +1019,7 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/ts.nix>
    vim.languages.ts.format.enable

    Whether to enable Enable Typescript/Javascript formatting.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/ts.nix> -
    vim.languages.ts.format.package

    Typescript/Javascript formatter package

    Type: package

    Default: <derivation prettier-3.0.0>

    Declared by:

    +
    vim.languages.ts.format.package

    Typescript/Javascript formatter package

    Type: package

    Default: <derivation prettier-3.0.3>

    Declared by:

    <neovim-flake/modules/languages/ts.nix>
    vim.languages.ts.format.type

    Typescript/Javascript formatter to use

    Type: one of "prettier", "prettierd"

    Default: "prettier"

    Declared by:

    <neovim-flake/modules/languages/ts.nix> @@ -1039,9 +1039,9 @@ This is a python package with debugpy installed, see https://nixos.wiki/wiki/Pyt <neovim-flake/modules/languages/zig.nix>
    vim.languages.zig.lsp.enable

    Whether to enable Zig LSP support (zls).

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/zig.nix> -
    vim.languages.zig.lsp.package

    ZLS package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation zls-0.10.0>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    +
    vim.languages.zig.lsp.package

    ZLS package, or the command to run as a list of strings

    Type: package or list of string

    Default: <derivation zls-0.11.0>

    Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

    Declared by:

    <neovim-flake/modules/languages/zig.nix> -
    vim.languages.zig.lsp.zigPackage

    Zig package used by ZLS

    Type: package

    Default: <derivation zig-0.10.1>

    Declared by:

    +
    vim.languages.zig.lsp.zigPackage

    Zig package used by ZLS

    Type: package

    Default: <derivation zig-0.11.0>

    Declared by:

    <neovim-flake/modules/languages/zig.nix>
    vim.languages.zig.treesitter.enable

    Whether to enable Enable Zig treesitter.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/languages/zig.nix> @@ -1788,7 +1788,7 @@ Thus, it will not be wrapped in `""`.

    Type:

    vim.terminal.toggleterm.lazygit.enable

    Whether to enable LazyGit integration.

    Type: boolean

    Default: false

    Example: true

    Declared by:

    <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
    vim.terminal.toggleterm.lazygit.package

    The package that should be used for lazygit. Setting it to null will attempt to use lazygit from your PATH

    Type: null or package

    Default: <derivation lazygit-0.39.4>

    Declared by:

    +
    vim.terminal.toggleterm.lazygit.package

    The package that should be used for lazygit. Setting it to null will attempt to use lazygit from your PATH

    Type: null or package

    Default: <derivation lazygit-0.40.2>

    Declared by:

    <neovim-flake/modules/terminal/toggleterm/toggleterm.nix>
    vim.terminal.toggleterm.lazygit.direction

    Direction of the lazygit window

    Type: one of "horizontal", "vertical", "tab", "float"

    Default: "float"

    Declared by:

    <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> diff --git a/release-notes.html b/release-notes.html index 0a7a51a5..8abfc9ac 100644 --- a/release-notes.html +++ b/release-notes.html @@ -1,5 +1,5 @@ -Appendix B. Release Notes
    Appendix B. Release Notes
    Prev   

    Appendix 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

    This section lists the release notes for tagged version of neovim-flake and current main.

    B.1. Release 0.1

    This is the current master branch and information here is not final. These are changes from the v0.01 tag.

    Special thanks to home-manager for this release. Docs/manual generation, the new module evaluation system, and DAG implementation are from them.

    B.1.1. Changelog

    jordanisaacs:

    • +Appendix B. Release Notes
      Appendix B. Release Notes
      Prev   

      Appendix 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
      B.5. Release 0.5
      B.5.1. Changelog

      This section lists the release notes for tagged version of neovim-flake and current main.

      B.1. Release 0.1

      This is the current master branch and information here is not final. These are changes from the v0.01 tag.

      Special thanks to home-manager for this release. Docs/manual generation, the new module evaluation system, and DAG implementation are from them.

      B.1.1. Changelog

      jordanisaacs:

      • Removed hare language support (lsp/tree-sitter/etc). vim.lsp.hare is no longer defined. If you use hare and would like it added back, please file an issue.

      • vim.startPlugins & vim.optPlugins are now an enum of string for options sourced from the flake inputs. Users can still provide vim plugin packages. @@ -172,4 +172,52 @@ Added prettierd as an alternative formatter to prettier - currently defaults to Fixed presence.nvim inheriting the wrong client id

      • Cleaned up documentation +

      B.5. Release 0.5

      B.5.1. Changelog

      horriblename:

      • +Added transparency support for tokyonight theme. +
      • +Fixed a bug where cmp’s close and scrollDocs mappings wasn’t working. +
      • +Streamlined and simplified extra plugin API with the addition of vim.extraPlugins +
      • +Allow using command names in place of LSP packages to avoid automatic installation. +
      • +Add lua LSP and treesitter support, and neodev.nvim plugin support. +

      amanse:

      • +Added daily notes options for obsidian plugin. +
      • +Added jdt-language-server for Java. +

      yavko:

      frothymarrow:

      notashelf:

      • +Added GitHub Copilot to nvim-cmp completion sources. +
      • +Added vim.ui.borders.enable for global and individual plugin border configuration. +
      • +LSP integrated breadcrumbs with vim.ui.breadcrumbs.enable through nvim-navic +
      • +LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically enabled) +
      • +Addeed nvim-navic integration for catppuccin theme +
      • +Fixed mismatching zig language description +
      • +Added support for statix and deadnix through vim.languages.nix.extraDiagnostics.types +
      • +Added lsp_lines plugin for showing diagnostic messages +
      • +Added a configuration option for choosing the leader key +
      • +The package used for neovim is now customizable by the user, using vim.package. For best results, always use an unwrapped package. +

      jacekpoz:

      • +Fixed scrollOffset not being used +
      • +Updated clangd to 16 +
      • +Disabled useSystemClipboard by default
      Prev   
      Appendix A. Configuration Options Home 
      \ No newline at end of file