neoconf
neoconf copied to clipboard
Cli-Tool to handle Neovim configuration.
Neoconf - Neovim Config-Tool
Neoconf is a CLI-Tool to help configuring Neovim.
WIP
It is highly WIP so use at own risk.
Goals
- Lua-Free configuration: no need to open the actual configuration files
- Flexible integration: run from terminal or as a Neovim plugin
- Abstraction for config: no obscure values you have to google/:help to find out what they do
- sensible defaults
- helpers, f.e. install language servers
- database of plugins incl. installations / stars, searchable
Basics
Simply make sure neoconf is in your $PATH. Download the binary from here or build from source:
git clone https://github.com/abenz1267/neoconf
cd neoconf
go install
init: looks for all required folders/files and creates them, if they don't already exist. Also installs all plugins listed in the "plugins.json" file.
Plugin Management
Barebone management of plugins is in place! Not defining a branch explicitly -> neoconf will first try to clone master, if that fails it will try to clone main. Right now it is not possible to define opt packages. Installation & updates are processed concurrently.
Commands:
install <plugin1> <plugin2> ...: installs all plugins provided and all missing plugins from 'plugins.json'. Creates plugin configuration-file underlua/plugins- Branch:
glepnir/galaxyline.nvim@SOMEBRANCH - ....what about post-install hooks, bro? This is a bit sub-optimal at the moment: neoconf will look for a
cd DIR && yarn installoryarn installcommand in the repository's README file. I'd definitely prefer aconfig.jsonfile with meta-data to be parsed, but this would require work from maintainers.
- Branch:
update: updates all pluginsclean: removes plugins not found in "plugins.json", removes<plugin>.luafromlua/pluginsremove: this will list all plugins installed and prompt you to enter the index of the plugins you want to remove. Does not remove plugin config. Automatically.list: Simply lists all plugins installed.
Todo
- Configuration management (editor configuration, ...plugin configuration?)
- create a database in order to be able to search for plugins
- neovim plugin!