Skip to content

docs: split general tips from lazy.nvim migration notes #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zuqini merged 1 commit into from
Apr 15, 2026
Merged

docs: split general tips from lazy.nvim migration notes #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions doc/zpack.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,8 +870,35 @@ dev mode Use `src = vim.fn.expand('~/projects/my_plugin.nvim')`
profiling Use `nvim --startuptime startuptime.log`.
Also see: https://gist.github.com/zuqini/35993710f81983fbfa6baca67bdb32ed

*zpack-migration-default-lazy*
default lazy plugins lazy.nvim's community specs silently default
top-level specs for utility libraries like
`plenary.nvim` to `lazy = true`, even without
lazy triggers or a lazy parent. zpack respects
your specs as-written, so set `lazy = true`
explicitly on such specs if you want the same
default.

------------------------------------------------------------------------------
11.2 TIPS *zpack-tips*

General tips and gotchas when using zpack:

*zpack-tip-install-update*
install/update feedback `vim.pack` surfaces install/update progress
via `:messages` (e.g. "vim.pack: Downloading
updates (0/83)"). These messages are hidden
if you have `vim.opt.cmdheight = 0`. Raise
it, check `:messages`, or route them through
a notifier:
- https://github.com/folke/snacks.nvim
- https://github.com/rcarriga/nvim-notify
- https://github.com/folke/noice.nvim
Also see |zpack-tip-noice| for compatibility
notes.

------------------------------------------------------------------------------
11.2 SNACKS.NVIM DASHBOARD *zpack-tip-snacks*
11.3 SNACKS.NVIM DASHBOARD *zpack-tip-snacks*

The default Snacks.nvim dashboard configuration includes a startup time
section that has a hard dependency on lazy.nvim. This will cause errors with
Expand All @@ -892,7 +919,7 @@ To work around this, remove the startup section from your dashboard config:
See: https://github.com/folke/snacks.nvim/issues/1778

------------------------------------------------------------------------------
11.3 NOICE.NVIM WITH VIM.PACK *zpack-tip-noice*
11.4 NOICE.NVIM WITH VIM.PACK *zpack-tip-noice*

noice.nvim filters out `vim.pack` messages by default, which means you
won't see install/update notifications from your plugin manager.
Expand Down
8 changes: 6 additions & 2 deletions docs/tips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ Most of your lazy.nvim plugin specs will work as-is with zpack. However, zpack f
- **version pinning**: lazy.nvim's `version` field maps to zpack's `sem_version`. See [Spec Reference](spec.md) and [version pinning examples](examples.md#version-pinning-for-lazynvim-compatibility)
- **dev mode**: Use `src = vim.fn.expand('~/projects/my_plugin.nvim')` for local development
- **profiling**: Use `nvim --startuptime startuptime.log`. Also refer to example [Neovim Profiler script](https://gist.github.com/zuqini/35993710f81983fbfa6baca67bdb32ed)
- **install/update feedback**: `vim.pack` surfaces progress via `:messages` (e.g. `vim.pack: Downloading updates (0/83)`) instead of a dedicated UI. These messages are hidden if you have `vim.opt.cmdheight = 0` — raise it, check `:messages`, or route them through a notifier like [snacks.notifier](https://github.com/folke/snacks.nvim), [nvim-notify](https://github.com/rcarriga/nvim-notify), or [noice.nvim](https://github.com/folke/noice.nvim)
- **passive libraries**: lazy.nvim's community specs silently force utility libraries like `plenary.nvim` to `lazy = true` regardless of your config. zpack respects your spec as-written, so set `lazy = true` explicitly on pure-dependency plugins you don't want eager-loaded
- **default lazy plugins**: lazy.nvim's community specs silently default top-level specs for utility libraries like `plenary.nvim` to `lazy = true`, even without lazy triggers or a lazy parent. zpack respects your specs as-written, so set `lazy = true` explicitly on such specs if you want the same default

## Tips

General tips and gotchas when using zpack:
- **install/update feedback**: `vim.pack` surfaces install/update progress via `:messages` (e.g. `vim.pack: Downloading updates (0/83)`). These messages are hidden if you have `vim.opt.cmdheight = 0` — raise it, check `:messages`, or route them through a notifier like [snacks.notifier](https://github.com/folke/snacks.nvim), [nvim-notify](https://github.com/rcarriga/nvim-notify), or [noice.nvim](https://github.com/folke/noice.nvim). Also see [noice.nvim with vim.pack](#noicenvim-with-vimpack) for compatibility notes

## Compatibility Notes

Expand Down
Loading