Distro agnostic Neovim plugin to upgrade your current distro from its github remote.
If you use Neovim in multiple machines, you can use the command :DistroUpdate
to get the latest changes of your config from your GitHub repository from any
device.
If you are developing a Neovim distro, you can ship this plugin, and users will
get updates from your distro GitHub repository when they run :DistroUpdate
.
Running :DistroUpdate
will overwrite any uncommited change in your
local nvim config.
This plugin requires you to use lazy package manager
{
"Zeioth/distroupgrade.nvim",
dependencies = "nvim-lua/plenary.nvim",
event = "VeryLazy",
opts = {}
}
Command | Description |
---|---|
:DistroUpdate | If the value of the option channel is stable , it will update from the latest available released version of the remote of the git repository of your nvim config. If the value of channel is nightly , it will update from the latest changes in the branch nightly of the git repository of your nvim config. |
:DistroUpdateRevert | Uses git to bring your config to the state it had before running :DistroUpdate . |
:DistroFreezePluginVersions | Saves your current plugin versions into lazy_versions.lua in your config directory. You can import this file and pass it to your lazy config, so it respects your locked versions. Check the option spec in lazy. |
:DistroReadVersion | Prints the commit number of the current distro version. |
:DistroReadChangelog | Prints the changelog. |
All options described here are 100% optional and you don't need to define them to use this plugin.
Options to configure what version/commit will be downloaded.
Name | Default value | Description |
---|---|---|
channel | stable |
Channel used by the command :DistroUpdate . stable will update the distro from the latest available released version of your git repository. nightly will update the distro from the nightly branch of your git repository. |
commit | nil |
If this option is specified, it will prevail over release_tag and channel . |
release_tag | nil |
If this option is specified, it will prevail over channel . The format must be semantic versioning, like: "v1.0" . |
remote | origin |
If you have multiple remotes, you can specify the one to use with this option. |
Options to configure what happen during the update.
Name | Default value | Description |
---|---|---|
overwrite_uncommitted_local_changes | true |
If true, uncommitted local changes will be lost. If false, the update will fail with an error. |
update_plugins | true |
If true, after :DistroUpdate , plugins will update automatically before closing Neovim. If false, you will have to update them manually using lazy. |
on_update_show_changelog | true |
If true, after :DistroUpdate , the changes of the new version will be displayed. |
on_update_auto_quit | false |
If true, after :DistroUpdate , Neovim will close automatically. If false, you will have to close it manually to ensure stability. |
auto_accept_prompts | false |
If true, all prompts in :DistroUpdate will be accepted automatically. |
Options to configure where to store the plugins file and the rollback file.
Name | Default value | Description |
---|---|---|
snapshot_file | <nvim_config_dir>/lua/lazy_snapshot.lua |
File used by the command :DistroFreezePluginVersions to write the plugins. |
rollback_file | <nvim_cache_dir>/rollback.lua |
Rollback file automatically triggered by :DistroUpdate . This file will be used when you use :DistroUpdateRevert . |
-- distroupdate.nvim [distro update]
-- https://github.com/Zeioth/distroupdate.nvim
{
"Zeioth/distroupdate.nvim",
dependencies = { "nvim-lua/plenary.nvim" },
event = "VeryLazy",
opts = {
channel = "stable"
}
},
If you've used :DistroFreezePluginVersions
you have to pass the generated file to lazy, so it can use it. For that use the spec
option. You can find an example here.
One of the biggest challenges NormalNvim face is marketing. So share the project and tell your friends!
The GPL3 lua libraries this plugin use come from NormalNvim (Full rewrite) and AstroNvim (Foundation and git wrapper). So please support both projects if you enjoy this plugin.