Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/klen/nvim-config-local
Secure load local config files for neovim
https://github.com/klen/nvim-config-local
neovim neovim-configuration neovim-plugin nvim nvim-configs nvim-plugin
Last synced: about 2 months ago
JSON representation
Secure load local config files for neovim
- Host: GitHub
- URL: https://github.com/klen/nvim-config-local
- Owner: klen
- License: mit
- Created: 2021-12-22T21:13:13.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-15T14:00:21.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:45:32.936Z (4 months ago)
- Topics: neovim, neovim-configuration, neovim-plugin, nvim, nvim-configs, nvim-plugin
- Language: Lua
- Homepage:
- Size: 55.7 KB
- Stars: 144
- Watchers: 2
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - klen/nvim-config-local - Secure load local config files from working directories. (Project / PHP)
README
# nvim-config-local 2.1.0
Secure load local config files.
[](https://github.com/klen/nvim-config-local/actions/workflows/tests.yml)
[](https://github.com/rockerBOO/awesome-neovim)
Vim provides a feature called `exrc`, which allows to use config files that are
local to the current working directory. However, unconditionally sourcing
whatever files we might have in our current working directory can be
potentially dangerous. ~~Because of that, neovim has disabled the feature.~~
(reenabled from version 0.9) The plugin tries to solve this issue by keeping
track of file hashes and allowing only trusted files to be sourced.
## Usage
When the plugin detects a new config file, it will ask what do you want to do
with it:
```
[config-local]: Unknown config file found: ".nvim.lua"
[s]kip, (o)pen, (i)gnore, (t)rust:
```
You can either `s`kip this file for now, `o`pen it to see if it doesn't contain
anything malicious, `i`ignore the file so `config-local` won't ask you about it
again, or `t`rust (mark it trusted) and source it right away.
To manually mark file as trusted, open the config file with `:edit .nvim.lua` or
`:ConfigEdit` and save it. You will be asked to trust the current config file.
File has to be marked as trusted each time its contents or path changes.
## Install
with [packer](https://github.com/wbthomason/packer.nvim):
```lua
use {
"klen/nvim-config-local",
config = function()
require('config-local').setup {
-- Default options (optional)
-- Config file patterns to load (lua supported)
config_files = { ".nvim.lua", ".nvimrc", ".exrc" },
-- Where the plugin keeps files data
hashfile = vim.fn.stdpath("data") .. "/config-local",
autocommands_create = true, -- Create autocommands (VimEnter, DirectoryChanged)
commands_create = true, -- Create commands (ConfigLocalSource, ConfigLocalEdit, ConfigLocalTrust, ConfigLocalIgnore)
silent = false, -- Disable plugin messages (Config loaded/ignored)
lookup_parents = false, -- Lookup config files in parent directories
}
end
}
```
## Commands
The plugin defines the commands:
- `ConfigLocalSource` - Source config file from the current working directory
- `ConfigLocalEdit` - Edit (create) config file for the current working directory
- `ConfigLocalTrust` - Add config file for the current working directory to trusted files.
- `ConfigLocalIgnore` - Add config file for the current working directory to ignore files.
## Events
The plugin sends event `User ConfigLocalLoaded` after loading configuration.
So users may bind `autocmd` to the event:
```vim
autocmd User ConfigLocalFinished lua my_custom_function()
```