7.6 KiB
neovim-flake
Get Started
Using nix
If you would like to try out the configuration before even thinking about installing it, you can run:
nix run github:notashelf/neovim-flake
to get a feel for the base configuration. The package exposes .#nix as the default package. You may use .#nix, .#tidal or .#maximal to get different configurations.
It is as simply as changing the target output to get a different configuration. For example, to get a configuration with tidal support, run:
nix run github:notashelf/neovim-flake#tidal
Similar instructions will apply for nix profile install.
P.S. The maximal configuration is massive and will take a while to build. To get a feel for the configuration, use the default nix or tidal configurations.
Documentation
See the neovim-flake Manual for detailed installation guide(s), configuration, available options, and release notes.
If you want to dive right into trying neovim-flake you can get a fully featured configuration with nix language support by running:
nix run github:notashelf/neovim-flake
Please create an issue on the issue tracker if you find the documentation lacking or confusing. I also appreciate any contributions to the documentation.
Help
You can create an issue on the issue tracker to ask questions or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue tracker for now.
Contributing
I am always looking for new ways to help improve this flake. If you would like to contribute, please read the contributing guide before submitting a pull request. You can also create an issue on the issue tracker before submitting a pull request if you would like to discuss a feature or bug fix.
Philosophy
The philosophy behind this flake configuration is to create an easily configurable and reproducible Neovim environment. While it does sacrifice in size (which I know some users will find disagreeable), it offers a lot of flexibility and customizability in exchange for the large size of the flake inputs. The KISS (Keep it simple, stupid) principle has been abandoned here, but you can ultimately declare a configuration that follows KISS. For it is very easy to bring your own plugins and configurations. Whether you are a developer, writer, or live coder (see tidal cycles below!), quickly craft a config that suits every project's need. Think of it like a distribution of Neovim that takes advantage of pinning vim plugins and third party dependencies (such as tree-sitter grammars, language servers, and more).
One should never get a broken config when setting options. If setting multiple options results in a broken Neovim, file an issue! Each plugin knows when another plugin which allows for smart configuration of keybindings and automatic setup of things like completion sources and languages.
FAQ
Q: Why is this flake so big?
A: I have sacrificed in size in order to provide a highly configurable and reproducible Neovim environment. A binary cache is provided to
eleminate the need to build the flake from source, but it is still a large flake. If you do not need all the features, you can use the default nix output
instead of the maximal output. This will reduce size by a lot, but you will lose some language specific features.
Q: Will you try to make this flake smaller?
A: Yes. As a matter of fact, I am actively working on making this flake smaller. Unfortunately the process of providing everything possible by itself makes the flake large. Best I can do is to optimize the flake as much as possible by selecting plugins that are small and fast. And the binary cache, so at least you don't have to build it from source.
Q: Will you use a plugin manager?
A: No. If you feel the need to ask that question, then you have missed the whole point of using nix and ultimately this flake. We load plugins with raw lua.
Q: Can you add X?
A: Maybe. Open an issue using the appropriate template and I will consider it. I do not intend to add every plugin that is in existence, but I will consider it, should it offer something useful to the flake.
Credits
Contributors
- @fufexan - For the transition to flake-parts
Inspiration
This configuration is based on a few other configurations, including:
I am grateful for their previous work and inspiration.