dotnvim

Extend your neovim configuration on a per-project basis.

What is it?

dotnvim allows you to create project specific neovim configurations so you don't have to pile on configurations you only need in specific circumstances. When you open neovim and the plugin is loaded it will source your configuration files.

How do I use it?

Add the plugin. Here's an example for packer using the defaults:

use { 
  "Steven0351/dotnvim",
  requires = "nvim-lua/plenary.nvim",
  config = function()
    require("dotnvim").setup {}
  end
}

Currently the default options are

{
  project_configs_parent_dir = "~/.config/dotnvim"
}

There are two primary ways to use it

In the project itself

Create a .nvim file with your configurations. For example:

-- .nvim 
local lspconfig = require("lspconfig")
lspconfig.sumneko_lua.setup {}

If you need something a bit more complex, you can create a lua module inside of an .nvim directory:

.nvim
└── lua
    └── yourmodule
        ├── init.lua
        └── other.lua

In a config directory

In your project_configs_parent_dir, create a folder that matches the folder name of the project you want to source configurations for. For example, if I had a project at ~/Projects/web/my-cool-spa, you would create a folder in ~/.config/dotnvim/my-cool-spa (assuming you leave the default configuration directory).

Once you've created your project specific directory, you can either put your configuration in a init.lua file in the root of that directory, or create a lua module at lua/yourmodule:

project_configuration_parent_dir
└── project_name
    └── init.lua

or

project_configuration_parent_dir
└── project_name
    └── lua
        └── yourmodule
            ├── init.lua
            └── other.lua

Security

This plugin loads arbitrary code to be executed. Be mindful of what you are cloning and loading. At some point I may add some security features to allow users to preview what is attempting to be loaded before doing so, but this is not currently a priority for me since the usage is targeted at my needs.

Contributing

Issues are disabled. If you want to fix something, open a PR. I make no guarantees on accepting additional features that I do not intend to use myself.