nix-neovim

KO | EN

gitlite — search

#typescript #go #golang #machine-learning #deep-learning #docker #java #windows #cli #kubernetes #awesome-list #security #openai #open-source

(★ 19)

Declaratively configure neovim with the magic of nix! Personal toy project.

nix-neovim 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

nix-neovim
==========

The goal of this project is to have a [NixOS](https://nixos.org)- and [home-manager](https://github.com/nix-community/home-manager)-like way to manage my neovim installation.
I will add stuff I use but it is completely extendible by everyone! You can split up your configuration into modules because I'm piggybacking off the NixOS module system.

![The output of running `:checkhealth`.](https://raw.githubusercontent.com/syberant/nix-neovim/main/checkhealth.png)

Usage
-----
This project gives you the function `buildNeovim` that takes a `configuration` and `pkgs`.
Available options for configuration can be found by running `:help nix-neovim-configuration.txt` inside of a neovim instance produced by nix-neovim.
A very basic example configuration goes as follows:
```nix
# config.nix
{ pkgs, ... }:

{
  # imports = [ <your other modules here> ];

vim = {
    keybindings = {
      leader = " ";
      which-key-nvim = true;

keybindings-shortened = {
        "<leader>;" = {
          command = "<Plug>NERDCommenterToggle";
          options.silent = true;
        };
      };
    };

g.tokyonight_style = "storm";
    opt.showmode = false;
  };

output = {
    path.style = "pure";
    plugins = with pkgs.vimPlugins; [
      nerdcommenter
      vim-nix
      tokyonight-nvim
    ];
    extraConfig = ''
      colorscheme tokyonight
    '';
  };
}

# flake.nix
{
  inputs = { nix-neovim.url = "github:syberant/nix-neovim"; };

outputs = { self, nix-neovim }: {
    # For nix build
    defaultPackage."x86_64-linux" = nix-neovim.buildNeovim {
      configuration = ./config.nix;
      # pkgs = <your own instance of nixpkgs here>;
    };

# For nix run
    defaultApp."x86_64-linux" = {
      type = "app";
      program = "${self.defaultPackage."x86_64-linux"}/bin/nvim";
    };
  };
}
```
Now you can try it out with `nix run .#`!

You could also try out some premade configs:
```bash
$ # Try out the example (./test.nix) configuration
$ nix run github:syberant/nix-neovim
$ # Or my personal configuration (warning: it has LARGE dependencies, LaTeX in particular.)
$ nix run github:syberant/nix-config#neovim
```

Philosophy
----------
Early on this project contained default configurations for many common plugins, each with relevant options.
This caused a great deal of pain as there was little distinction between `nix-neovim` and [my personal neovim config](https://github.com/syberant/nix-config/blob/master/configuration/home-manager/modules/neovim/configuration.nix) and constantly updating these options turned out to be very opinionated and problematic (trying to get them complete even more so).
If extensive and elaborate options appeal to you go check out some of the other projects in the [Links](#links) section!

My current goal for this project is to explicitly exclude configuration of specific plugins and instead only provide tools for managing neovim configuration with Nix.
This results in features like:
- `vim.opt` to set options (`set KEY=VALUE` in vimscript)
- `vim.g` to set global variables (`let g:KEY=VALUE` in vimscript)
- `vim.keybindings` to set keymappings (a hot mess in vimscript)
- Purity modes
- `plugin.setup` to handle the common pattern `require(KEY).setup(VALUE)` of lua plugins

Many of these features are accomplished by allowing users to define a Nix set and then generating an equivalent JSON file, lua code then reads that JSON file and does the appropriate configuration.
This allows splitting up your configuration into many small modules as these Nix sets are merged together like you expect.

Debugging
---------
`nix-neovim` provides some tools for helping you debug your neovim config:
- `:help nix-neovim-configuration.txt` contains a complete list of options, similar to `man configuration.nix` for NixOS
- `:checkhealth nix_neovim` for a quick overview of your configuration
- `:NixNeovimRc` opens your generated vimrc
- `:NixNeovimPlugins` opens the directory of your installed plugins
- Switching between purity modes (see `:h output.path.style`) can be done live:
    - `:NixNeovimPathPure` sets `$PATH` to only contain packages defined in `output.path.path`
    - `:NixNeovimPathImpure` prefixes `$PATH` with packages defined in `output.path.path`
    - `:NixNeovimPathNopath` resets `$PATH` to your own environment

Links
-----
- [vi-tality/neovitality](https://github.com/vi-tality/neovitality), another project aiming to configure neovim with Nix
- [pta2002/nixvim](https://github.com/pta2002/nixvim), also aiming to configure neovim with Nix
- [Nixpkgs manual section on (neo)vim](https://nixos.org/manual/nixpkgs/stable/#vim), nix-neovim depends on this Nixpkgs functionality
- [nanotee/nvim-lua-guide](https://github.com/nanotee/nvim-lua-guide), guide to using lua for neovim configuration, used for writing much of the internals of nix-neovim

nix-neovim

nix-neovim 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

nix-neovim

nix-neovim 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README